SSMContacts module#
Index > SSMContacts
Auto-generated documentation for SSMContacts type annotations stubs module mypy-boto3-ssm-contacts.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.13' mypy_boto3_builder
- Select
boto3-stubs
AWS SDK. - Add
SSMContacts
service. - Use provided commands to install generated packages.
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#
python -m pip uninstall -y mypy-boto3-ssm-contacts
Usage#
Code samples can be found in Examples.
SSMContactsClient#
Type annotations and code completion for boto3.client("ssm-contacts")
as SSMContactsClient
boto3 documentation
# SSMContactsClient 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("...")
.
# ListContactChannelsPaginator 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
- ListPageResolutionsPaginator
- ListPagesByContactPaginator
- ListPagesByEngagementPaginator
- ListPreviewRotationShiftsPaginator
- ListRotationOverridesPaginator
- ListRotationShiftsPaginator
- ListRotationsPaginator
Literals#
Type annotations for literals used in methods and schema.
# AcceptCodeValidationType usage example
from mypy_boto3_ssm_contacts.literals import AcceptCodeValidationType
def get_value() -> AcceptCodeValidationType:
return "ENFORCE"
- AcceptCodeValidationType
- AcceptTypeType
- ActivationStatusType
- ChannelTypeType
- ContactTypeType
- DayOfWeekType
- ListContactChannelsPaginatorName
- ListContactsPaginatorName
- ListEngagementsPaginatorName
- ListPageReceiptsPaginatorName
- ListPageResolutionsPaginatorName
- ListPagesByContactPaginatorName
- ListPagesByEngagementPaginatorName
- ListPreviewRotationShiftsPaginatorName
- ListRotationOverridesPaginatorName
- ListRotationShiftsPaginatorName
- ListRotationsPaginatorName
- ReceiptTypeType
- ShiftTypeType
- SSMContactsServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AcceptPageRequestTypeDef
- ActivateContactChannelRequestTypeDef
- ChannelTargetInfoTypeDef
- ContactChannelAddressTypeDef
- ContactTargetInfoTypeDef
- ContactTypeDef
- HandOffTimeTypeDef
- ResponseMetadataTypeDef
- TagTypeDef
- TimestampTypeDef
- DeactivateContactChannelRequestTypeDef
- DeleteContactChannelRequestTypeDef
- DeleteContactRequestTypeDef
- DeleteRotationOverrideRequestTypeDef
- DeleteRotationRequestTypeDef
- DescribeEngagementRequestTypeDef
- DescribePageRequestTypeDef
- EngagementTypeDef
- GetContactChannelRequestTypeDef
- GetContactPolicyRequestTypeDef
- GetContactRequestTypeDef
- GetRotationOverrideRequestTypeDef
- GetRotationRequestTypeDef
- PaginatorConfigTypeDef
- ListContactChannelsRequestTypeDef
- ListContactsRequestTypeDef
- ListPageReceiptsRequestTypeDef
- ReceiptTypeDef
- ListPageResolutionsRequestTypeDef
- ResolutionContactTypeDef
- ListPagesByContactRequestTypeDef
- PageTypeDef
- ListPagesByEngagementRequestTypeDef
- RotationOverrideTypeDef
- ListRotationsRequestTypeDef
- ListTagsForResourceRequestTypeDef
- PutContactPolicyRequestTypeDef
- ShiftDetailsTypeDef
- SendActivationCodeRequestTypeDef
- StartEngagementRequestTypeDef
- StopEngagementRequestTypeDef
- UntagResourceRequestTypeDef
- ContactChannelTypeDef
- CreateContactChannelRequestTypeDef
- UpdateContactChannelRequestTypeDef
- TargetTypeDef
- CoverageTimeTypeDef
- MonthlySettingTypeDef
- WeeklySettingTypeDef
- CreateContactChannelResultTypeDef
- CreateContactResultTypeDef
- CreateRotationOverrideResultTypeDef
- CreateRotationResultTypeDef
- DescribeEngagementResultTypeDef
- DescribePageResultTypeDef
- GetContactChannelResultTypeDef
- GetContactPolicyResultTypeDef
- GetRotationOverrideResultTypeDef
- ListContactsResultTypeDef
- StartEngagementResultTypeDef
- ListTagsForResourceResultTypeDef
- TagResourceRequestTypeDef
- CreateRotationOverrideRequestTypeDef
- ListRotationOverridesRequestTypeDef
- ListRotationShiftsRequestTypeDef
- PreviewOverrideTypeDef
- TimeRangeTypeDef
- ListEngagementsResultTypeDef
- ListContactChannelsRequestPaginateTypeDef
- ListContactsRequestPaginateTypeDef
- ListPageReceiptsRequestPaginateTypeDef
- ListPageResolutionsRequestPaginateTypeDef
- ListPagesByContactRequestPaginateTypeDef
- ListPagesByEngagementRequestPaginateTypeDef
- ListRotationOverridesRequestPaginateTypeDef
- ListRotationShiftsRequestPaginateTypeDef
- ListRotationsRequestPaginateTypeDef
- ListPageReceiptsResultTypeDef
- ListPageResolutionsResultTypeDef
- ListPagesByContactResultTypeDef
- ListPagesByEngagementResultTypeDef
- ListRotationOverridesResultTypeDef
- RotationShiftTypeDef
- ListContactChannelsResultTypeDef
- StageOutputTypeDef
- StageTypeDef
- RecurrenceSettingsOutputTypeDef
- RecurrenceSettingsTypeDef
- ListEngagementsRequestPaginateTypeDef
- ListEngagementsRequestTypeDef
- ListPreviewRotationShiftsResultTypeDef
- ListRotationShiftsResultTypeDef
- PlanOutputTypeDef
- PlanTypeDef
- GetRotationResultTypeDef
- RotationTypeDef
- RecurrenceSettingsUnionTypeDef
- GetContactResultTypeDef
- PlanUnionTypeDef
- ListRotationsResultTypeDef
- CreateRotationRequestTypeDef
- ListPreviewRotationShiftsRequestPaginateTypeDef
- ListPreviewRotationShiftsRequestTypeDef
- UpdateRotationRequestTypeDef
- CreateContactRequestTypeDef
- UpdateContactRequestTypeDef