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.
client = session.create_client('ssm-contacts')
These are the available methods:
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'
)
PageId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the engagement to a contact channel.
ContactChannelId (string) – The ARN of the contact channel.
AcceptType (string) –
[REQUIRED]
The type indicates if the page was DELIVERED
or READ
.
Note (string) – Information provided by the user when the user acknowledges the page.
AcceptCode (string) –
[REQUIRED]
The accept code is a 6-digit code used to acknowledge the page.
AcceptCodeValidation (string) –
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
(dict) –
Exceptions
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'
)
ContactChannelId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the contact channel.
ActivationCode (string) –
[REQUIRED]
The code sent to the contact channel when it was created in the contact.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
can_paginate
(operation_name)¶Check if an operation can be paginated.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is 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.
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'
)
Alias (string) –
[REQUIRED]
The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.
DisplayName (string) – The full name of the contact or escalation plan.
Type (string) –
[REQUIRED]
To create an escalation plan use ESCALATION
. To create a contact use PERSONAL
.
Plan (dict) –
[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.
Stages (list) – [REQUIRED]
A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.
(dict) –
A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.
DurationInMinutes (integer) – [REQUIRED]
The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
Targets (list) – [REQUIRED]
The contacts or contact methods that the escalation plan or engagement plan is engaging.
(dict) –
The contact or contact channel that’s being engaged.
ChannelTargetInfo (dict) –
Information about the contact channel Incident Manager is engaging.
ContactChannelId (string) – [REQUIRED]
The Amazon Resource Name (ARN) of the contact channel.
RetryIntervalInMinutes (integer) –
The number of minutes to wait to retry sending engagement in the case the engagement initially fails.
ContactTargetInfo (dict) –
Information about the contact that Incident Manager is engaging.
ContactId (string) –
The Amazon Resource Name (ARN) of the contact.
IsEssential (boolean) – [REQUIRED]
A Boolean value determining if the contact’s acknowledgement stops the progress of stages in the plan.
Tags (list) –
Adds a tag to the target. You can only tag resources created in the first Region of your replication set.
(dict) –
A container of a key-value name pair.
Key (string) –
Name of the object key.
Value (string) –
Value of the tag.
IdempotencyToken (string) –
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
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'
)
ContactId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
Name (string) –
[REQUIRED]
The name of the contact channel.
Type (string) –
[REQUIRED]
Incident Manager supports three types of contact channels:
SMS
VOICE
EMAIL
DeliveryAddress (dict) –
[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:
SMS - ‘+’ followed by the country code and phone number
VOICE - ‘+’ followed by the country code and phone number
EMAIL - any standard email format
SimpleAddress (string) –
The format is dependent on the type of the contact channel. The following are the expected formats:
SMS - ‘+’ followed by the country code and phone number
VOICE - ‘+’ followed by the country code and phone number
EMAIL - any standard email format
DeferActivation (boolean) – If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can’t engage your contact channel until it has been activated.
IdempotencyToken (string) –
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
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'
)
ContactChannelId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the contact channel you’re deactivating.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
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'
)
ContactId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the contact that you’re deleting.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
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'
)
ContactChannelId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the contact channel.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
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'
)
EngagementId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the engagement you want the details of.
dict
Response Syntax
{
'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
(dict) –
ContactArn (string) –
The ARN of the escalation plan or contacts involved in the engagement.
EngagementArn (string) –
The ARN of the engagement.
Sender (string) –
The user that started the engagement.
Subject (string) –
The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE
and EMAIL
.
Content (string) –
The secure content of the message that was sent to the contact. Use this field for engagements to VOICE
and EMAIL
.
PublicSubject (string) –
The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS
.
PublicContent (string) –
The insecure content of the message that was sent to the contact. Use this field for engagements to SMS
.
IncidentId (string) –
The ARN of the incident in which the engagement occurred.
StartTime (datetime) –
The time that the engagement started.
StopTime (datetime) –
The time that the engagement ended.
Exceptions
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'
)
PageId (string) –
[REQUIRED]
The ID of the engagement to a contact channel.
dict
Response Syntax
{
'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
(dict) –
PageArn (string) –
The Amazon Resource Name (ARN) of the engagement to a contact channel.
EngagementArn (string) –
The ARN of the engagement that engaged the contact channel.
ContactArn (string) –
The ARN of the contact that was engaged.
Sender (string) –
The user that started the engagement.
Subject (string) –
The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE
and EMAIL
.
Content (string) –
The secure content of the message that was sent to the contact. Use this field for engagements to VOICE
and EMAIL
.
PublicSubject (string) –
The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS
.
PublicContent (string) –
The insecure content of the message that was sent to the contact. Use this field for engagements to SMS
.
IncidentId (string) –
The ARN of the incident that engaged the contact channel.
SentTime (datetime) –
The time the engagement was sent to the contact channel.
ReadTime (datetime) –
The time that the contact channel acknowledged the engagement.
DeliveryTime (datetime) –
The time that the contact channel received the engagement.
Exceptions
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'
)
ContactId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the contact or escalation plan.
dict
Response Syntax
{
'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
(dict) –
ContactArn (string) –
The ARN of the contact or escalation plan.
Alias (string) –
The alias of the contact or escalation plan. The alias is unique and identifiable.
DisplayName (string) –
The full name of the contact or escalation plan.
Type (string) –
The type of contact, either PERSONAL
or ESCALATION
.
Plan (dict) –
Details about the specific timing or stages and targets of the escalation plan or engagement plan.
Stages (list) –
A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.
(dict) –
A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.
DurationInMinutes (integer) –
The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
Targets (list) –
The contacts or contact methods that the escalation plan or engagement plan is engaging.
(dict) –
The contact or contact channel that’s being engaged.
ChannelTargetInfo (dict) –
Information about the contact channel Incident Manager is engaging.
ContactChannelId (string) –
The Amazon Resource Name (ARN) of the contact channel.
RetryIntervalInMinutes (integer) –
The number of minutes to wait to retry sending engagement in the case the engagement initially fails.
ContactTargetInfo (dict) –
Information about the contact that Incident Manager is engaging.
ContactId (string) –
The Amazon Resource Name (ARN) of the contact.
IsEssential (boolean) –
A Boolean value determining if the contact’s acknowledgement stops the progress of stages in the plan.
Exceptions
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'
)
ContactChannelId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the contact channel you want information about.
dict
Response Syntax
{
'ContactArn': 'string',
'ContactChannelArn': 'string',
'Name': 'string',
'Type': 'SMS'|'VOICE'|'EMAIL',
'DeliveryAddress': {
'SimpleAddress': 'string'
},
'ActivationStatus': 'ACTIVATED'|'NOT_ACTIVATED'
}
Response Structure
(dict) –
ContactArn (string) –
The ARN of the contact that the channel belongs to.
ContactChannelArn (string) –
The ARN of the contact channel.
Name (string) –
The name of the contact channel
Type (string) –
The type of contact channel. The type is SMS
, VOICE
, or EMAIL
.
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:
SMS - ‘+’ followed by the country code and phone number
VOICE - ‘+’ followed by the country code and phone number
EMAIL - any standard email format
ActivationStatus (string) –
A Boolean value indicating if the contact channel has been activated or not.
Exceptions
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'
)
ContactArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the contact or escalation plan.
dict
Response Syntax
{
'ContactArn': 'string',
'Policy': 'string'
}
Response Structure
(dict) –
ContactArn (string) –
The ARN of the contact or escalation plan.
Policy (string) –
Details about the resource policy attached to the contact or escalation plan.
Exceptions
get_paginator
(operation_name)¶Create a paginator for an operation.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is 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")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
get_waiter
(waiter_name)¶Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
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
)
ContactId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the contact.
NextToken (string) – The pagination token to continue to the next page of results.
MaxResults (integer) – The maximum number of contact channels per page.
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:
SMS
VOICE
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:
SMS - ‘+’ followed by the country code and phone number
VOICE - ‘+’ followed by the country code and phone number
EMAIL - any standard email format
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
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'
)
NextToken (string) – The pagination token to continue to the next page of results.
MaxResults (integer) – The maximum number of contacts and escalation plans per page of results.
AliasPrefix (string) – Used to list only contacts who’s aliases start with the specified prefix.
Type (string) – The type of contact. A contact is type 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
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)
}
)
NextToken (string) – The pagination token to continue to the next page of results.
MaxResults (integer) – The maximum number of engagements per page of results.
IncidentId (string) – The Amazon Resource Name (ARN) of the incident you’re listing engagements for.
TimeRangeValue (dict) –
The time range to lists engagements for an incident.
StartTime (datetime) –
The start of the time range.
EndTime (datetime) –
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
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
)
PageId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the engagement to a specific contact channel.
NextToken (string) – The pagination token to continue to the next page of results.
MaxResults (integer) – The maximum number of acknowledgements per page of results.
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
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
)
ContactId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the contact you are retrieving engagements for.
NextToken (string) – The pagination token to continue to the next page of results.
MaxResults (integer) – The maximum number of engagements to contact channels to list per page of results.
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
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
)
EngagementId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the engagement.
NextToken (string) – The pagination token to continue to the next page of results.
MaxResults (integer) – The maximum number of engagements to contact channels to list per page of results.
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
Lists the tags of an escalation plan or contact.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceARN='string'
)
ResourceARN (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the contact or escalation plan.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) –
Tags (list) –
The tags related to the contact or escalation plan.
(dict) –
A container of a key-value name pair.
Key (string) –
Name of the object key.
Value (string) –
Value of the tag.
Exceptions
put_contact_policy
(**kwargs)¶Adds a resource to the specified contact or escalation plan.
See also: AWS API Documentation
Request Syntax
response = client.put_contact_policy(
ContactArn='string',
Policy='string'
)
ContactArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the contact or escalation plan.
Policy (string) –
[REQUIRED]
Details of the resource policy.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
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'
)
ContactChannelId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the contact channel.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
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'
)
ContactId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the contact being engaged.
Sender (string) –
[REQUIRED]
The user that started the engagement.
Subject (string) –
[REQUIRED]
The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE
or EMAIL
.
Content (string) –
[REQUIRED]
The secure content of the message that was sent to the contact. Use this field for engagements to VOICE
or EMAIL
.
PublicSubject (string) – The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS
.
PublicContent (string) – The insecure content of the message that was sent to the contact. Use this field for engagements to SMS
.
IncidentId (string) – The ARN of the incident that the engagement is part of.
IdempotencyToken (string) –
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
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'
)
EngagementId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the engagement.
Reason (string) – The reason that you’re stopping the engagement.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
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'
},
]
)
ResourceARN (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the contact or escalation plan.
Tags (list) –
[REQUIRED]
A list of tags that you are adding to the contact or escalation plan.
(dict) –
A container of a key-value name pair.
Key (string) –
Name of the object key.
Value (string) –
Value of the tag.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
untag_resource
(**kwargs)¶Removes tags from the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
ResourceARN (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the contact or escalation plan.
TagKeys (list) –
[REQUIRED]
The key of the tag that you want to remove.
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
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
}
},
]
},
]
}
)
ContactId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the contact or escalation plan you’re updating.
DisplayName (string) – The full name of the contact or escalation plan.
Plan (dict) –
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.
Stages (list) – [REQUIRED]
A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.
(dict) –
A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.
DurationInMinutes (integer) – [REQUIRED]
The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
Targets (list) – [REQUIRED]
The contacts or contact methods that the escalation plan or engagement plan is engaging.
(dict) –
The contact or contact channel that’s being engaged.
ChannelTargetInfo (dict) –
Information about the contact channel Incident Manager is engaging.
ContactChannelId (string) – [REQUIRED]
The Amazon Resource Name (ARN) of the contact channel.
RetryIntervalInMinutes (integer) –
The number of minutes to wait to retry sending engagement in the case the engagement initially fails.
ContactTargetInfo (dict) –
Information about the contact that Incident Manager is engaging.
ContactId (string) –
The Amazon Resource Name (ARN) of the contact.
IsEssential (boolean) – [REQUIRED]
A Boolean value determining if the contact’s acknowledgement stops the progress of stages in the plan.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
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'
}
)
ContactChannelId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the contact channel you want to update.
Name (string) – The name of the contact channel.
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:
SMS - ‘+’ followed by the country code and phone number
VOICE - ‘+’ followed by the country code and phone number
EMAIL - any standard email format
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
SSMContacts.Client.exceptions.
AccessDeniedException
¶You don’t have sufficient access to perform this operation.
Example
try:
...
except client.exceptions.AccessDeniedException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
You don’t have sufficient access to perform this operation.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
SSMContacts.Client.exceptions.
ConflictException
¶Updating or deleting a resource causes an inconsistent state.
Example
try:
...
except client.exceptions.ConflictException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'ResourceId': 'string',
'ResourceType': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
Updating or deleting a resource causes an inconsistent state.
Message (string) –
ResourceId (string) – Identifier of the resource in use
ResourceType (string) – ype of the resource in use
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
SSMContacts.Client.exceptions.
DataEncryptionException
¶The operation failed to due an encryption key error.
Example
try:
...
except client.exceptions.DataEncryptionException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The operation failed to due an encryption key error.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
SSMContacts.Client.exceptions.
InternalServerException
¶Unexpected error occurred while processing the request.
Example
try:
...
except client.exceptions.InternalServerException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'RetryAfterSeconds': 123,
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
Unexpected error occurred while processing the request.
Message (string) –
RetryAfterSeconds (integer) – Advice to clients on when the call can be safely retried
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
SSMContacts.Client.exceptions.
ResourceNotFoundException
¶Request references a resource that doesn’t exist.
Example
try:
...
except client.exceptions.ResourceNotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'ResourceId': 'string',
'ResourceType': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
Request references a resource that doesn’t exist.
Message (string) –
ResourceId (string) – Hypothetical resource identifier that was not found
ResourceType (string) – Hypothetical resource type that was not found
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
SSMContacts.Client.exceptions.
ServiceQuotaExceededException
¶Request would cause a service quota to be exceeded.
Example
try:
...
except client.exceptions.ServiceQuotaExceededException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'ResourceId': 'string',
'ResourceType': 'string',
'QuotaCode': 'string',
'ServiceCode': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
Request would cause a service quota to be exceeded.
Message (string) –
ResourceId (string) – Identifier of the resource affected
ResourceType (string) – Type of the resource affected
QuotaCode (string) – Service Quotas requirement to identify originating service
ServiceCode (string) – Service Quotas requirement to identify originating quota
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
SSMContacts.Client.exceptions.
ThrottlingException
¶The request was denied due to request throttling.
Example
try:
...
except client.exceptions.ThrottlingException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'QuotaCode': 'string',
'ServiceCode': 'string',
'RetryAfterSeconds': 123,
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The request was denied due to request throttling.
Message (string) –
QuotaCode (string) – Service Quotas requirement to identify originating service
ServiceCode (string) – Service Quotas requirement to identify originating quota
RetryAfterSeconds (integer) – Advice to clients on when the call can be safely retried
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
SSMContacts.Client.exceptions.
ValidationException
¶The input fails to satisfy the constraints specified by an Amazon Web Services service.
Example
try:
...
except client.exceptions.ValidationException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Reason': 'UNKNOWN_OPERATION'|'CANNOT_PARSE'|'FIELD_VALIDATION_FAILED'|'OTHER',
'Fields': [
{
'Name': 'string',
'Message': 'string'
},
],
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The input fails to satisfy the constraints specified by an Amazon Web Services service.
Message (string) –
Reason (string) – Reason the request failed validation
Fields (list) – The fields that caused the error
(dict) –
Provides information about which field caused the exception.
Name (string) –
The name of the field that caused the exception.
Message (string) –
Information about what caused the field to cause an exception.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The available paginators are:
SSMContacts.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'
}
)
ContactId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the contact.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
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.
PageSize (integer) –
The size of each page.
StartingToken (string) –
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:
SMS
VOICE
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:
SMS - ‘+’ followed by the country code and phone number
VOICE - ‘+’ followed by the country code and phone number
EMAIL - any standard email format
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'
}
)
AliasPrefix (string) – Used to list only contacts who’s aliases start with the specified prefix.
Type (string) – The type of contact. A contact is type PERSONAL
and an escalation plan is type ESCALATION
.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
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.
PageSize (integer) –
The size of each page.
StartingToken (string) –
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'
}
)
IncidentId (string) – The Amazon Resource Name (ARN) of the incident you’re listing engagements for.
TimeRangeValue (dict) –
The time range to lists engagements for an incident.
StartTime (datetime) –
The start of the time range.
EndTime (datetime) –
The end of the time range.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
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.
PageSize (integer) –
The size of each page.
StartingToken (string) –
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'
}
)
PageId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the engagement to a specific contact channel.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
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.
PageSize (integer) –
The size of each page.
StartingToken (string) –
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'
}
)
ContactId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the contact you are retrieving engagements for.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
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.
PageSize (integer) –
The size of each page.
StartingToken (string) –
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'
}
)
EngagementId (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the engagement.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
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.
PageSize (integer) –
The size of each page.
StartingToken (string) –
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.