Type definitions#
Index > SSMContacts > Type definitions
Auto-generated documentation for SSMContacts type annotations stubs module types-aiobotocore-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)
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],
- See ContactTypeType
HandOffTimeTypeDef#
# HandOffTimeTypeDef definition
class HandOffTimeTypeDef(TypedDict):
HourOfDay: int,
MinuteOfHour: int,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
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)
- 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],
- 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],
- 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)
CreateContactChannelRequestRequestTypeDef#
# CreateContactChannelRequestRequestTypeDef definition
class CreateContactChannelRequestRequestTypeDef(TypedDict):
ContactId: str,
Name: str,
Type: ChannelTypeType, # (1)
DeliveryAddress: ContactChannelAddressTypeDef, # (2)
DeferActivation: NotRequired[bool],
IdempotencyToken: NotRequired[str],
UpdateContactChannelRequestRequestTypeDef#
# UpdateContactChannelRequestRequestTypeDef definition
class UpdateContactChannelRequestRequestTypeDef(TypedDict):
ContactChannelId: str,
Name: NotRequired[str],
DeliveryAddress: NotRequired[ContactChannelAddressTypeDef], # (1)
TargetTypeDef#
# TargetTypeDef definition
class TargetTypeDef(TypedDict):
ChannelTargetInfo: NotRequired[ChannelTargetInfoTypeDef], # (1)
ContactTargetInfo: NotRequired[ContactTargetInfoTypeDef], # (2)
CoverageTimeTypeDef#
# CoverageTimeTypeDef definition
class CoverageTimeTypeDef(TypedDict):
Start: NotRequired[HandOffTimeTypeDef], # (1)
End: NotRequired[HandOffTimeTypeDef], # (1)
- See HandOffTimeTypeDef
- See HandOffTimeTypeDef
MonthlySettingTypeDef#
# MonthlySettingTypeDef definition
class MonthlySettingTypeDef(TypedDict):
DayOfMonth: int,
HandOffTime: HandOffTimeTypeDef, # (1)
WeeklySettingTypeDef#
# WeeklySettingTypeDef definition
class WeeklySettingTypeDef(TypedDict):
DayOfWeek: DayOfWeekType, # (1)
HandOffTime: HandOffTimeTypeDef, # (2)
- See DayOfWeekType
- See HandOffTimeTypeDef
CreateContactChannelResultTypeDef#
# CreateContactChannelResultTypeDef definition
class CreateContactChannelResultTypeDef(TypedDict):
ContactChannelArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateContactResultTypeDef#
# CreateContactResultTypeDef definition
class CreateContactResultTypeDef(TypedDict):
ContactArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateRotationOverrideResultTypeDef#
# CreateRotationOverrideResultTypeDef definition
class CreateRotationOverrideResultTypeDef(TypedDict):
RotationOverrideId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateRotationResultTypeDef#
# CreateRotationResultTypeDef definition
class CreateRotationResultTypeDef(TypedDict):
RotationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
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)
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)
GetContactChannelResultTypeDef#
# GetContactChannelResultTypeDef definition
class GetContactChannelResultTypeDef(TypedDict):
ContactArn: str,
ContactChannelArn: str,
Name: str,
Type: ChannelTypeType, # (1)
DeliveryAddress: ContactChannelAddressTypeDef, # (2)
ActivationStatus: ActivationStatusType, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See ChannelTypeType
- See ContactChannelAddressTypeDef
- See ActivationStatusType
- See ResponseMetadataTypeDef
GetContactPolicyResultTypeDef#
# GetContactPolicyResultTypeDef definition
class GetContactPolicyResultTypeDef(TypedDict):
ContactArn: str,
Policy: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetRotationOverrideResultTypeDef#
# GetRotationOverrideResultTypeDef definition
class GetRotationOverrideResultTypeDef(TypedDict):
RotationOverrideId: str,
RotationArn: str,
NewContactIds: List[str],
StartTime: datetime,
EndTime: datetime,
CreateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListContactsResultTypeDef#
# ListContactsResultTypeDef definition
class ListContactsResultTypeDef(TypedDict):
NextToken: str,
Contacts: List[ContactTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartEngagementResultTypeDef#
# StartEngagementResultTypeDef definition
class StartEngagementResultTypeDef(TypedDict):
EngagementArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResultTypeDef#
# ListTagsForResourceResultTypeDef definition
class ListTagsForResourceResultTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (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)
ListContactChannelsRequestListContactChannelsPaginateTypeDef#
# ListContactChannelsRequestListContactChannelsPaginateTypeDef definition
class ListContactChannelsRequestListContactChannelsPaginateTypeDef(TypedDict):
ContactId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListContactsRequestListContactsPaginateTypeDef#
# ListContactsRequestListContactsPaginateTypeDef definition
class ListContactsRequestListContactsPaginateTypeDef(TypedDict):
AliasPrefix: NotRequired[str],
Type: NotRequired[ContactTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListPageReceiptsRequestListPageReceiptsPaginateTypeDef#
# ListPageReceiptsRequestListPageReceiptsPaginateTypeDef definition
class ListPageReceiptsRequestListPageReceiptsPaginateTypeDef(TypedDict):
PageId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPageResolutionsRequestListPageResolutionsPaginateTypeDef#
# ListPageResolutionsRequestListPageResolutionsPaginateTypeDef definition
class ListPageResolutionsRequestListPageResolutionsPaginateTypeDef(TypedDict):
PageId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPagesByContactRequestListPagesByContactPaginateTypeDef#
# ListPagesByContactRequestListPagesByContactPaginateTypeDef definition
class ListPagesByContactRequestListPagesByContactPaginateTypeDef(TypedDict):
ContactId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPagesByEngagementRequestListPagesByEngagementPaginateTypeDef#
# ListPagesByEngagementRequestListPagesByEngagementPaginateTypeDef definition
class ListPagesByEngagementRequestListPagesByEngagementPaginateTypeDef(TypedDict):
EngagementId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListRotationOverridesRequestListRotationOverridesPaginateTypeDef#
# ListRotationOverridesRequestListRotationOverridesPaginateTypeDef definition
class ListRotationOverridesRequestListRotationOverridesPaginateTypeDef(TypedDict):
RotationId: str,
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListRotationShiftsRequestListRotationShiftsPaginateTypeDef#
# ListRotationShiftsRequestListRotationShiftsPaginateTypeDef definition
class ListRotationShiftsRequestListRotationShiftsPaginateTypeDef(TypedDict):
RotationId: str,
EndTime: Union[datetime, str],
StartTime: NotRequired[Union[datetime, str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListRotationsRequestListRotationsPaginateTypeDef#
# ListRotationsRequestListRotationsPaginateTypeDef definition
class ListRotationsRequestListRotationsPaginateTypeDef(TypedDict):
RotationNamePrefix: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPageReceiptsResultTypeDef#
# ListPageReceiptsResultTypeDef definition
class ListPageReceiptsResultTypeDef(TypedDict):
NextToken: str,
Receipts: List[ReceiptTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListPageResolutionsResultTypeDef#
# ListPageResolutionsResultTypeDef definition
class ListPageResolutionsResultTypeDef(TypedDict):
NextToken: str,
PageResolutions: List[ResolutionContactTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListPagesByContactResultTypeDef#
# ListPagesByContactResultTypeDef definition
class ListPagesByContactResultTypeDef(TypedDict):
NextToken: str,
Pages: List[PageTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See PageTypeDef
- See ResponseMetadataTypeDef
ListPagesByEngagementResultTypeDef#
# ListPagesByEngagementResultTypeDef definition
class ListPagesByEngagementResultTypeDef(TypedDict):
NextToken: str,
Pages: List[PageTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See PageTypeDef
- See ResponseMetadataTypeDef
ListRotationOverridesResultTypeDef#
# ListRotationOverridesResultTypeDef definition
class ListRotationOverridesResultTypeDef(TypedDict):
RotationOverrides: List[RotationOverrideTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RotationShiftTypeDef#
# RotationShiftTypeDef definition
class RotationShiftTypeDef(TypedDict):
StartTime: datetime,
EndTime: datetime,
ContactIds: NotRequired[List[str]],
Type: NotRequired[ShiftTypeType], # (1)
ShiftDetails: NotRequired[ShiftDetailsTypeDef], # (2)
- See ShiftTypeType
- See ShiftDetailsTypeDef
ListContactChannelsResultTypeDef#
# ListContactChannelsResultTypeDef definition
class ListContactChannelsResultTypeDef(TypedDict):
NextToken: str,
ContactChannels: List[ContactChannelTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StageTypeDef#
# StageTypeDef definition
class StageTypeDef(TypedDict):
DurationInMinutes: int,
Targets: Sequence[TargetTypeDef], # (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)
- See MonthlySettingTypeDef
- See WeeklySettingTypeDef
- See HandOffTimeTypeDef
- See DayOfWeekType CoverageTimeTypeDef
ListEngagementsRequestListEngagementsPaginateTypeDef#
# ListEngagementsRequestListEngagementsPaginateTypeDef definition
class ListEngagementsRequestListEngagementsPaginateTypeDef(TypedDict):
IncidentId: NotRequired[str],
TimeRangeValue: NotRequired[TimeRangeTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListEngagementsRequestRequestTypeDef#
# ListEngagementsRequestRequestTypeDef definition
class ListEngagementsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
IncidentId: NotRequired[str],
TimeRangeValue: NotRequired[TimeRangeTypeDef], # (1)
- See TimeRangeTypeDef
ListPreviewRotationShiftsResultTypeDef#
# ListPreviewRotationShiftsResultTypeDef definition
class ListPreviewRotationShiftsResultTypeDef(TypedDict):
RotationShifts: List[RotationShiftTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListRotationShiftsResultTypeDef#
# ListRotationShiftsResultTypeDef definition
class ListRotationShiftsResultTypeDef(TypedDict):
RotationShifts: List[RotationShiftTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PlanTypeDef#
# PlanTypeDef definition
class PlanTypeDef(TypedDict):
Stages: NotRequired[Sequence[StageTypeDef]], # (1)
RotationIds: NotRequired[Sequence[str]],
- 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],
- See RecurrenceSettingsTypeDef
- 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)
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)
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],
RotationTypeDef#
# RotationTypeDef definition
class RotationTypeDef(TypedDict):
RotationArn: str,
Name: str,
ContactIds: NotRequired[List[str]],
StartTime: NotRequired[datetime],
TimeZoneId: NotRequired[str],
Recurrence: NotRequired[RecurrenceSettingsTypeDef], # (1)
UpdateRotationRequestRequestTypeDef#
# UpdateRotationRequestRequestTypeDef definition
class UpdateRotationRequestRequestTypeDef(TypedDict):
RotationId: str,
Recurrence: RecurrenceSettingsTypeDef, # (1)
ContactIds: NotRequired[Sequence[str]],
StartTime: NotRequired[Union[datetime, str]],
TimeZoneId: NotRequired[str],
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],
- See ContactTypeType
- See PlanTypeDef
- See TagTypeDef
GetContactResultTypeDef#
# GetContactResultTypeDef definition
class GetContactResultTypeDef(TypedDict):
ContactArn: str,
Alias: str,
DisplayName: str,
Type: ContactTypeType, # (1)
Plan: PlanTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See ContactTypeType
- See PlanTypeDef
- See ResponseMetadataTypeDef
UpdateContactRequestRequestTypeDef#
# UpdateContactRequestRequestTypeDef definition
class UpdateContactRequestRequestTypeDef(TypedDict):
ContactId: str,
DisplayName: NotRequired[str],
Plan: NotRequired[PlanTypeDef], # (1)
- See PlanTypeDef
ListRotationsResultTypeDef#
# ListRotationsResultTypeDef definition
class ListRotationsResultTypeDef(TypedDict):
NextToken: str,
Rotations: List[RotationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)