Skip to content

Typed dictionaries

Index > SSMContacts > Typed dictionaries

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

AcceptPageRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import AcceptPageRequestRequestTypeDef

def get_value() -> AcceptPageRequestRequestTypeDef:
    return {
        "PageId": ...,
        "AcceptType": ...,
        "AcceptCode": ...,
    }
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

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ActivateContactChannelRequestRequestTypeDef

def get_value() -> ActivateContactChannelRequestRequestTypeDef:
    return {
        "ContactChannelId": ...,
        "ActivationCode": ...,
    }
Definition
class ActivateContactChannelRequestRequestTypeDef(TypedDict):
    ContactChannelId: str,
    ActivationCode: str,

ChannelTargetInfoTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ChannelTargetInfoTypeDef

def get_value() -> ChannelTargetInfoTypeDef:
    return {
        "ContactChannelId": ...,
    }
Definition
class ChannelTargetInfoTypeDef(TypedDict):
    ContactChannelId: str,
    RetryIntervalInMinutes: NotRequired[int],

ContactChannelAddressTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ContactChannelAddressTypeDef

def get_value() -> ContactChannelAddressTypeDef:
    return {
        "SimpleAddress": ...,
    }
Definition
class ContactChannelAddressTypeDef(TypedDict):
    SimpleAddress: NotRequired[str],

ContactTargetInfoTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ContactTargetInfoTypeDef

def get_value() -> ContactTargetInfoTypeDef:
    return {
        "IsEssential": ...,
    }
Definition
class ContactTargetInfoTypeDef(TypedDict):
    IsEssential: bool,
    ContactId: NotRequired[str],

ContactTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ContactTypeDef

def get_value() -> ContactTypeDef:
    return {
        "ContactArn": ...,
        "Alias": ...,
        "Type": ...,
    }
Definition
class ContactTypeDef(TypedDict):
    ContactArn: str,
    Alias: str,
    Type: ContactTypeType,  # (1)
    DisplayName: NotRequired[str],
  1. See ContactTypeType

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

TagTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }
Definition
class TagTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],

DeactivateContactChannelRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import DeactivateContactChannelRequestRequestTypeDef

def get_value() -> DeactivateContactChannelRequestRequestTypeDef:
    return {
        "ContactChannelId": ...,
    }
Definition
class DeactivateContactChannelRequestRequestTypeDef(TypedDict):
    ContactChannelId: str,

DeleteContactChannelRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import DeleteContactChannelRequestRequestTypeDef

def get_value() -> DeleteContactChannelRequestRequestTypeDef:
    return {
        "ContactChannelId": ...,
    }
Definition
class DeleteContactChannelRequestRequestTypeDef(TypedDict):
    ContactChannelId: str,

DeleteContactRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import DeleteContactRequestRequestTypeDef

def get_value() -> DeleteContactRequestRequestTypeDef:
    return {
        "ContactId": ...,
    }
Definition
class DeleteContactRequestRequestTypeDef(TypedDict):
    ContactId: str,

DescribeEngagementRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import DescribeEngagementRequestRequestTypeDef

def get_value() -> DescribeEngagementRequestRequestTypeDef:
    return {
        "EngagementId": ...,
    }
Definition
class DescribeEngagementRequestRequestTypeDef(TypedDict):
    EngagementId: str,

DescribePageRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import DescribePageRequestRequestTypeDef

def get_value() -> DescribePageRequestRequestTypeDef:
    return {
        "PageId": ...,
    }
Definition
class DescribePageRequestRequestTypeDef(TypedDict):
    PageId: str,

EngagementTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import EngagementTypeDef

def get_value() -> EngagementTypeDef:
    return {
        "EngagementArn": ...,
        "ContactArn": ...,
        "Sender": ...,
    }
Definition
class EngagementTypeDef(TypedDict):
    EngagementArn: str,
    ContactArn: str,
    Sender: str,
    IncidentId: NotRequired[str],
    StartTime: NotRequired[datetime],
    StopTime: NotRequired[datetime],

GetContactChannelRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import GetContactChannelRequestRequestTypeDef

def get_value() -> GetContactChannelRequestRequestTypeDef:
    return {
        "ContactChannelId": ...,
    }
Definition
class GetContactChannelRequestRequestTypeDef(TypedDict):
    ContactChannelId: str,

GetContactPolicyRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import GetContactPolicyRequestRequestTypeDef

def get_value() -> GetContactPolicyRequestRequestTypeDef:
    return {
        "ContactArn": ...,
    }
Definition
class GetContactPolicyRequestRequestTypeDef(TypedDict):
    ContactArn: str,

GetContactRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import GetContactRequestRequestTypeDef

def get_value() -> GetContactRequestRequestTypeDef:
    return {
        "ContactId": ...,
    }
Definition
class GetContactRequestRequestTypeDef(TypedDict):
    ContactId: str,

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListContactChannelsRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ListContactChannelsRequestRequestTypeDef

def get_value() -> ListContactChannelsRequestRequestTypeDef:
    return {
        "ContactId": ...,
    }
Definition
class ListContactChannelsRequestRequestTypeDef(TypedDict):
    ContactId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListContactsRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ListContactsRequestRequestTypeDef

def get_value() -> ListContactsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
Definition
class ListContactsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    AliasPrefix: NotRequired[str],
    Type: NotRequired[ContactTypeType],  # (1)
  1. See ContactTypeType

TimeRangeTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import TimeRangeTypeDef

def get_value() -> TimeRangeTypeDef:
    return {
        "StartTime": ...,
    }
Definition
class TimeRangeTypeDef(TypedDict):
    StartTime: NotRequired[Union[datetime, str]],
    EndTime: NotRequired[Union[datetime, str]],

ListPageReceiptsRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ListPageReceiptsRequestRequestTypeDef

def get_value() -> ListPageReceiptsRequestRequestTypeDef:
    return {
        "PageId": ...,
    }
Definition
class ListPageReceiptsRequestRequestTypeDef(TypedDict):
    PageId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ReceiptTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ReceiptTypeDef

def get_value() -> ReceiptTypeDef:
    return {
        "ReceiptType": ...,
        "ReceiptTime": ...,
    }
Definition
class ReceiptTypeDef(TypedDict):
    ReceiptType: ReceiptTypeType,  # (1)
    ReceiptTime: datetime,
    ContactChannelArn: NotRequired[str],
    ReceiptInfo: NotRequired[str],
  1. See ReceiptTypeType

ListPagesByContactRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ListPagesByContactRequestRequestTypeDef

def get_value() -> ListPagesByContactRequestRequestTypeDef:
    return {
        "ContactId": ...,
    }
Definition
class ListPagesByContactRequestRequestTypeDef(TypedDict):
    ContactId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

PageTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import PageTypeDef

def get_value() -> PageTypeDef:
    return {
        "PageArn": ...,
        "EngagementArn": ...,
        "ContactArn": ...,
        "Sender": ...,
    }
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

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ListPagesByEngagementRequestRequestTypeDef

def get_value() -> ListPagesByEngagementRequestRequestTypeDef:
    return {
        "EngagementId": ...,
    }
Definition
class ListPagesByEngagementRequestRequestTypeDef(TypedDict):
    EngagementId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListTagsForResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
    }
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,

PutContactPolicyRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import PutContactPolicyRequestRequestTypeDef

def get_value() -> PutContactPolicyRequestRequestTypeDef:
    return {
        "ContactArn": ...,
        "Policy": ...,
    }
Definition
class PutContactPolicyRequestRequestTypeDef(TypedDict):
    ContactArn: str,
    Policy: str,

SendActivationCodeRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import SendActivationCodeRequestRequestTypeDef

def get_value() -> SendActivationCodeRequestRequestTypeDef:
    return {
        "ContactChannelId": ...,
    }
Definition
class SendActivationCodeRequestRequestTypeDef(TypedDict):
    ContactChannelId: str,

StartEngagementRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import StartEngagementRequestRequestTypeDef

def get_value() -> StartEngagementRequestRequestTypeDef:
    return {
        "ContactId": ...,
        "Sender": ...,
        "Subject": ...,
        "Content": ...,
    }
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

Usage Example
from mypy_boto3_ssm_contacts.type_defs import StopEngagementRequestRequestTypeDef

def get_value() -> StopEngagementRequestRequestTypeDef:
    return {
        "EngagementId": ...,
    }
Definition
class StopEngagementRequestRequestTypeDef(TypedDict):
    EngagementId: str,
    Reason: NotRequired[str],

UntagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
        "TagKeys": ...,
    }
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

ContactChannelTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ContactChannelTypeDef

def get_value() -> ContactChannelTypeDef:
    return {
        "ContactChannelArn": ...,
        "ContactArn": ...,
        "Name": ...,
        "DeliveryAddress": ...,
        "ActivationStatus": ...,
    }
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

Usage Example
from mypy_boto3_ssm_contacts.type_defs import CreateContactChannelRequestRequestTypeDef

def get_value() -> CreateContactChannelRequestRequestTypeDef:
    return {
        "ContactId": ...,
        "Name": ...,
        "Type": ...,
        "DeliveryAddress": ...,
    }
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

Usage Example
from mypy_boto3_ssm_contacts.type_defs import UpdateContactChannelRequestRequestTypeDef

def get_value() -> UpdateContactChannelRequestRequestTypeDef:
    return {
        "ContactChannelId": ...,
    }
Definition
class UpdateContactChannelRequestRequestTypeDef(TypedDict):
    ContactChannelId: str,
    Name: NotRequired[str],
    DeliveryAddress: NotRequired[ContactChannelAddressTypeDef],  # (1)
  1. See ContactChannelAddressTypeDef

TargetTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import TargetTypeDef

def get_value() -> TargetTypeDef:
    return {
        "ChannelTargetInfo": ...,
    }
Definition
class TargetTypeDef(TypedDict):
    ChannelTargetInfo: NotRequired[ChannelTargetInfoTypeDef],  # (1)
    ContactTargetInfo: NotRequired[ContactTargetInfoTypeDef],  # (2)
  1. See ChannelTargetInfoTypeDef
  2. See ContactTargetInfoTypeDef

CreateContactChannelResultTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import CreateContactChannelResultTypeDef

def get_value() -> CreateContactChannelResultTypeDef:
    return {
        "ContactChannelArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateContactChannelResultTypeDef(TypedDict):
    ContactChannelArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateContactResultTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import CreateContactResultTypeDef

def get_value() -> CreateContactResultTypeDef:
    return {
        "ContactArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateContactResultTypeDef(TypedDict):
    ContactArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeEngagementResultTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import DescribeEngagementResultTypeDef

def get_value() -> DescribeEngagementResultTypeDef:
    return {
        "ContactArn": ...,
        "EngagementArn": ...,
        "Sender": ...,
        "Subject": ...,
        "Content": ...,
        "PublicSubject": ...,
        "PublicContent": ...,
        "IncidentId": ...,
        "StartTime": ...,
        "StopTime": ...,
        "ResponseMetadata": ...,
    }
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

Usage Example
from mypy_boto3_ssm_contacts.type_defs import DescribePageResultTypeDef

def get_value() -> DescribePageResultTypeDef:
    return {
        "PageArn": ...,
        "EngagementArn": ...,
        "ContactArn": ...,
        "Sender": ...,
        "Subject": ...,
        "Content": ...,
        "PublicSubject": ...,
        "PublicContent": ...,
        "IncidentId": ...,
        "SentTime": ...,
        "ReadTime": ...,
        "DeliveryTime": ...,
        "ResponseMetadata": ...,
    }
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

Usage Example
from mypy_boto3_ssm_contacts.type_defs import GetContactChannelResultTypeDef

def get_value() -> GetContactChannelResultTypeDef:
    return {
        "ContactArn": ...,
        "ContactChannelArn": ...,
        "Name": ...,
        "Type": ...,
        "DeliveryAddress": ...,
        "ActivationStatus": ...,
        "ResponseMetadata": ...,
    }
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

Usage Example
from mypy_boto3_ssm_contacts.type_defs import GetContactPolicyResultTypeDef

def get_value() -> GetContactPolicyResultTypeDef:
    return {
        "ContactArn": ...,
        "Policy": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetContactPolicyResultTypeDef(TypedDict):
    ContactArn: str,
    Policy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListContactsResultTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ListContactsResultTypeDef

def get_value() -> ListContactsResultTypeDef:
    return {
        "NextToken": ...,
        "Contacts": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListContactsResultTypeDef(TypedDict):
    NextToken: str,
    Contacts: List[ContactTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContactTypeDef
  2. See ResponseMetadataTypeDef

StartEngagementResultTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import StartEngagementResultTypeDef

def get_value() -> StartEngagementResultTypeDef:
    return {
        "EngagementArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class StartEngagementResultTypeDef(TypedDict):
    EngagementArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResultTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ListTagsForResourceResultTypeDef

def get_value() -> ListTagsForResourceResultTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListTagsForResourceResultTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
        "Tags": ...,
    }
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

ListEngagementsResultTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ListEngagementsResultTypeDef

def get_value() -> ListEngagementsResultTypeDef:
    return {
        "NextToken": ...,
        "Engagements": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListEngagementsResultTypeDef(TypedDict):
    NextToken: str,
    Engagements: List[EngagementTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EngagementTypeDef
  2. See ResponseMetadataTypeDef

ListContactChannelsRequestListContactChannelsPaginateTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ListContactChannelsRequestListContactChannelsPaginateTypeDef

def get_value() -> ListContactChannelsRequestListContactChannelsPaginateTypeDef:
    return {
        "ContactId": ...,
    }
Definition
class ListContactChannelsRequestListContactChannelsPaginateTypeDef(TypedDict):
    ContactId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListContactsRequestListContactsPaginateTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ListContactsRequestListContactsPaginateTypeDef

def get_value() -> ListContactsRequestListContactsPaginateTypeDef:
    return {
        "AliasPrefix": ...,
    }
Definition
class ListContactsRequestListContactsPaginateTypeDef(TypedDict):
    AliasPrefix: NotRequired[str],
    Type: NotRequired[ContactTypeType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ContactTypeType
  2. See PaginatorConfigTypeDef

ListPageReceiptsRequestListPageReceiptsPaginateTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ListPageReceiptsRequestListPageReceiptsPaginateTypeDef

def get_value() -> ListPageReceiptsRequestListPageReceiptsPaginateTypeDef:
    return {
        "PageId": ...,
    }
Definition
class ListPageReceiptsRequestListPageReceiptsPaginateTypeDef(TypedDict):
    PageId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPagesByContactRequestListPagesByContactPaginateTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ListPagesByContactRequestListPagesByContactPaginateTypeDef

def get_value() -> ListPagesByContactRequestListPagesByContactPaginateTypeDef:
    return {
        "ContactId": ...,
    }
Definition
class ListPagesByContactRequestListPagesByContactPaginateTypeDef(TypedDict):
    ContactId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPagesByEngagementRequestListPagesByEngagementPaginateTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ListPagesByEngagementRequestListPagesByEngagementPaginateTypeDef

def get_value() -> ListPagesByEngagementRequestListPagesByEngagementPaginateTypeDef:
    return {
        "EngagementId": ...,
    }
Definition
class ListPagesByEngagementRequestListPagesByEngagementPaginateTypeDef(TypedDict):
    EngagementId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListEngagementsRequestListEngagementsPaginateTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ListEngagementsRequestListEngagementsPaginateTypeDef

def get_value() -> ListEngagementsRequestListEngagementsPaginateTypeDef:
    return {
        "IncidentId": ...,
    }
Definition
class ListEngagementsRequestListEngagementsPaginateTypeDef(TypedDict):
    IncidentId: NotRequired[str],
    TimeRangeValue: NotRequired[TimeRangeTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See TimeRangeTypeDef
  2. See PaginatorConfigTypeDef

ListEngagementsRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ListEngagementsRequestRequestTypeDef

def get_value() -> ListEngagementsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
Definition
class ListEngagementsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    IncidentId: NotRequired[str],
    TimeRangeValue: NotRequired[TimeRangeTypeDef],  # (1)
  1. See TimeRangeTypeDef

ListPageReceiptsResultTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ListPageReceiptsResultTypeDef

def get_value() -> ListPageReceiptsResultTypeDef:
    return {
        "NextToken": ...,
        "Receipts": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListPageReceiptsResultTypeDef(TypedDict):
    NextToken: str,
    Receipts: List[ReceiptTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReceiptTypeDef
  2. See ResponseMetadataTypeDef

ListPagesByContactResultTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ListPagesByContactResultTypeDef

def get_value() -> ListPagesByContactResultTypeDef:
    return {
        "NextToken": ...,
        "Pages": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListPagesByContactResultTypeDef(TypedDict):
    NextToken: str,
    Pages: List[PageTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PageTypeDef
  2. See ResponseMetadataTypeDef

ListPagesByEngagementResultTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ListPagesByEngagementResultTypeDef

def get_value() -> ListPagesByEngagementResultTypeDef:
    return {
        "NextToken": ...,
        "Pages": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListPagesByEngagementResultTypeDef(TypedDict):
    NextToken: str,
    Pages: List[PageTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PageTypeDef
  2. See ResponseMetadataTypeDef

ListContactChannelsResultTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import ListContactChannelsResultTypeDef

def get_value() -> ListContactChannelsResultTypeDef:
    return {
        "NextToken": ...,
        "ContactChannels": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListContactChannelsResultTypeDef(TypedDict):
    NextToken: str,
    ContactChannels: List[ContactChannelTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContactChannelTypeDef
  2. See ResponseMetadataTypeDef

StageTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import StageTypeDef

def get_value() -> StageTypeDef:
    return {
        "DurationInMinutes": ...,
        "Targets": ...,
    }
Definition
class StageTypeDef(TypedDict):
    DurationInMinutes: int,
    Targets: Sequence[TargetTypeDef],  # (1)
  1. See TargetTypeDef

PlanTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import PlanTypeDef

def get_value() -> PlanTypeDef:
    return {
        "Stages": ...,
    }
Definition
class PlanTypeDef(TypedDict):
    Stages: Sequence[StageTypeDef],  # (1)
  1. See StageTypeDef

CreateContactRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm_contacts.type_defs import CreateContactRequestRequestTypeDef

def get_value() -> CreateContactRequestRequestTypeDef:
    return {
        "Alias": ...,
        "Type": ...,
        "Plan": ...,
    }
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

Usage Example
from mypy_boto3_ssm_contacts.type_defs import GetContactResultTypeDef

def get_value() -> GetContactResultTypeDef:
    return {
        "ContactArn": ...,
        "Alias": ...,
        "DisplayName": ...,
        "Type": ...,
        "Plan": ...,
        "ResponseMetadata": ...,
    }
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

Usage Example
from mypy_boto3_ssm_contacts.type_defs import UpdateContactRequestRequestTypeDef

def get_value() -> UpdateContactRequestRequestTypeDef:
    return {
        "ContactId": ...,
    }
Definition
class UpdateContactRequestRequestTypeDef(TypedDict):
    ContactId: str,
    DisplayName: NotRequired[str],
    Plan: NotRequired[PlanTypeDef],  # (1)
  1. See PlanTypeDef