AWS Systems Manager Incident Manager API Reference

(1)

AWS Systems Manager Incident Manager

API Reference

AWS Systems Manager Incident Manager: API Reference

(2)

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

Welcome

AWS Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents aﬀecting their AWS-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.

(6)

Actions

The following actions are supported by AWS Systems Manager Incident Manager:

• CreateReplicationSet (p. 5)

• CreateResponsePlan (p. 8)

• CreateTimelineEvent (p. 13)

• DeleteIncidentRecord (p. 17)

• DeleteReplicationSet (p. 19)

• DeleteResourcePolicy (p. 21)

• DeleteResponsePlan (p. 24)

• DeleteTimelineEvent (p. 26)

• GetIncidentRecord (p. 29)

• GetReplicationSet (p. 32)

• GetResourcePolicies (p. 35)

• GetResponsePlan (p. 39)

• GetTimelineEvent (p. 43)

• ListIncidentRecords (p. 46)

• ListRelatedItems (p. 50)

• ListReplicationSets (p. 54)

• ListResponsePlans (p. 57)

• ListTagsForResource (p. 60)

• ListTimelineEvents (p. 63)

• PutResourcePolicy (p. 68)

• StartIncident (p. 71)

• TagResource (p. 75)

• UntagResource (p. 78)

• UpdateDeletionProtection (p. 81)

• UpdateIncidentRecord (p. 84)

• UpdateRelatedItems (p. 88)

• UpdateReplicationSet (p. 91)

• UpdateResponsePlan (p. 94)

• UpdateTimelineEvent (p. 99)

The following actions are supported by AWS Systems Manager Incident Manager Contacts:

• AcceptPage (p. 103)

• ActivateContactChannel (p. 107)

• CreateContact (p. 110)

• CreateContactChannel (p. 114)

• DeactivateContactChannel (p. 118)

• DeleteContact (p. 120)

• DeleteContactChannel (p. 123)

• DescribeEngagement (p. 125)

(7)

AWS Systems Manager Incident Manager

• DescribePage (p. 129)

• GetContact (p. 134)

• GetContactChannel (p. 138)

• GetContactPolicy (p. 142)

• ListContactChannels (p. 145)

• ListContacts (p. 149)

• ListEngagements (p. 153)

• ListPageReceipts (p. 157)

• ListPagesByContact (p. 161)

• ListPagesByEngagement (p. 165)

• PutContactPolicy (p. 172)

• SendActivationCode (p. 175)

• StartEngagement (p. 178)

• StopEngagement (p. 182)

• UpdateContact (p. 191)

• UpdateContactChannel (p. 195)

AWS Systems Manager Incident Manager

The following actions are supported by AWS Systems Manager Incident Manager:

• CreateReplicationSet (p. 5)

• CreateResponsePlan (p. 8)

• CreateTimelineEvent (p. 13)

• DeleteIncidentRecord (p. 17)

• DeleteReplicationSet (p. 19)

• DeleteResourcePolicy (p. 21)

• DeleteResponsePlan (p. 24)

• DeleteTimelineEvent (p. 26)

• GetIncidentRecord (p. 29)

• GetReplicationSet (p. 32)

• GetResourcePolicies (p. 35)

• GetResponsePlan (p. 39)

• GetTimelineEvent (p. 43)

• ListIncidentRecords (p. 46)

• ListRelatedItems (p. 50)

• ListReplicationSets (p. 54)

• ListResponsePlans (p. 57)

• ListTimelineEvents (p. 63)

• PutResourcePolicy (p. 68)

• StartIncident (p. 71)

(8)

AWS Systems Manager Incident Manager

• UpdateDeletionProtection (p. 81)

• UpdateIncidentRecord (p. 84)

• UpdateRelatedItems (p. 88)

• UpdateReplicationSet (p. 91)

• UpdateResponsePlan (p. 94)

• UpdateTimelineEvent (p. 99)

(9)

CreateReplicationSet

Service: AWS Systems Manager Incident Manager

A replication set replicates and encrypts your data to the provided Regions with the provided AWS KMS key.

Request Syntax

POST /createReplicationSet HTTP/1.1 Content-type: application/json {

"clientToken": "string", "regions": {

"string" : {

"sseKmsKeyId": "string"

} }}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken (p. 5)

A token ensuring that the operation is called only once with the speciﬁed details.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Required: No regions (p. 5)

The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.

Type: String to RegionMapInputValue (p. 224) object map Map Entries: Maximum number of 3 items.

Key Length Constraints: Minimum length of 0. Maximum length of 20.

Required: Yes

Response Syntax

HTTP/1.1 201

Content-type: application/json { "arn": "string"

(10)

}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

arn (p. 5)

The Amazon Resource Name (ARN) of the replication set.

Type: String

Pattern: ^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$

Errors

For information about the errors that are common to all actions, see Common Errors (p. 257).

AccessDeniedException

You don't have suﬃcient access to perform this operation.

HTTP Status Code: 403 ConﬂictException

Updating or deleting a resource causes an inconsistent state.

HTTP Status Code: 409 InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500 ServiceQuotaExceededException

Request would cause a service quota to be exceeded.

HTTP Status Code: 402 ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429 ValidationException

The input fails to satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of CreateReplicationSet.

(11)

Sample Request

POST /createReplicationSet HTTP/1.1

Host: ssm-incidents.us-east-1.amazonaws.com Accept-Encoding: identity

User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/

x86_64.amzn.2 prompt/off command/ssm-incidents.create-replication-set X-Amz-Date: 20210810T210320Z

Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210810/us-east-1/ssm- incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 286

{ "regions": {"us-east-1": {"sseKmsKeyId": "arn:aws:kms:us-east-1:111122223333:key/

de6a2f4e-5d40-4443-ad82-1db179510a32"}, "us-east-2": {"sseKmsKeyId": "arn:aws:kms:us- east-2:111122223333:key/6f1572c9-05ca-43cf-bf03-ee7bc93f59bd"}},

"clientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE"

}

Sample Response

{ "arn":"arn:aws:ssm-incidents::111122223333:replication-set/40bd98f0-4110-2dee-b35e- b87006f9e172"

}

CreateResponsePlan

Creates a response plan that automates the initial response to incidents. A response plan engages contacts, starts chat channel collaboration, and initiates runbooks at the beginning of an incident.

Request Syntax

POST /createResponsePlan HTTP/1.1 Content-type: application/json { "actions": [

{

"ssmAutomation": {

"documentName": "string", "documentVersion": "string", "parameters": {

"string" : [ "string" ] },

"roleArn": "string", "targetAccount": "string"

} } ],

"chatChannel": {

"chatbotSns": [ "string" ], "empty": {

} },

"clientToken": "string", "displayName": "string", "engagements": [ "string" ], "incidentTemplate": { "dedupeString": "string", "impact": number,

"notificationTargets": [ {

"snsTopicArn": "string"

} ],

"summary": "string", "title": "string"

},

"name": "string", "tags": {

"string" : "string"

} }

URI Request Parameters

Request Body

actions (p. 8)

The actions that the response plan starts at the beginning of an incident.

(13)

CreateResponsePlan

Type: Array of Action (p. 200) objects

Array Members: Minimum number of 0 items. Maximum number of 1 item.

Required: No chatChannel (p. 8)

The AWS Chatbot chat channel used for collaboration during an incident.

Type: ChatChannel (p. 204) object Required: No

A token ensuring that the operation is called only once with the speciﬁed details.

Type: String

Required: No displayName (p. 8)

The long format of the response plan name. This ﬁeld can contain spaces.

Type: String

Required: No engagements (p. 8)

The contacts and escalation plans that the response plan engages during an incident.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Pattern: ^arn:[-\w+=/,.@]+:ssm-contacts:[-\w+=/,.@]*:[0-9]+:([\w+=/,.@:-]+)*$

Required: No incidentTemplate (p. 8)

Details used to create an incident when using this response plan.

Type: IncidentTemplate (p. 218) object Required: Yes

name (p. 8)

The short format name of the response plan. Can't include spaces.

Type: String

Pattern: ^[a-zA-Z0-9-_]*$

Required: Yes

(14)

CreateResponsePlan

tags (p. 8)

A list of tags that you are adding to the response plan.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[A-Za-z0-9 _=@:.+-/]+$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ^[A-Za-z0-9 _=@:.+-/]*$

Required: No

Response Syntax

HTTP/1.1 201

Content-type: application/json {

"arn": "string"

}

Response Elements

arn (p. 10)

The Amazon Resource Name (ARN) of the response plan.

Type: String

Errors

HTTP Status Code: 403 ConﬂictException

(15)

CreateResponsePlan

InternalServerException

HTTP Status Code: 500 ResourceNotFoundException

Request references a resource which doesn't exist.

Examples

Example

This example illustrates one usage of CreateResponsePlan.

Sample Request

POST /createResponsePlan HTTP/1.1

x86_64.amzn.2 prompt/off command/ssm-incidents.create-response-plan X-Amz-Date: 20210810T213532Z

{ "actions": [

{ "ssmAutomation": {

"documentName": "AWSIncidents-CriticalIncidentRunbookTemplate", "documentVersion": "$DEFAULT",

"roleArn": "arn:aws:iam::111122223333:role/aws-service-role/ssm- incidents.amazonaws.com/AWSServiceRoleForIncidentManager",

"targetAccount": "RESPONSE_PLAN_OWNER_ACCOUNT"

} } ],

"chatChannel": {

"chatbotSns": ["arn:aws:sns:us-east-1:111122223333:Standard_User"]

},

"displayName": "Example response plan",

"engagements": ["arn:aws:ssm-contacts:us-east-1:111122223333:contact/example"], "incidentTemplate": {

"impact": 5,

"title": "example-incident"

}, "name": "example-response",

(16)

CreateResponsePlan

}

Sample Response

{

"arn":"arn:aws:ssm-incidents::111122223333:response-plan/example-response"

}

CreateTimelineEvent

Creates a custom timeline event on the incident details page of an incident record. Timeline events are automatically created by Incident Manager, marking key moment during an incident. You can create custom timeline events to mark important events that are automatically detected by Incident Manager.

Request Syntax

POST /createTimelineEvent HTTP/1.1 Content-type: application/json {

"clientToken": "string", "eventData": "string", "eventTime": number, "eventType": "string",

"incidentRecordArn": "string"

}

URI Request Parameters

Request Body

A token ensuring that the action is called only once with the speciﬁed details.

Type: String

Required: No eventData (p. 13)

A short description of the event.

Type: String

Required: Yes eventTime (p. 13)

The time that the event occurred.

Type: Timestamp Required: Yes eventType (p. 13)

The type of the event. You can create timeline events of type Custom Event.

Type: String

(18)

CreateTimelineEvent

Required: Yes

incidentRecordArn (p. 13)

The Amazon Resource Name (ARN) of the incident record to which the event will be added.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 201

"eventId": "string",

}

Response Elements

eventId (p. 14)

The ID of the event for easy reference later.

Type: String

The ARN of the incident record that you added the event to.

Type: String

Errors

(19)

CreateTimelineEvent

ConﬂictException

Examples

Example

This example illustrates one usage of CreateTimelineEvent.

Sample Request

POST /createTimelineEvent HTTP/1.1

x86_64.amzn.2 prompt/off command/ssm-incidents.create-timeline-event X-Amz-Date: 20210810T221725Z

{

"eventData": "\"example timeline event\"", "eventTime": 1601584200,

"eventType": "Custom Event",

"incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/example- response/bebd9911-63a7-672f-820b-63731f2543ad",

}

Sample Response

{ "eventId":"56bd9912-28e5-b4fc-ec3e-ca4f06309c99",

"incidentRecordArn":"arn:aws:ssm-incidents::111122223333:incident-record/example- response/bebd9911-63a7-672f-820b-63731f2543ad"

(20)

CreateTimelineEvent

}

DeleteIncidentRecord

Service: AWS Systems Manager Incident Manager Delete an incident record from Incident Manager.

Request Syntax

POST /deleteIncidentRecord HTTP/1.1 Content-type: application/json { "arn": "string"

}

URI Request Parameters

Request Body

arn (p. 17)

The Amazon Resource Name (ARN) of the incident record you are deleting.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 204

Response Elements

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors

(22)

DeleteIncidentRecord

Examples

Example

This example illustrates one usage of DeleteIncidentRecord.

Sample Request

POST /deleteIncidentRecord HTTP/1.1

x86_64.amzn.2 prompt/off command/ssm-incidents.delete-incident-record X-Amz-Date: 20210810T222351Z

{

"arn": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/

bebd9911-63a7-672f-820b-63731f2543ad"

}

Sample Response

{}

DeleteReplicationSet

Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data.

Request Syntax

POST /deleteReplicationSet?arn=arn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

arn (p. 19)

The Amazon Resource Name (ARN) of the replication set you're deleting.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 204

Response Elements

Errors

(24)

DeleteReplicationSet

ThrottlingException

Examples

Example

This example illustrates one usage of DeleteReplicationSet.

Sample Request

POST /deleteReplicationSet?arn=arn%3Aaws%3Assm-incidents%3A%111122223333%3Areplication-set

%2F40bd98f0-4110-2dee-b35e-b87006f9e172 HTTP/1.1 Host: ssm-incidents.us-east-1.amazonaws.com Accept-Encoding: identity

x86_64.amzn.2 prompt/off command/ssm-incidents.delete-replication-set X-Amz-Date: 20210811T215946Z

Sample Response

{}

DeleteResourcePolicy

Deletes the resource policy that AWS Resource Access Manager uses to share your Incident Manager resource.

Request Syntax

POST /deleteResourcePolicy HTTP/1.1 Content-type: application/json { "policyId": "string", "resourceArn": "string"

}

URI Request Parameters

Request Body

policyId (p. 21)

The ID of the resource policy you're deleting.

Type: String

Required: Yes resourceArn (p. 21)

The Amazon Resource Name (ARN) of the resource you're deleting the policy from.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

Errors

(26)

Examples

Example

This example illustrates one usage of DeleteResourcePolicy.

Sample Request

POST /deleteResourcePolicy HTTP/1.1

x86_64.amzn.2 prompt/off command/ssm-incidents.delete-resource-policy X-Amz-Date: 20210811T204449Z

{ "policyId": "72f95d0502d05ebf6e7d2c30ee0445cf",

"resourceArn": "arn:aws:ssm-incidents::111122223333:response-plan/example-response"

}

Sample Response

{}

DeleteResponsePlan

Deletes the speciﬁed response plan. Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this response plan.

Request Syntax

POST /deleteResponsePlan HTTP/1.1 Content-type: application/json { "arn": "string"

}

URI Request Parameters

Request Body

arn (p. 24)

Type: String

Required: Yes

Response Syntax

HTTP/1.1 204

Response Elements

Errors

(29)

DeleteResponsePlan

Examples

Example

This example illustrates one usage of DeleteResponsePlan.

Sample Request

POST /deleteResponsePlan HTTP/1.1

x86_64.amzn.2 prompt/off command/ssm-incidents.delete-response-plan X-Amz-Date: 20210811T204938Z

{

"arn": "arn:aws:ssm-incidents::111122223333:response-plan/example-response"

}

Sample Response

{}

DeleteTimelineEvent

Service: AWS Systems Manager Incident Manager Deletes a timeline event from an incident.

Request Syntax

POST /deleteTimelineEvent HTTP/1.1 Content-type: application/json { "eventId": "string",

}

URI Request Parameters

Request Body

eventId (p. 26)

The ID of the event you are updating. You can ﬁnd this by using ListTimelineEvents.

Type: String

Required: Yes

The Amazon Resource Name (ARN) of the incident that includes the timeline event.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 204

Response Elements

Errors

(31)

DeleteTimelineEvent

Examples

Example

This example illustrates one usage of DeleteTimelineEvent.

Sample Request

POST /updateTimelineEvent HTTP/1.1

x86_64.amzn.2 prompt/off command/ssm-incidents.update-timeline-event X-Amz-Date: 20210811T203312Z

{ "eventId": "a4bd9b45-1fcf-64c3-9d53-121d0f53a7ec", "eventTime": 1621620657,

"incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/example- response/64bd9b45-1d0e-2622-840d-03a87a1451fa",

}

Sample Response

{}

GetIncidentRecord

Service: AWS Systems Manager Incident Manager Returns the details for the speciﬁed incident record.

Request Syntax

GET /getIncidentRecord?arn=arn HTTP/1.1

URI Request Parameters

arn (p. 29)

The Amazon Resource Name (ARN) of the incident record.

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

"incidentRecord": { "arn": "string",

"automationExecutions": [ {

"ssmExecutionArn": "string"

} ],

"chatChannel": {

} },

"creationTime": number, "dedupeString": "string", "impact": number,

"incidentRecordSource": { "createdBy": "string", "invokedBy": "string", "resourceArn": "string", "source": "string"

},

"lastModifiedBy": "string", "lastModifiedTime": number, "notificationTargets": [ {

(34)

GetIncidentRecord

} ],

"resolvedTime": number, "status": "string", "summary": "string", "title": "string"

}}

Response Elements

incidentRecord (p. 29)

Details the structure of the incident record.

Type: IncidentRecord (p. 211) object

Errors

Examples

Example

This example illustrates one usage of GetIncidentRecord.

(35)

GetIncidentRecord

Sample Request

GET /getIncidentRecord?arn=arn%3Aaws%3Assm-incidents%3A%111122223333%3Aincident-record

%2Fexample-response%2F78bd9919-b9ac-962d-91e0-149960600e3f HTTP/1.1 Host: ssm-incidents.us-east-1.amazonaws.com

Accept-Encoding: identity

x86_64.amzn.2 prompt/off command/ssm-incidents.get-incident-record X-Amz-Date: 20210810T223503Z

Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210810/us-east-1/ssm- incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE

Sample Response

{ "incidentRecord":

{ "arn":"arn:aws:ssm-incidents::111122223333:incident-record/example-response/78bd9919- b9ac-962d-91e0-149960600e3f",

"automationExecutions":[], "chatChannel":{

"chatbotSns":["arn:aws:sns:us-east-1:111122223333:Standard_User"]

},

"creationTime":1.628634837849E9,

"dedupeString":"00bd9919-b99f-367c-c282-eabcaff587f7", "impact":5,

"incidentRecordSource": {

"createdBy":"arn:aws:sts::111122223333:assumed-role/Admin/exampleUser", "invokedBy":"arn:aws:sts::111122223333:assumed-role/Admin/exampleUser", "resourceArn":null,"source":"aws.ssm-incidents.custom"

},

"lastModifiedBy":"arn:aws:sts::111122223333:assumed-role/Admin/exampleUser", "lastModifiedTime":1.628634838724E9,

"notificationTargets":[], "resolvedTime":null, "status":"OPEN", "summary":null,

"title":"example-incident"

} }

GetReplicationSet

Service: AWS Systems Manager Incident Manager Retrieve your Incident Manager replication set.

Request Syntax

GET /getReplicationSet?arn=arn HTTP/1.1

URI Request Parameters

arn (p. 32)

The Amazon Resource Name (ARN) of the replication set you want to retrieve.

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

Content-type: application/json { "replicationSet": {

"arn": "string", "createdBy": "string", "createdTime": number,

"deletionProtected": boolean, "lastModifiedBy": "string", "lastModifiedTime": number, "regionMap": {

"string" : {

"sseKmsKeyId": "string", "status": "string", "statusMessage": "string", "statusUpdateDateTime": number }

},

"status": "string"

} }

Response Elements

(37)

GetReplicationSet

replicationSet (p. 32)

Details of the replication set.

Type: ReplicationSet (p. 227) object

Errors

Examples

Example

This example illustrates one usage of GetReplicationSet.

Sample Request

GET /getReplicationSet?arn=arn%3Aaws%3Assm-incidents%3A%111122223333%3Areplication-set

%2F40bd98f0-4110-2dee-b35e-b87006f9e172 HTTP/1.1 Host: ssm-incidents.us-east-1.amazonaws.com Accept-Encoding: identity

x86_64.amzn.2 prompt/off command/ssm-incidents.get-replication-set X-Amz-Date: 20210810T224619Z

Sample Response

{

(38)

GetReplicationSet

"replicationSet": {

"createdBy": "arn:aws:iam::111122223333:user/exampleUser", "createdTime": "2021-08-10T21:03:21.332000+00:00",

"deletionProtected": false,

"lastModifiedBy": "arn:aws:iam::111122223333:user/exampleUser", "lastModifiedTime": "2021-08-10T21:03:21.332000+00:00",

"regionMap": { "us-east-1": {

"sseKmsKeyId": "arn:aws:kms:us-east-1:111122223333:key/de6a2f4e-5d40-4443- ad82-1db179510a32",

"status": "ACTIVE"

},

"us-east-2": {

"sseKmsKeyId": "arn:aws:kms:us-east-2:111122223333:key/6f1572c9-05ca-43cf- bf03-ee7bc93f59bd",

"status": "ACTIVE",

"statusMessage": "Tagging inaccessible"

} },

"status": "ACTIVE"

} }

GetResourcePolicies

Retrieves the resource policies attached to the speciﬁed response plan.

Request Syntax

POST /getResourcePolicies?resourceArn=resourceArn HTTP/1.1 Content-type: application/json

{ "maxResults": number, "nextToken": "string"

}

URI Request Parameters

resourceArn (p. 35)

The Amazon Resource Name (ARN) of the response plan with the attached resource policy.

Required: Yes

Request Body

maxResults (p. 35)

The maximum number of resource policies to display per page of results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No nextToken (p. 35)

The pagination token to continue to the next page of results.

Type: String

Required: No

Response Syntax

HTTP/1.1 200

(40)

GetResourcePolicies

Content-type: application/json { "nextToken": "string", "resourcePolicies": [ {

"policyDocument": "string", "policyId": "string",

"ramResourceShareRegion": "string"

} ] }

Response Elements

nextToken (p. 35)

Type: String

resourcePolicies (p. 35)

Details about the resource policy attached to the response plan.

Type: Array of ResourcePolicy (p. 229) objects

Errors

(41)

GetResourcePolicies

ValidationException

Examples

Example

This example illustrates one usage of GetResourcePolicies.

Sample Request

POST /getResourcePolicies?resourceArn=arn%3Aaws%3Assm-incidents%3A%111122223333%3Aresponse- plan%2Fexample-response HTTP/1.1

x86_64.amzn.2 prompt/off command/ssm-incidents.get-resource-policies X-Amz-Date: 20210810T230018Z

Sample Response

{ "nextToken":null,

"resourcePolicies": [ {

"policyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":

[{\"Sid\":\"ExampleResourcePolciy\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":

\"arn:aws:iam::444455556666:root\"},\"Action\":[\"ssm-incidents:GetResponsePlan

\",\"ssm-incidents:StartIncident\",\"ssm-incidents:UpdateIncidentRecord

\",\"ssm-incidents:GetIncidentRecord\",\"ssm-incidents:CreateTimelineEvent

\",\"ssm-incidents:UpdateTimelineEvent\",\"ssm-incidents:GetTimelineEvent

\",\"ssm-incidents:ListTimelineEvents\",\"ssm-incidents:UpdateRelatedItems

\",\"ssm-incidents:ListRelatedItems\"],\"Resource\":[\"arn:aws:ssm- incidents:*:111122223333:response-plan/example-response\",\"arn:aws:ssm- incidents:*:111122223333:incident-record/example-incident/*\"]}]}", "policyId": "72f95d0502d05ebf6e7d2c30ee0445cf",

"ramResourceShareRegion": "us-east-1"

} ] }

GetResponsePlan

Service: AWS Systems Manager Incident Manager Retrieves the details of the speciﬁed response plan.

Request Syntax

GET /getResponsePlan?arn=arn HTTP/1.1

URI Request Parameters

arn (p. 39)

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

"actions": [ {

"ssmAutomation": {

"documentName": "string", "documentVersion": "string", "parameters": {

"string" : [ "string" ] },

"roleArn": "string", "targetAccount": "string"

} } ],

"arn": "string", "chatChannel": {

} },

"displayName": "string", "engagements": [ "string" ], "incidentTemplate": { "dedupeString": "string", "impact": number,

"notificationTargets": [

(44)

GetResponsePlan

{

} ],

"summary": "string", "title": "string"

},

"name": "string"

}

Response Elements

actions (p. 39)

The actions that this response plan takes at the beginning of the incident.

Type: Array of Action (p. 200) objects

Array Members: Minimum number of 0 items. Maximum number of 1 item.

arn (p. 39)

The ARN of the response plan.

Type: String

chatChannel (p. 39)

The AWS Chatbot chat channel used for collaboration during an incident.

Type: ChatChannel (p. 204) object displayName (p. 39)

The long format name of the response plan. Can contain spaces.

Type: String

engagements (p. 39)

The contacts and escalation plans that the response plan engages during an incident.

Type: Array of strings

Pattern: ^arn:[-\w+=/,.@]+:ssm-contacts:[-\w+=/,.@]*:[0-9]+:([\w+=/,.@:-]+)*$

incidentTemplate (p. 39)

Details used to create the incident when using this response plan.

Type: IncidentTemplate (p. 218) object

(45)

GetResponsePlan

name (p. 39)

The short format name of the response plan. The name can't contain spaces.

Type: String

Pattern: ^[a-zA-Z0-9-_]*$

Errors

Examples

Example

This example illustrates one usage of GetResponsePlan.

Sample Request

GET /getResponsePlan?arn=arn%3Aaws%3Assm-incidents%3A%111122223333%3Aresponse-plan

%2Fexample-response HTTP/1.1

x86_64.amzn.2 prompt/off command/ssm-incidents.get-response-plan X-Amz-Date: 20210810T230500Z

(46)

GetResponsePlan

Sample Response

{ "actions": [ {

"ssmAutomation": {

"documentName": "AWSIncidents-CriticalIncidentRunbookTemplate", "documentVersion": "$DEFAULT",

"roleArn": "arn:aws:iam::111122223333:role/aws-service-role/ssm- incidents.amazonaws.com/AWSServiceRoleForIncidentManager",

"targetAccount": "RESPONSE_PLAN_OWNER_ACCOUNT"

} } ],

"arn": "arn:aws:ssm-incidents::111122223333:response-plan/example-response", "chatChannel": {

"chatbotSns": [

"arn:aws:sns:us-east-1:111122223333:Standard_User"

] },

"displayName": "Example response plan", "engagements": [

"arn:aws:ssm-contacts:us-east-1:111122223333:contact/example"

],

"incidentTemplate": { "impact": 5,

"title": "example-incident"

},

"name": "example-response"

}

GetTimelineEvent

Retrieves a timeline event based on its ID and incident record.

Request Syntax

GET /getTimelineEvent?eventId=eventId&incidentRecordArn=incidentRecordArn HTTP/1.1

URI Request Parameters

eventId (p. 43)

The ID of the event. You can get an event's ID when you create it, or by using ListTimelineEvents.

Required: Yes

The Amazon Resource Name (ARN) of the incident that includes the timeline event.

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

Content-type: application/json { "event": {

"eventData": "string", "eventId": "string", "eventTime": number, "eventType": "string", "eventUpdatedTime": number, "incidentRecordArn": "string"

}}

Response Elements

(48)

GetTimelineEvent

event (p. 43)

Details about the timeline event.

Type: TimelineEvent (p. 233) object

Errors

Examples

Example

This example illustrates one usage of GetTimelineEvent.

Sample Request

GET /getTimelineEvent?eventId=ecbd9919-bba6-d317-6cfc-7232df620b6d&incidentRecordArn=arn

%3Aaws%3Assm-incidents%3A%111122223333%3Aincident-record%2Fexample-response%2F78bd9919- b9ac-962d-91e0-149960600e3f HTTP/1.1

x86_64.amzn.2 prompt/off command/ssm-incidents.get-timeline-event X-Amz-Date: 20210811T165600Z

(49)

GetTimelineEvent

Sample Response

{ "event": {

"eventData": "{\"modifiedBy\":\"arn:aws:sts::111122223333:assumed-role/Admin/

exampleUser\",\"modifiedAttributes\":[{\"attributeName\":\"relatedItems\",\"newValue\":\"{\

\\"itemToAdd\\\":{\\\"identifier\\\":{\\\"type\\\":\\\"PARENT\\\",\\\"value\\\":{\\\"arn\

\\":\\\"arn:aws:ssm:us-east-1:111122223333:opsItem/oi-4008965bf3a7\\\"}},\\\"title\\\":\\

\"parentItem\\\"}}\"}],\"incidentTitle\":\"example-incident\"}", "eventId": "ecbd9919-bba6-d317-6cfc-7232df620b6d", "eventTime": "2021-08-10T22:33:58.724000+00:00", "eventType": "SSM Incident Record Update",

"eventUpdatedTime": "2021-08-10T22:33:58.724000+00:00",

"incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/example- response/78bd9919-b9ac-962d-91e0-149960600e3f"

} }

ListIncidentRecords

Lists all incident records in your account. Use this command to retrieve the Amazon Resource Name (ARN) of the incident record you want to update.

Request Syntax

POST /listIncidentRecords HTTP/1.1 Content-type: application/json { "filters": [

{

"condition": { "after": number, "before": number, "equals": {

"integerValues": [ number ], "stringValues": [ "string" ] }

},

"key": "string"

} ],

"maxResults": number, "nextToken": "string"

}

URI Request Parameters

Request Body

ﬁlters (p. 46)

Filters the list of incident records through which you are searching. You can ﬁlter on the following keys:

• creationTime

• impact

• status

• createdBy

Note the following when deciding how to use Filters:

• If you don't specify a Filter, the response includes all incident records.

• If you specify more than one ﬁlter in a single request, the response returns incident records that match all ﬁlters.

• If you specify a ﬁlter with more than one value, the response returns incident records that match any of the values provided.

Type: Array of Filter (p. 210) objects

(51)

ListIncidentRecords

Required: No maxResults (p. 46)

The maximum number of results per page.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No nextToken (p. 46)

Type: String

Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json { "incidentRecordSummaries": [ {

"arn": "string",

"creationTime": number, "impact": number,

"incidentRecordSource": { "createdBy": "string", "invokedBy": "string", "resourceArn": "string", "source": "string"

},

"resolvedTime": number, "status": "string", "title": "string"

} ],

"nextToken": "string"

}

Response Elements

incidentRecordSummaries (p. 47)

The details of each listed incident record.

Type: Array of IncidentRecordSummary (p. 216) objects

AWS Systems Manager Incident Manager API Reference

AWS Systems Manager Incident Manager

API Reference

AWS Systems Manager Incident Manager: API Reference

Table of Contents

Welcome

Actions

AWS Systems Manager Incident Manager

CreateReplicationSet

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

Examples

Example

See Also

CreateResponsePlan

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

Examples

Example

See Also

CreateTimelineEvent

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

Examples

Example

See Also

DeleteIncidentRecord

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

Examples

Example

See Also

DeleteReplicationSet

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

Examples

Example

See Also

DeleteResourcePolicy

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

Examples

Example

See Also

DeleteResponsePlan

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

Examples

Example

See Also

DeleteTimelineEvent

Request Syntax