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#

# ListContactChannelsRequestListContactChannelsPaginateTypeDef definition

class ListContactChannelsRequestListContactChannelsPaginateTypeDef(TypedDict):
    ContactId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListContactsRequestListContactsPaginateTypeDef#

# ListContactsRequestListContactsPaginateTypeDef definition

class ListContactsRequestListContactsPaginateTypeDef(TypedDict):
    AliasPrefix: NotRequired[str],
    Type: NotRequired[ContactTypeType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ContactTypeType
  2. See PaginatorConfigTypeDef

ListPageReceiptsRequestListPageReceiptsPaginateTypeDef#

# ListPageReceiptsRequestListPageReceiptsPaginateTypeDef definition

class ListPageReceiptsRequestListPageReceiptsPaginateTypeDef(TypedDict):
    PageId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPageResolutionsRequestListPageResolutionsPaginateTypeDef#

# ListPageResolutionsRequestListPageResolutionsPaginateTypeDef definition

class ListPageResolutionsRequestListPageResolutionsPaginateTypeDef(TypedDict):
    PageId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPagesByContactRequestListPagesByContactPaginateTypeDef#

# ListPagesByContactRequestListPagesByContactPaginateTypeDef definition

class ListPagesByContactRequestListPagesByContactPaginateTypeDef(TypedDict):
    ContactId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPagesByEngagementRequestListPagesByEngagementPaginateTypeDef#

# ListPagesByEngagementRequestListPagesByEngagementPaginateTypeDef definition

class ListPagesByEngagementRequestListPagesByEngagementPaginateTypeDef(TypedDict):
    EngagementId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListRotationOverridesRequestListRotationOverridesPaginateTypeDef#

# ListRotationOverridesRequestListRotationOverridesPaginateTypeDef definition

class ListRotationOverridesRequestListRotationOverridesPaginateTypeDef(TypedDict):
    RotationId: str,
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListRotationShiftsRequestListRotationShiftsPaginateTypeDef#

# ListRotationShiftsRequestListRotationShiftsPaginateTypeDef definition

class ListRotationShiftsRequestListRotationShiftsPaginateTypeDef(TypedDict):
    RotationId: str,
    EndTime: Union[datetime, str],
    StartTime: NotRequired[Union[datetime, str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListRotationsRequestListRotationsPaginateTypeDef#

# ListRotationsRequestListRotationsPaginateTypeDef definition

class ListRotationsRequestListRotationsPaginateTypeDef(TypedDict):
    RotationNamePrefix: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPageReceiptsResultTypeDef#

# ListPageReceiptsResultTypeDef definition

class ListPageReceiptsResultTypeDef(TypedDict):
    NextToken: str,
    Receipts: List[ReceiptTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReceiptTypeDef
  2. See ResponseMetadataTypeDef

ListPageResolutionsResultTypeDef#

# ListPageResolutionsResultTypeDef definition

class ListPageResolutionsResultTypeDef(TypedDict):
    NextToken: str,
    PageResolutions: List[ResolutionContactTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResolutionContactTypeDef
  2. See ResponseMetadataTypeDef

ListPagesByContactResultTypeDef#

# ListPagesByContactResultTypeDef definition

class ListPagesByContactResultTypeDef(TypedDict):
    NextToken: str,
    Pages: List[PageTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PageTypeDef
  2. See ResponseMetadataTypeDef

ListPagesByEngagementResultTypeDef#

# ListPagesByEngagementResultTypeDef definition

class ListPagesByEngagementResultTypeDef(TypedDict):
    NextToken: str,
    Pages: List[PageTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PageTypeDef
  2. See ResponseMetadataTypeDef

ListRotationOverridesResultTypeDef#

# ListRotationOverridesResultTypeDef definition

class ListRotationOverridesResultTypeDef(TypedDict):
    RotationOverrides: List[RotationOverrideTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RotationOverrideTypeDef
  2. See ResponseMetadataTypeDef

RotationShiftTypeDef#

# RotationShiftTypeDef definition

class RotationShiftTypeDef(TypedDict):
    StartTime: datetime,
    EndTime: datetime,
    ContactIds: NotRequired[List[str]],
    Type: NotRequired[ShiftTypeType],  # (1)
    ShiftDetails: NotRequired[ShiftDetailsTypeDef],  # (2)
  1. See ShiftTypeType
  2. See ShiftDetailsTypeDef

ListContactChannelsResultTypeDef#

# ListContactChannelsResultTypeDef definition

class ListContactChannelsResultTypeDef(TypedDict):
    NextToken: str,
    ContactChannels: List[ContactChannelTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContactChannelTypeDef
  2. See ResponseMetadataTypeDef

StageTypeDef#

# StageTypeDef definition

class StageTypeDef(TypedDict):
    DurationInMinutes: int,
    Targets: Sequence[TargetTypeDef],  # (1)
  1. See TargetTypeDef

RecurrenceSettingsTypeDef#

# RecurrenceSettingsTypeDef definition

class RecurrenceSettingsTypeDef(TypedDict):
    NumberOfOnCalls: int,
    RecurrenceMultiplier: int,
    MonthlySettings: NotRequired[Sequence[MonthlySettingTypeDef]],  # (1)
    WeeklySettings: NotRequired[Sequence[WeeklySettingTypeDef]],  # (2)
    DailySettings: NotRequired[Sequence[HandOffTimeTypeDef]],  # (3)
    ShiftCoverages: NotRequired[Mapping[DayOfWeekType, Sequence[CoverageTimeTypeDef]]],  # (4)
  1. See MonthlySettingTypeDef
  2. See WeeklySettingTypeDef
  3. See HandOffTimeTypeDef
  4. See DayOfWeekType CoverageTimeTypeDef

ListEngagementsRequestListEngagementsPaginateTypeDef#

# ListEngagementsRequestListEngagementsPaginateTypeDef definition

class ListEngagementsRequestListEngagementsPaginateTypeDef(TypedDict):
    IncidentId: NotRequired[str],
    TimeRangeValue: NotRequired[TimeRangeTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See TimeRangeTypeDef
  2. See PaginatorConfigTypeDef

ListEngagementsRequestRequestTypeDef#

# ListEngagementsRequestRequestTypeDef definition

class ListEngagementsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    IncidentId: NotRequired[str],
    TimeRangeValue: NotRequired[TimeRangeTypeDef],  # (1)
  1. See TimeRangeTypeDef

ListPreviewRotationShiftsResultTypeDef#

# ListPreviewRotationShiftsResultTypeDef definition

class ListPreviewRotationShiftsResultTypeDef(TypedDict):
    RotationShifts: List[RotationShiftTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RotationShiftTypeDef
  2. See ResponseMetadataTypeDef

ListRotationShiftsResultTypeDef#

# ListRotationShiftsResultTypeDef definition

class ListRotationShiftsResultTypeDef(TypedDict):
    RotationShifts: List[RotationShiftTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RotationShiftTypeDef
  2. See ResponseMetadataTypeDef

PlanTypeDef#

# PlanTypeDef definition

class PlanTypeDef(TypedDict):
    Stages: NotRequired[Sequence[StageTypeDef]],  # (1)
    RotationIds: NotRequired[Sequence[str]],
  1. See StageTypeDef

CreateRotationRequestRequestTypeDef#

# CreateRotationRequestRequestTypeDef definition

class CreateRotationRequestRequestTypeDef(TypedDict):
    Name: str,
    ContactIds: Sequence[str],
    TimeZoneId: str,
    Recurrence: RecurrenceSettingsTypeDef,  # (1)
    StartTime: NotRequired[Union[datetime, str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    IdempotencyToken: NotRequired[str],
  1. See RecurrenceSettingsTypeDef
  2. See TagTypeDef

GetRotationResultTypeDef#

# GetRotationResultTypeDef definition

class GetRotationResultTypeDef(TypedDict):
    RotationArn: str,
    Name: str,
    ContactIds: List[str],
    StartTime: datetime,
    TimeZoneId: str,
    Recurrence: RecurrenceSettingsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RecurrenceSettingsTypeDef
  2. See ResponseMetadataTypeDef

ListPreviewRotationShiftsRequestListPreviewRotationShiftsPaginateTypeDef#

# ListPreviewRotationShiftsRequestListPreviewRotationShiftsPaginateTypeDef definition

class ListPreviewRotationShiftsRequestListPreviewRotationShiftsPaginateTypeDef(TypedDict):
    EndTime: Union[datetime, str],
    Members: Sequence[str],
    TimeZoneId: str,
    Recurrence: RecurrenceSettingsTypeDef,  # (1)
    RotationStartTime: NotRequired[Union[datetime, str]],
    StartTime: NotRequired[Union[datetime, str]],
    Overrides: NotRequired[Sequence[PreviewOverrideTypeDef]],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See RecurrenceSettingsTypeDef
  2. See PreviewOverrideTypeDef
  3. See PaginatorConfigTypeDef

ListPreviewRotationShiftsRequestRequestTypeDef#

# ListPreviewRotationShiftsRequestRequestTypeDef definition

class ListPreviewRotationShiftsRequestRequestTypeDef(TypedDict):
    EndTime: Union[datetime, str],
    Members: Sequence[str],
    TimeZoneId: str,
    Recurrence: RecurrenceSettingsTypeDef,  # (1)
    RotationStartTime: NotRequired[Union[datetime, str]],
    StartTime: NotRequired[Union[datetime, str]],
    Overrides: NotRequired[Sequence[PreviewOverrideTypeDef]],  # (2)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See RecurrenceSettingsTypeDef
  2. See PreviewOverrideTypeDef

RotationTypeDef#

# RotationTypeDef definition

class RotationTypeDef(TypedDict):
    RotationArn: str,
    Name: str,
    ContactIds: NotRequired[List[str]],
    StartTime: NotRequired[datetime],
    TimeZoneId: NotRequired[str],
    Recurrence: NotRequired[RecurrenceSettingsTypeDef],  # (1)
  1. See RecurrenceSettingsTypeDef

UpdateRotationRequestRequestTypeDef#

# UpdateRotationRequestRequestTypeDef definition

class UpdateRotationRequestRequestTypeDef(TypedDict):
    RotationId: str,
    Recurrence: RecurrenceSettingsTypeDef,  # (1)
    ContactIds: NotRequired[Sequence[str]],
    StartTime: NotRequired[Union[datetime, str]],
    TimeZoneId: NotRequired[str],
  1. See RecurrenceSettingsTypeDef

CreateContactRequestRequestTypeDef#

# CreateContactRequestRequestTypeDef definition

class CreateContactRequestRequestTypeDef(TypedDict):
    Alias: str,
    Type: ContactTypeType,  # (1)
    Plan: PlanTypeDef,  # (2)
    DisplayName: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
    IdempotencyToken: NotRequired[str],
  1. See ContactTypeType
  2. See PlanTypeDef
  3. See TagTypeDef

GetContactResultTypeDef#

# GetContactResultTypeDef definition

class GetContactResultTypeDef(TypedDict):
    ContactArn: str,
    Alias: str,
    DisplayName: str,
    Type: ContactTypeType,  # (1)
    Plan: PlanTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ContactTypeType
  2. See PlanTypeDef
  3. See ResponseMetadataTypeDef

UpdateContactRequestRequestTypeDef#

# UpdateContactRequestRequestTypeDef definition

class UpdateContactRequestRequestTypeDef(TypedDict):
    ContactId: str,
    DisplayName: NotRequired[str],
    Plan: NotRequired[PlanTypeDef],  # (1)
  1. See PlanTypeDef

ListRotationsResultTypeDef#

# ListRotationsResultTypeDef definition

class ListRotationsResultTypeDef(TypedDict):
    NextToken: str,
    Rotations: List[RotationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RotationTypeDef
  2. See ResponseMetadataTypeDef