SSMContacts module
Index > SSMContacts
Auto-generated documentation for SSMContacts type annotations stubs module mypy-boto3-ssm-contacts.
How to install
VSCode extension
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and SSMContacts
.
From PyPI with pip
Install boto3-stubs
for SSMContacts
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[ssm-contacts]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[ssm-contacts]'
# standalone installation
python -m pip install mypy-boto3-ssm-contacts
How to uninstall
Usage
Code samples can be found in Examples.
SSMContactsClient
Type annotations and code completion for boto3.client("ssm-contacts")
as SSMContactsClient
boto3 documentation
Usage example
from boto3.session import Session
from mypy_boto3_ssm_contacts.client import SSMContactsClient
def get_client() -> SSMContactsClient:
return Session().client("ssm-contacts")
Paginators
Type annotations and code completion for paginators
from boto3.client("ssm-contacts").get_paginator("...")
.
Usage example
from boto3.session import Session
from mypy_boto3_ssm_contacts.paginator import ListContactChannelsPaginator
def get_list_contact_channels_paginator() -> ListContactChannelsPaginator:
return Session().client("ssm-contacts").get_paginator("list_contact_channels"))
- ListContactChannelsPaginator
- ListContactsPaginator
- ListEngagementsPaginator
- ListPageReceiptsPaginator
- ListPagesByContactPaginator
- ListPagesByEngagementPaginator
Literals
Type annotations for literals used in methods and schemas.
Usage example
from mypy_boto3_ssm_contacts.literals import AcceptCodeValidationType
def get_value() -> AcceptCodeValidationType:
return "ENFORCE"
- AcceptCodeValidationType
- AcceptTypeType
- ActivationStatusType
- ChannelTypeType
- ContactTypeType
- ListContactChannelsPaginatorName
- ListContactsPaginatorName
- ListEngagementsPaginatorName
- ListPageReceiptsPaginatorName
- ListPagesByContactPaginatorName
- ListPagesByEngagementPaginatorName
- ReceiptTypeType
- SSMContactsServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from mypy_boto3_ssm_contacts.type_defs import AcceptPageRequestRequestTypeDef
def get_value() -> AcceptPageRequestRequestTypeDef:
return {
"PageId": ...,
"AcceptType": ...,
"AcceptCode": ...,
}
- AcceptPageRequestRequestTypeDef
- ActivateContactChannelRequestRequestTypeDef
- ChannelTargetInfoTypeDef
- ContactChannelAddressTypeDef
- ContactTargetInfoTypeDef
- ContactTypeDef
- ResponseMetadataTypeDef
- TagTypeDef
- DeactivateContactChannelRequestRequestTypeDef
- DeleteContactChannelRequestRequestTypeDef
- DeleteContactRequestRequestTypeDef
- DescribeEngagementRequestRequestTypeDef
- DescribePageRequestRequestTypeDef
- EngagementTypeDef
- GetContactChannelRequestRequestTypeDef
- GetContactPolicyRequestRequestTypeDef
- GetContactRequestRequestTypeDef
- PaginatorConfigTypeDef
- ListContactChannelsRequestRequestTypeDef
- ListContactsRequestRequestTypeDef
- TimeRangeTypeDef
- ListPageReceiptsRequestRequestTypeDef
- ReceiptTypeDef
- ListPagesByContactRequestRequestTypeDef
- PageTypeDef
- ListPagesByEngagementRequestRequestTypeDef
- ListTagsForResourceRequestRequestTypeDef
- PutContactPolicyRequestRequestTypeDef
- SendActivationCodeRequestRequestTypeDef
- StartEngagementRequestRequestTypeDef
- StopEngagementRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- ContactChannelTypeDef
- CreateContactChannelRequestRequestTypeDef
- UpdateContactChannelRequestRequestTypeDef
- TargetTypeDef
- CreateContactChannelResultTypeDef
- CreateContactResultTypeDef
- DescribeEngagementResultTypeDef
- DescribePageResultTypeDef
- GetContactChannelResultTypeDef
- GetContactPolicyResultTypeDef
- ListContactsResultTypeDef
- StartEngagementResultTypeDef
- ListTagsForResourceResultTypeDef
- TagResourceRequestRequestTypeDef
- ListEngagementsResultTypeDef
- ListContactChannelsRequestListContactChannelsPaginateTypeDef
- ListContactsRequestListContactsPaginateTypeDef
- ListPageReceiptsRequestListPageReceiptsPaginateTypeDef
- ListPagesByContactRequestListPagesByContactPaginateTypeDef
- ListPagesByEngagementRequestListPagesByEngagementPaginateTypeDef
- ListEngagementsRequestListEngagementsPaginateTypeDef
- ListEngagementsRequestRequestTypeDef
- ListPageReceiptsResultTypeDef
- ListPagesByContactResultTypeDef
- ListPagesByEngagementResultTypeDef
- ListContactChannelsResultTypeDef
- StageTypeDef
- PlanTypeDef
- CreateContactRequestRequestTypeDef
- GetContactResultTypeDef
- UpdateContactRequestRequestTypeDef