SSMContactsClient
Index > SSMContacts > SSMContactsClient
Auto-generated documentation for SSMContacts type annotations stubs module types-aiobotocore-ssm-contacts.
SSMContactsClient
Type annotations and code completion for session.client("ssm-contacts")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_ssm_contacts.client import SSMContactsClient
session = Session()
async with session.client("ssm-contacts") as client:
client: SSMContactsClient
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("ssm-contacts").exceptions
structure.
async with session.client("ssm-contacts") as client:
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.DataEncryptionException,
client.InternalServerException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
from types_aiobotocore_ssm_contacts.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
accept_page
Used to acknowledge an engagement to a contact channel during an incident.
Type annotations and code completion for session.client("ssm-contacts").accept_page
method.
boto3 documentation
await def accept_page(
self,
*,
PageId: str,
AcceptType: AcceptTypeType, # (1)
AcceptCode: str,
ContactChannelId: str = ...,
Note: str = ...,
AcceptCodeValidation: AcceptCodeValidationType = ..., # (2)
) -> Dict[str, Any]:
...
kwargs: AcceptPageRequestRequestTypeDef = { # (1)
"PageId": ...,
"AcceptType": ...,
"AcceptCode": ...,
}
parent.accept_page(**kwargs)
activate_contact_channel
Activates a contact's contact channel.
Type annotations and code completion for session.client("ssm-contacts").activate_contact_channel
method.
boto3 documentation
await def activate_contact_channel(
self,
*,
ContactChannelId: str,
ActivationCode: str,
) -> Dict[str, Any]:
...
kwargs: ActivateContactChannelRequestRequestTypeDef = { # (1)
"ContactChannelId": ...,
"ActivationCode": ...,
}
parent.activate_contact_channel(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for session.client("ssm-contacts").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("ssm-contacts").close
method.
boto3 documentation
create_contact
Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident.
Type annotations and code completion for session.client("ssm-contacts").create_contact
method.
boto3 documentation
await def create_contact(
self,
*,
Alias: str,
Type: ContactTypeType, # (1)
Plan: PlanTypeDef, # (2)
DisplayName: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (3)
IdempotencyToken: str = ...,
) -> CreateContactResultTypeDef: # (4)
...
- See ContactTypeType
- See PlanTypeDef
- See TagTypeDef
- See CreateContactResultTypeDef
kwargs: CreateContactRequestRequestTypeDef = { # (1)
"Alias": ...,
"Type": ...,
"Plan": ...,
}
parent.create_contact(**kwargs)
create_contact_channel
A contact channel is the method that Incident Manager uses to engage your contact.
Type annotations and code completion for session.client("ssm-contacts").create_contact_channel
method.
boto3 documentation
await def create_contact_channel(
self,
*,
ContactId: str,
Name: str,
Type: ChannelTypeType, # (1)
DeliveryAddress: ContactChannelAddressTypeDef, # (2)
DeferActivation: bool = ...,
IdempotencyToken: str = ...,
) -> CreateContactChannelResultTypeDef: # (3)
...
kwargs: CreateContactChannelRequestRequestTypeDef = { # (1)
"ContactId": ...,
"Name": ...,
"Type": ...,
"DeliveryAddress": ...,
}
parent.create_contact_channel(**kwargs)
deactivate_contact_channel
To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
Type annotations and code completion for session.client("ssm-contacts").deactivate_contact_channel
method.
boto3 documentation
await def deactivate_contact_channel(
self,
*,
ContactChannelId: str,
) -> Dict[str, Any]:
...
kwargs: DeactivateContactChannelRequestRequestTypeDef = { # (1)
"ContactChannelId": ...,
}
parent.deactivate_contact_channel(**kwargs)
delete_contact
To remove a contact from Incident Manager, you can delete the contact.
Type annotations and code completion for session.client("ssm-contacts").delete_contact
method.
boto3 documentation
kwargs: DeleteContactRequestRequestTypeDef = { # (1)
"ContactId": ...,
}
parent.delete_contact(**kwargs)
delete_contact_channel
To no longer receive engagements on a contact channel, you can delete the channel from a contact.
Type annotations and code completion for session.client("ssm-contacts").delete_contact_channel
method.
boto3 documentation
await def delete_contact_channel(
self,
*,
ContactChannelId: str,
) -> Dict[str, Any]:
...
kwargs: DeleteContactChannelRequestRequestTypeDef = { # (1)
"ContactChannelId": ...,
}
parent.delete_contact_channel(**kwargs)
describe_engagement
Incident Manager uses engagements to engage contacts and escalation plans during an incident.
Type annotations and code completion for session.client("ssm-contacts").describe_engagement
method.
boto3 documentation
await def describe_engagement(
self,
*,
EngagementId: str,
) -> DescribeEngagementResultTypeDef: # (1)
...
kwargs: DescribeEngagementRequestRequestTypeDef = { # (1)
"EngagementId": ...,
}
parent.describe_engagement(**kwargs)
describe_page
Lists details of the engagement to a contact channel.
Type annotations and code completion for session.client("ssm-contacts").describe_page
method.
boto3 documentation
await def describe_page(
self,
*,
PageId: str,
) -> DescribePageResultTypeDef: # (1)
...
kwargs: DescribePageRequestRequestTypeDef = { # (1)
"PageId": ...,
}
parent.describe_page(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("ssm-contacts").generate_presigned_url
method.
boto3 documentation
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_contact
Retrieves information about the specified contact or escalation plan.
Type annotations and code completion for session.client("ssm-contacts").get_contact
method.
boto3 documentation
await def get_contact(
self,
*,
ContactId: str,
) -> GetContactResultTypeDef: # (1)
...
kwargs: GetContactRequestRequestTypeDef = { # (1)
"ContactId": ...,
}
parent.get_contact(**kwargs)
get_contact_channel
List details about a specific contact channel.
Type annotations and code completion for session.client("ssm-contacts").get_contact_channel
method.
boto3 documentation
await def get_contact_channel(
self,
*,
ContactChannelId: str,
) -> GetContactChannelResultTypeDef: # (1)
...
kwargs: GetContactChannelRequestRequestTypeDef = { # (1)
"ContactChannelId": ...,
}
parent.get_contact_channel(**kwargs)
get_contact_policy
Retrieves the resource policies attached to the specified contact or escalation plan.
Type annotations and code completion for session.client("ssm-contacts").get_contact_policy
method.
boto3 documentation
await def get_contact_policy(
self,
*,
ContactArn: str,
) -> GetContactPolicyResultTypeDef: # (1)
...
kwargs: GetContactPolicyRequestRequestTypeDef = { # (1)
"ContactArn": ...,
}
parent.get_contact_policy(**kwargs)
list_contact_channels
Lists all contact channels for the specified contact.
Type annotations and code completion for session.client("ssm-contacts").list_contact_channels
method.
boto3 documentation
await def list_contact_channels(
self,
*,
ContactId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListContactChannelsResultTypeDef: # (1)
...
kwargs: ListContactChannelsRequestRequestTypeDef = { # (1)
"ContactId": ...,
}
parent.list_contact_channels(**kwargs)
list_contacts
Lists all contacts and escalation plans in Incident Manager.
Type annotations and code completion for session.client("ssm-contacts").list_contacts
method.
boto3 documentation
await def list_contacts(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
AliasPrefix: str = ...,
Type: ContactTypeType = ..., # (1)
) -> ListContactsResultTypeDef: # (2)
...
kwargs: ListContactsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_contacts(**kwargs)
list_engagements
Lists all engagements that have happened in an incident.
Type annotations and code completion for session.client("ssm-contacts").list_engagements
method.
boto3 documentation
await def list_engagements(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
IncidentId: str = ...,
TimeRangeValue: TimeRangeTypeDef = ..., # (1)
) -> ListEngagementsResultTypeDef: # (2)
...
kwargs: ListEngagementsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_engagements(**kwargs)
list_page_receipts
Lists all of the engagements to contact channels that have been acknowledged.
Type annotations and code completion for session.client("ssm-contacts").list_page_receipts
method.
boto3 documentation
await def list_page_receipts(
self,
*,
PageId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListPageReceiptsResultTypeDef: # (1)
...
kwargs: ListPageReceiptsRequestRequestTypeDef = { # (1)
"PageId": ...,
}
parent.list_page_receipts(**kwargs)
list_pages_by_contact
Lists the engagements to a contact's contact channels.
Type annotations and code completion for session.client("ssm-contacts").list_pages_by_contact
method.
boto3 documentation
await def list_pages_by_contact(
self,
*,
ContactId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListPagesByContactResultTypeDef: # (1)
...
kwargs: ListPagesByContactRequestRequestTypeDef = { # (1)
"ContactId": ...,
}
parent.list_pages_by_contact(**kwargs)
list_pages_by_engagement
Lists the engagements to contact channels that occurred by engaging a contact.
Type annotations and code completion for session.client("ssm-contacts").list_pages_by_engagement
method.
boto3 documentation
await def list_pages_by_engagement(
self,
*,
EngagementId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListPagesByEngagementResultTypeDef: # (1)
...
kwargs: ListPagesByEngagementRequestRequestTypeDef = { # (1)
"EngagementId": ...,
}
parent.list_pages_by_engagement(**kwargs)
list_tags_for_resource
Lists the tags of an escalation plan or contact.
Type annotations and code completion for session.client("ssm-contacts").list_tags_for_resource
method.
boto3 documentation
await def list_tags_for_resource(
self,
*,
ResourceARN: str,
) -> ListTagsForResourceResultTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)
put_contact_policy
Adds a resource policy to the specified contact or escalation plan.
Type annotations and code completion for session.client("ssm-contacts").put_contact_policy
method.
boto3 documentation
await def put_contact_policy(
self,
*,
ContactArn: str,
Policy: str,
) -> Dict[str, Any]:
...
kwargs: PutContactPolicyRequestRequestTypeDef = { # (1)
"ContactArn": ...,
"Policy": ...,
}
parent.put_contact_policy(**kwargs)
send_activation_code
Sends an activation code to a contact channel.
Type annotations and code completion for session.client("ssm-contacts").send_activation_code
method.
boto3 documentation
await def send_activation_code(
self,
*,
ContactChannelId: str,
) -> Dict[str, Any]:
...
kwargs: SendActivationCodeRequestRequestTypeDef = { # (1)
"ContactChannelId": ...,
}
parent.send_activation_code(**kwargs)
start_engagement
Starts an engagement to a contact or escalation plan.
Type annotations and code completion for session.client("ssm-contacts").start_engagement
method.
boto3 documentation
await def start_engagement(
self,
*,
ContactId: str,
Sender: str,
Subject: str,
Content: str,
PublicSubject: str = ...,
PublicContent: str = ...,
IncidentId: str = ...,
IdempotencyToken: str = ...,
) -> StartEngagementResultTypeDef: # (1)
...
kwargs: StartEngagementRequestRequestTypeDef = { # (1)
"ContactId": ...,
"Sender": ...,
"Subject": ...,
"Content": ...,
}
parent.start_engagement(**kwargs)
stop_engagement
Stops an engagement before it finishes the final stage of the escalation plan or engagement plan.
Type annotations and code completion for session.client("ssm-contacts").stop_engagement
method.
boto3 documentation
await def stop_engagement(
self,
*,
EngagementId: str,
Reason: str = ...,
) -> Dict[str, Any]:
...
kwargs: StopEngagementRequestRequestTypeDef = { # (1)
"EngagementId": ...,
}
parent.stop_engagement(**kwargs)
tag_resource
Tags a contact or escalation plan.
Type annotations and code completion for session.client("ssm-contacts").tag_resource
method.
boto3 documentation
await def tag_resource(
self,
*,
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes tags from the specified resource.
Type annotations and code completion for session.client("ssm-contacts").untag_resource
method.
boto3 documentation
await def untag_resource(
self,
*,
ResourceARN: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_contact
Updates the contact or escalation plan specified.
Type annotations and code completion for session.client("ssm-contacts").update_contact
method.
boto3 documentation
await def update_contact(
self,
*,
ContactId: str,
DisplayName: str = ...,
Plan: PlanTypeDef = ..., # (1)
) -> Dict[str, Any]:
...
- See PlanTypeDef
kwargs: UpdateContactRequestRequestTypeDef = { # (1)
"ContactId": ...,
}
parent.update_contact(**kwargs)
update_contact_channel
Updates a contact's contact channel.
Type annotations and code completion for session.client("ssm-contacts").update_contact_channel
method.
boto3 documentation
await def update_contact_channel(
self,
*,
ContactChannelId: str,
Name: str = ...,
DeliveryAddress: ContactChannelAddressTypeDef = ..., # (1)
) -> Dict[str, Any]:
...
kwargs: UpdateContactChannelRequestRequestTypeDef = { # (1)
"ContactChannelId": ...,
}
parent.update_contact_channel(**kwargs)
__aenter__
Type annotations and code completion for session.client("ssm-contacts").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("ssm-contacts").__aexit__
method.
boto3 documentation
get_paginator
Type annotations and code completion for session.client("ssm-contacts").get_paginator
method with overloads.
client.get_paginator("list_contact_channels")
-> ListContactChannelsPaginatorclient.get_paginator("list_contacts")
-> ListContactsPaginatorclient.get_paginator("list_engagements")
-> ListEngagementsPaginatorclient.get_paginator("list_page_receipts")
-> ListPageReceiptsPaginatorclient.get_paginator("list_pages_by_contact")
-> ListPagesByContactPaginatorclient.get_paginator("list_pages_by_engagement")
-> ListPagesByEngagementPaginator