2021/05/11 - AWS Systems Manager Incident Manager Contacts - 27 new api methods
Changes AWS Systems Manager Incident Manager enables faster resolution of critical application availability and performance issues, management of contacts and post incident analysis
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
client.stop_engagement(
EngagementId='string',
Reason='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the engagement.
string
The reason that you're stopping the engagement.
dict
Response Syntax
{}
Response Structure
(dict) --
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
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'
)
string
[REQUIRED]
The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.
string
The full name of the contact or escalation plan.
string
[REQUIRED]
To create an escalation plan use ESCALATION. To create a contact use PERSONAL.
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.
Targets (list) -- [REQUIRED]
The contacts or contact methods that the escalation plan or engagement plan is engaging.
(dict) --
The contact or contact channel that is 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.
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.
string
A token ensuring that the action 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.
List details about a specific contact channel.
See also: AWS API Documentation
Request Syntax
client.get_contact_channel(
ContactChannelId='string'
)
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.
Retrieves information about the specified contact or escalation plan.
See also: AWS API Documentation
Request Syntax
client.get_contact(
ContactId='string'
)
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.
Targets (list) --
The contacts or contact methods that the escalation plan or engagement plan is engaging.
(dict) --
The contact or contact channel that is 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.
Lists all contact channels for the specified contact.
See also: AWS API Documentation
Request Syntax
client.list_contact_channels(
ContactId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the contact.
string
The pagination token to continue to the next page of results.
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.
Lists all contacts and escalation plans in Incident Manager.
See also: AWS API Documentation
Request Syntax
client.list_contacts(
NextToken='string',
MaxResults=123,
AliasPrefix='string',
Type='PERSONAL'|'ESCALATION'
)
string
The pagination token to continue to the next page of results.
integer
The maximum number of contacts and escalation plans per page of results.
string
Used to list only contacts who's aliases start with the specified prefix.
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.
Lists the engagements to contact channels that occurred by engaging a contact.
See also: AWS API Documentation
Request Syntax
client.list_pages_by_engagement(
EngagementId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the engagement.
string
The pagination token to continue to the next page of results.
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.
Lists all of the engagements to contact channels that have been acknowledged.
See also: AWS API Documentation
Request Syntax
client.list_page_receipts(
PageId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the engagement to a specific contact channel.
string
The pagination token to continue to the next page of results.
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.
Retrieves the resource policies attached to the specified contact or escalation plan.
See also: AWS API Documentation
Request Syntax
client.get_contact_policy(
ContactArn='string'
)
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.
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
client.delete_contact(
ContactId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the contact that you're deleting.
dict
Response Syntax
{}
Response Structure
(dict) --
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
client.activate_contact_channel(
ContactChannelId='string',
ActivationCode='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the contact channel.
string
[REQUIRED]
The code sent to the contact channel when it was created in the contact.
dict
Response Syntax
{}
Response Structure
(dict) --
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
client.start_engagement(
ContactId='string',
Sender='string',
Subject='string',
Content='string',
PublicSubject='string',
PublicContent='string',
IncidentId='string',
IdempotencyToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the contact being engaged.
string
[REQUIRED]
The user that started the engagement.
string
[REQUIRED]
The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.
string
[REQUIRED]
The secure content of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.
string
The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.
string
The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.
string
The ARN of the incident that the engagement is part of.
string
A token ensuring that the action 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.
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 action. Incident Manager can't engage a contact channel until it has been activated.
See also: AWS API Documentation
Request Syntax
client.send_activation_code(
ContactChannelId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the contact channel.
dict
Response Syntax
{}
Response Structure
(dict) --
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
client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the contact or escalation plan.
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) --
Lists the engagements to a contact's contact channels.
See also: AWS API Documentation
Request Syntax
client.list_pages_by_contact(
ContactId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the contact you are retrieving engagements for.
string
The pagination token to continue to the next page of results.
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.
A contact channel is the method that Incident Manager uses to engage your contact.
See also: AWS API Documentation
Request Syntax
client.create_contact_channel(
ContactId='string',
Name='string',
Type='SMS'|'VOICE'|'EMAIL',
DeliveryAddress={
'SimpleAddress': 'string'
},
DeferActivation=True|False,
IdempotencyToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the contact channel.
string
[REQUIRED]
The name of the contact channel.
string
[REQUIRED]
Incident Manager supports three types of contact channels:
SMS
VOICE
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
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.
string
A token ensuring that the action 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 ARN of the contact channel.
Updates a contact's contact channel.
See also: AWS API Documentation
Request Syntax
client.update_contact_channel(
ContactChannelId='string',
Name='string',
DeliveryAddress={
'SimpleAddress': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the contact channel you want to update.
string
The name of the contact channel
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) --
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
client.describe_engagement(
EngagementId='string'
)
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.
Lists details of the engagement to a contact channel.
See also: AWS API Documentation
Request Syntax
client.describe_page(
PageId='string'
)
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.
Lists the tags of an escalation plan or contact.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceARN='string'
)
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.
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
client.delete_contact_channel(
ContactChannelId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the contact channel.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates the contact or escalation plan specified.
See also: AWS API Documentation
Request Syntax
client.update_contact(
ContactId='string',
DisplayName='string',
Plan={
'Stages': [
{
'DurationInMinutes': 123,
'Targets': [
{
'ChannelTargetInfo': {
'ContactChannelId': 'string',
'RetryIntervalInMinutes': 123
},
'ContactTargetInfo': {
'ContactId': 'string',
'IsEssential': True|False
}
},
]
},
]
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the contact or escalation plan you're updating.
string
The full name of the contact or escalation 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.
Targets (list) -- [REQUIRED]
The contacts or contact methods that the escalation plan or engagement plan is engaging.
(dict) --
The contact or contact channel that is 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) --
To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
See also: AWS API Documentation
Request Syntax
client.deactivate_contact_channel(
ContactChannelId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the contact channel you're deactivating.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists all engagements that have happened in an incident.
See also: AWS API Documentation
Request Syntax
client.list_engagements(
NextToken='string',
MaxResults=123,
IncidentId='string',
TimeRangeValue={
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
}
)
string
The pagination token to continue to the next page of results.
integer
The maximum number of engagements per page of results.
string
The Amazon Resource Name (ARN) of the incident you're listing engagements for.
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.
Removes tags from the specified resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the contact or escalation plan.
list
[REQUIRED]
The key of the tag that you want to remove.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Adds a resource to the specified contact or escalation plan.
See also: AWS API Documentation
Request Syntax
client.put_contact_policy(
ContactArn='string',
Policy='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the contact or escalation plan.
string
[REQUIRED]
Details of the resource policy.
dict
Response Syntax
{}
Response Structure
(dict) --
Used to acknowledge an engagement to a contact channel during an incident.
See also: AWS API Documentation
Request Syntax
client.accept_page(
PageId='string',
ContactChannelId='string',
AcceptType='DELIVERED'|'READ',
Note='string',
AcceptCode='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the engagement to a contact channel.
string
The ARN of the contact channel.
string
[REQUIRED]
The type indicates if the page was DELIVERED or READ.
string
Information provided by the user when the user acknowledges the page.
string
[REQUIRED]
The accept code is a 6-digit code used to acknowledge the page.
dict
Response Syntax
{}
Response Structure
(dict) --