Skip to content

Type definitions#

Index > SSMContacts > Type definitions

Auto-generated documentation for SSMContacts type annotations stubs module mypy-boto3-ssm-contacts.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AcceptPageRequestRequestTypeDef#

# AcceptPageRequestRequestTypeDef definition

class AcceptPageRequestRequestTypeDef(TypedDict):
    PageId: str,
    AcceptType: AcceptTypeType,  # (1)
    AcceptCode: str,
    ContactChannelId: NotRequired[str],
    Note: NotRequired[str],
    AcceptCodeValidation: NotRequired[AcceptCodeValidationType],  # (2)
  1. See AcceptTypeType
  2. See AcceptCodeValidationType

ActivateContactChannelRequestRequestTypeDef#

# ActivateContactChannelRequestRequestTypeDef definition

class ActivateContactChannelRequestRequestTypeDef(TypedDict):
    ContactChannelId: str,
    ActivationCode: str,

ChannelTargetInfoTypeDef#

# ChannelTargetInfoTypeDef definition

class ChannelTargetInfoTypeDef(TypedDict):
    ContactChannelId: str,
    RetryIntervalInMinutes: NotRequired[int],

ContactChannelAddressTypeDef#

# ContactChannelAddressTypeDef definition

class ContactChannelAddressTypeDef(TypedDict):
    SimpleAddress: NotRequired[str],

ContactTargetInfoTypeDef#

# ContactTargetInfoTypeDef definition

class ContactTargetInfoTypeDef(TypedDict):
    IsEssential: bool,
    ContactId: NotRequired[str],

ContactTypeDef#

# ContactTypeDef definition

class ContactTypeDef(TypedDict):
    ContactArn: str,
    Alias: str,
    Type: ContactTypeType,  # (1)
    DisplayName: NotRequired[str],
  1. See ContactTypeType

HandOffTimeTypeDef#

# HandOffTimeTypeDef definition

class HandOffTimeTypeDef(TypedDict):
    HourOfDay: int,
    MinuteOfHour: int,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],

DeactivateContactChannelRequestRequestTypeDef#

# DeactivateContactChannelRequestRequestTypeDef definition

class DeactivateContactChannelRequestRequestTypeDef(TypedDict):
    ContactChannelId: str,

DeleteContactChannelRequestRequestTypeDef#

# DeleteContactChannelRequestRequestTypeDef definition

class DeleteContactChannelRequestRequestTypeDef(TypedDict):
    ContactChannelId: str,

DeleteContactRequestRequestTypeDef#

# DeleteContactRequestRequestTypeDef definition

class DeleteContactRequestRequestTypeDef(TypedDict):
    ContactId: str,

DeleteRotationOverrideRequestRequestTypeDef#

# DeleteRotationOverrideRequestRequestTypeDef definition

class DeleteRotationOverrideRequestRequestTypeDef(TypedDict):
    RotationId: str,
    RotationOverrideId: str,

DeleteRotationRequestRequestTypeDef#

# DeleteRotationRequestRequestTypeDef definition

class DeleteRotationRequestRequestTypeDef(TypedDict):
    RotationId: str,

DescribeEngagementRequestRequestTypeDef#

# DescribeEngagementRequestRequestTypeDef definition

class DescribeEngagementRequestRequestTypeDef(TypedDict):
    EngagementId: str,

DescribePageRequestRequestTypeDef#

# DescribePageRequestRequestTypeDef definition

class DescribePageRequestRequestTypeDef(TypedDict):
    PageId: str,

EngagementTypeDef#

# EngagementTypeDef definition

class EngagementTypeDef(TypedDict):
    EngagementArn: str,
    ContactArn: str,
    Sender: str,
    IncidentId: NotRequired[str],
    StartTime: NotRequired[datetime],
    StopTime: NotRequired[datetime],

GetContactChannelRequestRequestTypeDef#

# GetContactChannelRequestRequestTypeDef definition

class GetContactChannelRequestRequestTypeDef(TypedDict):
    ContactChannelId: str,

GetContactPolicyRequestRequestTypeDef#

# GetContactPolicyRequestRequestTypeDef definition

class GetContactPolicyRequestRequestTypeDef(TypedDict):
    ContactArn: str,

GetContactRequestRequestTypeDef#

# GetContactRequestRequestTypeDef definition

class GetContactRequestRequestTypeDef(TypedDict):
    ContactId: str,

GetRotationOverrideRequestRequestTypeDef#

# GetRotationOverrideRequestRequestTypeDef definition

class GetRotationOverrideRequestRequestTypeDef(TypedDict):
    RotationId: str,
    RotationOverrideId: str,

GetRotationRequestRequestTypeDef#

# GetRotationRequestRequestTypeDef definition

class GetRotationRequestRequestTypeDef(TypedDict):
    RotationId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListContactChannelsRequestRequestTypeDef#

# ListContactChannelsRequestRequestTypeDef definition

class ListContactChannelsRequestRequestTypeDef(TypedDict):
    ContactId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListContactsRequestRequestTypeDef#

# ListContactsRequestRequestTypeDef definition

class ListContactsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    AliasPrefix: NotRequired[str],
    Type: NotRequired[ContactTypeType],  # (1)
  1. See ContactTypeType

ListPageReceiptsRequestRequestTypeDef#

# ListPageReceiptsRequestRequestTypeDef definition

class ListPageReceiptsRequestRequestTypeDef(TypedDict):
    PageId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ReceiptTypeDef#

# ReceiptTypeDef definition

class ReceiptTypeDef(TypedDict):
    ReceiptType: ReceiptTypeType,  # (1)
    ReceiptTime: datetime,
    ContactChannelArn: NotRequired[str],
    ReceiptInfo: NotRequired[str],
  1. See ReceiptTypeType

ListPageResolutionsRequestRequestTypeDef#

# ListPageResolutionsRequestRequestTypeDef definition

class ListPageResolutionsRequestRequestTypeDef(TypedDict):
    PageId: str,
    NextToken: NotRequired[str],

ResolutionContactTypeDef#

# ResolutionContactTypeDef definition

class ResolutionContactTypeDef(TypedDict):
    ContactArn: str,
    Type: ContactTypeType,  # (1)
    StageIndex: NotRequired[int],
  1. See ContactTypeType

ListPagesByContactRequestRequestTypeDef#

# ListPagesByContactRequestRequestTypeDef definition

class ListPagesByContactRequestRequestTypeDef(TypedDict):
    ContactId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

PageTypeDef#

# PageTypeDef definition

class PageTypeDef(TypedDict):
    PageArn: str,
    EngagementArn: str,
    ContactArn: str,
    Sender: str,
    IncidentId: NotRequired[str],
    SentTime: NotRequired[datetime],
    DeliveryTime: NotRequired[datetime],
    ReadTime: NotRequired[datetime],

ListPagesByEngagementRequestRequestTypeDef#

# ListPagesByEngagementRequestRequestTypeDef definition

class ListPagesByEngagementRequestRequestTypeDef(TypedDict):
    EngagementId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

RotationOverrideTypeDef#

# RotationOverrideTypeDef definition

class RotationOverrideTypeDef(TypedDict):
    RotationOverrideId: str,
    NewContactIds: List[str],
    StartTime: datetime,
    EndTime: datetime,
    CreateTime: datetime,

ListRotationsRequestRequestTypeDef#

# ListRotationsRequestRequestTypeDef definition

class ListRotationsRequestRequestTypeDef(TypedDict):
    RotationNamePrefix: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,

PutContactPolicyRequestRequestTypeDef#

# PutContactPolicyRequestRequestTypeDef definition

class PutContactPolicyRequestRequestTypeDef(TypedDict):
    ContactArn: str,
    Policy: str,

ShiftDetailsTypeDef#

# ShiftDetailsTypeDef definition

class ShiftDetailsTypeDef(TypedDict):
    OverriddenContactIds: List[str],

SendActivationCodeRequestRequestTypeDef#

# SendActivationCodeRequestRequestTypeDef definition

class SendActivationCodeRequestRequestTypeDef(TypedDict):
    ContactChannelId: str,

StartEngagementRequestRequestTypeDef#

# StartEngagementRequestRequestTypeDef definition

class StartEngagementRequestRequestTypeDef(TypedDict):
    ContactId: str,
    Sender: str,
    Subject: str,
    Content: str,
    PublicSubject: NotRequired[str],
    PublicContent: NotRequired[str],
    IncidentId: NotRequired[str],
    IdempotencyToken: NotRequired[str],

StopEngagementRequestRequestTypeDef#

# StopEngagementRequestRequestTypeDef definition

class StopEngagementRequestRequestTypeDef(TypedDict):
    EngagementId: str,
    Reason: NotRequired[str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

ContactChannelTypeDef#

# ContactChannelTypeDef definition

class ContactChannelTypeDef(TypedDict):
    ContactChannelArn: str,
    ContactArn: str,
    Name: str,
    DeliveryAddress: ContactChannelAddressTypeDef,  # (2)
    ActivationStatus: ActivationStatusType,  # (3)
    Type: NotRequired[ChannelTypeType],  # (1)
  1. See ChannelTypeType
  2. See ContactChannelAddressTypeDef
  3. See ActivationStatusType

CreateContactChannelRequestRequestTypeDef#

# CreateContactChannelRequestRequestTypeDef definition

class CreateContactChannelRequestRequestTypeDef(TypedDict):
    ContactId: str,
    Name: str,
    Type: ChannelTypeType,  # (1)
    DeliveryAddress: ContactChannelAddressTypeDef,  # (2)
    DeferActivation: NotRequired[bool],
    IdempotencyToken: NotRequired[str],
  1. See ChannelTypeType
  2. See ContactChannelAddressTypeDef

UpdateContactChannelRequestRequestTypeDef#

# UpdateContactChannelRequestRequestTypeDef definition

class UpdateContactChannelRequestRequestTypeDef(TypedDict):
    ContactChannelId: str,
    Name: NotRequired[str],
    DeliveryAddress: NotRequired[ContactChannelAddressTypeDef],  # (1)
  1. See ContactChannelAddressTypeDef

TargetTypeDef#

# TargetTypeDef definition

class TargetTypeDef(TypedDict):
    ChannelTargetInfo: NotRequired[ChannelTargetInfoTypeDef],  # (1)
    ContactTargetInfo: NotRequired[ContactTargetInfoTypeDef],  # (2)
  1. See ChannelTargetInfoTypeDef
  2. See ContactTargetInfoTypeDef

CoverageTimeTypeDef#

# CoverageTimeTypeDef definition

class CoverageTimeTypeDef(TypedDict):
    Start: NotRequired[HandOffTimeTypeDef],  # (1)
    End: NotRequired[HandOffTimeTypeDef],  # (1)
  1. See HandOffTimeTypeDef
  2. See HandOffTimeTypeDef

MonthlySettingTypeDef#

# MonthlySettingTypeDef definition

class MonthlySettingTypeDef(TypedDict):
    DayOfMonth: int,
    HandOffTime: HandOffTimeTypeDef,  # (1)
  1. See HandOffTimeTypeDef

WeeklySettingTypeDef#

# WeeklySettingTypeDef definition

class WeeklySettingTypeDef(TypedDict):
    DayOfWeek: DayOfWeekType,  # (1)
    HandOffTime: HandOffTimeTypeDef,  # (2)
  1. See DayOfWeekType
  2. See HandOffTimeTypeDef

CreateContactChannelResultTypeDef#

# CreateContactChannelResultTypeDef definition

class CreateContactChannelResultTypeDef(TypedDict):
    ContactChannelArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateContactResultTypeDef#

# CreateContactResultTypeDef definition

class CreateContactResultTypeDef(TypedDict):
    ContactArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateRotationOverrideResultTypeDef#

# CreateRotationOverrideResultTypeDef definition

class CreateRotationOverrideResultTypeDef(TypedDict):
    RotationOverrideId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateRotationResultTypeDef#

# CreateRotationResultTypeDef definition

class CreateRotationResultTypeDef(TypedDict):
    RotationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeEngagementResultTypeDef#

# DescribeEngagementResultTypeDef definition

class DescribeEngagementResultTypeDef(TypedDict):
    ContactArn: str,
    EngagementArn: str,
    Sender: str,
    Subject: str,
    Content: str,
    PublicSubject: str,
    PublicContent: str,
    IncidentId: str,
    StartTime: datetime,
    StopTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribePageResultTypeDef#

# DescribePageResultTypeDef definition

class DescribePageResultTypeDef(TypedDict):
    PageArn: str,
    EngagementArn: str,
    ContactArn: str,
    Sender: str,
    Subject: str,
    Content: str,
    PublicSubject: str,
    PublicContent: str,
    IncidentId: str,
    SentTime: datetime,
    ReadTime: datetime,
    DeliveryTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetContactChannelResultTypeDef#

# GetContactChannelResultTypeDef definition

class GetContactChannelResultTypeDef(TypedDict):
    ContactArn: str,
    ContactChannelArn: str,
    Name: str,
    Type: ChannelTypeType,  # (1)
    DeliveryAddress: ContactChannelAddressTypeDef,  # (2)
    ActivationStatus: ActivationStatusType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ChannelTypeType
  2. See ContactChannelAddressTypeDef
  3. See ActivationStatusType
  4. See ResponseMetadataTypeDef

GetContactPolicyResultTypeDef#

# GetContactPolicyResultTypeDef definition

class GetContactPolicyResultTypeDef(TypedDict):
    ContactArn: str,
    Policy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetRotationOverrideResultTypeDef#

# GetRotationOverrideResultTypeDef definition

class GetRotationOverrideResultTypeDef(TypedDict):
    RotationOverrideId: str,
    RotationArn: str,
    NewContactIds: List[str],
    StartTime: datetime,
    EndTime: datetime,
    CreateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListContactsResultTypeDef#

# ListContactsResultTypeDef definition

class ListContactsResultTypeDef(TypedDict):
    NextToken: str,
    Contacts: List[ContactTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContactTypeDef
  2. See ResponseMetadataTypeDef

StartEngagementResultTypeDef#

# StartEngagementResultTypeDef definition

class StartEngagementResultTypeDef(TypedDict):
    EngagementArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResultTypeDef#

# ListTagsForResourceResultTypeDef definition

class ListTagsForResourceResultTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateRotationOverrideRequestRequestTypeDef#

# CreateRotationOverrideRequestRequestTypeDef definition

class CreateRotationOverrideRequestRequestTypeDef(TypedDict):
    RotationId: str,
    NewContactIds: Sequence[str],
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
    IdempotencyToken: NotRequired[str],

ListRotationOverridesRequestRequestTypeDef#

# ListRotationOverridesRequestRequestTypeDef definition

class ListRotationOverridesRequestRequestTypeDef(TypedDict):
    RotationId: str,
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListRotationShiftsRequestRequestTypeDef#

# ListRotationShiftsRequestRequestTypeDef definition

class ListRotationShiftsRequestRequestTypeDef(TypedDict):
    RotationId: str,
    EndTime: Union[datetime, str],
    StartTime: NotRequired[Union[datetime, str]],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

PreviewOverrideTypeDef#

# PreviewOverrideTypeDef definition

class PreviewOverrideTypeDef(TypedDict):
    NewMembers: NotRequired[Sequence[str]],
    StartTime: NotRequired[Union[datetime, str]],
    EndTime: NotRequired[Union[datetime, str]],

TimeRangeTypeDef#

# TimeRangeTypeDef definition

class TimeRangeTypeDef(TypedDict):
    StartTime: NotRequired[Union[datetime, str]],
    EndTime: NotRequired[Union[datetime, str]],

ListEngagementsResultTypeDef#

# ListEngagementsResultTypeDef definition

class ListEngagementsResultTypeDef(TypedDict):
    NextToken: str,
    Engagements: List[EngagementTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EngagementTypeDef
  2. See ResponseMetadataTypeDef

ListContactChannelsRequestListContactChannelsPaginateTypeDef