# AWS Systems Manager Incident Manager
<a name="API_Operations_AWS_Systems_Manager_Incident_Manager"></a>

The following actions are supported by AWS Systems Manager Incident Manager:
+  [BatchGetIncidentFindings](API_BatchGetIncidentFindings.md) 
+  [CreateReplicationSet](API_CreateReplicationSet.md) 
+  [CreateResponsePlan](API_CreateResponsePlan.md) 
+  [CreateTimelineEvent](API_CreateTimelineEvent.md) 
+  [DeleteIncidentRecord](API_DeleteIncidentRecord.md) 
+  [DeleteReplicationSet](API_DeleteReplicationSet.md) 
+  [DeleteResourcePolicy](API_DeleteResourcePolicy.md) 
+  [DeleteResponsePlan](API_DeleteResponsePlan.md) 
+  [DeleteTimelineEvent](API_DeleteTimelineEvent.md) 
+  [GetIncidentRecord](API_GetIncidentRecord.md) 
+  [GetReplicationSet](API_GetReplicationSet.md) 
+  [GetResourcePolicies](API_GetResourcePolicies.md) 
+  [GetResponsePlan](API_GetResponsePlan.md) 
+  [GetTimelineEvent](API_GetTimelineEvent.md) 
+  [ListIncidentFindings](API_ListIncidentFindings.md) 
+  [ListIncidentRecords](API_ListIncidentRecords.md) 
+  [ListRelatedItems](API_ListRelatedItems.md) 
+  [ListReplicationSets](API_ListReplicationSets.md) 
+  [ListResponsePlans](API_ListResponsePlans.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListTimelineEvents](API_ListTimelineEvents.md) 
+  [PutResourcePolicy](API_PutResourcePolicy.md) 
+  [StartIncident](API_StartIncident.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateDeletionProtection](API_UpdateDeletionProtection.md) 
+  [UpdateIncidentRecord](API_UpdateIncidentRecord.md) 
+  [UpdateRelatedItems](API_UpdateRelatedItems.md) 
+  [UpdateReplicationSet](API_UpdateReplicationSet.md) 
+  [UpdateResponsePlan](API_UpdateResponsePlan.md) 
+  [UpdateTimelineEvent](API_UpdateTimelineEvent.md) 

# BatchGetIncidentFindings
<a name="API_BatchGetIncidentFindings"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Retrieves details about all specified findings for an incident, including descriptive details about each finding. A finding represents a recent application environment change made by an AWS CodeDeploy deployment or an AWS CloudFormation stack creation or update that can be investigated as a potential cause of the incident.

## Request Syntax
<a name="API_BatchGetIncidentFindings_RequestSyntax"></a>

```
POST /batchGetIncidentFindings HTTP/1.1
Content-type: application/json

{
   "findingIds": [ "string" ],
   "incidentRecordArn": "string"
}
```

## URI Request Parameters
<a name="API_BatchGetIncidentFindings_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_BatchGetIncidentFindings_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [findingIds](#API_BatchGetIncidentFindings_RequestSyntax) **   <a name="IncidentManager-BatchGetIncidentFindings-request-findingIds"></a>
A list of IDs of findings for which you want to view details.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 20 items.  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Required: Yes

 ** [incidentRecordArn](#API_BatchGetIncidentFindings_RequestSyntax) **   <a name="IncidentManager-BatchGetIncidentFindings-request-incidentRecordArn"></a>
The Amazon Resource Name (ARN) of the incident for which you want to view finding details.  
Type: String  
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

## Response Syntax
<a name="API_BatchGetIncidentFindings_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "errors": [ 
      { 
         "code": "string",
         "findingId": "string",
         "message": "string"
      }
   ],
   "findings": [ 
      { 
         "creationTime": number,
         "details": { ... },
         "id": "string",
         "lastModifiedTime": number
      }
   ]
}
```

## Response Elements
<a name="API_BatchGetIncidentFindings_ResponseElements"></a>

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

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

 ** [errors](#API_BatchGetIncidentFindings_ResponseSyntax) **   <a name="IncidentManager-BatchGetIncidentFindings-response-errors"></a>
A list of errors encountered during the operation.  
Type: Array of [BatchGetIncidentFindingsError](API_BatchGetIncidentFindingsError.md) objects

 ** [findings](#API_BatchGetIncidentFindings_ResponseSyntax) **   <a name="IncidentManager-BatchGetIncidentFindings-response-findings"></a>
Information about the requested findings.  
Type: Array of [Finding](API_Finding.md) objects

## Errors
<a name="API_BatchGetIncidentFindings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_BatchGetIncidentFindings_Examples"></a>

### Example
<a name="API_BatchGetIncidentFindings_Example_1"></a>

This example illustrates one usage of BatchGetIncidentFindings.

#### Sample Request
<a name="API_BatchGetIncidentFindings_Example_1_Request"></a>

```
POST /batchGetIncidentFindings HTTP/1.1
Host: ssm-incidents.us-east-2.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.batch-get-incident-findings
X-Amz-Date: 20231210T104650Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20231210/us-east-2/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 154

{
  "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/my-incident/c6c59324-8fee-34eb-2ea1-1a279EXAMPLE",
  "findingIds": [
    "08c5c945-b204-adaa-f0ef-2f212INVALID",
    "92c59324-ad98-c955-ebe1-35779EXAMPLE",
    "96c59324-ad98-2f5b-f74b-b6c3aEXAMPLE",
    "64c5c950-1d68-8b04-7852-c471dEXAMPLE"
  ]
}
```

#### Sample Response
<a name="API_BatchGetIncidentFindings_Example_1_Response"></a>

```
{
  "errors": [
    {
      "code": "ResourceNotFoundException",
      "findingId": "08c5c945-b204-adaa-f0ef-2f212INVALID",
      "message": "Finding with ID '08c5c945-b204-adaa-f0ef-2f212INVALID' is not accessible"
    }
  ],
  "findings": [
    {
      "creationTime": "2023-12-13T10:47:03.560000+11:00",
      "details": {
        "cloudFormationStackUpdate": {
          "endTime": "2023-12-13T10:46:05.616000+11:00",
          "stackArn": "arn:aws:cloudformation:us-east-2:111122223333:stack/my-test-stack/54ae4890-6632-11ee-8958-0ac64EXAMPLE",
          "startTime": "2023-12-13T10:45:53.850000+11:00"
        }
      },
      "id": "92c59324-ad98-c955-ebe1-35779EXAMPLE",
      "lastModifiedTime": "2023-12-13T10:47:03.560000+11:00"
    },
    {
      "creationTime": "2023-12-13T10:47:03.560000+11:00",
      "details": {
        "cloudFormationStackUpdate": {
          "endTime": "2023-12-13T10:46:33.015000+11:00",
          "stackArn": "arn:aws:cloudformation:us-east-2:111122223333:stack/my-test-stack/54ae4890-6632-11ee-8958-0ac64EXAMPLE",
          "startTime": "2023-12-13T10:46:21.480000+11:00"
        }
      },
      "id": "96c59324-ad98-2f5b-f74b-b6c3aEXAMPLE",
      "lastModifiedTime": "2023-12-13T10:47:03.560000+11:00"
    },
    {
      "creationTime": "2023-12-13T11:40:56.273000+11:00",
      "details": {
        "codeDeployDeployment": {
          "deploymentGroupArn": "arn:aws:codedeploy:us-east-2:111122223333:deploymentgroup:my-ServerlessDeploymentApplication-7lLr2EXAMPLE/myLambdaFunctionDeploymentGroup-ID2K1EXAMPLE",
          "deploymentId": "d-RI2EXAMPLE",
          "endTime": "2023-12-13T11:37:03.174000+11:00",
          "startTime": "2023-12-13T11:37:00.790000+11:00"
        }
      },
      "id": "64c5c950-1d68-8b04-7852-c471dEXAMPLE",
      "lastModifiedTime": "2023-12-13T11:40:56.273000+11:00"
    }
  ]
}
```

## See Also
<a name="API_BatchGetIncidentFindings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/BatchGetIncidentFindings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/BatchGetIncidentFindings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/BatchGetIncidentFindings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/BatchGetIncidentFindings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/BatchGetIncidentFindings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/BatchGetIncidentFindings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/BatchGetIncidentFindings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/BatchGetIncidentFindings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/BatchGetIncidentFindings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/BatchGetIncidentFindings) 

# CreateReplicationSet
<a name="API_CreateReplicationSet"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

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

## Request Syntax
<a name="API_CreateReplicationSet_RequestSyntax"></a>

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

{
   "clientToken": "string",
   "regions": { 
      "string" : { 
         "sseKmsKeyId": "string"
      }
   },
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateReplicationSet_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateReplicationSet_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateReplicationSet_RequestSyntax) **   <a name="IncidentManager-CreateReplicationSet-request-clientToken"></a>
A token that ensures that the operation is called only once with the specified details.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Required: No

 ** [regions](#API_CreateReplicationSet_RequestSyntax) **   <a name="IncidentManager-CreateReplicationSet-request-regions"></a>
The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.  
Type: String to [RegionMapInputValue](API_RegionMapInputValue.md) object map  
Map Entries: Maximum number of 3 items.  
Key Length Constraints: Minimum length of 0. Maximum length of 20.  
Required: Yes

 ** [tags](#API_CreateReplicationSet_RequestSyntax) **   <a name="IncidentManager-CreateReplicationSet-request-tags"></a>
A list of tags to add to the replication set.  
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
<a name="API_CreateReplicationSet_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "arn": "string"
}
```

## Response Elements
<a name="API_CreateReplicationSet_ResponseElements"></a>

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](#API_CreateReplicationSet_ResponseSyntax) **   <a name="IncidentManager-CreateReplicationSet-response-arn"></a>
The Amazon Resource Name (ARN) of the replication set.   
Type: String  
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})?:.+` 

## Errors
<a name="API_CreateReplicationSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
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 specified by an AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_CreateReplicationSet_Examples"></a>

### Example
<a name="API_CreateReplicationSet_Example_1"></a>

This example illustrates one usage of CreateReplicationSet.

#### Sample Request
<a name="API_CreateReplicationSet_Example_1_Request"></a>

```
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
<a name="API_CreateReplicationSet_Example_1_Response"></a>

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

## See Also
<a name="API_CreateReplicationSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/CreateReplicationSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/CreateReplicationSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/CreateReplicationSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/CreateReplicationSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/CreateReplicationSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/CreateReplicationSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/CreateReplicationSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/CreateReplicationSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/CreateReplicationSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/CreateReplicationSet) 

# CreateResponsePlan
<a name="API_CreateResponsePlan"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

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
<a name="API_CreateResponsePlan_RequestSyntax"></a>

```
POST /createResponsePlan HTTP/1.1
Content-type: application/json

{
   "actions": [ 
      { ... }
   ],
   "chatChannel": { ... },
   "clientToken": "string",
   "displayName": "string",
   "engagements": [ "string" ],
   "incidentTemplate": { 
      "dedupeString": "string",
      "impact": number,
      "incidentTags": { 
         "string" : "string" 
      },
      "notificationTargets": [ 
         { ... }
      ],
      "summary": "string",
      "title": "string"
   },
   "integrations": [ 
      { ... }
   ],
   "name": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateResponsePlan_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateResponsePlan_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [actions](#API_CreateResponsePlan_RequestSyntax) **   <a name="IncidentManager-CreateResponsePlan-request-actions"></a>
The actions that the response plan starts at the beginning of an incident.  
Type: Array of [Action](API_Action.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Required: No

 ** [chatChannel](#API_CreateResponsePlan_RequestSyntax) **   <a name="IncidentManager-CreateResponsePlan-request-chatChannel"></a>
The Amazon Q Developer in chat applications chat channel used for collaboration during an incident.  
Type: [ChatChannel](API_ChatChannel.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [clientToken](#API_CreateResponsePlan_RequestSyntax) **   <a name="IncidentManager-CreateResponsePlan-request-clientToken"></a>
A token ensuring that the operation is called only once with the specified details.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Required: No

 ** [displayName](#API_CreateResponsePlan_RequestSyntax) **   <a name="IncidentManager-CreateResponsePlan-request-displayName"></a>
The long format of the response plan name. This field can contain spaces.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Required: No

 ** [engagements](#API_CreateResponsePlan_RequestSyntax) **   <a name="IncidentManager-CreateResponsePlan-request-engagements"></a>
The Amazon Resource Name (ARN) for 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.  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `arn:aws(-cn|-us-gov)?:ssm-contacts:[a-z0-9-]*:([0-9]{12}):contact/[a-z0-9_-]+`   
Required: No

 ** [incidentTemplate](#API_CreateResponsePlan_RequestSyntax) **   <a name="IncidentManager-CreateResponsePlan-request-incidentTemplate"></a>
Details used to create an incident when using this response plan.  
Type: [IncidentTemplate](API_IncidentTemplate.md) object  
Required: Yes

 ** [integrations](#API_CreateResponsePlan_RequestSyntax) **   <a name="IncidentManager-CreateResponsePlan-request-integrations"></a>
Information about third-party services integrated into the response plan.  
Type: Array of [Integration](API_Integration.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Required: No

 ** [name](#API_CreateResponsePlan_RequestSyntax) **   <a name="IncidentManager-CreateResponsePlan-request-name"></a>
The short format name of the response plan. Can't include spaces.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `[a-zA-Z0-9-_]*`   
Required: Yes

 ** [tags](#API_CreateResponsePlan_RequestSyntax) **   <a name="IncidentManager-CreateResponsePlan-request-tags"></a>
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
<a name="API_CreateResponsePlan_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "arn": "string"
}
```

## Response Elements
<a name="API_CreateResponsePlan_ResponseElements"></a>

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](#API_CreateResponsePlan_ResponseSyntax) **   <a name="IncidentManager-CreateResponsePlan-response-arn"></a>
The Amazon Resource Name (ARN) of the response plan.  
Type: String  
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})?:.+` 

## Errors
<a name="API_CreateResponsePlan_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
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

 ** 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
<a name="API_CreateResponsePlan_Examples"></a>

### Example
<a name="API_CreateResponsePlan_Example_1"></a>

This example illustrates one usage of CreateResponsePlan.

#### Sample Request
<a name="API_CreateResponsePlan_Example_1_Request"></a>

```
POST /createResponsePlan 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-response-plan
X-Amz-Date: 20210810T213532Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210810/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 652

{
	"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", 
	"clientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE"
}
```

#### Sample Response
<a name="API_CreateResponsePlan_Example_1_Response"></a>

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

## See Also
<a name="API_CreateResponsePlan_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/CreateResponsePlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/CreateResponsePlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/CreateResponsePlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/CreateResponsePlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/CreateResponsePlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/CreateResponsePlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/CreateResponsePlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/CreateResponsePlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/CreateResponsePlan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/CreateResponsePlan) 

# CreateTimelineEvent
<a name="API_CreateTimelineEvent"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Creates a custom timeline event on the incident details page of an incident record. Incident Manager automatically creates timeline events that mark key moments during an incident. You can create custom timeline events to mark important events that Incident Manager can detect automatically.

## Request Syntax
<a name="API_CreateTimelineEvent_RequestSyntax"></a>

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

{
   "clientToken": "string",
   "eventData": "string",
   "eventReferences": [ 
      { ... }
   ],
   "eventTime": number,
   "eventType": "string",
   "incidentRecordArn": "string"
}
```

## URI Request Parameters
<a name="API_CreateTimelineEvent_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateTimelineEvent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateTimelineEvent_RequestSyntax) **   <a name="IncidentManager-CreateTimelineEvent-request-clientToken"></a>
A token that ensures that a client calls the action only once with the specified details.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Required: No

 ** [eventData](#API_CreateTimelineEvent_RequestSyntax) **   <a name="IncidentManager-CreateTimelineEvent-request-eventData"></a>
A short description of the event.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 12000.  
Required: Yes

 ** [eventReferences](#API_CreateTimelineEvent_RequestSyntax) **   <a name="IncidentManager-CreateTimelineEvent-request-eventReferences"></a>
Adds one or more references to the `TimelineEvent`. A reference is an AWS resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with a resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.  
Type: Array of [EventReference](API_EventReference.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [eventTime](#API_CreateTimelineEvent_RequestSyntax) **   <a name="IncidentManager-CreateTimelineEvent-request-eventTime"></a>
The timestamp for when the event occurred.  
Type: Timestamp  
Required: Yes

 ** [eventType](#API_CreateTimelineEvent_RequestSyntax) **   <a name="IncidentManager-CreateTimelineEvent-request-eventType"></a>
The type of event. You can create timeline events of type `Custom Event` and `Note`.  
To make a Note-type event appear on the *Incident notes* panel in the console, specify `eventType` as `Note`and enter the Amazon Resource Name (ARN) of the incident as the value for `eventReference`.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Required: Yes

 ** [incidentRecordArn](#API_CreateTimelineEvent_RequestSyntax) **   <a name="IncidentManager-CreateTimelineEvent-request-incidentRecordArn"></a>
The Amazon Resource Name (ARN) of the incident record that the action adds the incident to.  
Type: String  
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

## Response Syntax
<a name="API_CreateTimelineEvent_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "eventId": "string",
   "incidentRecordArn": "string"
}
```

## Response Elements
<a name="API_CreateTimelineEvent_ResponseElements"></a>

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

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

 ** [eventId](#API_CreateTimelineEvent_ResponseSyntax) **   <a name="IncidentManager-CreateTimelineEvent-response-eventId"></a>
The ID of the event for easy reference later.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 50.

 ** [incidentRecordArn](#API_CreateTimelineEvent_ResponseSyntax) **   <a name="IncidentManager-CreateTimelineEvent-response-incidentRecordArn"></a>
The ARN of the incident record that you added the event to.  
Type: String  
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})?:.+` 

## Errors
<a name="API_CreateTimelineEvent_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
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

 ** 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
<a name="API_CreateTimelineEvent_Examples"></a>

### Example
<a name="API_CreateTimelineEvent_Example_1"></a>

This example illustrates one usage of CreateTimelineEvent.

#### Sample Request
<a name="API_CreateTimelineEvent_Example_1_Request"></a>

```
POST /createTimelineEvent 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-timeline-event
X-Amz-Date: 20210810T221725Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210810/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 282

{
	"eventData": "\"example timeline event"\", 
	"eventTime": 1601584200, 
	"eventType": "Note", 
	"incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/bebd9911-63a7-672f-820b-63731EXAMPLE", 
	"eventReferences": "arn:aws:ssm-incidents::111122223333:incident-record/example-incident/6cc46130-ca6c-3b38-68f1-f6abeEXAMPLE",
	"clientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE"
}
```

#### Sample Response
<a name="API_CreateTimelineEvent_Example_1_Response"></a>

```
{
 	"eventId":"56bd9912-28e5-b4fc-ec3e-ca4f06309c99",
 	"incidentRecordArn":"arn:aws:ssm-incidents::111122223333:incident-record/example-response/bebd9911-63a7-672f-820b-63731f2543ad"
 }
```

## See Also
<a name="API_CreateTimelineEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/CreateTimelineEvent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/CreateTimelineEvent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/CreateTimelineEvent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/CreateTimelineEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/CreateTimelineEvent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/CreateTimelineEvent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/CreateTimelineEvent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/CreateTimelineEvent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/CreateTimelineEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/CreateTimelineEvent) 

# DeleteIncidentRecord
<a name="API_DeleteIncidentRecord"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Delete an incident record from Incident Manager. 

## Request Syntax
<a name="API_DeleteIncidentRecord_RequestSyntax"></a>

```
POST /deleteIncidentRecord HTTP/1.1
Content-type: application/json

{
   "arn": "string"
}
```

## URI Request Parameters
<a name="API_DeleteIncidentRecord_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_DeleteIncidentRecord_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [arn](#API_DeleteIncidentRecord_RequestSyntax) **   <a name="IncidentManager-DeleteIncidentRecord-request-arn"></a>
The Amazon Resource Name (ARN) of the incident record you are deleting.  
Type: String  
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

## Response Syntax
<a name="API_DeleteIncidentRecord_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteIncidentRecord_ResponseElements"></a>

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

## Errors
<a name="API_DeleteIncidentRecord_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** 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
<a name="API_DeleteIncidentRecord_Examples"></a>

### Example
<a name="API_DeleteIncidentRecord_Example_1"></a>

This example illustrates one usage of DeleteIncidentRecord.

#### Sample Request
<a name="API_DeleteIncidentRecord_Example_1_Request"></a>

```
POST /deleteIncidentRecord 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.delete-incident-record
X-Amz-Date: 20210810T222351Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210810/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 116

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

#### Sample Response
<a name="API_DeleteIncidentRecord_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DeleteIncidentRecord_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/DeleteIncidentRecord) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/DeleteIncidentRecord) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/DeleteIncidentRecord) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/DeleteIncidentRecord) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/DeleteIncidentRecord) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/DeleteIncidentRecord) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/DeleteIncidentRecord) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/DeleteIncidentRecord) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/DeleteIncidentRecord) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/DeleteIncidentRecord) 

# DeleteReplicationSet
<a name="API_DeleteReplicationSet"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

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

## Request Syntax
<a name="API_DeleteReplicationSet_RequestSyntax"></a>

```
POST /deleteReplicationSet?arn=arn HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteReplicationSet_RequestParameters"></a>

The request uses the following URI parameters.

 ** [arn](#API_DeleteReplicationSet_RequestSyntax) **   <a name="IncidentManager-DeleteReplicationSet-request-uri-arn"></a>
The Amazon Resource Name (ARN) of the replication set you're deleting.  
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
<a name="API_DeleteReplicationSet_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteReplicationSet_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteReplicationSet_ResponseElements"></a>

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

## Errors
<a name="API_DeleteReplicationSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_DeleteReplicationSet_Examples"></a>

### Example
<a name="API_DeleteReplicationSet_Example_1"></a>

This example illustrates one usage of DeleteReplicationSet.

#### Sample Request
<a name="API_DeleteReplicationSet_Example_1_Request"></a>

```
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
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.delete-replication-set
X-Amz-Date: 20210811T215946Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 0
```

#### Sample Response
<a name="API_DeleteReplicationSet_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DeleteReplicationSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/DeleteReplicationSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/DeleteReplicationSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/DeleteReplicationSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/DeleteReplicationSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/DeleteReplicationSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/DeleteReplicationSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/DeleteReplicationSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/DeleteReplicationSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/DeleteReplicationSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/DeleteReplicationSet) 

# DeleteResourcePolicy
<a name="API_DeleteResourcePolicy"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

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

## Request Syntax
<a name="API_DeleteResourcePolicy_RequestSyntax"></a>

```
POST /deleteResourcePolicy HTTP/1.1
Content-type: application/json

{
   "policyId": "string",
   "resourceArn": "string"
}
```

## URI Request Parameters
<a name="API_DeleteResourcePolicy_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_DeleteResourcePolicy_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [policyId](#API_DeleteResourcePolicy_RequestSyntax) **   <a name="IncidentManager-DeleteResourcePolicy-request-policyId"></a>
The ID of the resource policy you're deleting.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

 ** [resourceArn](#API_DeleteResourcePolicy_RequestSyntax) **   <a name="IncidentManager-DeleteResourcePolicy-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource you're deleting the policy from.  
Type: String  
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

## Response Syntax
<a name="API_DeleteResourcePolicy_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteResourcePolicy_ResponseElements"></a>

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

## Errors
<a name="API_DeleteResourcePolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_DeleteResourcePolicy_Examples"></a>

### Example
<a name="API_DeleteResourcePolicy_Example_1"></a>

This example illustrates one usage of DeleteResourcePolicy.

#### Sample Request
<a name="API_DeleteResourcePolicy_Example_1_Request"></a>

```
POST /deleteResourcePolicy 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.delete-resource-policy
X-Amz-Date: 20210811T204449Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 133

{
	"policyId": "72f95d0502d05ebf6e7d2c30ee0445cf", 
	"resourceArn": "arn:aws:ssm-incidents::111122223333:response-plan/example-response"
}
```

#### Sample Response
<a name="API_DeleteResourcePolicy_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DeleteResourcePolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/DeleteResourcePolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/DeleteResourcePolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/DeleteResourcePolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/DeleteResourcePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/DeleteResourcePolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/DeleteResourcePolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/DeleteResourcePolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/DeleteResourcePolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/DeleteResourcePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/DeleteResourcePolicy) 

# DeleteResponsePlan
<a name="API_DeleteResponsePlan"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

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

## Request Syntax
<a name="API_DeleteResponsePlan_RequestSyntax"></a>

```
POST /deleteResponsePlan HTTP/1.1
Content-type: application/json

{
   "arn": "string"
}
```

## URI Request Parameters
<a name="API_DeleteResponsePlan_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_DeleteResponsePlan_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [arn](#API_DeleteResponsePlan_RequestSyntax) **   <a name="IncidentManager-DeleteResponsePlan-request-arn"></a>
The Amazon Resource Name (ARN) of the response plan.  
Type: String  
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

## Response Syntax
<a name="API_DeleteResponsePlan_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteResponsePlan_ResponseElements"></a>

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

## Errors
<a name="API_DeleteResponsePlan_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** 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
<a name="API_DeleteResponsePlan_Examples"></a>

### Example
<a name="API_DeleteResponsePlan_Example_1"></a>

This example illustrates one usage of DeleteResponsePlan.

#### Sample Request
<a name="API_DeleteResponsePlan_Example_1_Request"></a>

```
POST /deleteResponsePlan 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.delete-response-plan
X-Amz-Date: 20210811T204938Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 77

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

#### Sample Response
<a name="API_DeleteResponsePlan_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DeleteResponsePlan_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/DeleteResponsePlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/DeleteResponsePlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/DeleteResponsePlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/DeleteResponsePlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/DeleteResponsePlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/DeleteResponsePlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/DeleteResponsePlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/DeleteResponsePlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/DeleteResponsePlan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/DeleteResponsePlan) 

# DeleteTimelineEvent
<a name="API_DeleteTimelineEvent"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Deletes a timeline event from an incident.

## Request Syntax
<a name="API_DeleteTimelineEvent_RequestSyntax"></a>

```
POST /deleteTimelineEvent HTTP/1.1
Content-type: application/json

{
   "eventId": "string",
   "incidentRecordArn": "string"
}
```

## URI Request Parameters
<a name="API_DeleteTimelineEvent_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_DeleteTimelineEvent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [eventId](#API_DeleteTimelineEvent_RequestSyntax) **   <a name="IncidentManager-DeleteTimelineEvent-request-eventId"></a>
The ID of the event to update. You can use `ListTimelineEvents` to find an event's ID.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 50.  
Required: Yes

 ** [incidentRecordArn](#API_DeleteTimelineEvent_RequestSyntax) **   <a name="IncidentManager-DeleteTimelineEvent-request-incidentRecordArn"></a>
The Amazon Resource Name (ARN) of the incident that includes the timeline event.  
Type: String  
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

## Response Syntax
<a name="API_DeleteTimelineEvent_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteTimelineEvent_ResponseElements"></a>

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

## Errors
<a name="API_DeleteTimelineEvent_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** 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
<a name="API_DeleteTimelineEvent_Examples"></a>

### Example
<a name="API_DeleteTimelineEvent_Example_1"></a>

This example illustrates one usage of DeleteTimelineEvent.

#### Sample Request
<a name="API_DeleteTimelineEvent_Example_1_Request"></a>

```
POST /updateTimelineEvent 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.update-timeline-event
X-Amz-Date: 20210811T203312Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 261

{
	"eventId": "a4bd9b45-1fcf-64c3-9d53-121d0f53a7ec", 
	"eventTime": 1621620657, 
	"incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/64bd9b45-1d0e-2622-840d-03a87a1451fa", 
	"clientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE"
}
```

#### Sample Response
<a name="API_DeleteTimelineEvent_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DeleteTimelineEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/DeleteTimelineEvent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/DeleteTimelineEvent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/DeleteTimelineEvent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/DeleteTimelineEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/DeleteTimelineEvent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/DeleteTimelineEvent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/DeleteTimelineEvent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/DeleteTimelineEvent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/DeleteTimelineEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/DeleteTimelineEvent) 

# GetIncidentRecord
<a name="API_GetIncidentRecord"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Returns the details for the specified incident record.

## Request Syntax
<a name="API_GetIncidentRecord_RequestSyntax"></a>

```
GET /getIncidentRecord?arn=arn HTTP/1.1
```

## URI Request Parameters
<a name="API_GetIncidentRecord_RequestParameters"></a>

The request uses the following URI parameters.

 ** [arn](#API_GetIncidentRecord_RequestSyntax) **   <a name="IncidentManager-GetIncidentRecord-request-uri-arn"></a>
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
<a name="API_GetIncidentRecord_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetIncidentRecord_ResponseSyntax"></a>

```
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
<a name="API_GetIncidentRecord_ResponseElements"></a>

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](#API_GetIncidentRecord_ResponseSyntax) **   <a name="IncidentManager-GetIncidentRecord-response-incidentRecord"></a>
Details the structure of the incident record.  
Type: [IncidentRecord](API_IncidentRecord.md) object

## Errors
<a name="API_GetIncidentRecord_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_GetIncidentRecord_Examples"></a>

### Example
<a name="API_GetIncidentRecord_Example_1"></a>

This example illustrates one usage of GetIncidentRecord.

#### Sample Request
<a name="API_GetIncidentRecord_Example_1_Request"></a>

```
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=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_GetIncidentRecord_Example_1_Response"></a>

```
{
	"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
<a name="API_GetIncidentRecord_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/GetIncidentRecord) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/GetIncidentRecord) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/GetIncidentRecord) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/GetIncidentRecord) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/GetIncidentRecord) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/GetIncidentRecord) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/GetIncidentRecord) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/GetIncidentRecord) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/GetIncidentRecord) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/GetIncidentRecord) 

# GetReplicationSet
<a name="API_GetReplicationSet"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Retrieve your Incident Manager replication set.

## Request Syntax
<a name="API_GetReplicationSet_RequestSyntax"></a>

```
GET /getReplicationSet?arn=arn HTTP/1.1
```

## URI Request Parameters
<a name="API_GetReplicationSet_RequestParameters"></a>

The request uses the following URI parameters.

 ** [arn](#API_GetReplicationSet_RequestSyntax) **   <a name="IncidentManager-GetReplicationSet-request-uri-arn"></a>
The Amazon Resource Name (ARN) of the replication set you want to retrieve.  
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
<a name="API_GetReplicationSet_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetReplicationSet_ResponseSyntax"></a>

```
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
<a name="API_GetReplicationSet_ResponseElements"></a>

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

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

 ** [replicationSet](#API_GetReplicationSet_ResponseSyntax) **   <a name="IncidentManager-GetReplicationSet-response-replicationSet"></a>
Details of the replication set.  
Type: [ReplicationSet](API_ReplicationSet.md) object

## Errors
<a name="API_GetReplicationSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_GetReplicationSet_Examples"></a>

### Example
<a name="API_GetReplicationSet_Example_1"></a>

This example illustrates one usage of GetReplicationSet.

#### Sample Request
<a name="API_GetReplicationSet_Example_1_Request"></a>

```
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
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-replication-set
X-Amz-Date: 20210810T224619Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210810/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_GetReplicationSet_Example_1_Response"></a>

```
{
    "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"
    }
}
```

## See Also
<a name="API_GetReplicationSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/GetReplicationSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/GetReplicationSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/GetReplicationSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/GetReplicationSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/GetReplicationSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/GetReplicationSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/GetReplicationSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/GetReplicationSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/GetReplicationSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/GetReplicationSet) 

# GetResourcePolicies
<a name="API_GetResourcePolicies"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Retrieves the resource policies attached to the specified response plan.

## Request Syntax
<a name="API_GetResourcePolicies_RequestSyntax"></a>

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

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

## URI Request Parameters
<a name="API_GetResourcePolicies_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_GetResourcePolicies_RequestSyntax) **   <a name="IncidentManager-GetResourcePolicies-request-uri-resourceArn"></a>
The Amazon Resource Name (ARN) of the response plan with the attached resource policy.   
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
<a name="API_GetResourcePolicies_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxResults](#API_GetResourcePolicies_RequestSyntax) **   <a name="IncidentManager-GetResourcePolicies-request-maxResults"></a>
The maximum number of resource policies to display for each page of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_GetResourcePolicies_RequestSyntax) **   <a name="IncidentManager-GetResourcePolicies-request-nextToken"></a>
The pagination token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2000.  
Required: No

## Response Syntax
<a name="API_GetResourcePolicies_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "resourcePolicies": [ 
      { 
         "policyDocument": "string",
         "policyId": "string",
         "ramResourceShareRegion": "string"
      }
   ]
}
```

## Response Elements
<a name="API_GetResourcePolicies_ResponseElements"></a>

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

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

 ** [nextToken](#API_GetResourcePolicies_ResponseSyntax) **   <a name="IncidentManager-GetResourcePolicies-response-nextToken"></a>
The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2000.

 ** [resourcePolicies](#API_GetResourcePolicies_ResponseSyntax) **   <a name="IncidentManager-GetResourcePolicies-response-resourcePolicies"></a>
Details about the resource policy attached to the response plan.  
Type: Array of [ResourcePolicy](API_ResourcePolicy.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

## Errors
<a name="API_GetResourcePolicies_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_GetResourcePolicies_Examples"></a>

### Example
<a name="API_GetResourcePolicies_Example_1"></a>

This example illustrates one usage of GetResourcePolicies.

#### Sample Request
<a name="API_GetResourcePolicies_Example_1_Request"></a>

```
POST /getResourcePolicies?resourceArn=arn%3Aaws%3Assm-incidents%3A%111122223333%3Aresponse-plan%2Fexample-response 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-resource-policies
X-Amz-Date: 20210810T230018Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210810/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 0
```

#### Sample Response
<a name="API_GetResourcePolicies_Example_1_Response"></a>

```
{
	"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"
        }
    ]
}
```

## See Also
<a name="API_GetResourcePolicies_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/GetResourcePolicies) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/GetResourcePolicies) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/GetResourcePolicies) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/GetResourcePolicies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/GetResourcePolicies) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/GetResourcePolicies) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/GetResourcePolicies) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/GetResourcePolicies) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/GetResourcePolicies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/GetResourcePolicies) 

# GetResponsePlan
<a name="API_GetResponsePlan"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Retrieves the details of the specified response plan.

## Request Syntax
<a name="API_GetResponsePlan_RequestSyntax"></a>

```
GET /getResponsePlan?arn=arn HTTP/1.1
```

## URI Request Parameters
<a name="API_GetResponsePlan_RequestParameters"></a>

The request uses the following URI parameters.

 ** [arn](#API_GetResponsePlan_RequestSyntax) **   <a name="IncidentManager-GetResponsePlan-request-uri-arn"></a>
The Amazon Resource Name (ARN) of the response plan.  
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
<a name="API_GetResponsePlan_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetResponsePlan_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "actions": [ 
      { ... }
   ],
   "arn": "string",
   "chatChannel": { ... },
   "displayName": "string",
   "engagements": [ "string" ],
   "incidentTemplate": { 
      "dedupeString": "string",
      "impact": number,
      "incidentTags": { 
         "string" : "string" 
      },
      "notificationTargets": [ 
         { ... }
      ],
      "summary": "string",
      "title": "string"
   },
   "integrations": [ 
      { ... }
   ],
   "name": "string"
}
```

## Response Elements
<a name="API_GetResponsePlan_ResponseElements"></a>

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

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

 ** [actions](#API_GetResponsePlan_ResponseSyntax) **   <a name="IncidentManager-GetResponsePlan-response-actions"></a>
The actions that this response plan takes at the beginning of the incident.  
Type: Array of [Action](API_Action.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 1 item.

 ** [arn](#API_GetResponsePlan_ResponseSyntax) **   <a name="IncidentManager-GetResponsePlan-response-arn"></a>
The ARN of the response plan.  
Type: String  
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})?:.+` 

 ** [chatChannel](#API_GetResponsePlan_ResponseSyntax) **   <a name="IncidentManager-GetResponsePlan-response-chatChannel"></a>
The Amazon Q Developer in chat applications chat channel used for collaboration during an incident.  
Type: [ChatChannel](API_ChatChannel.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [displayName](#API_GetResponsePlan_ResponseSyntax) **   <a name="IncidentManager-GetResponsePlan-response-displayName"></a>
The long format name of the response plan. Can contain spaces.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.

 ** [engagements](#API_GetResponsePlan_ResponseSyntax) **   <a name="IncidentManager-GetResponsePlan-response-engagements"></a>
The Amazon Resource Name (ARN) for 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.  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `arn:aws(-cn|-us-gov)?:ssm-contacts:[a-z0-9-]*:([0-9]{12}):contact/[a-z0-9_-]+` 

 ** [incidentTemplate](#API_GetResponsePlan_ResponseSyntax) **   <a name="IncidentManager-GetResponsePlan-response-incidentTemplate"></a>
Details used to create the incident when using this response plan.  
Type: [IncidentTemplate](API_IncidentTemplate.md) object

 ** [integrations](#API_GetResponsePlan_ResponseSyntax) **   <a name="IncidentManager-GetResponsePlan-response-integrations"></a>
Information about third-party services integrated into the Incident Manager response plan.  
Type: Array of [Integration](API_Integration.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 1 item.

 ** [name](#API_GetResponsePlan_ResponseSyntax) **   <a name="IncidentManager-GetResponsePlan-response-name"></a>
The short format name of the response plan. The name can't contain spaces.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `[a-zA-Z0-9-_]*` 

## Errors
<a name="API_GetResponsePlan_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_GetResponsePlan_Examples"></a>

### Example
<a name="API_GetResponsePlan_Example_1"></a>

This example illustrates one usage of GetResponsePlan.

#### Sample Request
<a name="API_GetResponsePlan_Example_1_Request"></a>

```
GET /getResponsePlan?arn=arn%3Aaws%3Assm-incidents%3A%111122223333%3Aresponse-plan%2Fexample-response 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-response-plan
X-Amz-Date: 20210810T230500Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210810/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_GetResponsePlan_Example_1_Response"></a>

```
{
    "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"
}
```

## See Also
<a name="API_GetResponsePlan_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/GetResponsePlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/GetResponsePlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/GetResponsePlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/GetResponsePlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/GetResponsePlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/GetResponsePlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/GetResponsePlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/GetResponsePlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/GetResponsePlan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/GetResponsePlan) 

# GetTimelineEvent
<a name="API_GetTimelineEvent"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

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

## Request Syntax
<a name="API_GetTimelineEvent_RequestSyntax"></a>

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

## URI Request Parameters
<a name="API_GetTimelineEvent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [eventId](#API_GetTimelineEvent_RequestSyntax) **   <a name="IncidentManager-GetTimelineEvent-request-uri-eventId"></a>
The ID of the event. You can get an event's ID when you create it, or by using `ListTimelineEvents`.  
Length Constraints: Minimum length of 0. Maximum length of 50.  
Required: Yes

 ** [incidentRecordArn](#API_GetTimelineEvent_RequestSyntax) **   <a name="IncidentManager-GetTimelineEvent-request-uri-incidentRecordArn"></a>
The Amazon Resource Name (ARN) of the incident that includes the timeline event.  
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
<a name="API_GetTimelineEvent_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetTimelineEvent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "event": { 
      "eventData": "string",
      "eventId": "string",
      "eventReferences": [ 
         { ... }
      ],
      "eventTime": number,
      "eventType": "string",
      "eventUpdatedTime": number,
      "incidentRecordArn": "string"
   }
}
```

## Response Elements
<a name="API_GetTimelineEvent_ResponseElements"></a>

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

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

 ** [event](#API_GetTimelineEvent_ResponseSyntax) **   <a name="IncidentManager-GetTimelineEvent-response-event"></a>
Details about the timeline event.  
Type: [TimelineEvent](API_TimelineEvent.md) object

## Errors
<a name="API_GetTimelineEvent_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_GetTimelineEvent_Examples"></a>

### Example
<a name="API_GetTimelineEvent_Example_1"></a>

This example illustrates one usage of GetTimelineEvent.

#### Sample Request
<a name="API_GetTimelineEvent_Example_1_Request"></a>

```
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
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-timeline-event
X-Amz-Date: 20210811T165600Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_GetTimelineEvent_Example_1_Response"></a>

```
{
    "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",
       "eventReferences": [
            {"relatedItemId": "related-item/OTHER/0515FAE92F4A572650D73DC0224D00EF"},
            {"resource": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/78bd9919-b9ac-962d-91e0-149960600e3f"}
         ],
        "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"
    }
}
```

## See Also
<a name="API_GetTimelineEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/GetTimelineEvent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/GetTimelineEvent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/GetTimelineEvent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/GetTimelineEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/GetTimelineEvent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/GetTimelineEvent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/GetTimelineEvent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/GetTimelineEvent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/GetTimelineEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/GetTimelineEvent) 

# ListIncidentFindings
<a name="API_ListIncidentFindings"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Retrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident. A finding represents a recent application environment change made by an AWS CloudFormation stack creation or update or an AWS CodeDeploy deployment that can be investigated as a potential cause of the incident.

## Request Syntax
<a name="API_ListIncidentFindings_RequestSyntax"></a>

```
POST /listIncidentFindings HTTP/1.1
Content-type: application/json

{
   "incidentRecordArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_ListIncidentFindings_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ListIncidentFindings_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [incidentRecordArn](#API_ListIncidentFindings_RequestSyntax) **   <a name="IncidentManager-ListIncidentFindings-request-incidentRecordArn"></a>
The Amazon Resource Name (ARN) of the incident for which you want to view associated findings.  
Type: String  
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

 ** [maxResults](#API_ListIncidentFindings_RequestSyntax) **   <a name="IncidentManager-ListIncidentFindings-request-maxResults"></a>
The maximum number of findings to retrieve per call.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 20.  
Required: No

 ** [nextToken](#API_ListIncidentFindings_RequestSyntax) **   <a name="IncidentManager-ListIncidentFindings-request-nextToken"></a>
The pagination token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2000.  
Required: No

## Response Syntax
<a name="API_ListIncidentFindings_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "findings": [ 
      { 
         "id": "string",
         "lastModifiedTime": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListIncidentFindings_ResponseElements"></a>

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

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

 ** [findings](#API_ListIncidentFindings_ResponseSyntax) **   <a name="IncidentManager-ListIncidentFindings-response-findings"></a>
A list of findings that represent deployments that might be the potential cause of the incident.  
Type: Array of [FindingSummary](API_FindingSummary.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

 ** [nextToken](#API_ListIncidentFindings_ResponseSyntax) **   <a name="IncidentManager-ListIncidentFindings-response-nextToken"></a>
The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2000.

## Errors
<a name="API_ListIncidentFindings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_ListIncidentFindings_Examples"></a>

### Example
<a name="API_ListIncidentFindings_Example_1"></a>

This example illustrates one usage of ListIncidentFindings.

#### Sample Request
<a name="API_ListIncidentFindings_Example_1_Request"></a>

```
POST /listIncidentFindings HTTP/1.1
Host: ssm-incidents.us-east-2.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.list-incident-findings
X-Amz-Date: 20231210T104650Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20231210/us-east-2/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 113

{
  "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/my-incident/c6c59324-8fee-34eb-2ea1-1a279EXAMPLE"
}
```

#### Sample Response
<a name="API_ListIncidentFindings_Example_1_Response"></a>

```
{
  "findings": [
    {
      "id": "92c59324-ad98-c955-ebe1-35779EXAMPLE",
      "lastModifiedTime": "2023-12-13T10:47:03.560000+11:00"
    },
    {
      "id": "96c59324-ad98-2f5b-f74b-b6c3aEXAMPLE",
      "lastModifiedTime": "2023-12-13T10:47:03.560000+11:00"
    }
  ]
}
```

## See Also
<a name="API_ListIncidentFindings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/ListIncidentFindings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/ListIncidentFindings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/ListIncidentFindings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/ListIncidentFindings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/ListIncidentFindings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/ListIncidentFindings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/ListIncidentFindings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/ListIncidentFindings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/ListIncidentFindings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/ListIncidentFindings) 

# ListIncidentRecords
<a name="API_ListIncidentRecords"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

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
<a name="API_ListIncidentRecords_RequestSyntax"></a>

```
POST /listIncidentRecords HTTP/1.1
Content-type: application/json

{
   "filters": [ 
      { 
         "condition": { ... },
         "key": "string"
      }
   ],
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_ListIncidentRecords_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ListIncidentRecords_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filters](#API_ListIncidentRecords_RequestSyntax) **   <a name="IncidentManager-ListIncidentRecords-request-filters"></a>
Filters the list of incident records you want to search through. You can filter on the following keys:  
+  `creationTime` 
+  `impact` 
+  `status` 
+  `createdBy` 
Note the following when when you use Filters:  
+ If you don't specify a Filter, the response includes all incident records.
+ If you specify more than one filter in a single request, the response returns incident records that match all filters.
+ If you specify a filter with more than one value, the response returns incident records that match any of the values provided.
Type: Array of [Filter](API_Filter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [maxResults](#API_ListIncidentRecords_RequestSyntax) **   <a name="IncidentManager-ListIncidentRecords-request-maxResults"></a>
The maximum number of results per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListIncidentRecords_RequestSyntax) **   <a name="IncidentManager-ListIncidentRecords-request-nextToken"></a>
The pagination token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2000.  
Required: No

## Response Syntax
<a name="API_ListIncidentRecords_ResponseSyntax"></a>

```
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
<a name="API_ListIncidentRecords_ResponseElements"></a>

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

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

 ** [incidentRecordSummaries](#API_ListIncidentRecords_ResponseSyntax) **   <a name="IncidentManager-ListIncidentRecords-response-incidentRecordSummaries"></a>
The details of each listed incident record.  
Type: Array of [IncidentRecordSummary](API_IncidentRecordSummary.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

 ** [nextToken](#API_ListIncidentRecords_ResponseSyntax) **   <a name="IncidentManager-ListIncidentRecords-response-nextToken"></a>
The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2000.

## Errors
<a name="API_ListIncidentRecords_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** 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
<a name="API_ListIncidentRecords_Examples"></a>

### Example
<a name="API_ListIncidentRecords_Example_1"></a>

This example illustrates one usage of ListIncidentRecords.

#### Sample Request
<a name="API_ListIncidentRecords_Example_1_Request"></a>

```
POST /listIncidentRecords 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.list-incident-records
X-Amz-Date: 20210811T170938Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 0
```

#### Sample Response
<a name="API_ListIncidentRecords_Example_1_Response"></a>

```
{
    "incidentRecordSummaries": [
        {
            "arn": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/78bd9919-b9ac-962d-91e0-149960600e3f",
            "creationTime": "2021-08-10T22:33:57.849000+00:00",
            "impact": 5,
            "incidentRecordSource": {
                "createdBy": "arn:aws:sts::111122223333:assumed-role/Admin/exampleUser",
                "invokedBy": "arn:aws:sts::111122223333:assumed-role/Admin/exampleUser",
                "source": "aws.ssm-incidents.custom"
            },
            "status": "OPEN",
            "title": "example-incident"
        }
    ]
}
```

## See Also
<a name="API_ListIncidentRecords_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/ListIncidentRecords) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/ListIncidentRecords) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/ListIncidentRecords) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/ListIncidentRecords) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/ListIncidentRecords) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/ListIncidentRecords) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/ListIncidentRecords) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/ListIncidentRecords) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/ListIncidentRecords) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/ListIncidentRecords) 

# ListRelatedItems
<a name="API_ListRelatedItems"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

List all related items for an incident record.

## Request Syntax
<a name="API_ListRelatedItems_RequestSyntax"></a>

```
POST /listRelatedItems HTTP/1.1
Content-type: application/json

{
   "incidentRecordArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_ListRelatedItems_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ListRelatedItems_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [incidentRecordArn](#API_ListRelatedItems_RequestSyntax) **   <a name="IncidentManager-ListRelatedItems-request-incidentRecordArn"></a>
The Amazon Resource Name (ARN) of the incident record containing the listed related items.  
Type: String  
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

 ** [maxResults](#API_ListRelatedItems_RequestSyntax) **   <a name="IncidentManager-ListRelatedItems-request-maxResults"></a>
The maximum number of related items per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListRelatedItems_RequestSyntax) **   <a name="IncidentManager-ListRelatedItems-request-nextToken"></a>
The pagination token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2000.  
Required: No

## Response Syntax
<a name="API_ListRelatedItems_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "relatedItems": [ 
      { 
         "generatedId": "string",
         "identifier": { 
            "type": "string",
            "value": { ... }
         },
         "title": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListRelatedItems_ResponseElements"></a>

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

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

 ** [nextToken](#API_ListRelatedItems_ResponseSyntax) **   <a name="IncidentManager-ListRelatedItems-response-nextToken"></a>
The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2000.

 ** [relatedItems](#API_ListRelatedItems_ResponseSyntax) **   <a name="IncidentManager-ListRelatedItems-response-relatedItems"></a>
Details about each related item.  
Type: Array of [RelatedItem](API_RelatedItem.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

## Errors
<a name="API_ListRelatedItems_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** 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
<a name="API_ListRelatedItems_Examples"></a>

### Example
<a name="API_ListRelatedItems_Example_1"></a>

This example illustrates one usage of ListRelatedItems.

#### Sample Request
<a name="API_ListRelatedItems_Example_1_Request"></a>

```
POST /listRelatedItems 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.list-related-items
X-Amz-Date: 20210811T172030Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 130

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

#### Sample Response
<a name="API_ListRelatedItems_Example_1_Response"></a>

```
{
    "relatedItems": [
        {
            "identifier": {
                "type": "OTHER",
                "value": {
                    "url": "https://us-east-1.console.aws.amazon.com/systems-manager/opsitems/oi-cd91EXAMPLE/workbench?region=us-east-1"
                }
            },
            "title": "Example related item",
            "generatedId": "related-item/PARENT/F95638BAA087E072DC56189CB4D2ADEC"

        },
        {
            "identifier": {
                "type": "PARENT",
                "value": {
                    "arn": "arn:aws:ssm:us-east-1:111122223333:opsitem/oi-40089EXAMPLE"
                }
            },
            "title": "parentItem",
            "generatedId": "related-item/PARENT/F95638BAA087E072DC56189CB4D2ADEC"

        }
    ]
}
```

## See Also
<a name="API_ListRelatedItems_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/ListRelatedItems) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/ListRelatedItems) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/ListRelatedItems) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/ListRelatedItems) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/ListRelatedItems) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/ListRelatedItems) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/ListRelatedItems) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/ListRelatedItems) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/ListRelatedItems) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/ListRelatedItems) 

# ListReplicationSets
<a name="API_ListReplicationSets"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Lists details about the replication set configured in your account. 

## Request Syntax
<a name="API_ListReplicationSets_RequestSyntax"></a>

```
POST /listReplicationSets HTTP/1.1
Content-type: application/json

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

## URI Request Parameters
<a name="API_ListReplicationSets_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ListReplicationSets_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListReplicationSets_RequestSyntax) **   <a name="IncidentManager-ListReplicationSets-request-maxResults"></a>
The maximum number of results per page.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListReplicationSets_RequestSyntax) **   <a name="IncidentManager-ListReplicationSets-request-nextToken"></a>
The pagination token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2000.  
Required: No

## Response Syntax
<a name="API_ListReplicationSets_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "replicationSetArns": [ "string" ]
}
```

## Response Elements
<a name="API_ListReplicationSets_ResponseElements"></a>

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

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

 ** [nextToken](#API_ListReplicationSets_ResponseSyntax) **   <a name="IncidentManager-ListReplicationSets-response-nextToken"></a>
The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2000.

 ** [replicationSetArns](#API_ListReplicationSets_ResponseSyntax) **   <a name="IncidentManager-ListReplicationSets-response-replicationSetArns"></a>
The Amazon Resource Name (ARN) of the list replication set.  
Type: Array of strings  
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})?:.+` 

## Errors
<a name="API_ListReplicationSets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** 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
<a name="API_ListReplicationSets_Examples"></a>

### Example
<a name="API_ListReplicationSets_Example_1"></a>

This example illustrates one usage of ListReplicationSets.

#### Sample Request
<a name="API_ListReplicationSets_Example_1_Request"></a>

```
POST /listReplicationSets 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.list-replication-sets
X-Amz-Date: 20210810T223055Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210810/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 0
```

#### Sample Response
<a name="API_ListReplicationSets_Example_1_Response"></a>

```
{
	"nextToken":null,
	"replicationSetArns":
		[
			"arn:aws:ssm-incidents::111122223333:replication-set/40bd98f0-4110-2dee-b35e-b87006f9e172"
		]
}
```

## See Also
<a name="API_ListReplicationSets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/ListReplicationSets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/ListReplicationSets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/ListReplicationSets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/ListReplicationSets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/ListReplicationSets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/ListReplicationSets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/ListReplicationSets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/ListReplicationSets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/ListReplicationSets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/ListReplicationSets) 

# ListResponsePlans
<a name="API_ListResponsePlans"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Lists all response plans in your account.

## Request Syntax
<a name="API_ListResponsePlans_RequestSyntax"></a>

```
POST /listResponsePlans HTTP/1.1
Content-type: application/json

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

## URI Request Parameters
<a name="API_ListResponsePlans_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ListResponsePlans_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListResponsePlans_RequestSyntax) **   <a name="IncidentManager-ListResponsePlans-request-maxResults"></a>
The maximum number of response plans per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListResponsePlans_RequestSyntax) **   <a name="IncidentManager-ListResponsePlans-request-nextToken"></a>
The pagination token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2000.  
Required: No

## Response Syntax
<a name="API_ListResponsePlans_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "responsePlanSummaries": [ 
      { 
         "arn": "string",
         "displayName": "string",
         "name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListResponsePlans_ResponseElements"></a>

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

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

 ** [nextToken](#API_ListResponsePlans_ResponseSyntax) **   <a name="IncidentManager-ListResponsePlans-response-nextToken"></a>
The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2000.

 ** [responsePlanSummaries](#API_ListResponsePlans_ResponseSyntax) **   <a name="IncidentManager-ListResponsePlans-response-responsePlanSummaries"></a>
Details of each response plan.  
Type: Array of [ResponsePlanSummary](API_ResponsePlanSummary.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

## Errors
<a name="API_ListResponsePlans_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** 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
<a name="API_ListResponsePlans_Examples"></a>

### Example
<a name="API_ListResponsePlans_Example_1"></a>

This example illustrates one usage of ListResponsePlans.

#### Sample Request
<a name="API_ListResponsePlans_Example_1_Request"></a>

```
POST /listResponsePlans 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.list-response-plans
X-Amz-Date: 20210811T172723Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 461

{
	"nextToken": "AAMA-EFRSURBSGhxbUdFUS9sMGNSNUQwM1RCak1VM3FiUVpneVdwRHFlVGp0czk0cFg4MEdRSFM1cWQzSDZuOGFtNGt2ZXFkRHVoYkFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTVR3VGcreXpmN0NiUFZvSmJBZ0VRZ0R1ck5hL093U1dxVnRKa0hwNXptNkgrcWxuNk9tNFZnRS9iSzl1cVE5KzR4bmlZd2ZMQnZIYUlFVU1yY0x6OC80ZVlrTVQ2VFdOVzFTaU41dz09SeLKmN9a12em-UlGoYDbWb_1keR-kIBvT4Al40KQqiAxUEMCIJ_15yckvywELqL2WiYQBKkjMjyMyjhwkFAu3sfu_Wg4jRUTUA8hEA4lbhXk"
}
```

#### Sample Response
<a name="API_ListResponsePlans_Example_1_Response"></a>

```
{
    "responsePlanSummaries": [
        {
            "arn": "arn:aws:ssm-incidents::111122223333:response-plan/example-response",
            "displayName": "Example response plan",
            "name": "example-response"
        }
    ]
}
```

## See Also
<a name="API_ListResponsePlans_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/ListResponsePlans) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/ListResponsePlans) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/ListResponsePlans) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/ListResponsePlans) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/ListResponsePlans) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/ListResponsePlans) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/ListResponsePlans) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/ListResponsePlans) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/ListResponsePlans) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/ListResponsePlans) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Lists the tags that are attached to the specified response plan or incident.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/resourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="IncidentManager-ListTagsForResource-request-uri-resourceArn"></a>
The Amazon Resource Name (ARN) of the response plan or incident.  
Required: Yes

## Request Body
<a name="API_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

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

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

 ** [tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="IncidentManager-ListTagsForResource-response-tags"></a>
A list of tags for the response plan or incident.  
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 _=@:.+-/]*` 

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_ListTagsForResource_Examples"></a>

### Example
<a name="API_ListTagsForResource_Example_1"></a>

This example illustrates one usage of ListTagsForResource.

#### Sample Request
<a name="API_ListTagsForResource_Example_1_Request"></a>

```
GET /tags/arn%3Aaws%3Assm-incidents%3A%111122223333%3Aresponse-plan%2Fexample-response 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.list-tags-for-resource
X-Amz-Date: 20210811T180328Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
```

#### Sample Response
<a name="API_ListTagsForResource_Example_1_Response"></a>

```
{
    "tags": {
        "group1": "1"
    }
}
```

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/ListTagsForResource) 

# ListTimelineEvents
<a name="API_ListTimelineEvents"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Lists timeline events for the specified incident record.

## Request Syntax
<a name="API_ListTimelineEvents_RequestSyntax"></a>

```
POST /listTimelineEvents HTTP/1.1
Content-type: application/json

{
   "filters": [ 
      { 
         "condition": { ... },
         "key": "string"
      }
   ],
   "incidentRecordArn": "string",
   "maxResults": number,
   "nextToken": "string",
   "sortBy": "string",
   "sortOrder": "string"
}
```

## URI Request Parameters
<a name="API_ListTimelineEvents_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ListTimelineEvents_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filters](#API_ListTimelineEvents_RequestSyntax) **   <a name="IncidentManager-ListTimelineEvents-request-filters"></a>
Filters the timeline events based on the provided conditional values. You can filter timeline events with the following keys:  
+  `eventReference` 
+  `eventTime` 
+  `eventType` 
Note the following when deciding how to use Filters:  
+ If you don't specify a Filter, the response includes all timeline events.
+ If you specify more than one filter in a single request, the response returns timeline events that match all filters.
+ If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.
Type: Array of [Filter](API_Filter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: No

 ** [incidentRecordArn](#API_ListTimelineEvents_RequestSyntax) **   <a name="IncidentManager-ListTimelineEvents-request-incidentRecordArn"></a>
The Amazon Resource Name (ARN) of the incident that includes the timeline event.  
Type: String  
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

 ** [maxResults](#API_ListTimelineEvents_RequestSyntax) **   <a name="IncidentManager-ListTimelineEvents-request-maxResults"></a>
The maximum number of results per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListTimelineEvents_RequestSyntax) **   <a name="IncidentManager-ListTimelineEvents-request-nextToken"></a>
The pagination token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2000.  
Required: No

 ** [sortBy](#API_ListTimelineEvents_RequestSyntax) **   <a name="IncidentManager-ListTimelineEvents-request-sortBy"></a>
Sort timeline events by the specified key value pair.  
Type: String  
Valid Values: `EVENT_TIME`   
Required: No

 ** [sortOrder](#API_ListTimelineEvents_RequestSyntax) **   <a name="IncidentManager-ListTimelineEvents-request-sortOrder"></a>
Sorts the order of timeline events by the value specified in the `sortBy` field.  
Type: String  
Valid Values: `ASCENDING | DESCENDING`   
Required: No

## Response Syntax
<a name="API_ListTimelineEvents_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "eventSummaries": [ 
      { 
         "eventId": "string",
         "eventReferences": [ 
            { ... }
         ],
         "eventTime": number,
         "eventType": "string",
         "eventUpdatedTime": number,
         "incidentRecordArn": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListTimelineEvents_ResponseElements"></a>

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

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

 ** [eventSummaries](#API_ListTimelineEvents_ResponseSyntax) **   <a name="IncidentManager-ListTimelineEvents-response-eventSummaries"></a>
Details about each event that occurred during the incident.  
Type: Array of [EventSummary](API_EventSummary.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

 ** [nextToken](#API_ListTimelineEvents_ResponseSyntax) **   <a name="IncidentManager-ListTimelineEvents-response-nextToken"></a>
The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2000.

## Errors
<a name="API_ListTimelineEvents_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** 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
<a name="API_ListTimelineEvents_Examples"></a>

### Example
<a name="API_ListTimelineEvents_Example_1"></a>

This example illustrates one usage of ListTimelineEvents.

#### Sample Request
<a name="API_ListTimelineEvents_Example_1_Request"></a>

```
POST /listTimelineEvents 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.list-timeline-events
X-Amz-Date: 20210811T163348Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=AKIAIOSFODNN7EXAMPLE
Content-Length: 130

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

#### Sample Response
<a name="API_ListTimelineEvents_Example_1_Response"></a>

```
{
    "eventSummaries": [
        {
            "eventId": "ecbd9919-bba6-d317-6cfc-7232df620b6d",
            "eventTime": "2021-08-10T22:33:58.724000+00:00",
            "eventReferences": [
                { "resource": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/78bd9919-b9ac-962d-91e0-149960600e3f" }
            ],
            "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"
        },
        {
            "eventId": "08bd9919-bad3-d3a8-58f5-f26c362fe79f",
            "eventTime": "2021-08-10T22:33:58+00:00",
            "eventReferences": [
                { "relatedItemId": "related-item/AUTOMATION/369DAA0D8B9CB4E1856C52FA2D0787EC" }
            ],
            "eventType": "SSM Automation Execution Start Failure for Incident",
            "eventUpdatedTime": "2021-08-10T22:33:58.439000+00:00",
            "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/78bd9919-b9ac-962d-91e0-149960600e3f"
        },
        {
            "eventId": "58bd9919-bc2e-030b-11f0-76dc0d95bb36",
            "eventTime": "2021-08-10T22:33:57+00:00",
            "eventReferences": [
                { "relatedItemId": "related-item/METRIC/F95638BAA087E072DC56189CB4D2ADEC" },
                { "resource": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/78bd9919-b9ac-962d-91e0-149960600e3f" }
            ],
            "eventType": "Custom Event",
            "eventUpdatedTime": "2021-08-10T22:33:59.132000+00:00",
            "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/78bd9919-b9ac-962d-91e0-149960600e3f"
        }
    ]
}
```

## See Also
<a name="API_ListTimelineEvents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/ListTimelineEvents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/ListTimelineEvents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/ListTimelineEvents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/ListTimelineEvents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/ListTimelineEvents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/ListTimelineEvents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/ListTimelineEvents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/ListTimelineEvents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/ListTimelineEvents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/ListTimelineEvents) 

# PutResourcePolicy
<a name="API_PutResourcePolicy"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Adds a resource policy to the specified response plan. The resource policy is used to share the response plan using AWS Resource Access Manager (AWS RAM). For more information about cross-account sharing, see [Cross-Region and cross-account incident management](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-cross-account-cross-region.html).

## Request Syntax
<a name="API_PutResourcePolicy_RequestSyntax"></a>

```
POST /putResourcePolicy HTTP/1.1
Content-type: application/json

{
   "policy": "string",
   "resourceArn": "string"
}
```

## URI Request Parameters
<a name="API_PutResourcePolicy_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_PutResourcePolicy_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [policy](#API_PutResourcePolicy_RequestSyntax) **   <a name="IncidentManager-PutResourcePolicy-request-policy"></a>
Details of the resource policy.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4000.  
Required: Yes

 ** [resourceArn](#API_PutResourcePolicy_RequestSyntax) **   <a name="IncidentManager-PutResourcePolicy-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the response plan to add the resource policy to.  
Type: String  
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

## Response Syntax
<a name="API_PutResourcePolicy_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "policyId": "string"
}
```

## Response Elements
<a name="API_PutResourcePolicy_ResponseElements"></a>

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

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

 ** [policyId](#API_PutResourcePolicy_ResponseSyntax) **   <a name="IncidentManager-PutResourcePolicy-response-policyId"></a>
The ID of the resource policy.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.

## Errors
<a name="API_PutResourcePolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_PutResourcePolicy_Examples"></a>

### Example
<a name="API_PutResourcePolicy_Example_1"></a>

This example illustrates one usage of PutResourcePolicy.

#### Sample Request
<a name="API_PutResourcePolicy_Example_1_Request"></a>

```
POST /putResourcePolicy 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.put-resource-policy
X-Amz-Date: 20210810T225349Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210810/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 796

{
	"policy": "{\"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/*\"]}]}", 
	"resourceArn": "arn:aws:ssm-incidents::111122223333:response-plan/example-response"
}
```

#### Sample Response
<a name="API_PutResourcePolicy_Example_1_Response"></a>

```
{
	"policyId":"72f95d0502d05ebf6e7d2c30ee0445cf"
}
```

## See Also
<a name="API_PutResourcePolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/PutResourcePolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/PutResourcePolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/PutResourcePolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/PutResourcePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/PutResourcePolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/PutResourcePolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/PutResourcePolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/PutResourcePolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/PutResourcePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/PutResourcePolicy) 

# StartIncident
<a name="API_StartIncident"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Used to start an incident from CloudWatch alarms, EventBridge events, or manually. 

## Request Syntax
<a name="API_StartIncident_RequestSyntax"></a>

```
POST /startIncident HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "impact": number,
   "relatedItems": [ 
      { 
         "generatedId": "string",
         "identifier": { 
            "type": "string",
            "value": { ... }
         },
         "title": "string"
      }
   ],
   "responsePlanArn": "string",
   "title": "string",
   "triggerDetails": { 
      "rawData": "string",
      "source": "string",
      "timestamp": number,
      "triggerArn": "string"
   }
}
```

## URI Request Parameters
<a name="API_StartIncident_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartIncident_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_StartIncident_RequestSyntax) **   <a name="IncidentManager-StartIncident-request-clientToken"></a>
A token ensuring that the operation is called only once with the specified details.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Required: No

 ** [impact](#API_StartIncident_RequestSyntax) **   <a name="IncidentManager-StartIncident-request-impact"></a>
Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.  

**Supported impact codes**
+  `1` - Critical
+  `2` - High
+  `3` - Medium
+  `4` - Low
+  `5` - No Impact
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 5.  
Required: No

 ** [relatedItems](#API_StartIncident_RequestSyntax) **   <a name="IncidentManager-StartIncident-request-relatedItems"></a>
Add related items to the incident for other responders to use. Related items are AWS resources, external links, or files uploaded to an Amazon S3 bucket.   
Type: Array of [RelatedItem](API_RelatedItem.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Required: No

 ** [responsePlanArn](#API_StartIncident_RequestSyntax) **   <a name="IncidentManager-StartIncident-request-responsePlanArn"></a>
The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, Amazon SNS topics, runbooks, title, and impact of the incident.   
Type: String  
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

 ** [title](#API_StartIncident_RequestSyntax) **   <a name="IncidentManager-StartIncident-request-title"></a>
Provide a title for the incident. Providing a title overwrites the title provided by the response plan.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Required: No

 ** [triggerDetails](#API_StartIncident_RequestSyntax) **   <a name="IncidentManager-StartIncident-request-triggerDetails"></a>
Details of what created the incident record in Incident Manager.  
Type: [TriggerDetails](API_TriggerDetails.md) object  
Required: No

## Response Syntax
<a name="API_StartIncident_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "incidentRecordArn": "string"
}
```

## Response Elements
<a name="API_StartIncident_ResponseElements"></a>

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

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

 ** [incidentRecordArn](#API_StartIncident_ResponseSyntax) **   <a name="IncidentManager-StartIncident-response-incidentRecordArn"></a>
The ARN of the newly created incident record.  
Type: String  
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})?:.+` 

## Errors
<a name="API_StartIncident_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
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

 ** 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
<a name="API_StartIncident_Examples"></a>

### Example
<a name="API_StartIncident_Example_1"></a>

This example illustrates one usage of StartIncident.

#### Sample Request
<a name="API_StartIncident_Example_1_Request"></a>

```
POST /startIncident 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.start-incident
X-Amz-Date: 20210811T181411Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=AKIAIOSFODNN7EXAMPLE
Content-Length: 144

{
	"responsePlanArn": "arn:aws:ssm-incidents::111122223333:response-plan/example-response", 
	"clientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE"
}
```

#### Sample Response
<a name="API_StartIncident_Example_1_Response"></a>

```
{
    "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/1abd9b35-ff4c-eb47-f20f-712a6c4c88cc"
}
```

## See Also
<a name="API_StartIncident_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/StartIncident) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/StartIncident) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/StartIncident) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/StartIncident) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/StartIncident) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/StartIncident) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/StartIncident) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/StartIncident) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/StartIncident) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/StartIncident) 

# TagResource
<a name="API_TagResource"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Adds a tag to a response plan.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_TagResource_RequestSyntax) **   <a name="IncidentManager-TagResource-request-uri-resourceArn"></a>
The Amazon Resource Name (ARN) of the response plan you're adding the tags to.  
Required: Yes

## Request Body
<a name="API_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_TagResource_RequestSyntax) **   <a name="IncidentManager-TagResource-request-tags"></a>
A list of tags to add 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: Yes

## Response Syntax
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

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

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
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

 ** ResourceNotFoundException **   
Request references a resource which doesn't exist.   
HTTP Status Code: 404

 ** 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 specified by an AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_TagResource_Examples"></a>

### Example
<a name="API_TagResource_Example_1"></a>

This example illustrates one usage of TagResource.

#### Sample Request
<a name="API_TagResource_Example_1_Request"></a>

```
POST /tags/arn%3Aaws%3Assm-incidents%3A%111122223333%3Aresponse-plan%2Fexample-response 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.tag-resource
X-Amz-Date: 20210811T173902Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 25

{
	"tags": {"group1": "1"}
}
```

#### Sample Response
<a name="API_TagResource_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Removes a tag from a resource.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_UntagResource_RequestSyntax) **   <a name="IncidentManager-UntagResource-request-uri-resourceArn"></a>
The Amazon Resource Name (ARN) of the response plan you're removing a tag from.  
Required: Yes

 ** [tagKeys](#API_UntagResource_RequestSyntax) **   <a name="IncidentManager-UntagResource-request-uri-tagKeys"></a>
The name of the tag to remove from the response plan.  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `(?!aws:)[A-Za-z0-9 _=@:.+-/]+`   
Required: Yes

## Request Body
<a name="API_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

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

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
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

 ** 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
<a name="API_UntagResource_Examples"></a>

### Example
<a name="API_UntagResource_Example_1"></a>

This example illustrates one usage of UntagResource.

#### Sample Request
<a name="API_UntagResource_Example_1_Request"></a>

```
DELETE /tags/arn%3Aaws%3Assm-incidents%3A%111122223333%3Aresponse-plan%2Fexample-response?tagKeys=group1 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.untag-resource
X-Amz-Date: 20210811T182227Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 0
```

#### Sample Response
<a name="API_UntagResource_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/UntagResource) 

# UpdateDeletionProtection
<a name="API_UpdateDeletionProtection"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Update deletion protection to either allow or deny deletion of the final Region in a replication set.

## Request Syntax
<a name="API_UpdateDeletionProtection_RequestSyntax"></a>

```
POST /updateDeletionProtection HTTP/1.1
Content-type: application/json

{
   "arn": "string",
   "clientToken": "string",
   "deletionProtected": boolean
}
```

## URI Request Parameters
<a name="API_UpdateDeletionProtection_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_UpdateDeletionProtection_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [arn](#API_UpdateDeletionProtection_RequestSyntax) **   <a name="IncidentManager-UpdateDeletionProtection-request-arn"></a>
The Amazon Resource Name (ARN) of the replication set to update.  
Type: String  
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

 ** [clientToken](#API_UpdateDeletionProtection_RequestSyntax) **   <a name="IncidentManager-UpdateDeletionProtection-request-clientToken"></a>
A token that ensures that the operation is called only once with the specified details.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Required: No

 ** [deletionProtected](#API_UpdateDeletionProtection_RequestSyntax) **   <a name="IncidentManager-UpdateDeletionProtection-request-deletionProtected"></a>
Specifies if deletion protection is turned on or off in your account.   
Type: Boolean  
Required: Yes

## Response Syntax
<a name="API_UpdateDeletionProtection_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_UpdateDeletionProtection_ResponseElements"></a>

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

## Errors
<a name="API_UpdateDeletionProtection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_UpdateDeletionProtection_Examples"></a>

### Example
<a name="API_UpdateDeletionProtection_Example_1"></a>

This example illustrates one usage of UpdateDeletionProtection.

#### Sample Request
<a name="API_UpdateDeletionProtection_Example_1_Request"></a>

```
POST /updateDeletionProtection 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.update-deletion-protection
X-Amz-Date: 20210811T183059Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 181

{
	"arn": "arn:aws:ssm-incidents::111122223333:replication-set/40bd98f0-4110-2dee-b35e-b87006f9e172", 
	"deletionProtected": true, 
	"clientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE"
}
```

#### Sample Response
<a name="API_UpdateDeletionProtection_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_UpdateDeletionProtection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/UpdateDeletionProtection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/UpdateDeletionProtection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/UpdateDeletionProtection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/UpdateDeletionProtection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/UpdateDeletionProtection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/UpdateDeletionProtection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/UpdateDeletionProtection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/UpdateDeletionProtection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/UpdateDeletionProtection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/UpdateDeletionProtection) 

# UpdateIncidentRecord
<a name="API_UpdateIncidentRecord"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Update the details of an incident record. You can use this operation to update an incident record from the defined chat channel. For more information about using actions in chat channels, see [Interacting through chat](https://docs.aws.amazon.com/incident-manager/latest/userguide/chat.html#chat-interact).

## Request Syntax
<a name="API_UpdateIncidentRecord_RequestSyntax"></a>

```
POST /updateIncidentRecord HTTP/1.1
Content-type: application/json

{
   "arn": "string",
   "chatChannel": { ... },
   "clientToken": "string",
   "impact": number,
   "notificationTargets": [ 
      { ... }
   ],
   "status": "string",
   "summary": "string",
   "title": "string"
}
```

## URI Request Parameters
<a name="API_UpdateIncidentRecord_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_UpdateIncidentRecord_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [arn](#API_UpdateIncidentRecord_RequestSyntax) **   <a name="IncidentManager-UpdateIncidentRecord-request-arn"></a>
The Amazon Resource Name (ARN) of the incident record you are updating.  
Type: String  
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

 ** [chatChannel](#API_UpdateIncidentRecord_RequestSyntax) **   <a name="IncidentManager-UpdateIncidentRecord-request-chatChannel"></a>
The Amazon Q Developer in chat applications chat channel where responders can collaborate.  
Type: [ChatChannel](API_ChatChannel.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [clientToken](#API_UpdateIncidentRecord_RequestSyntax) **   <a name="IncidentManager-UpdateIncidentRecord-request-clientToken"></a>
A token that ensures that a client calls the operation only once with the specified details.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Required: No

 ** [impact](#API_UpdateIncidentRecord_RequestSyntax) **   <a name="IncidentManager-UpdateIncidentRecord-request-impact"></a>
Defines the impact of the incident to customers and applications. If you provide an impact for an incident, it overwrites the impact provided by the response plan.  

**Supported impact codes**
+  `1` - Critical
+  `2` - High
+  `3` - Medium
+  `4` - Low
+  `5` - No Impact
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 5.  
Required: No

 ** [notificationTargets](#API_UpdateIncidentRecord_RequestSyntax) **   <a name="IncidentManager-UpdateIncidentRecord-request-notificationTargets"></a>
The Amazon SNS targets that Incident Manager notifies when a client updates an incident.  
Using multiple SNS topics creates redundancy in the event that a Region is down during the incident.  
Type: Array of [NotificationTargetItem](API_NotificationTargetItem.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [status](#API_UpdateIncidentRecord_RequestSyntax) **   <a name="IncidentManager-UpdateIncidentRecord-request-status"></a>
The status of the incident. Possible statuses are `Open` or `Resolved`.  
Type: String  
Valid Values: `OPEN | RESOLVED`   
Required: No

 ** [summary](#API_UpdateIncidentRecord_RequestSyntax) **   <a name="IncidentManager-UpdateIncidentRecord-request-summary"></a>
A longer description of what occurred during the incident.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 8000.  
Required: No

 ** [title](#API_UpdateIncidentRecord_RequestSyntax) **   <a name="IncidentManager-UpdateIncidentRecord-request-title"></a>
A brief description of the incident.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Required: No

## Response Syntax
<a name="API_UpdateIncidentRecord_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_UpdateIncidentRecord_ResponseElements"></a>

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

## Errors
<a name="API_UpdateIncidentRecord_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
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

 ** 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
<a name="API_UpdateIncidentRecord_Examples"></a>

### Example
<a name="API_UpdateIncidentRecord_Example_1"></a>

This example illustrates one usage of UpdateIncidentRecord.

#### Sample Request
<a name="API_UpdateIncidentRecord_Example_1_Request"></a>

```
POST /updateIncidentRecord 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.update-incident-record
X-Amz-Date: 20210811T184336Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 193

{
	"arn": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/1abd9b35-ff4c-eb47-f20f-712a6c4c88cc", 
	"status": "RESOLVED", 
	"clientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE"
}
```

#### Sample Response
<a name="API_UpdateIncidentRecord_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_UpdateIncidentRecord_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/UpdateIncidentRecord) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/UpdateIncidentRecord) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/UpdateIncidentRecord) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/UpdateIncidentRecord) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/UpdateIncidentRecord) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/UpdateIncidentRecord) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/UpdateIncidentRecord) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/UpdateIncidentRecord) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/UpdateIncidentRecord) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/UpdateIncidentRecord) 

# UpdateRelatedItems
<a name="API_UpdateRelatedItems"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Add or remove related items from the related items tab of an incident record.

## Request Syntax
<a name="API_UpdateRelatedItems_RequestSyntax"></a>

```
POST /updateRelatedItems HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "incidentRecordArn": "string",
   "relatedItemsUpdate": { ... }
}
```

## URI Request Parameters
<a name="API_UpdateRelatedItems_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_UpdateRelatedItems_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_UpdateRelatedItems_RequestSyntax) **   <a name="IncidentManager-UpdateRelatedItems-request-clientToken"></a>
A token that ensures that a client calls the operation only once with the specified details.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Required: No

 ** [incidentRecordArn](#API_UpdateRelatedItems_RequestSyntax) **   <a name="IncidentManager-UpdateRelatedItems-request-incidentRecordArn"></a>
The Amazon Resource Name (ARN) of the incident record that contains the related items that you update.  
Type: String  
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

 ** [relatedItemsUpdate](#API_UpdateRelatedItems_RequestSyntax) **   <a name="IncidentManager-UpdateRelatedItems-request-relatedItemsUpdate"></a>
Details about the item that you are add to, or delete from, an incident.  
Type: [RelatedItemsUpdate](API_RelatedItemsUpdate.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## Response Syntax
<a name="API_UpdateRelatedItems_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_UpdateRelatedItems_ResponseElements"></a>

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

## Errors
<a name="API_UpdateRelatedItems_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
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

 ** 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
<a name="API_UpdateRelatedItems_Examples"></a>

### Example
<a name="API_UpdateRelatedItems_Example_1"></a>

This example illustrates one usage of UpdateRelatedItems.

#### Sample Request
<a name="API_UpdateRelatedItems_Example_1_Request"></a>

```
POST /updateRelatedItems 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.update-related-items
X-Amz-Date: 20210811T185139Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 325

{
	"incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/64bd9b45-1d0e-2622-840d-03a87a1451fa", 
	"relatedItemsUpdate": {
		"itemToRemove": {
			"type": "PARENT", 
			"value": {"arn": "arn:aws:ssm:us-east-1:111122223333:opsItem/oi-86700a5297dc"}
		}
	}, 
	"clientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE"
}
```

#### Sample Response
<a name="API_UpdateRelatedItems_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_UpdateRelatedItems_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/UpdateRelatedItems) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/UpdateRelatedItems) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/UpdateRelatedItems) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/UpdateRelatedItems) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/UpdateRelatedItems) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/UpdateRelatedItems) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/UpdateRelatedItems) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/UpdateRelatedItems) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/UpdateRelatedItems) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/UpdateRelatedItems) 

# UpdateReplicationSet
<a name="API_UpdateReplicationSet"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Add or delete Regions from your replication set.

## Request Syntax
<a name="API_UpdateReplicationSet_RequestSyntax"></a>

```
POST /updateReplicationSet HTTP/1.1
Content-type: application/json

{
   "actions": [ 
      { ... }
   ],
   "arn": "string",
   "clientToken": "string"
}
```

## URI Request Parameters
<a name="API_UpdateReplicationSet_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_UpdateReplicationSet_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [actions](#API_UpdateReplicationSet_RequestSyntax) **   <a name="IncidentManager-UpdateReplicationSet-request-actions"></a>
An action to add or delete a Region.  
Type: Array of [UpdateReplicationSetAction](API_UpdateReplicationSetAction.md) objects  
Array Members: Fixed number of 1 item.  
Required: Yes

 ** [arn](#API_UpdateReplicationSet_RequestSyntax) **   <a name="IncidentManager-UpdateReplicationSet-request-arn"></a>
The Amazon Resource Name (ARN) of the replication set you're updating.  
Type: String  
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

 ** [clientToken](#API_UpdateReplicationSet_RequestSyntax) **   <a name="IncidentManager-UpdateReplicationSet-request-clientToken"></a>
A token that ensures that the operation is called only once with the specified details.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Required: No

## Response Syntax
<a name="API_UpdateReplicationSet_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_UpdateReplicationSet_ResponseElements"></a>

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

## Errors
<a name="API_UpdateReplicationSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
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

 ** 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
<a name="API_UpdateReplicationSet_Examples"></a>

### Example
<a name="API_UpdateReplicationSet_Example_1"></a>

This example illustrates one usage of UpdateReplicationSet.

#### Sample Request
<a name="API_UpdateReplicationSet_Example_1_Request"></a>

```
POST /updateReplicationSet 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.update-replication-set
X-Amz-Date: 20210811T202020Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 220

{
	"actions": [
		{
			"deleteRegionAction": {
				"regionName": "us-east-2"
			}
		}
	], 
	"arn": "arn:aws:ssm-incidents::111122223333:replication-set/40bd98f0-4110-2dee-b35e-b87006f9e172", 
	"clientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE"
}
```

#### Sample Response
<a name="API_UpdateReplicationSet_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_UpdateReplicationSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/UpdateReplicationSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/UpdateReplicationSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/UpdateReplicationSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/UpdateReplicationSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/UpdateReplicationSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/UpdateReplicationSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/UpdateReplicationSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/UpdateReplicationSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/UpdateReplicationSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/UpdateReplicationSet) 

# UpdateResponsePlan
<a name="API_UpdateResponsePlan"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Updates the specified response plan.

## Request Syntax
<a name="API_UpdateResponsePlan_RequestSyntax"></a>

```
POST /updateResponsePlan HTTP/1.1
Content-type: application/json

{
   "actions": [ 
      { ... }
   ],
   "arn": "string",
   "chatChannel": { ... },
   "clientToken": "string",
   "displayName": "string",
   "engagements": [ "string" ],
   "incidentTemplateDedupeString": "string",
   "incidentTemplateImpact": number,
   "incidentTemplateNotificationTargets": [ 
      { ... }
   ],
   "incidentTemplateSummary": "string",
   "incidentTemplateTags": { 
      "string" : "string" 
   },
   "incidentTemplateTitle": "string",
   "integrations": [ 
      { ... }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateResponsePlan_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_UpdateResponsePlan_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [actions](#API_UpdateResponsePlan_RequestSyntax) **   <a name="IncidentManager-UpdateResponsePlan-request-actions"></a>
The actions that this response plan takes at the beginning of an incident.  
Type: Array of [Action](API_Action.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Required: No

 ** [arn](#API_UpdateResponsePlan_RequestSyntax) **   <a name="IncidentManager-UpdateResponsePlan-request-arn"></a>
The Amazon Resource Name (ARN) of the response plan.  
Type: String  
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

 ** [chatChannel](#API_UpdateResponsePlan_RequestSyntax) **   <a name="IncidentManager-UpdateResponsePlan-request-chatChannel"></a>
The Amazon Q Developer in chat applications chat channel used for collaboration during an incident.  
Use the empty structure to remove the chat channel from the response plan.  
Type: [ChatChannel](API_ChatChannel.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [clientToken](#API_UpdateResponsePlan_RequestSyntax) **   <a name="IncidentManager-UpdateResponsePlan-request-clientToken"></a>
A token ensuring that the operation is called only once with the specified details.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Required: No

 ** [displayName](#API_UpdateResponsePlan_RequestSyntax) **   <a name="IncidentManager-UpdateResponsePlan-request-displayName"></a>
The long format name of the response plan. The display name can't contain spaces.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Required: No

 ** [engagements](#API_UpdateResponsePlan_RequestSyntax) **   <a name="IncidentManager-UpdateResponsePlan-request-engagements"></a>
The Amazon Resource Name (ARN) for 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.  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `arn:aws(-cn|-us-gov)?:ssm-contacts:[a-z0-9-]*:([0-9]{12}):contact/[a-z0-9_-]+`   
Required: No

 ** [incidentTemplateDedupeString](#API_UpdateResponsePlan_RequestSyntax) **   <a name="IncidentManager-UpdateResponsePlan-request-incidentTemplateDedupeString"></a>
The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Required: No

 ** [incidentTemplateImpact](#API_UpdateResponsePlan_RequestSyntax) **   <a name="IncidentManager-UpdateResponsePlan-request-incidentTemplateImpact"></a>
Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.  

**Supported impact codes**
+  `1` - Critical
+  `2` - High
+  `3` - Medium
+  `4` - Low
+  `5` - No Impact
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 5.  
Required: No

 ** [incidentTemplateNotificationTargets](#API_UpdateResponsePlan_RequestSyntax) **   <a name="IncidentManager-UpdateResponsePlan-request-incidentTemplateNotificationTargets"></a>
The Amazon SNS targets that are notified when updates are made to an incident.  
Type: Array of [NotificationTargetItem](API_NotificationTargetItem.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [incidentTemplateSummary](#API_UpdateResponsePlan_RequestSyntax) **   <a name="IncidentManager-UpdateResponsePlan-request-incidentTemplateSummary"></a>
A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 8000.  
Required: No

 ** [incidentTemplateTags](#API_UpdateResponsePlan_RequestSyntax) **   <a name="IncidentManager-UpdateResponsePlan-request-incidentTemplateTags"></a>
Tags to assign to the template. When the `StartIncident` API action is called, Incident Manager assigns the tags specified in the template to the incident. To call this action, you must also have permission to call the `TagResource` API action for the incident record resource.  
Type: String to string map  
Map Entries: Minimum number of 0 items. 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

 ** [incidentTemplateTitle](#API_UpdateResponsePlan_RequestSyntax) **   <a name="IncidentManager-UpdateResponsePlan-request-incidentTemplateTitle"></a>
The short format name of the incident. The title can't contain spaces.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 200.  
Required: No

 ** [integrations](#API_UpdateResponsePlan_RequestSyntax) **   <a name="IncidentManager-UpdateResponsePlan-request-integrations"></a>
Information about third-party services integrated into the response plan.  
Type: Array of [Integration](API_Integration.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Required: No

## Response Syntax
<a name="API_UpdateResponsePlan_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_UpdateResponsePlan_ResponseElements"></a>

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

## Errors
<a name="API_UpdateResponsePlan_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
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

 ** 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
<a name="API_UpdateResponsePlan_Examples"></a>

### Example
<a name="API_UpdateResponsePlan_Example_1"></a>

This example illustrates one usage of UpdateResponsePlan.

#### Sample Request
<a name="API_UpdateResponsePlan_Example_1_Request"></a>

```
POST /updateResponsePlan 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.update-response-plan
X-Amz-Date: 20210811T202606Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 162

{
	"arn": "arn:aws:ssm-incidents::111122223333:response-plan/example-response", 
	"chatChannel": {"empty": {}}, 
	"clientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE"
}
```

#### Sample Response
<a name="API_UpdateResponsePlan_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_UpdateResponsePlan_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/UpdateResponsePlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/UpdateResponsePlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/UpdateResponsePlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/UpdateResponsePlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/UpdateResponsePlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/UpdateResponsePlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/UpdateResponsePlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/UpdateResponsePlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/UpdateResponsePlan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/UpdateResponsePlan) 

# UpdateTimelineEvent
<a name="API_UpdateTimelineEvent"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Systems Manager Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Updates a timeline event. You can update events of type `Custom Event`.

## Request Syntax
<a name="API_UpdateTimelineEvent_RequestSyntax"></a>

```
POST /updateTimelineEvent HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "eventData": "string",
   "eventId": "string",
   "eventReferences": [ 
      { ... }
   ],
   "eventTime": number,
   "eventType": "string",
   "incidentRecordArn": "string"
}
```

## URI Request Parameters
<a name="API_UpdateTimelineEvent_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_UpdateTimelineEvent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_UpdateTimelineEvent_RequestSyntax) **   <a name="IncidentManager-UpdateTimelineEvent-request-clientToken"></a>
A token that ensures that a client calls the operation only once with the specified details.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Required: No

 ** [eventData](#API_UpdateTimelineEvent_RequestSyntax) **   <a name="IncidentManager-UpdateTimelineEvent-request-eventData"></a>
A short description of the event.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 12000.  
Required: No

 ** [eventId](#API_UpdateTimelineEvent_RequestSyntax) **   <a name="IncidentManager-UpdateTimelineEvent-request-eventId"></a>
The ID of the event to update. You can use `ListTimelineEvents` to find an event's ID.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 50.  
Required: Yes

 ** [eventReferences](#API_UpdateTimelineEvent_RequestSyntax) **   <a name="IncidentManager-UpdateTimelineEvent-request-eventReferences"></a>
Updates all existing references in a `TimelineEvent`. A reference is an AWS resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with that resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use its ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.  
This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes any existing references and enters only new references.
Type: Array of [EventReference](API_EventReference.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [eventTime](#API_UpdateTimelineEvent_RequestSyntax) **   <a name="IncidentManager-UpdateTimelineEvent-request-eventTime"></a>
The timestamp for when the event occurred.  
Type: Timestamp  
Required: No

 ** [eventType](#API_UpdateTimelineEvent_RequestSyntax) **   <a name="IncidentManager-UpdateTimelineEvent-request-eventType"></a>
The type of event. You can update events of type `Custom Event` and `Note`.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Required: No

 ** [incidentRecordArn](#API_UpdateTimelineEvent_RequestSyntax) **   <a name="IncidentManager-UpdateTimelineEvent-request-incidentRecordArn"></a>
The Amazon Resource Name (ARN) of the incident that includes the timeline event.  
Type: String  
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

## Response Syntax
<a name="API_UpdateTimelineEvent_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_UpdateTimelineEvent_ResponseElements"></a>

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

## Errors
<a name="API_UpdateTimelineEvent_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this operation.  
HTTP Status Code: 403

 ** ConflictException **   
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

 ** 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
<a name="API_UpdateTimelineEvent_Examples"></a>

### Example
<a name="API_UpdateTimelineEvent_Example_1"></a>

This example illustrates one usage of UpdateTimelineEvent.

#### Sample Request
<a name="API_UpdateTimelineEvent_Example_1_Request"></a>

```
POST /updateTimelineEvent 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.update-timeline-event
X-Amz-Date: 20210811T203312Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 261

{
	"eventId": "a4bd9b45-1fcf-64c3-9d53-121d0f53a7ec", 
	"eventTime": 1621620657, 
	"incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/64bd9b45-1d0e-2622-840d-03a87a1451fa", 
	"clientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE"
}
```

#### Sample Response
<a name="API_UpdateTimelineEvent_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_UpdateTimelineEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-incidents-2018-05-10/UpdateTimelineEvent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-incidents-2018-05-10/UpdateTimelineEvent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-incidents-2018-05-10/UpdateTimelineEvent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-incidents-2018-05-10/UpdateTimelineEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-incidents-2018-05-10/UpdateTimelineEvent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-incidents-2018-05-10/UpdateTimelineEvent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-incidents-2018-05-10/UpdateTimelineEvent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-incidents-2018-05-10/UpdateTimelineEvent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-incidents-2018-05-10/UpdateTimelineEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-incidents-2018-05-10/UpdateTimelineEvent)