Table of Contents
SSMContacts.Client¶A low-level client representing AWS Systems Manager Incident Manager Contacts (SSM Contacts)
Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An incident is any unplanned interruption or reduction in quality of services.
Incident Manager increases incident resolution by notifying responders of impact, highlighting relevant troubleshooting data, and providing collaboration tools to get services back up and running. To achieve the primary goal of reducing the time-to-resolution of critical incidents, Incident Manager automates response plans and enables responder team escalation.
import boto3
client = boto3.client('ssm-contacts')
These are the available methods:
accept_page()activate_contact_channel()can_paginate()close()create_contact()create_contact_channel()deactivate_contact_channel()delete_contact()delete_contact_channel()describe_engagement()describe_page()get_contact()get_contact_channel()get_contact_policy()get_paginator()get_waiter()list_contact_channels()list_contacts()list_engagements()list_page_receipts()list_pages_by_contact()list_pages_by_engagement()list_tags_for_resource()put_contact_policy()send_activation_code()start_engagement()stop_engagement()tag_resource()untag_resource()update_contact()update_contact_channel()accept_page(**kwargs)¶Used to acknowledge an engagement to a contact channel during an incident.
See also: AWS API Documentation
Request Syntax
response = client.accept_page(
PageId='string',
ContactChannelId='string',
AcceptType='DELIVERED'|'READ',
Note='string',
AcceptCode='string',
AcceptCodeValidation='IGNORE'|'ENFORCE'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the engagement to a contact channel.
[REQUIRED]
The type indicates if the page was DELIVERED or READ .
[REQUIRED]
The accept code is a 6-digit code used to acknowledge the page.
An optional field that Incident Manager uses to ENFORCE AcceptCode validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.
Incident Manager can also IGNORE AcceptCode validation. Ignoring AcceptCode validation causes Incident Manager to accept any value entered for the AcceptCode .
dict
Response Syntax
{}
Response Structure
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionExamples
The following accept-page operation uses an accept code sent to the contact channel to accept a page.
response = client.accept_page(
AcceptCode='425440',
AcceptType='READ',
PageId='arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
activate_contact_channel(**kwargs)¶Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.
See also: AWS API Documentation
Request Syntax
response = client.activate_contact_channel(
ContactChannelId='string',
ActivationCode='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the contact channel.
[REQUIRED]
The code sent to the contact channel when it was created in the contact.
dict
Response Syntax
{}
Response Structure
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionExamples
The following activate-contact-channel example activates a contact channel and makes it usable as part of an incident.
response = client.activate_contact_channel(
ActivationCode='466136',
ContactChannelId='arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_contact(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.create_contact(
Alias='string',
DisplayName='string',
Type='PERSONAL'|'ESCALATION',
Plan={
'Stages': [
{
'DurationInMinutes': 123,
'Targets': [
{
'ChannelTargetInfo': {
'ContactChannelId': 'string',
'RetryIntervalInMinutes': 123
},
'ContactTargetInfo': {
'ContactId': 'string',
'IsEssential': True|False
}
},
]
},
]
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
IdempotencyToken='string'
)
[REQUIRED]
The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.
[REQUIRED]
To create an escalation plan use ESCALATION . To create a contact use PERSONAL .
[REQUIRED]
A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.
A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.
A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.
The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
The contacts or contact methods that the escalation plan or engagement plan is engaging.
The contact or contact channel that's being engaged.
Information about the contact channel Incident Manager is engaging.
The Amazon Resource Name (ARN) of the contact channel.
The number of minutes to wait to retry sending engagement in the case the engagement initially fails.
Information about the contact that Incident Manager is engaging.
The Amazon Resource Name (ARN) of the contact.
A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.
Adds a tag to the target. You can only tag resources created in the first Region of your replication set.
A container of a key-value name pair.
Name of the object key.
Value of the tag.
A token ensuring that the operation is called only once with the specified details.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ContactArn': 'string'
}
Response Structure
(dict) --
ContactArn (string) --
The Amazon Resource Name (ARN) of the created contact or escalation plan.
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.ConflictExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ServiceQuotaExceededExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionSSMContacts.Client.exceptions.DataEncryptionExceptionExamples
The following create-contact example creates a contact in your environment with a blank plan. The plan can be updated after creating contact channels. Use the create-contact-channel operation with the output ARN of this command. After you have created contact channels for this contact use update-contact to update the plan.
response = client.create_contact(
Alias='akuam',
DisplayName='Akua Mansa',
Plan={
'Stages': [
],
},
Type='PERSONAL',
)
print(response)
Expected Output:
{
'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
'ResponseMetadata': {
'...': '...',
},
}
create_contact_channel(**kwargs)¶A contact channel is the method that Incident Manager uses to engage your contact.
See also: AWS API Documentation
Request Syntax
response = client.create_contact_channel(
ContactId='string',
Name='string',
Type='SMS'|'VOICE'|'EMAIL',
DeliveryAddress={
'SimpleAddress': 'string'
},
DeferActivation=True|False,
IdempotencyToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
[REQUIRED]
The name of the contact channel.
[REQUIRED]
Incident Manager supports three types of contact channels:
SMSVOICEEMAIL[REQUIRED]
The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the type of the contact channel. The following are the expected formats:
The format is dependent on the type of the contact channel. The following are the expected formats:
A token ensuring that the operation is called only once with the specified details.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ContactChannelArn': 'string'
}
Response Structure
(dict) --
ContactChannelArn (string) --
The Amazon Resource Name (ARN) of the contact channel.
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.ConflictExceptionSSMContacts.Client.exceptions.DataEncryptionExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionExamples
Creates a contact channel of type SMS for the contact Akua Mansa. Contact channels can be created of type SMS, EMAIL, or VOICE.
response = client.create_contact_channel(
ContactId='arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam',
DeliveryAddress={
'SimpleAddress': '+15005550199',
},
Name='akuas sms-test',
Type='SMS',
)
print(response)
Expected Output:
{
'ContactChannelArn': 'arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/02f506b9-ea5d-4764-af89-2daa793ff024',
'ResponseMetadata': {
'...': '...',
},
}
deactivate_contact_channel(**kwargs)¶To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
See also: AWS API Documentation
Request Syntax
response = client.deactivate_contact_channel(
ContactChannelId='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the contact channel you're deactivating.
{}
Response Structure
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionExamples
The following deactivate-contact-channel example deactivates a contact channel. Deactivating a contact channel means the contact channel will no longer be paged during an incident. You can also reactivate a contact channel at any time using the activate-contact-channel operation.
response = client.deactivate_contact_channel(
ContactChannelId='arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
delete_contact(**kwargs)¶To remove a contact from Incident Manager, you can delete the contact. Deleting a contact removes them from all escalation plans and related response plans. Deleting an escalation plan removes it from all related response plans. You will have to recreate the contact and its contact channels before you can use it again.
See also: AWS API Documentation
Request Syntax
response = client.delete_contact(
ContactId='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the contact that you're deleting.
{}
Response Structure
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionExamples
The following delete-contact example deletes a contact. The contact will no longer be reachable from any escalation plan that refers to them.
response = client.delete_contact(
ContactId='arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
delete_contact_channel(**kwargs)¶To no longer receive engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel removes it from the contact's engagement plan. If you delete the only contact channel for a contact, you won't be able to engage that contact during an incident.
See also: AWS API Documentation
Request Syntax
response = client.delete_contact_channel(
ContactChannelId='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the contact channel.
{}
Response Structure
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionExamples
The following delete-contact-channel example deletes a contact channel. Deleting a contact channel ensures the contact channel will not be paged during an incident.
response = client.delete_contact_channel(
ContactChannelId='arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/13149bad-52ee-45ea-ae1e-45857f78f9b2',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_engagement(**kwargs)¶Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.
See also: AWS API Documentation
Request Syntax
response = client.describe_engagement(
EngagementId='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the engagement you want the details of.
{
'ContactArn': 'string',
'EngagementArn': 'string',
'Sender': 'string',
'Subject': 'string',
'Content': 'string',
'PublicSubject': 'string',
'PublicContent': 'string',
'IncidentId': 'string',
'StartTime': datetime(2015, 1, 1),
'StopTime': datetime(2015, 1, 1)
}
Response Structure
The ARN of the escalation plan or contacts involved in the engagement.
The ARN of the engagement.
The user that started the engagement.
The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL .
The secure content of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL .
The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS .
The insecure content of the message that was sent to the contact. Use this field for engagements to SMS .
The ARN of the incident in which the engagement occurred.
The time that the engagement started.
The time that the engagement ended.
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.DataEncryptionExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionExamples
The following describe-engagement example lists the details of an engagement to a contact or escalation plan. The subject and content are sent to the contact channels.
response = client.describe_engagement(
EngagementId='arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356',
)
print(response)
Expected Output:
{
'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation',
'Content': 'Testing engagements',
'EngagementArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356',
'PublicContent': 'Testing engagements',
'PublicSubject': 'test',
'Sender': 'tester',
'StartTime': datetime(2021, 5, 18, 18, 25, 41, 1, 138, 0),
'Subject': 'test',
'ResponseMetadata': {
'...': '...',
},
}
describe_page(**kwargs)¶Lists details of the engagement to a contact channel.
See also: AWS API Documentation
Request Syntax
response = client.describe_page(
PageId='string'
)
[REQUIRED]
The ID of the engagement to a contact channel.
{
'PageArn': 'string',
'EngagementArn': 'string',
'ContactArn': 'string',
'Sender': 'string',
'Subject': 'string',
'Content': 'string',
'PublicSubject': 'string',
'PublicContent': 'string',
'IncidentId': 'string',
'SentTime': datetime(2015, 1, 1),
'ReadTime': datetime(2015, 1, 1),
'DeliveryTime': datetime(2015, 1, 1)
}
Response Structure
The Amazon Resource Name (ARN) of the engagement to a contact channel.
The ARN of the engagement that engaged the contact channel.
The ARN of the contact that was engaged.
The user that started the engagement.
The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL .
The secure content of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL .
The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS .
The insecure content of the message that was sent to the contact. Use this field for engagements to SMS .
The ARN of the incident that engaged the contact channel.
The time the engagement was sent to the contact channel.
The time that the contact channel acknowledged the engagement.
The time that the contact channel received the engagement.
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.DataEncryptionExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionExamples
The following describe-page example lists details of a page to a contact channel. The page will include the subject and content provided.
response = client.describe_page(
PageId='arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93',
)
print(response)
Expected Output:
{
'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
'Content': 'Testing engagements',
'DeliveryTime': datetime(2021, 5, 18, 18, 43, 55, 1, 138, 0),
'EngagementArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0',
'PageArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93',
'PublicContent': 'Testing engagements',
'PublicSubject': 'test',
'ReadTime': datetime(2021, 5, 18, 18, 43, 55, 1, 138, 0),
'Sender': 'tester',
'SentTime': datetime(2021, 5, 18, 18, 43, 29, 1, 138, 0),
'Subject': 'test',
'ResponseMetadata': {
'...': '...',
},
}
get_contact(**kwargs)¶Retrieves information about the specified contact or escalation plan.
See also: AWS API Documentation
Request Syntax
response = client.get_contact(
ContactId='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the contact or escalation plan.
{
'ContactArn': 'string',
'Alias': 'string',
'DisplayName': 'string',
'Type': 'PERSONAL'|'ESCALATION',
'Plan': {
'Stages': [
{
'DurationInMinutes': 123,
'Targets': [
{
'ChannelTargetInfo': {
'ContactChannelId': 'string',
'RetryIntervalInMinutes': 123
},
'ContactTargetInfo': {
'ContactId': 'string',
'IsEssential': True|False
}
},
]
},
]
}
}
Response Structure
The ARN of the contact or escalation plan.
The alias of the contact or escalation plan. The alias is unique and identifiable.
The full name of the contact or escalation plan.
The type of contact, either PERSONAL or ESCALATION .
Details about the specific timing or stages and targets of the escalation plan or engagement plan.
A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.
A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.
The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
The contacts or contact methods that the escalation plan or engagement plan is engaging.
The contact or contact channel that's being engaged.
Information about the contact channel Incident Manager is engaging.
The Amazon Resource Name (ARN) of the contact channel.
The number of minutes to wait to retry sending engagement in the case the engagement initially fails.
Information about the contact that Incident Manager is engaging.
The Amazon Resource Name (ARN) of the contact.
A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionSSMContacts.Client.exceptions.DataEncryptionExceptionExamples
The following get-contact example describes a contact.
response = client.get_contact(
ContactId='arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
)
print(response)
Expected Output:
{
'Alias': 'akuam',
'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
'DisplayName': 'Akua Mansa',
'Plan': {
'Stages': [
{
'DurationInMinutes': 5,
'Targets': [
{
'ChannelTargetInfo': {
'ContactChannelId': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65',
'RetryIntervalInMinutes': 1,
},
},
],
},
{
'DurationInMinutes': 5,
'Targets': [
{
'ChannelTargetInfo': {
'ContactChannelId': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad',
'RetryIntervalInMinutes': 1,
},
},
],
},
{
'DurationInMinutes': 5,
'Targets': [
{
'ChannelTargetInfo': {
'ContactChannelId': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a',
'RetryIntervalInMinutes': 1,
},
},
],
},
],
},
'Type': 'PERSONAL',
'ResponseMetadata': {
'...': '...',
},
}
The following get-contact example describes an escalation plan.
response = client.get_contact(
ContactId='arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation',
)
print(response)
Expected Output:
{
'Alias': 'example_escalation',
'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation',
'DisplayName': 'Example Escalation Plan',
'Plan': {
'Stages': [
{
'DurationInMinutes': 5,
'Targets': [
{
'ContactTargetInfo': {
'ContactId': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
'IsEssential': True,
},
},
],
},
{
'DurationInMinutes': 5,
'Targets': [
{
'ContactTargetInfo': {
'ContactId': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr',
'IsEssential': False,
},
},
],
},
{
'DurationInMinutes': 0,
'Targets': [
{
'ContactTargetInfo': {
'ContactId': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi',
'IsEssential': False,
},
},
],
},
],
},
'Type': 'ESCALATION',
'ResponseMetadata': {
'...': '...',
},
}
get_contact_channel(**kwargs)¶List details about a specific contact channel.
See also: AWS API Documentation
Request Syntax
response = client.get_contact_channel(
ContactChannelId='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the contact channel you want information about.
{
'ContactArn': 'string',
'ContactChannelArn': 'string',
'Name': 'string',
'Type': 'SMS'|'VOICE'|'EMAIL',
'DeliveryAddress': {
'SimpleAddress': 'string'
},
'ActivationStatus': 'ACTIVATED'|'NOT_ACTIVATED'
}
Response Structure
The ARN of the contact that the channel belongs to.
The ARN of the contact channel.
The name of the contact channel
The type of contact channel. The type is SMS , VOICE , or EMAIL .
The details that Incident Manager uses when trying to engage the contact channel.
The format is dependent on the type of the contact channel. The following are the expected formats:
A Boolean value indicating if the contact channel has been activated or not.
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.DataEncryptionExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionExamples
The following get-contact-channel example lists the details of a contact channel.
response = client.get_contact_channel(
ContactChannelId='arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
)
print(response)
Expected Output:
{
'ActivationStatus': 'ACTIVATED',
'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
'ContactChannelArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
'DeliveryAddress': {
'SimpleAddress': '+15005550199',
},
'Name': 'akuas sms',
'Type': 'SMS',
'ResponseMetadata': {
'...': '...',
},
}
get_contact_policy(**kwargs)¶Retrieves the resource policies attached to the specified contact or escalation plan.
See also: AWS API Documentation
Request Syntax
response = client.get_contact_policy(
ContactArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the contact or escalation plan.
{
'ContactArn': 'string',
'Policy': 'string'
}
Response Structure
The ARN of the contact or escalation plan.
Details about the resource policy attached to the contact or escalation plan.
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionExamples
The following get-contact-policy example lists the resource policies associated with the specified contact.
response = client.get_contact_policy(
ContactArn='arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam',
)
print(response)
Expected Output:
{
'ContactArn': 'arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam',
'Policy': '{"Version":"2012-10-17","Statement":[{"Sid":"SharePolicyForDocumentationDralia","Effect":"Allow","Principal":{"AWS":"222233334444"},"Action":["ssm-contacts:GetContact","ssm-contacts:StartEngagement","ssm-contacts:DescribeEngagement","ssm-contacts:ListPagesByEngagement","ssm-contacts:StopEngagement"],"Resource":["arn:aws:ssm-contacts:*:111122223333:contact/akuam","arn:aws:ssm-contacts:*:111122223333:engagement/akuam/*"]}]}',
'ResponseMetadata': {
'...': '...',
},
}
get_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_contact_channels(**kwargs)¶Lists all contact channels for the specified contact.
See also: AWS API Documentation
Request Syntax
response = client.list_contact_channels(
ContactId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the contact.
dict
Response Syntax
{
'NextToken': 'string',
'ContactChannels': [
{
'ContactChannelArn': 'string',
'ContactArn': 'string',
'Name': 'string',
'Type': 'SMS'|'VOICE'|'EMAIL',
'DeliveryAddress': {
'SimpleAddress': 'string'
},
'ActivationStatus': 'ACTIVATED'|'NOT_ACTIVATED'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The pagination token to continue to the next page of results.
ContactChannels (list) --
A list of contact channels related to the specified contact.
(dict) --
The method that Incident Manager uses to engage a contact.
ContactChannelArn (string) --
The Amazon Resource Name (ARN) of the contact channel.
ContactArn (string) --
The ARN of the contact that contains the contact channel.
Name (string) --
The name of the contact channel.
Type (string) --
The type of the contact channel. Incident Manager supports three contact methods:
DeliveryAddress (dict) --
The details that Incident Manager uses when trying to engage the contact channel.
SimpleAddress (string) --
The format is dependent on the type of the contact channel. The following are the expected formats:
ActivationStatus (string) --
A Boolean value describing if the contact channel has been activated or not. If the contact channel isn't activated, Incident Manager can't engage the contact through it.
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.DataEncryptionExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionExamples
The following list-contact-channels example lists the available contact channels of the specified contact.
response = client.list_contact_channels(
ContactId='arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
)
print(response)
Expected Output:
{
'ContactChannels': [
{
'ActivationStatus': 'ACTIVATED',
'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
'ContactChannelArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
'DeliveryAddress': {
'SimpleAddress': '+15005550100',
},
'Name': 'akuas sms',
'Type': 'SMS',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_contacts(**kwargs)¶Lists all contacts and escalation plans in Incident Manager.
See also: AWS API Documentation
Request Syntax
response = client.list_contacts(
NextToken='string',
MaxResults=123,
AliasPrefix='string',
Type='PERSONAL'|'ESCALATION'
)
PERSONAL and an escalation plan is type ESCALATION .dict
Response Syntax
{
'NextToken': 'string',
'Contacts': [
{
'ContactArn': 'string',
'Alias': 'string',
'DisplayName': 'string',
'Type': 'PERSONAL'|'ESCALATION'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The pagination token to continue to the next page of results.
Contacts (list) --
A list of the contacts and escalation plans in your Incident Manager account.
(dict) --
A personal contact or escalation plan that Incident Manager engages during an incident.
ContactArn (string) --
The Amazon Resource Name (ARN) of the contact or escalation plan.
Alias (string) --
The unique and identifiable alias of the contact or escalation plan.
DisplayName (string) --
The full name of the contact or escalation plan.
Type (string) --
Refers to the type of contact. A single contact is type PERSONAL and an escalation plan is type ESCALATION .
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionExamples
The following list-contacts example lists the contacts and escalation plans in your account.
response = client.list_contacts(
)
print(response)
Expected Output:
{
'Contacts': [
{
'Alias': 'akuam',
'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
'DisplayName': 'Akua Mansa',
'Type': 'PERSONAL',
},
{
'Alias': 'alejr',
'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr',
'DisplayName': 'Alejandro Rosalez',
'Type': 'PERSONAL',
},
{
'Alias': 'anasi',
'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi',
'DisplayName': 'Ana Carolina Silva',
'Type': 'PERSONAL',
},
{
'Alias': 'example_escalation',
'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation',
'DisplayName': 'Example Escalation',
'Type': 'ESCALATION',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_engagements(**kwargs)¶Lists all engagements that have happened in an incident.
See also: AWS API Documentation
Request Syntax
response = client.list_engagements(
NextToken='string',
MaxResults=123,
IncidentId='string',
TimeRangeValue={
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
}
)
The time range to lists engagements for an incident.
The start of the time range.
The end of the time range.
dict
Response Syntax
{
'NextToken': 'string',
'Engagements': [
{
'EngagementArn': 'string',
'ContactArn': 'string',
'Sender': 'string',
'IncidentId': 'string',
'StartTime': datetime(2015, 1, 1),
'StopTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
NextToken (string) --
The pagination token to continue to the next page of results.
Engagements (list) --
A list of each engagement that occurred during the specified time range of an incident.
(dict) --
Incident Manager reaching out to a contact or escalation plan to engage contact during an incident.
EngagementArn (string) --
The Amazon Resource Name (ARN) of the engagement.
ContactArn (string) --
The ARN of the escalation plan or contact that Incident Manager is engaging.
Sender (string) --
The user that started the engagement.
IncidentId (string) --
The ARN of the incident that's engaging the contact.
StartTime (datetime) --
The time that the engagement began.
StopTime (datetime) --
The time that the engagement ended.
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionExamples
The following list-engagements example lists engagements to escalation plans and contacts. You can also list engagements for a single incident.
response = client.list_engagements(
)
print(response)
Expected Output:
{
'Engagements': [
{
'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
'EngagementArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/91792571-0b53-4821-9f73-d25d13d9e529',
'Sender': 'cli',
'StartTime': datetime(2021, 5, 18, 20, 37, 50, 1, 138, 0),
},
{
'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
'EngagementArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0',
'Sender': 'cli',
'StartTime': datetime(2021, 5, 18, 18, 40, 26, 1, 138, 0),
},
{
'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation',
'EngagementArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356',
'Sender': 'cli',
'StartTime': datetime(2021, 5, 18, 18, 25, 41, 1, 138, 0),
},
{
'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
'EngagementArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f',
'Sender': 'cli',
'StartTime': datetime(2021, 5, 18, 18, 20, 58, 1, 138, 0),
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_page_receipts(**kwargs)¶Lists all of the engagements to contact channels that have been acknowledged.
See also: AWS API Documentation
Request Syntax
response = client.list_page_receipts(
PageId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the engagement to a specific contact channel.
dict
Response Syntax
{
'NextToken': 'string',
'Receipts': [
{
'ContactChannelArn': 'string',
'ReceiptType': 'DELIVERED'|'ERROR'|'READ'|'SENT'|'STOP',
'ReceiptInfo': 'string',
'ReceiptTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
NextToken (string) --
The pagination token to continue to the next page of results.
Receipts (list) --
A list of each acknowledgement.
(dict) --
Records events during an engagement.
ContactChannelArn (string) --
The Amazon Resource Name (ARN) of the contact channel Incident Manager engaged.
ReceiptType (string) --
The type follows the engagement cycle, SENT , DELIVERED , and READ .
ReceiptInfo (string) --
Information provided during the page acknowledgement.
ReceiptTime (datetime) --
The time receipt was SENT , DELIVERED , or READ .
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionExamples
The following command-name example lists whether a page was received or not by a contact.
response = client.list_page_receipts(
PageId='arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3',
)
print(response)
Expected Output:
{
'Receipts': [
{
'ContactChannelArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
'ReceiptInfo': '425440',
'ReceiptTime': datetime(2021, 5, 18, 20, 42, 57, 1, 138, 0),
'ReceiptType': 'DELIVERED',
},
{
'ContactChannelArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
'ReceiptInfo': '425440',
'ReceiptTime': datetime(2021, 5, 18, 20, 42, 57, 1, 138, 0),
'ReceiptType': 'READ',
},
{
'ContactChannelArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
'ReceiptInfo': 'SM6656c19132f1465f9c9c1123a5dde7c9',
'ReceiptTime': datetime(2021, 5, 18, 20, 40, 52, 1, 138, 0),
'ReceiptType': 'SENT',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_pages_by_contact(**kwargs)¶Lists the engagements to a contact's contact channels.
See also: AWS API Documentation
Request Syntax
response = client.list_pages_by_contact(
ContactId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the contact you are retrieving engagements for.
dict
Response Syntax
{
'NextToken': 'string',
'Pages': [
{
'PageArn': 'string',
'EngagementArn': 'string',
'ContactArn': 'string',
'Sender': 'string',
'IncidentId': 'string',
'SentTime': datetime(2015, 1, 1),
'DeliveryTime': datetime(2015, 1, 1),
'ReadTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
NextToken (string) --
The pagination token to continue to the next page of results.
Pages (list) --
The list of engagements to a contact's contact channel.
(dict) --
Incident Manager engaging a contact's contact channel.
PageArn (string) --
The Amazon Resource Name (ARN) of the page to the contact channel.
EngagementArn (string) --
The ARN of the engagement that this page is part of.
ContactArn (string) --
The ARN of the contact that Incident Manager is engaging.
Sender (string) --
The user that started the engagement.
IncidentId (string) --
The ARN of the incident that's engaging the contact channel.
SentTime (datetime) --
The time that Incident Manager engaged the contact channel.
DeliveryTime (datetime) --
The time the message was delivered to the contact channel.
ReadTime (datetime) --
The time that the contact channel acknowledged engagement.
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionExamples
The following list-pages-by-contact example lists all pages to the specified contact.
response = client.list_pages_by_contact(
ContactId='arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
)
print(response)
Expected Output:
{
'Pages': [
{
'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
'DeliveryTime': datetime(2021, 5, 18, 18, 43, 55, 1, 138, 0),
'EngagementArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0',
'PageArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93',
'ReadTime': datetime(2021, 5, 18, 18, 43, 55, 1, 138, 0),
'Sender': 'cli',
'SentTime': datetime(2021, 5, 18, 18, 43, 29, 1, 138, 0),
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_pages_by_engagement(**kwargs)¶Lists the engagements to contact channels that occurred by engaging a contact.
See also: AWS API Documentation
Request Syntax
response = client.list_pages_by_engagement(
EngagementId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the engagement.
dict
Response Syntax
{
'NextToken': 'string',
'Pages': [
{
'PageArn': 'string',
'EngagementArn': 'string',
'ContactArn': 'string',
'Sender': 'string',
'IncidentId': 'string',
'SentTime': datetime(2015, 1, 1),
'DeliveryTime': datetime(2015, 1, 1),
'ReadTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
NextToken (string) --
The pagination token to continue to the next page of results.
Pages (list) --
The list of engagements to contact channels.
(dict) --
Incident Manager engaging a contact's contact channel.
PageArn (string) --
The Amazon Resource Name (ARN) of the page to the contact channel.
EngagementArn (string) --
The ARN of the engagement that this page is part of.
ContactArn (string) --
The ARN of the contact that Incident Manager is engaging.
Sender (string) --
The user that started the engagement.
IncidentId (string) --
The ARN of the incident that's engaging the contact channel.
SentTime (datetime) --
The time that Incident Manager engaged the contact channel.
DeliveryTime (datetime) --
The time the message was delivered to the contact channel.
ReadTime (datetime) --
The time that the contact channel acknowledged engagement.
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionExamples
The following list-pages-by-engagement example lists the pages that occurred while engaging the defined engagement plan.
response = client.list_pages_by_engagement(
EngagementId='arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0',
)
print(response)
Expected Output:
{
'Pages': [
{
'ContactArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
'EngagementArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0',
'PageArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93',
'Sender': 'cli',
'SentTime': datetime(2021, 5, 18, 18, 40, 27, 1, 138, 0),
},
],
'ResponseMetadata': {
'...': '...',
},
}
Lists the tags of an escalation plan or contact.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the contact or escalation plan.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The tags related to the contact or escalation plan.
A container of a key-value name pair.
Name of the object key.
Value of the tag.
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ValidationExceptionSSMContacts.Client.exceptions.InternalServerExceptionExamples
The following list-tags-for-resource example lists the tags of the specified contact.
response = client.list_tags_for_resource(
ResourceARN='arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam',
)
print(response)
Expected Output:
{
'Tags': [
{
'Key': 'group1',
'Value': '1',
},
],
'ResponseMetadata': {
'...': '...',
},
}
put_contact_policy(**kwargs)¶Adds a resource policy to the specified contact or escalation plan. The resource policy is used to share the contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Setting up cross-account functionality .
See also: AWS API Documentation
Request Syntax
response = client.put_contact_policy(
ContactArn='string',
Policy='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the contact or escalation plan.
[REQUIRED]
Details of the resource policy.
dict
Response Syntax
{}
Response Structure
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.ConflictExceptionSSMContacts.Client.exceptions.ValidationExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.InternalServerExceptionExamples
The following put-contact-policy example adds a resource policy to the contact Akua that shares the contact and related engagements with the principal.
response = client.put_contact_policy(
ContactArn='arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam',
Policy='{"Version":"2012-10-17","Statement":[{"Sid":"ExampleResourcePolicy","Action":["ssm-contacts:GetContact","ssm-contacts:StartEngagement","ssm-contacts:DescribeEngagement","ssm-contacts:ListPagesByEngagement","ssm-contacts:StopEngagement"],"Principal":{"AWS":"222233334444"},"Effect":"Allow","Resource":["arn:aws:ssm-contacts:*:111122223333:contact/akuam","arn:aws:ssm-contacts:*:111122223333:engagement/akuam/*"]}]}',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
send_activation_code(**kwargs)¶Sends an activation code to a contact channel. The contact can use this code to activate the contact channel in the console or with the ActivateChannel operation. Incident Manager can't engage a contact channel until it has been activated.
See also: AWS API Documentation
Request Syntax
response = client.send_activation_code(
ContactChannelId='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the contact channel.
{}
Response Structure
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.DataEncryptionExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ServiceQuotaExceededExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionExamples
The following send-activation-code example sends an activation code and message to the specified contact channel.
response = client.send_activation_code(
ContactChannelId='arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/8ddae2d1-12c8-4e45-b852-c8587266c400',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
start_engagement(**kwargs)¶Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.
See also: AWS API Documentation
Request Syntax
response = client.start_engagement(
ContactId='string',
Sender='string',
Subject='string',
Content='string',
PublicSubject='string',
PublicContent='string',
IncidentId='string',
IdempotencyToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the contact being engaged.
[REQUIRED]
The user that started the engagement.
[REQUIRED]
The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL .
[REQUIRED]
The secure content of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL .
SMS .SMS .A token ensuring that the operation is called only once with the specified details.
This field is autopopulated if not provided.
dict
Response Syntax
{
'EngagementArn': 'string'
}
Response Structure
(dict) --
EngagementArn (string) --
The ARN of the engagement.
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.DataEncryptionExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionExamples
The following start-engagement pages contact's contact channels. Sender, subject, public-subject, and public-content are all free from fields. Incident Manager sends the subject and content to the provided VOICE or EMAIL contact channels. Incident Manager sends the public-subject and public-content to the provided SMS contact channels. Sender is used to track who started the engagement.
response = client.start_engagement(
ContactId='arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
Content='Testing engagements',
PublicContent='Testing engagements',
PublicSubject='test',
Sender='tester',
Subject='test',
)
print(response)
Expected Output:
{
'EngagementArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f',
'ResponseMetadata': {
'...': '...',
},
}
The following start-engagement engages contact's through an escalation plan. Each contact is paged according to their engagement plan.
response = client.start_engagement(
ContactId='arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation',
Content='Testing engagements',
PublicContent='Testing engagements',
PublicSubject='test',
Sender='tester',
Subject='test',
)
print(response)
Expected Output:
{
'EngagementArn': 'arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356',
'ResponseMetadata': {
'...': '...',
},
}
stop_engagement(**kwargs)¶Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.
See also: AWS API Documentation
Request Syntax
response = client.stop_engagement(
EngagementId='string',
Reason='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the engagement.
dict
Response Syntax
{}
Response Structure
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.ValidationExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.InternalServerExceptionExamples
The following stop-engagement example stops an engagement from paging further contacts and contact channels.
response = client.stop_engagement(
EngagementId='arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
tag_resource(**kwargs)¶Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the contact or escalation plan.
[REQUIRED]
A list of tags that you are adding to the contact or escalation plan.
A container of a key-value name pair.
Name of the object key.
Value of the tag.
dict
Response Syntax
{}
Response Structure
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ServiceQuotaExceededExceptionSSMContacts.Client.exceptions.ValidationExceptionExamples
The following tag-resource example tags a specified contact with the provided tag key value pair.
response = client.tag_resource(
ResourceARN='arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam',
Tags=[
{
'Key': 'group1',
'Value': '1',
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
untag_resource(**kwargs)¶Removes tags from the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the contact or escalation plan.
[REQUIRED]
The key of the tag that you want to remove.
dict
Response Syntax
{}
Response Structure
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ValidationExceptionSSMContacts.Client.exceptions.InternalServerExceptionExamples
The following untag-resource example removes the group1 tag from the specified contact.
response = client.untag_resource(
ResourceARN='arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam',
TagKeys=[
'group1',
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
update_contact(**kwargs)¶Updates the contact or escalation plan specified.
See also: AWS API Documentation
Request Syntax
response = client.update_contact(
ContactId='string',
DisplayName='string',
Plan={
'Stages': [
{
'DurationInMinutes': 123,
'Targets': [
{
'ChannelTargetInfo': {
'ContactChannelId': 'string',
'RetryIntervalInMinutes': 123
},
'ContactTargetInfo': {
'ContactId': 'string',
'IsEssential': True|False
}
},
]
},
]
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the contact or escalation plan you're updating.
A list of stages. A contact has an engagement plan with stages for specified contact channels. An escalation plan uses these stages to contact specified contacts.
A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.
A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.
The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
The contacts or contact methods that the escalation plan or engagement plan is engaging.
The contact or contact channel that's being engaged.
Information about the contact channel Incident Manager is engaging.
The Amazon Resource Name (ARN) of the contact channel.
The number of minutes to wait to retry sending engagement in the case the engagement initially fails.
Information about the contact that Incident Manager is engaging.
The Amazon Resource Name (ARN) of the contact.
A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.
dict
Response Syntax
{}
Response Structure
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ServiceQuotaExceededExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionSSMContacts.Client.exceptions.DataEncryptionExceptionExamples
The following update-contact example updates the engagement plan of the contact Akua to include the three types of contacts channels. This is done after creating contact channels for Akua.
response = client.update_contact(
ContactId='arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam',
Plan={
'Stages': [
{
'DurationInMinutes': 5,
'Targets': [
{
'ChannelTargetInfo': {
'ContactChannelId': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65',
'RetryIntervalInMinutes': 1,
},
},
],
},
{
'DurationInMinutes': 5,
'Targets': [
{
'ChannelTargetInfo': {
'ContactChannelId': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad',
'RetryIntervalInMinutes': 1,
},
},
],
},
{
'DurationInMinutes': 5,
'Targets': [
{
'ChannelTargetInfo': {
'ContactChannelId': 'arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a',
'RetryIntervalInMinutes': 1,
},
},
],
},
],
},
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
update_contact_channel(**kwargs)¶Updates a contact's contact channel.
See also: AWS API Documentation
Request Syntax
response = client.update_contact_channel(
ContactChannelId='string',
Name='string',
DeliveryAddress={
'SimpleAddress': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the contact channel you want to update.
The details that Incident Manager uses when trying to engage the contact channel.
The format is dependent on the type of the contact channel. The following are the expected formats:
dict
Response Syntax
{}
Response Structure
Exceptions
SSMContacts.Client.exceptions.AccessDeniedExceptionSSMContacts.Client.exceptions.ConflictExceptionSSMContacts.Client.exceptions.DataEncryptionExceptionSSMContacts.Client.exceptions.InternalServerExceptionSSMContacts.Client.exceptions.ResourceNotFoundExceptionSSMContacts.Client.exceptions.ThrottlingExceptionSSMContacts.Client.exceptions.ValidationExceptionExamples
The following update-contact-channel example updates the name and delivery address of a contact channel.
response = client.update_contact_channel(
ContactChannelId='arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad',
DeliveryAddress={
'SimpleAddress': '+15005550198',
},
Name='akuas voice channel',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
The available paginators are:
SSMContacts.Paginator.ListContactChannelsSSMContacts.Paginator.ListContactsSSMContacts.Paginator.ListEngagementsSSMContacts.Paginator.ListPageReceiptsSSMContacts.Paginator.ListPagesByContactSSMContacts.Paginator.ListPagesByEngagementSSMContacts.Paginator.ListContactChannels¶paginator = client.get_paginator('list_contact_channels')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SSMContacts.Client.list_contact_channels().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ContactId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the contact.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ContactChannels': [
{
'ContactChannelArn': 'string',
'ContactArn': 'string',
'Name': 'string',
'Type': 'SMS'|'VOICE'|'EMAIL',
'DeliveryAddress': {
'SimpleAddress': 'string'
},
'ActivationStatus': 'ACTIVATED'|'NOT_ACTIVATED'
},
]
}
Response Structure
(dict) --
ContactChannels (list) --
A list of contact channels related to the specified contact.
(dict) --
The method that Incident Manager uses to engage a contact.
ContactChannelArn (string) --
The Amazon Resource Name (ARN) of the contact channel.
ContactArn (string) --
The ARN of the contact that contains the contact channel.
Name (string) --
The name of the contact channel.
Type (string) --
The type of the contact channel. Incident Manager supports three contact methods:
DeliveryAddress (dict) --
The details that Incident Manager uses when trying to engage the contact channel.
SimpleAddress (string) --
The format is dependent on the type of the contact channel. The following are the expected formats:
ActivationStatus (string) --
A Boolean value describing if the contact channel has been activated or not. If the contact channel isn't activated, Incident Manager can't engage the contact through it.
SSMContacts.Paginator.ListContacts¶paginator = client.get_paginator('list_contacts')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SSMContacts.Client.list_contacts().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AliasPrefix='string',
Type='PERSONAL'|'ESCALATION',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
PERSONAL and an escalation plan is type ESCALATION .A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Contacts': [
{
'ContactArn': 'string',
'Alias': 'string',
'DisplayName': 'string',
'Type': 'PERSONAL'|'ESCALATION'
},
]
}
Response Structure
(dict) --
Contacts (list) --
A list of the contacts and escalation plans in your Incident Manager account.
(dict) --
A personal contact or escalation plan that Incident Manager engages during an incident.
ContactArn (string) --
The Amazon Resource Name (ARN) of the contact or escalation plan.
Alias (string) --
The unique and identifiable alias of the contact or escalation plan.
DisplayName (string) --
The full name of the contact or escalation plan.
Type (string) --
Refers to the type of contact. A single contact is type PERSONAL and an escalation plan is type ESCALATION .
SSMContacts.Paginator.ListEngagements¶paginator = client.get_paginator('list_engagements')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SSMContacts.Client.list_engagements().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
IncidentId='string',
TimeRangeValue={
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The time range to lists engagements for an incident.
The start of the time range.
The end of the time range.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Engagements': [
{
'EngagementArn': 'string',
'ContactArn': 'string',
'Sender': 'string',
'IncidentId': 'string',
'StartTime': datetime(2015, 1, 1),
'StopTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Engagements (list) --
A list of each engagement that occurred during the specified time range of an incident.
(dict) --
Incident Manager reaching out to a contact or escalation plan to engage contact during an incident.
EngagementArn (string) --
The Amazon Resource Name (ARN) of the engagement.
ContactArn (string) --
The ARN of the escalation plan or contact that Incident Manager is engaging.
Sender (string) --
The user that started the engagement.
IncidentId (string) --
The ARN of the incident that's engaging the contact.
StartTime (datetime) --
The time that the engagement began.
StopTime (datetime) --
The time that the engagement ended.
SSMContacts.Paginator.ListPageReceipts¶paginator = client.get_paginator('list_page_receipts')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SSMContacts.Client.list_page_receipts().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PageId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the engagement to a specific contact channel.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Receipts': [
{
'ContactChannelArn': 'string',
'ReceiptType': 'DELIVERED'|'ERROR'|'READ'|'SENT'|'STOP',
'ReceiptInfo': 'string',
'ReceiptTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Receipts (list) --
A list of each acknowledgement.
(dict) --
Records events during an engagement.
ContactChannelArn (string) --
The Amazon Resource Name (ARN) of the contact channel Incident Manager engaged.
ReceiptType (string) --
The type follows the engagement cycle, SENT , DELIVERED , and READ .
ReceiptInfo (string) --
Information provided during the page acknowledgement.
ReceiptTime (datetime) --
The time receipt was SENT , DELIVERED , or READ .
SSMContacts.Paginator.ListPagesByContact¶paginator = client.get_paginator('list_pages_by_contact')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SSMContacts.Client.list_pages_by_contact().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ContactId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the contact you are retrieving engagements for.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Pages': [
{
'PageArn': 'string',
'EngagementArn': 'string',
'ContactArn': 'string',
'Sender': 'string',
'IncidentId': 'string',
'SentTime': datetime(2015, 1, 1),
'DeliveryTime': datetime(2015, 1, 1),
'ReadTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Pages (list) --
The list of engagements to a contact's contact channel.
(dict) --
Incident Manager engaging a contact's contact channel.
PageArn (string) --
The Amazon Resource Name (ARN) of the page to the contact channel.
EngagementArn (string) --
The ARN of the engagement that this page is part of.
ContactArn (string) --
The ARN of the contact that Incident Manager is engaging.
Sender (string) --
The user that started the engagement.
IncidentId (string) --
The ARN of the incident that's engaging the contact channel.
SentTime (datetime) --
The time that Incident Manager engaged the contact channel.
DeliveryTime (datetime) --
The time the message was delivered to the contact channel.
ReadTime (datetime) --
The time that the contact channel acknowledged engagement.
SSMContacts.Paginator.ListPagesByEngagement¶paginator = client.get_paginator('list_pages_by_engagement')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from SSMContacts.Client.list_pages_by_engagement().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
EngagementId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the engagement.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Pages': [
{
'PageArn': 'string',
'EngagementArn': 'string',
'ContactArn': 'string',
'Sender': 'string',
'IncidentId': 'string',
'SentTime': datetime(2015, 1, 1),
'DeliveryTime': datetime(2015, 1, 1),
'ReadTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Pages (list) --
The list of engagements to contact channels.
(dict) --
Incident Manager engaging a contact's contact channel.
PageArn (string) --
The Amazon Resource Name (ARN) of the page to the contact channel.
EngagementArn (string) --
The ARN of the engagement that this page is part of.
ContactArn (string) --
The ARN of the contact that Incident Manager is engaging.
Sender (string) --
The user that started the engagement.
IncidentId (string) --
The ARN of the incident that's engaging the contact channel.
SentTime (datetime) --
The time that Incident Manager engaged the contact channel.
DeliveryTime (datetime) --
The time the message was delivered to the contact channel.
ReadTime (datetime) --
The time that the contact channel acknowledged engagement.