GetIncidentRecord
Returns the details for the specified incident record.
Request Syntax
GET /getIncidentRecord?arn=arn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- arn
-
The Amazon Resource Name (ARN) of the incident record.
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern:
^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"incidentRecord": {
"arn": "string",
"automationExecutions": [
{ ... }
],
"chatChannel": { ... },
"creationTime": number,
"dedupeString": "string",
"impact": number,
"incidentRecordSource": {
"createdBy": "string",
"invokedBy": "string",
"resourceArn": "string",
"source": "string"
},
"lastModifiedBy": "string",
"lastModifiedTime": number,
"notificationTargets": [
{ ... }
],
"resolvedTime": number,
"status": "string",
"summary": "string",
"title": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- incidentRecord
-
Details the structure of the incident record.
Type: IncidentRecord object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient access to perform this operation.
HTTP Status Code: 403
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
Request references a resource which doesn't exist.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of 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
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.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=39c3b3042cd2aEXAMPLESample 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"
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
