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

The following actions are supported by AWS Systems Manager Incident Manager Contacts:
+  [AcceptPage](API_SSMContacts_AcceptPage.md) 
+  [ActivateContactChannel](API_SSMContacts_ActivateContactChannel.md) 
+  [CreateContact](API_SSMContacts_CreateContact.md) 
+  [CreateContactChannel](API_SSMContacts_CreateContactChannel.md) 
+  [CreateRotation](API_SSMContacts_CreateRotation.md) 
+  [CreateRotationOverride](API_SSMContacts_CreateRotationOverride.md) 
+  [DeactivateContactChannel](API_SSMContacts_DeactivateContactChannel.md) 
+  [DeleteContact](API_SSMContacts_DeleteContact.md) 
+  [DeleteContactChannel](API_SSMContacts_DeleteContactChannel.md) 
+  [DeleteRotation](API_SSMContacts_DeleteRotation.md) 
+  [DeleteRotationOverride](API_SSMContacts_DeleteRotationOverride.md) 
+  [DescribeEngagement](API_SSMContacts_DescribeEngagement.md) 
+  [DescribePage](API_SSMContacts_DescribePage.md) 
+  [GetContact](API_SSMContacts_GetContact.md) 
+  [GetContactChannel](API_SSMContacts_GetContactChannel.md) 
+  [GetContactPolicy](API_SSMContacts_GetContactPolicy.md) 
+  [GetRotation](API_SSMContacts_GetRotation.md) 
+  [GetRotationOverride](API_SSMContacts_GetRotationOverride.md) 
+  [ListContactChannels](API_SSMContacts_ListContactChannels.md) 
+  [ListContacts](API_SSMContacts_ListContacts.md) 
+  [ListEngagements](API_SSMContacts_ListEngagements.md) 
+  [ListPageReceipts](API_SSMContacts_ListPageReceipts.md) 
+  [ListPageResolutions](API_SSMContacts_ListPageResolutions.md) 
+  [ListPagesByContact](API_SSMContacts_ListPagesByContact.md) 
+  [ListPagesByEngagement](API_SSMContacts_ListPagesByEngagement.md) 
+  [ListPreviewRotationShifts](API_SSMContacts_ListPreviewRotationShifts.md) 
+  [ListRotationOverrides](API_SSMContacts_ListRotationOverrides.md) 
+  [ListRotations](API_SSMContacts_ListRotations.md) 
+  [ListRotationShifts](API_SSMContacts_ListRotationShifts.md) 
+  [ListTagsForResource](API_SSMContacts_ListTagsForResource.md) 
+  [PutContactPolicy](API_SSMContacts_PutContactPolicy.md) 
+  [SendActivationCode](API_SSMContacts_SendActivationCode.md) 
+  [StartEngagement](API_SSMContacts_StartEngagement.md) 
+  [StopEngagement](API_SSMContacts_StopEngagement.md) 
+  [TagResource](API_SSMContacts_TagResource.md) 
+  [UntagResource](API_SSMContacts_UntagResource.md) 
+  [UpdateContact](API_SSMContacts_UpdateContact.md) 
+  [UpdateContactChannel](API_SSMContacts_UpdateContactChannel.md) 
+  [UpdateRotation](API_SSMContacts_UpdateRotation.md) 

# AcceptPage
<a name="API_SSMContacts_AcceptPage"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Used to acknowledge an engagement to a contact channel during an incident.

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

```
{
   "AcceptCode": "string",
   "AcceptCodeValidation": "string",
   "AcceptType": "string",
   "ContactChannelId": "string",
   "Note": "string",
   "PageId": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_AcceptPage_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AcceptCode](#API_SSMContacts_AcceptPage_RequestSyntax) **   <a name="IncidentManager-SSMContacts_AcceptPage-request-AcceptCode"></a>
A 6-digit code used to acknowledge the page.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 10.  
Pattern: `^[0-9]*$`   
Required: Yes

 ** [AcceptCodeValidation](#API_SSMContacts_AcceptPage_RequestSyntax) **   <a name="IncidentManager-SSMContacts_AcceptPage-request-AcceptCodeValidation"></a>
An optional field that Incident Manager uses to `ENFORCE` `AcceptCode` validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.  
Incident Manager can also `IGNORE` `AcceptCode` validation. Ignoring `AcceptCode` validation causes Incident Manager to accept any value entered for the `AcceptCode`.  
Type: String  
Valid Values: `IGNORE | ENFORCE`   
Required: No

 ** [AcceptType](#API_SSMContacts_AcceptPage_RequestSyntax) **   <a name="IncidentManager-SSMContacts_AcceptPage-request-AcceptType"></a>
The type indicates if the page was `DELIVERED` or `READ`.  
Type: String  
Valid Values: `DELIVERED | READ`   
Required: Yes

 ** [ContactChannelId](#API_SSMContacts_AcceptPage_RequestSyntax) **   <a name="IncidentManager-SSMContacts_AcceptPage-request-ContactChannelId"></a>
The ARN of the contact channel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: No

 ** [Note](#API_SSMContacts_AcceptPage_RequestSyntax) **   <a name="IncidentManager-SSMContacts_AcceptPage-request-Note"></a>
Information provided by the user when the user acknowledges the page.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[.\s\S]*$`   
Required: No

 ** [PageId](#API_SSMContacts_AcceptPage_RequestSyntax) **   <a name="IncidentManager-SSMContacts_AcceptPage-request-PageId"></a>
The Amazon Resource Name (ARN) of the engagement to a contact channel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

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

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

## Errors
<a name="API_SSMContacts_AcceptPage_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of AcceptPage.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.AcceptPage
Content-Type: application/x-amz-json-1.1
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-contacts.accept-page
X-Amz-Date: 20220816T191158Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220816/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 151

{
	"PageId": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/2f92b456-2350-442b-95e7-ed8b0EXAMPLE", 
	"AcceptType": "READ", 
	"AcceptCode": "425440"
}
```

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

```
{}
```

## See Also
<a name="API_SSMContacts_AcceptPage_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-contacts-2021-05-03/AcceptPage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/AcceptPage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/AcceptPage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/AcceptPage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/AcceptPage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/AcceptPage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/AcceptPage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/AcceptPage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/AcceptPage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/AcceptPage) 

# ActivateContactChannel
<a name="API_SSMContacts_ActivateContactChannel"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.

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

```
{
   "ActivationCode": "string",
   "ContactChannelId": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_ActivateContactChannel_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ActivationCode](#API_SSMContacts_ActivateContactChannel_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ActivateContactChannel-request-ActivationCode"></a>
The code sent to the contact channel when it was created in the contact.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 10.  
Pattern: `^[0-9]*$`   
Required: Yes

 ** [ContactChannelId](#API_SSMContacts_ActivateContactChannel_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ActivateContactChannel-request-ContactChannelId"></a>
The Amazon Resource Name (ARN) of the contact channel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

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

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

## Errors
<a name="API_SSMContacts_ActivateContactChannel_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of ActivateContactChannel.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.ActivateContactChannel
Content-Type: application/x-amz-json-1.1
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-contacts.activate-contact-channel
X-Amz-Date: 20220812T183313Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220812/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 154

{
	"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/e5bd2c57-406a-487f-8d26-7c032EXAMPLE", 
	"ActivationCode": "345140"
}
```

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

```
{}
```

## See Also
<a name="API_SSMContacts_ActivateContactChannel_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-contacts-2021-05-03/ActivateContactChannel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/ActivateContactChannel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/ActivateContactChannel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/ActivateContactChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/ActivateContactChannel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/ActivateContactChannel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/ActivateContactChannel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/ActivateContactChannel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/ActivateContactChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/ActivateContactChannel) 

# CreateContact
<a name="API_SSMContacts_CreateContact"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident.

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

```
{
   "Alias": "string",
   "DisplayName": "string",
   "IdempotencyToken": "string",
   "Plan": { 
      "RotationIds": [ "string" ],
      "Stages": [ 
         { 
            "DurationInMinutes": number,
            "Targets": [ 
               { 
                  "ChannelTargetInfo": { 
                     "ContactChannelId": "string",
                     "RetryIntervalInMinutes": number
                  },
                  "ContactTargetInfo": { 
                     "ContactId": "string",
                     "IsEssential": boolean
                  }
               }
            ]
         }
      ]
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Type": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_CreateContact_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Alias](#API_SSMContacts_CreateContact_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateContact-request-Alias"></a>
The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-z0-9_\-]*$`   
Required: Yes

 ** [DisplayName](#API_SSMContacts_CreateContact_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateContact-request-DisplayName"></a>
The full name of the contact or escalation plan.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `^[\p{L}\p{Z}\p{N}_.\-]*$`   
Required: No

 ** [IdempotencyToken](#API_SSMContacts_CreateContact_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateContact-request-IdempotencyToken"></a>
A token ensuring that the operation is called only once with the specified details.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$`   
Required: No

 ** [Plan](#API_SSMContacts_CreateContact_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateContact-request-Plan"></a>
A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.  
Type: [Plan](API_SSMContacts_Plan.md) object  
Required: Yes

 ** [Tags](#API_SSMContacts_CreateContact_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateContact-request-Tags"></a>
Adds a tag to the target. You can only tag resources created in the first Region of your replication set.  
Type: Array of [Tag](API_SSMContacts_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** [Type](#API_SSMContacts_CreateContact_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateContact-request-Type"></a>
The type of contact to create.  
+  `PERSONAL`: A single, individual contact.
+  `ESCALATION`: An escalation plan.
+  `ONCALL_SCHEDULE`: An on-call schedule.
Type: String  
Valid Values: `PERSONAL | ESCALATION | ONCALL_SCHEDULE`   
Required: Yes

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

```
{
   "ContactArn": "string"
}
```

## Response Elements
<a name="API_SSMContacts_CreateContact_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.

 ** [ContactArn](#API_SSMContacts_CreateContact_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_CreateContact-response-ContactArn"></a>
The Amazon Resource Name (ARN) of the created contact or escalation plan.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*` 

## Errors
<a name="API_SSMContacts_CreateContact_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: 400

 ** ConflictException **   
Updating or deleting a resource causes an inconsistent state.  
HTTP Status Code: 400

 ** DataEncryptionException **   
The operation failed to due an encryption key error.  
HTTP Status Code: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
Request would cause a service quota to be exceeded.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of CreateContact.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.CreateContact
Content-Type: application/x-amz-json-1.1
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-contacts.create-contact
X-Amz-Date: 20220812T172928Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220812/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=AKIAIOSFODNN7EXAMPLE
Content-Length: 151

{
	"Alias": "akuam", 
	"DisplayName": "Akua Mansa", 
	"Type": "PERSONAL", 
	"Plan": {
		"Stages": []
	}, 
	"IdempotencyToken": "5b03013e-6255-404c-a673-1aa10EXAMPLE"
}
```

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

```
{
    "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
}
```

## See Also
<a name="API_SSMContacts_CreateContact_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-contacts-2021-05-03/CreateContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/CreateContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/CreateContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/CreateContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/CreateContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/CreateContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/CreateContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/CreateContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/CreateContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/CreateContact) 

# CreateContactChannel
<a name="API_SSMContacts_CreateContactChannel"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

A contact channel is the method that Incident Manager uses to engage your contact.

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

```
{
   "ContactId": "string",
   "DeferActivation": boolean,
   "DeliveryAddress": { 
      "SimpleAddress": "string"
   },
   "IdempotencyToken": "string",
   "Name": "string",
   "Type": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_CreateContactChannel_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ContactId](#API_SSMContacts_CreateContactChannel_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateContactChannel-request-ContactId"></a>
The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

 ** [DeferActivation](#API_SSMContacts_CreateContactChannel_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateContactChannel-request-DeferActivation"></a>
If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't engage your contact channel until it has been activated.  
Type: Boolean  
Required: No

 ** [DeliveryAddress](#API_SSMContacts_CreateContactChannel_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateContactChannel-request-DeliveryAddress"></a>
The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the type of the contact channel. The following are the expected formats:  
+ SMS - '\$1' followed by the country code and phone number
+ VOICE - '\$1' followed by the country code and phone number
+ EMAIL - any standard email format
Type: [ContactChannelAddress](API_SSMContacts_ContactChannelAddress.md) object  
Required: Yes

 ** [IdempotencyToken](#API_SSMContacts_CreateContactChannel_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateContactChannel-request-IdempotencyToken"></a>
A token ensuring that the operation is called only once with the specified details.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$`   
Required: No

 ** [Name](#API_SSMContacts_CreateContactChannel_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateContactChannel-request-Name"></a>
The name of the contact channel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[\p{L}\p{Z}\p{N}_.\-]*$`   
Required: Yes

 ** [Type](#API_SSMContacts_CreateContactChannel_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateContactChannel-request-Type"></a>
Incident Manager supports three types of contact channels:  
+  `SMS` 
+  `VOICE` 
+  `EMAIL` 
Type: String  
Valid Values: `SMS | VOICE | EMAIL`   
Required: Yes

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

```
{
   "ContactChannelArn": "string"
}
```

## Response Elements
<a name="API_SSMContacts_CreateContactChannel_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.

 ** [ContactChannelArn](#API_SSMContacts_CreateContactChannel_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_CreateContactChannel-response-ContactChannelArn"></a>
The Amazon Resource Name (ARN) of the contact channel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*` 

## Errors
<a name="API_SSMContacts_CreateContactChannel_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: 400

 ** ConflictException **   
Updating or deleting a resource causes an inconsistent state.  
HTTP Status Code: 400

 ** DataEncryptionException **   
The operation failed to due an encryption key error.  
HTTP Status Code: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of CreateContactChannel.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.CreateContactChannel
Content-Type: application/x-amz-json-1.1
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-contacts.create-contact-channel
X-Amz-Date: 20220812T174315Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220812/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 229

{
	"ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
	"Name": "akuas sms-test", 
	"Type": "SMS", 
	"DeliveryAddress": {"SimpleAddress": "+15005550199"}, 
	"IdempotencyToken": "922b8f50-9bb9-4dd7-83cf-a4c25EXAMPLE"
}
```

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

```
{
    "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/e5bd2c57-406a-487f-8d26-7c032EXAMPLE"
}
```

## See Also
<a name="API_SSMContacts_CreateContactChannel_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-contacts-2021-05-03/CreateContactChannel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/CreateContactChannel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/CreateContactChannel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/CreateContactChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/CreateContactChannel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/CreateContactChannel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/CreateContactChannel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/CreateContactChannel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/CreateContactChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/CreateContactChannel) 

# CreateRotation
<a name="API_SSMContacts_CreateRotation"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Creates a rotation in an on-call schedule.

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

```
{
   "ContactIds": [ "string" ],
   "IdempotencyToken": "string",
   "Name": "string",
   "Recurrence": { 
      "DailySettings": [ 
         { 
            "HourOfDay": number,
            "MinuteOfHour": number
         }
      ],
      "MonthlySettings": [ 
         { 
            "DayOfMonth": number,
            "HandOffTime": { 
               "HourOfDay": number,
               "MinuteOfHour": number
            }
         }
      ],
      "NumberOfOnCalls": number,
      "RecurrenceMultiplier": number,
      "ShiftCoverages": { 
         "string" : [ 
            { 
               "End": { 
                  "HourOfDay": number,
                  "MinuteOfHour": number
               },
               "Start": { 
                  "HourOfDay": number,
                  "MinuteOfHour": number
               }
            }
         ]
      },
      "WeeklySettings": [ 
         { 
            "DayOfWeek": "string",
            "HandOffTime": { 
               "HourOfDay": number,
               "MinuteOfHour": number
            }
         }
      ]
   },
   "StartTime": number,
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TimeZoneId": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_CreateRotation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ContactIds](#API_SSMContacts_CreateRotation_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateRotation-request-ContactIds"></a>
The Amazon Resource Names (ARNs) of the contacts to add to the rotation.  
Only the `PERSONAL` contact type is supported. The contact types `ESCALATION` and `ONCALL_SCHEDULE` are not supported for this operation. 
The order that you list the contacts in is their shift order in the rotation schedule. To change the order of the contact's shifts, use the [UpdateRotation](API_SSMContacts_UpdateRotation.md) operation.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 30 items.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

 ** [IdempotencyToken](#API_SSMContacts_CreateRotation_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateRotation-request-IdempotencyToken"></a>
A token that ensures that the operation is called only once with the specified details.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$`   
Required: No

 ** [Name](#API_SSMContacts_CreateRotation_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateRotation-request-Name"></a>
The name of the rotation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9_\-\s\.]*$`   
Required: Yes

 ** [Recurrence](#API_SSMContacts_CreateRotation_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateRotation-request-Recurrence"></a>
Information about the rule that specifies when a shift's team members rotate.  
Type: [RecurrenceSettings](API_SSMContacts_RecurrenceSettings.md) object  
Required: Yes

 ** [StartTime](#API_SSMContacts_CreateRotation_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateRotation-request-StartTime"></a>
The date and time that the rotation goes into effect.  
Type: Timestamp  
Required: No

 ** [Tags](#API_SSMContacts_CreateRotation_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateRotation-request-Tags"></a>
Optional metadata to assign to the rotation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For more information, see [Tagging Incident Manager resources](https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html) in the *Incident Manager User Guide*.  
Type: Array of [Tag](API_SSMContacts_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** [TimeZoneId](#API_SSMContacts_CreateRotation_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateRotation-request-TimeZoneId"></a>
The time zone to base the rotation’s activity on in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los\$1Angeles", "UTC", or "Asia/Seoul". For more information, see the [Time Zone Database](https://www.iana.org/time-zones) on the IANA website.  
Designators for time zones that don’t support Daylight Savings Time rules, such as Pacific Standard Time (PST), are not supported.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[:a-zA-Z0-9_\-\s\.\\/]*$`   
Required: Yes

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

```
{
   "RotationArn": "string"
}
```

## Response Elements
<a name="API_SSMContacts_CreateRotation_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.

 ** [RotationArn](#API_SSMContacts_CreateRotation_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_CreateRotation-response-RotationArn"></a>
The Amazon Resource Name (ARN) of the created rotation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*` 

## Errors
<a name="API_SSMContacts_CreateRotation_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
Request would cause a service quota to be exceeded.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_SSMContacts_CreateRotation_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-contacts-2021-05-03/CreateRotation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/CreateRotation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/CreateRotation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/CreateRotation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/CreateRotation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/CreateRotation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/CreateRotation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/CreateRotation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/CreateRotation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/CreateRotation) 

# CreateRotationOverride
<a name="API_SSMContacts_CreateRotationOverride"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Creates an override for a rotation in an on-call schedule.

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

```
{
   "EndTime": number,
   "IdempotencyToken": "string",
   "NewContactIds": [ "string" ],
   "RotationId": "string",
   "StartTime": number
}
```

## Request Parameters
<a name="API_SSMContacts_CreateRotationOverride_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EndTime](#API_SSMContacts_CreateRotationOverride_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateRotationOverride-request-EndTime"></a>
The date and time when the override ends.  
Type: Timestamp  
Required: Yes

 ** [IdempotencyToken](#API_SSMContacts_CreateRotationOverride_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateRotationOverride-request-IdempotencyToken"></a>
A token that ensures that the operation is called only once with the specified details.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$`   
Required: No

 ** [NewContactIds](#API_SSMContacts_CreateRotationOverride_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateRotationOverride-request-NewContactIds"></a>
The Amazon Resource Names (ARNs) of the contacts to replace those in the current on-call rotation with.  
If you want to include any current team members in the override shift, you must include their ARNs in the new contact ID list.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 30 items.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

 ** [RotationId](#API_SSMContacts_CreateRotationOverride_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateRotationOverride-request-RotationId"></a>
The Amazon Resource Name (ARN) of the rotation to create an override for.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

 ** [StartTime](#API_SSMContacts_CreateRotationOverride_RequestSyntax) **   <a name="IncidentManager-SSMContacts_CreateRotationOverride-request-StartTime"></a>
The date and time when the override goes into effect.  
Type: Timestamp  
Required: Yes

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

```
{
   "RotationOverrideId": "string"
}
```

## Response Elements
<a name="API_SSMContacts_CreateRotationOverride_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.

 ** [RotationOverrideId](#API_SSMContacts_CreateRotationOverride_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_CreateRotationOverride-response-RotationOverrideId"></a>
The Amazon Resource Name (ARN) of the created rotation override.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 39.  
Pattern: `([a-fA-Z0-9]{8,11}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}){1}` 

## Errors
<a name="API_SSMContacts_CreateRotationOverride_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
Request would cause a service quota to be exceeded.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_SSMContacts_CreateRotationOverride_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-contacts-2021-05-03/CreateRotationOverride) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/CreateRotationOverride) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/CreateRotationOverride) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/CreateRotationOverride) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/CreateRotationOverride) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/CreateRotationOverride) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/CreateRotationOverride) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/CreateRotationOverride) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/CreateRotationOverride) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/CreateRotationOverride) 

# DeactivateContactChannel
<a name="API_SSMContacts_DeactivateContactChannel"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.

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

```
{
   "ContactChannelId": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_DeactivateContactChannel_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ContactChannelId](#API_SSMContacts_DeactivateContactChannel_RequestSyntax) **   <a name="IncidentManager-SSMContacts_DeactivateContactChannel-request-ContactChannelId"></a>
The Amazon Resource Name (ARN) of the contact channel you're deactivating.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

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

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

## Errors
<a name="API_SSMContacts_DeactivateContactChannel_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of DeactivateContactChannel.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.DeactivateContactChannel
Content-Type: application/x-amz-json-1.1
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-contacts.deactivate-contact-channel
X-Amz-Date: 20220817T184424Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220817/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 126

{
	"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/e5bd2c57-406a-487f-8d26-7c032EXAMPLE"
}
```

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

```
{}
```

## See Also
<a name="API_SSMContacts_DeactivateContactChannel_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-contacts-2021-05-03/DeactivateContactChannel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/DeactivateContactChannel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/DeactivateContactChannel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/DeactivateContactChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/DeactivateContactChannel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/DeactivateContactChannel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/DeactivateContactChannel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/DeactivateContactChannel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/DeactivateContactChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/DeactivateContactChannel) 

# DeleteContact
<a name="API_SSMContacts_DeleteContact"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

To remove a contact from Incident Manager, you can delete the contact. However, deleting a contact does not remove it from escalation plans and related response plans. Deleting an escalation plan also does not remove it from all related response plans. To modify an escalation plan, we recommend using the [UpdateContact](API_SSMContacts_UpdateContact.md) action to specify a different existing contact.

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

```
{
   "ContactId": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_DeleteContact_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ContactId](#API_SSMContacts_DeleteContact_RequestSyntax) **   <a name="IncidentManager-SSMContacts_DeleteContact-request-ContactId"></a>
The Amazon Resource Name (ARN) of the contact that you're deleting.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

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

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

## Errors
<a name="API_SSMContacts_DeleteContact_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: 400

 ** ConflictException **   
Updating or deleting a resource causes an inconsistent state.  
HTTP Status Code: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of DeleteContact.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.DeleteContact
Content-Type: application/x-amz-json-1.1
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-contacts.delete-contact
X-Amz-Date: 20220817T184920Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220817/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 74

{
	"ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
}
```

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

```
{}
```

## See Also
<a name="API_SSMContacts_DeleteContact_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-contacts-2021-05-03/DeleteContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/DeleteContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/DeleteContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/DeleteContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/DeleteContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/DeleteContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/DeleteContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/DeleteContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/DeleteContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/DeleteContact) 

# DeleteContactChannel
<a name="API_SSMContacts_DeleteContactChannel"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

To stop receiving engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel does not remove it from the contact's engagement plan, but the stage that includes the channel will be ignored. If you delete the only contact channel for a contact, you'll no longer be able to engage that contact during an incident.

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

```
{
   "ContactChannelId": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_DeleteContactChannel_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ContactChannelId](#API_SSMContacts_DeleteContactChannel_RequestSyntax) **   <a name="IncidentManager-SSMContacts_DeleteContactChannel-request-ContactChannelId"></a>
The Amazon Resource Name (ARN) of the contact channel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

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

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

## Errors
<a name="API_SSMContacts_DeleteContactChannel_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of DeleteContactChannel.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.DeleteContactChannel
Content-Type: application/x-amz-json-1.1
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-contacts.delete-contact-channel
X-Amz-Date: 20220817T184639Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220817/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 126

{
	"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/e5bd2c57-406a-487f-8d26-7c032EXAMPLE"
}
```

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

```
{}
```

## See Also
<a name="API_SSMContacts_DeleteContactChannel_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-contacts-2021-05-03/DeleteContactChannel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/DeleteContactChannel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/DeleteContactChannel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/DeleteContactChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/DeleteContactChannel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/DeleteContactChannel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/DeleteContactChannel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/DeleteContactChannel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/DeleteContactChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/DeleteContactChannel) 

# DeleteRotation
<a name="API_SSMContacts_DeleteRotation"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Deletes a rotation from the system. If a rotation belongs to more than one on-call schedule, this operation deletes it from all of them.

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

```
{
   "RotationId": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_DeleteRotation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [RotationId](#API_SSMContacts_DeleteRotation_RequestSyntax) **   <a name="IncidentManager-SSMContacts_DeleteRotation-request-RotationId"></a>
The Amazon Resource Name (ARN) of the on-call rotation to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

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

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

## Errors
<a name="API_SSMContacts_DeleteRotation_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: 400

 ** ConflictException **   
Updating or deleting a resource causes an inconsistent state.  
HTTP Status Code: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_SSMContacts_DeleteRotation_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-contacts-2021-05-03/DeleteRotation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/DeleteRotation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/DeleteRotation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/DeleteRotation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/DeleteRotation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/DeleteRotation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/DeleteRotation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/DeleteRotation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/DeleteRotation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/DeleteRotation) 

# DeleteRotationOverride
<a name="API_SSMContacts_DeleteRotationOverride"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Deletes an existing override for an on-call rotation.

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

```
{
   "RotationId": "string",
   "RotationOverrideId": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_DeleteRotationOverride_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [RotationId](#API_SSMContacts_DeleteRotationOverride_RequestSyntax) **   <a name="IncidentManager-SSMContacts_DeleteRotationOverride-request-RotationId"></a>
The Amazon Resource Name (ARN) of the rotation that was overridden.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

 ** [RotationOverrideId](#API_SSMContacts_DeleteRotationOverride_RequestSyntax) **   <a name="IncidentManager-SSMContacts_DeleteRotationOverride-request-RotationOverrideId"></a>
The Amazon Resource Name (ARN) of the on-call rotation override to delete.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 39.  
Pattern: `([a-fA-Z0-9]{8,11}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}){1}`   
Required: Yes

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

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

## Errors
<a name="API_SSMContacts_DeleteRotationOverride_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_SSMContacts_DeleteRotationOverride_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-contacts-2021-05-03/DeleteRotationOverride) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/DeleteRotationOverride) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/DeleteRotationOverride) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/DeleteRotationOverride) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/DeleteRotationOverride) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/DeleteRotationOverride) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/DeleteRotationOverride) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/DeleteRotationOverride) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/DeleteRotationOverride) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/DeleteRotationOverride) 

# DescribeEngagement
<a name="API_SSMContacts_DescribeEngagement"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.

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

```
{
   "EngagementId": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_DescribeEngagement_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EngagementId](#API_SSMContacts_DescribeEngagement_RequestSyntax) **   <a name="IncidentManager-SSMContacts_DescribeEngagement-request-EngagementId"></a>
The Amazon Resource Name (ARN) of the engagement you want the details of.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

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

```
{
   "ContactArn": "string",
   "Content": "string",
   "EngagementArn": "string",
   "IncidentId": "string",
   "PublicContent": "string",
   "PublicSubject": "string",
   "Sender": "string",
   "StartTime": number,
   "StopTime": number,
   "Subject": "string"
}
```

## Response Elements
<a name="API_SSMContacts_DescribeEngagement_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.

 ** [ContactArn](#API_SSMContacts_DescribeEngagement_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribeEngagement-response-ContactArn"></a>
The ARN of the escalation plan or contacts involved in the engagement.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*` 

 ** [Content](#API_SSMContacts_DescribeEngagement_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribeEngagement-response-Content"></a>
The secure content of the message that was sent to the contact. Use this field for engagements to `VOICE` and `EMAIL`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Pattern: `^[.\s\S]*$` 

 ** [EngagementArn](#API_SSMContacts_DescribeEngagement_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribeEngagement-response-EngagementArn"></a>
The ARN of the engagement.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*` 

 ** [IncidentId](#API_SSMContacts_DescribeEngagement_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribeEngagement-response-IncidentId"></a>
The ARN of the incident in which the engagement occurred.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `^[\\a-zA-Z0-9_@#%*+=:?.\/!\s-]*$` 

 ** [PublicContent](#API_SSMContacts_DescribeEngagement_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribeEngagement-response-PublicContent"></a>
The insecure content of the message that was sent to the contact. Use this field for engagements to `SMS`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Pattern: `^[.\s\S]*$` 

 ** [PublicSubject](#API_SSMContacts_DescribeEngagement_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribeEngagement-response-PublicSubject"></a>
The insecure subject of the message that was sent to the contact. Use this field for engagements to `SMS`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[.\s\S]*$` 

 ** [Sender](#API_SSMContacts_DescribeEngagement_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribeEngagement-response-Sender"></a>
The user that started the engagement.  
Type: String  
Length Constraints: Maximum length of 255.  
Pattern: `^[\\a-zA-Z0-9_@#%*+=:?.\/!\s-]*$` 

 ** [StartTime](#API_SSMContacts_DescribeEngagement_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribeEngagement-response-StartTime"></a>
The time that the engagement started.  
Type: Timestamp

 ** [StopTime](#API_SSMContacts_DescribeEngagement_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribeEngagement-response-StopTime"></a>
The time that the engagement ended.  
Type: Timestamp

 ** [Subject](#API_SSMContacts_DescribeEngagement_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribeEngagement-response-Subject"></a>
The secure subject of the message that was sent to the contact. Use this field for engagements to `VOICE` and `EMAIL`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[.\s\S]*$` 

## Errors
<a name="API_SSMContacts_DescribeEngagement_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: 400

 ** DataEncryptionException **   
The operation failed to due an encryption key error.  
HTTP Status Code: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of DescribeEngagement.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.DescribeEngagement
Content-Type: application/x-amz-json-1.1
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-contacts.describe-engagement
X-Amz-Date: 20220816T192348Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220816/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 132

{
	"EngagementId": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/test_escalation_plan/27bd86cf-6d50-49d2-a9ab-da39bEXAMPLE"
}
```

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

```
{
    "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/test_escalation_plan",
    "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/test_escalation_plan/27bd86cf-6d50-49d2-a9ab-da39bEXAMPLE",
    "Sender": "cli",
    "Subject": "cli-test",
    "Content": "Testing engagements via CLI",
    "PublicSubject": "cli-test",
    "PublicContent": "Testing engagements via CLI",
    "StartTime": "2022-08-16T18:48:50.153000+00:00"
}
```

## See Also
<a name="API_SSMContacts_DescribeEngagement_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-contacts-2021-05-03/DescribeEngagement) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/DescribeEngagement) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/DescribeEngagement) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/DescribeEngagement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/DescribeEngagement) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/DescribeEngagement) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/DescribeEngagement) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/DescribeEngagement) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/DescribeEngagement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/DescribeEngagement) 

# DescribePage
<a name="API_SSMContacts_DescribePage"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Lists details of the engagement to a contact channel.

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

```
{
   "PageId": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_DescribePage_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [PageId](#API_SSMContacts_DescribePage_RequestSyntax) **   <a name="IncidentManager-SSMContacts_DescribePage-request-PageId"></a>
The ID of the engagement to a contact channel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

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

```
{
   "ContactArn": "string",
   "Content": "string",
   "DeliveryTime": number,
   "EngagementArn": "string",
   "IncidentId": "string",
   "PageArn": "string",
   "PublicContent": "string",
   "PublicSubject": "string",
   "ReadTime": number,
   "Sender": "string",
   "SentTime": number,
   "Subject": "string"
}
```

## Response Elements
<a name="API_SSMContacts_DescribePage_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.

 ** [ContactArn](#API_SSMContacts_DescribePage_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribePage-response-ContactArn"></a>
The ARN of the contact that was engaged.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*` 

 ** [Content](#API_SSMContacts_DescribePage_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribePage-response-Content"></a>
The secure content of the message that was sent to the contact. Use this field for engagements to `VOICE` and `EMAIL`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Pattern: `^[.\s\S]*$` 

 ** [DeliveryTime](#API_SSMContacts_DescribePage_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribePage-response-DeliveryTime"></a>
The time that the contact channel received the engagement.  
Type: Timestamp

 ** [EngagementArn](#API_SSMContacts_DescribePage_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribePage-response-EngagementArn"></a>
The ARN of the engagement that engaged the contact channel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*` 

 ** [IncidentId](#API_SSMContacts_DescribePage_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribePage-response-IncidentId"></a>
The ARN of the incident that engaged the contact channel.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `^[\\a-zA-Z0-9_@#%*+=:?.\/!\s-]*$` 

 ** [PageArn](#API_SSMContacts_DescribePage_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribePage-response-PageArn"></a>
The Amazon Resource Name (ARN) of the engagement to a contact channel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*` 

 ** [PublicContent](#API_SSMContacts_DescribePage_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribePage-response-PublicContent"></a>
The insecure content of the message that was sent to the contact. Use this field for engagements to `SMS`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Pattern: `^[.\s\S]*$` 

 ** [PublicSubject](#API_SSMContacts_DescribePage_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribePage-response-PublicSubject"></a>
The insecure subject of the message that was sent to the contact. Use this field for engagements to `SMS`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[.\s\S]*$` 

 ** [ReadTime](#API_SSMContacts_DescribePage_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribePage-response-ReadTime"></a>
The time that the contact channel acknowledged the engagement.  
Type: Timestamp

 ** [Sender](#API_SSMContacts_DescribePage_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribePage-response-Sender"></a>
The user that started the engagement.  
Type: String  
Length Constraints: Maximum length of 255.  
Pattern: `^[\\a-zA-Z0-9_@#%*+=:?.\/!\s-]*$` 

 ** [SentTime](#API_SSMContacts_DescribePage_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribePage-response-SentTime"></a>
The time the engagement was sent to the contact channel.  
Type: Timestamp

 ** [Subject](#API_SSMContacts_DescribePage_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_DescribePage-response-Subject"></a>
The secure subject of the message that was sent to the contact. Use this field for engagements to `VOICE` and `EMAIL`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[.\s\S]*$` 

## Errors
<a name="API_SSMContacts_DescribePage_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: 400

 ** DataEncryptionException **   
The operation failed to due an encryption key error.  
HTTP Status Code: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of DescribePage.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.DescribePage
Content-Type: application/x-amz-json-1.1
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-contacts.describe-page
X-Amz-Date: 20220816T193722Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220816/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 105

{
	"PageId": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/2f92b456-2350-442b-95e7-ed8b0EXAMPLE"
}
```

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

```
{
    "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/2f92b456-2350-442b-95e7-ed8b0EXAMPLE",
    "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/27bd86cf-6d50-49d2-a9ab-da39bEXAMPLE",
    "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
    "Sender": "cli",
    "Subject": "cli-test",
    "Content": "Testing engagements via CLI",
    "PublicSubject": "cli-test",
    "PublicContent": "Testing engagements via CLI",
    "SentTime": "2022-08-16T18:57:52.058000+00:00",
    "ReadTime": "2022-08-16T19:11:58.746000+00:00"
}
```

## See Also
<a name="API_SSMContacts_DescribePage_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-contacts-2021-05-03/DescribePage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/DescribePage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/DescribePage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/DescribePage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/DescribePage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/DescribePage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/DescribePage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/DescribePage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/DescribePage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/DescribePage) 

# GetContact
<a name="API_SSMContacts_GetContact"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Retrieves information about the specified contact or escalation plan.

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

```
{
   "ContactId": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_GetContact_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ContactId](#API_SSMContacts_GetContact_RequestSyntax) **   <a name="IncidentManager-SSMContacts_GetContact-request-ContactId"></a>
The Amazon Resource Name (ARN) of the contact or escalation plan.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

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

```
{
   "Alias": "string",
   "ContactArn": "string",
   "DisplayName": "string",
   "Plan": { 
      "RotationIds": [ "string" ],
      "Stages": [ 
         { 
            "DurationInMinutes": number,
            "Targets": [ 
               { 
                  "ChannelTargetInfo": { 
                     "ContactChannelId": "string",
                     "RetryIntervalInMinutes": number
                  },
                  "ContactTargetInfo": { 
                     "ContactId": "string",
                     "IsEssential": boolean
                  }
               }
            ]
         }
      ]
   },
   "Type": "string"
}
```

## Response Elements
<a name="API_SSMContacts_GetContact_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.

 ** [Alias](#API_SSMContacts_GetContact_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetContact-response-Alias"></a>
The alias of the contact or escalation plan. The alias is unique and identifiable.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-z0-9_\-]*$` 

 ** [ContactArn](#API_SSMContacts_GetContact_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetContact-response-ContactArn"></a>
The ARN of the contact or escalation plan.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*` 

 ** [DisplayName](#API_SSMContacts_GetContact_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetContact-response-DisplayName"></a>
The full name of the contact or escalation plan.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `^[\p{L}\p{Z}\p{N}_.\-]*$` 

 ** [Plan](#API_SSMContacts_GetContact_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetContact-response-Plan"></a>
Details about the specific timing or stages and targets of the escalation plan or engagement plan.  
Type: [Plan](API_SSMContacts_Plan.md) object

 ** [Type](#API_SSMContacts_GetContact_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetContact-response-Type"></a>
The type of contact.  
Type: String  
Valid Values: `PERSONAL | ESCALATION | ONCALL_SCHEDULE` 

## Errors
<a name="API_SSMContacts_GetContact_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: 400

 ** DataEncryptionException **   
The operation failed to due an encryption key error.  
HTTP Status Code: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of GetContact.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.GetContact
Content-Type: application/x-amz-json-1.1
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-contacts.get-contact
X-Amz-Date: 20220816T210534Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220816/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 74

{
	"ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
}
```

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

```
{
    "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
    "Alias": "akuam",
    "DisplayName": "Akua Mansa",
    "Type": "PERSONAL",
    "Plan": {
        "Stages": [
            {
                "DurationInMinutes": 5,
                "Targets": [
                    {
                        "ChannelTargetInfo": {
                            "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/31111aa5-9b84-4591-a5a6-5a8f9EXAMPLE",
                            "RetryIntervalInMinutes": 1
                        }
                    }
                ]
            },
            {
                "DurationInMinutes": 5,
                "Targets": [
                    {
                        "ChannelTargetInfo": {
                            "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/e5bd2c57-406a-487f-8d26-7c032EXAMPLE",
                            "RetryIntervalInMinutes": 1
                        }
                    }
                ]
            }
        ]
    }
}
```

## See Also
<a name="API_SSMContacts_GetContact_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-contacts-2021-05-03/GetContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/GetContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/GetContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/GetContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/GetContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/GetContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/GetContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/GetContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/GetContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/GetContact) 

# GetContactChannel
<a name="API_SSMContacts_GetContactChannel"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

List details about a specific contact channel.

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

```
{
   "ContactChannelId": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_GetContactChannel_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ContactChannelId](#API_SSMContacts_GetContactChannel_RequestSyntax) **   <a name="IncidentManager-SSMContacts_GetContactChannel-request-ContactChannelId"></a>
The Amazon Resource Name (ARN) of the contact channel you want information about.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

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

```
{
   "ActivationStatus": "string",
   "ContactArn": "string",
   "ContactChannelArn": "string",
   "DeliveryAddress": { 
      "SimpleAddress": "string"
   },
   "Name": "string",
   "Type": "string"
}
```

## Response Elements
<a name="API_SSMContacts_GetContactChannel_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.

 ** [ActivationStatus](#API_SSMContacts_GetContactChannel_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetContactChannel-response-ActivationStatus"></a>
A Boolean value indicating if the contact channel has been activated or not.  
Type: String  
Valid Values: `ACTIVATED | NOT_ACTIVATED` 

 ** [ContactArn](#API_SSMContacts_GetContactChannel_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetContactChannel-response-ContactArn"></a>
The ARN of the contact that the channel belongs to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*` 

 ** [ContactChannelArn](#API_SSMContacts_GetContactChannel_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetContactChannel-response-ContactChannelArn"></a>
The ARN of the contact channel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*` 

 ** [DeliveryAddress](#API_SSMContacts_GetContactChannel_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetContactChannel-response-DeliveryAddress"></a>
The details that Incident Manager uses when trying to engage the contact channel.  
Type: [ContactChannelAddress](API_SSMContacts_ContactChannelAddress.md) object

 ** [Name](#API_SSMContacts_GetContactChannel_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetContactChannel-response-Name"></a>
The name of the contact channel  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[\p{L}\p{Z}\p{N}_.\-]*$` 

 ** [Type](#API_SSMContacts_GetContactChannel_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetContactChannel-response-Type"></a>
The type of contact channel. The type is `SMS`, `VOICE`, or `EMAIL`.  
Type: String  
Valid Values: `SMS | VOICE | EMAIL` 

## Errors
<a name="API_SSMContacts_GetContactChannel_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: 400

 ** DataEncryptionException **   
The operation failed to due an encryption key error.  
HTTP Status Code: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of GetContactChannel.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.GetContactChannel
Content-Type: application/x-amz-json-1.1
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-contacts.get-contact-channel
X-Amz-Date: 20220816T211314Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220816/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 126

{
	"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/e5bd2c57-406a-487f-8d26-7c032EXAMPLE"
}
```

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

```
{
    "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
    "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/e5bd2c57-406a-487f-8d26-7c032EXAMPLE",
    "Name": "akuas voice channel",
    "Type": "SMS",
    "DeliveryAddress": {
        "SimpleAddress": "+15005550199"
    },
    "ActivationStatus": "ACTIVATED"
}
```

## See Also
<a name="API_SSMContacts_GetContactChannel_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-contacts-2021-05-03/GetContactChannel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/GetContactChannel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/GetContactChannel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/GetContactChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/GetContactChannel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/GetContactChannel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/GetContactChannel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/GetContactChannel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/GetContactChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/GetContactChannel) 

# GetContactPolicy
<a name="API_SSMContacts_GetContactPolicy"></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 [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 contact or escalation plan.

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

```
{
   "ContactArn": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_GetContactPolicy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ContactArn](#API_SSMContacts_GetContactPolicy_RequestSyntax) **   <a name="IncidentManager-SSMContacts_GetContactPolicy-request-ContactArn"></a>
The Amazon Resource Name (ARN) of the contact or escalation plan.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

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

```
{
   "ContactArn": "string",
   "Policy": "string"
}
```

## Response Elements
<a name="API_SSMContacts_GetContactPolicy_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.

 ** [ContactArn](#API_SSMContacts_GetContactPolicy_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetContactPolicy-response-ContactArn"></a>
The ARN of the contact or escalation plan.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*` 

 ** [Policy](#API_SSMContacts_GetContactPolicy_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetContactPolicy-response-Policy"></a>
Details about the resource policy attached to the contact or escalation plan.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 395000.  
Pattern: `.*\S.*` 

## Errors
<a name="API_SSMContacts_GetContactPolicy_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of GetContactPolicy.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.GetContactPolicy
Content-Type: application/x-amz-json-1.1
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-contacts.get-contact-policy
X-Amz-Date: 20220816T213040Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220816/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 75

{
	"ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
}
```

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

```
{
    "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
    "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"ExampleResourcePolicy\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"444455556666\"},\"Action\":[\"ssm-contacts:GetContact\",\"ssm-contacts:StartEngagement\",\"ssm-contacts:DescribeEngagement\",\"ssm-contacts:ListPagesByEngagement\",\"ssm-contacts:StopEngagement\"],\"Resource\":[\"arn:aws:ssm-contacts:*:111122223333:contact/akuam\",\"arn:aws:ssm-contacts:*:111122223333:engagement/akuam/*\"]}]}"
}
```

## See Also
<a name="API_SSMContacts_GetContactPolicy_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-contacts-2021-05-03/GetContactPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/GetContactPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/GetContactPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/GetContactPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/GetContactPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/GetContactPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/GetContactPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/GetContactPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/GetContactPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/GetContactPolicy) 

# GetRotation
<a name="API_SSMContacts_GetRotation"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Retrieves information about an on-call rotation.

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

```
{
   "RotationId": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_GetRotation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [RotationId](#API_SSMContacts_GetRotation_RequestSyntax) **   <a name="IncidentManager-SSMContacts_GetRotation-request-RotationId"></a>
The Amazon Resource Name (ARN) of the on-call rotation to retrieve information about.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

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

```
{
   "ContactIds": [ "string" ],
   "Name": "string",
   "Recurrence": { 
      "DailySettings": [ 
         { 
            "HourOfDay": number,
            "MinuteOfHour": number
         }
      ],
      "MonthlySettings": [ 
         { 
            "DayOfMonth": number,
            "HandOffTime": { 
               "HourOfDay": number,
               "MinuteOfHour": number
            }
         }
      ],
      "NumberOfOnCalls": number,
      "RecurrenceMultiplier": number,
      "ShiftCoverages": { 
         "string" : [ 
            { 
               "End": { 
                  "HourOfDay": number,
                  "MinuteOfHour": number
               },
               "Start": { 
                  "HourOfDay": number,
                  "MinuteOfHour": number
               }
            }
         ]
      },
      "WeeklySettings": [ 
         { 
            "DayOfWeek": "string",
            "HandOffTime": { 
               "HourOfDay": number,
               "MinuteOfHour": number
            }
         }
      ]
   },
   "RotationArn": "string",
   "StartTime": number,
   "TimeZoneId": "string"
}
```

## Response Elements
<a name="API_SSMContacts_GetRotation_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.

 ** [ContactIds](#API_SSMContacts_GetRotation_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetRotation-response-ContactIds"></a>
The Amazon Resource Names (ARNs) of the contacts assigned to the on-call rotation team.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 30 items.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*` 

 ** [Name](#API_SSMContacts_GetRotation_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetRotation-response-Name"></a>
The name of the on-call rotation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9_\-\s\.]*$` 

 ** [Recurrence](#API_SSMContacts_GetRotation_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetRotation-response-Recurrence"></a>
Specifies how long a rotation lasts before restarting at the beginning of the shift order.  
Type: [RecurrenceSettings](API_SSMContacts_RecurrenceSettings.md) object

 ** [RotationArn](#API_SSMContacts_GetRotation_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetRotation-response-RotationArn"></a>
The Amazon Resource Name (ARN) of the on-call rotation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*` 

 ** [StartTime](#API_SSMContacts_GetRotation_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetRotation-response-StartTime"></a>
The specified start time for the on-call rotation.  
Type: Timestamp

 ** [TimeZoneId](#API_SSMContacts_GetRotation_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetRotation-response-TimeZoneId"></a>
The time zone that the rotation’s activity is based on, in Internet Assigned Numbers Authority (IANA) format.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[:a-zA-Z0-9_\-\s\.\\/]*$` 

## Errors
<a name="API_SSMContacts_GetRotation_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_SSMContacts_GetRotation_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-contacts-2021-05-03/GetRotation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/GetRotation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/GetRotation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/GetRotation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/GetRotation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/GetRotation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/GetRotation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/GetRotation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/GetRotation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/GetRotation) 

# GetRotationOverride
<a name="API_SSMContacts_GetRotationOverride"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Retrieves information about an override to an on-call rotation.

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

```
{
   "RotationId": "string",
   "RotationOverrideId": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_GetRotationOverride_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [RotationId](#API_SSMContacts_GetRotationOverride_RequestSyntax) **   <a name="IncidentManager-SSMContacts_GetRotationOverride-request-RotationId"></a>
The Amazon Resource Name (ARN) of the overridden rotation to retrieve information about.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

 ** [RotationOverrideId](#API_SSMContacts_GetRotationOverride_RequestSyntax) **   <a name="IncidentManager-SSMContacts_GetRotationOverride-request-RotationOverrideId"></a>
The Amazon Resource Name (ARN) of the on-call rotation override to retrieve information about.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 39.  
Pattern: `([a-fA-Z0-9]{8,11}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}){1}`   
Required: Yes

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

```
{
   "CreateTime": number,
   "EndTime": number,
   "NewContactIds": [ "string" ],
   "RotationArn": "string",
   "RotationOverrideId": "string",
   "StartTime": number
}
```

## Response Elements
<a name="API_SSMContacts_GetRotationOverride_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.

 ** [CreateTime](#API_SSMContacts_GetRotationOverride_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetRotationOverride-response-CreateTime"></a>
The date and time when the override was created.  
Type: Timestamp

 ** [EndTime](#API_SSMContacts_GetRotationOverride_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetRotationOverride-response-EndTime"></a>
The date and time when the override ends.  
Type: Timestamp

 ** [NewContactIds](#API_SSMContacts_GetRotationOverride_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetRotationOverride-response-NewContactIds"></a>
The Amazon Resource Names (ARNs) of the contacts assigned to the override of the on-call rotation.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 25 items.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*` 

 ** [RotationArn](#API_SSMContacts_GetRotationOverride_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetRotationOverride-response-RotationArn"></a>
The Amazon Resource Name (ARN) of the on-call rotation that was overridden.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*` 

 ** [RotationOverrideId](#API_SSMContacts_GetRotationOverride_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetRotationOverride-response-RotationOverrideId"></a>
The Amazon Resource Name (ARN) of the override to an on-call rotation.  
Type: String  
Length Constraints: Minimum length of 36. Maximum length of 39.  
Pattern: `([a-fA-Z0-9]{8,11}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}){1}` 

 ** [StartTime](#API_SSMContacts_GetRotationOverride_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_GetRotationOverride-response-StartTime"></a>
The date and time when the override goes into effect.  
Type: Timestamp

## Errors
<a name="API_SSMContacts_GetRotationOverride_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_SSMContacts_GetRotationOverride_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-contacts-2021-05-03/GetRotationOverride) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/GetRotationOverride) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/GetRotationOverride) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/GetRotationOverride) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/GetRotationOverride) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/GetRotationOverride) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/GetRotationOverride) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/GetRotationOverride) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/GetRotationOverride) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/GetRotationOverride) 

# ListContactChannels
<a name="API_SSMContacts_ListContactChannels"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Lists all contact channels for the specified contact.

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

```
{
   "ContactId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_ListContactChannels_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ContactId](#API_SSMContacts_ListContactChannels_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListContactChannels-request-ContactId"></a>
The Amazon Resource Name (ARN) of the contact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

 ** [MaxResults](#API_SSMContacts_ListContactChannels_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListContactChannels-request-MaxResults"></a>
The maximum number of contact channels per page.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1024.  
Required: No

 ** [NextToken](#API_SSMContacts_ListContactChannels_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListContactChannels-request-NextToken"></a>
The pagination token to continue to the next page of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$`   
Required: No

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

```
{
   "ContactChannels": [ 
      { 
         "ActivationStatus": "string",
         "ContactArn": "string",
         "ContactChannelArn": "string",
         "DeliveryAddress": { 
            "SimpleAddress": "string"
         },
         "Name": "string",
         "Type": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_SSMContacts_ListContactChannels_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.

 ** [ContactChannels](#API_SSMContacts_ListContactChannels_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListContactChannels-response-ContactChannels"></a>
A list of contact channels related to the specified contact.  
Type: Array of [ContactChannel](API_SSMContacts_ContactChannel.md) objects

 ** [NextToken](#API_SSMContacts_ListContactChannels_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListContactChannels-response-NextToken"></a>
The pagination token to continue to the next page of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$` 

## Errors
<a name="API_SSMContacts_ListContactChannels_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: 400

 ** DataEncryptionException **   
The operation failed to due an encryption key error.  
HTTP Status Code: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of ListContactChannels.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.ListContactChannels
Content-Type: application/x-amz-json-1.1
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-contacts.list-contact-channels
X-Amz-Date: 20220812T180323Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220812/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 74

{
	"ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
}
```

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

```
{
    "ContactChannels": [
        {
            "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/31111aa5-9b84-4591-a5a6-5a8f9EXAMPLE",
            "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
            "Name": "akuas email-test",
            "Type": "EMAIL",
            "DeliveryAddress": {
                "SimpleAddress": "akuam@example.com"
            },
            "ActivationStatus": "ACTIVATED"
        },
        {
            "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/e5bd2c57-406a-487f-8d26-7c032EXAMPLE",
            "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
            "Name": "akuas sms-test",
            "Type": "SMS",
            "DeliveryAddress": {
                "SimpleAddress": "+15005550199"
            },
            "ActivationStatus": "ACTIVATED"
        }
    ]
}
```

## See Also
<a name="API_SSMContacts_ListContactChannels_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-contacts-2021-05-03/ListContactChannels) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/ListContactChannels) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/ListContactChannels) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/ListContactChannels) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/ListContactChannels) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/ListContactChannels) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/ListContactChannels) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/ListContactChannels) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/ListContactChannels) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/ListContactChannels) 

# ListContacts
<a name="API_SSMContacts_ListContacts"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Lists all contacts and escalation plans in Incident Manager.

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

```
{
   "AliasPrefix": "string",
   "MaxResults": number,
   "NextToken": "string",
   "Type": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_ListContacts_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AliasPrefix](#API_SSMContacts_ListContacts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListContacts-request-AliasPrefix"></a>
Used to list only contacts who's aliases start with the specified prefix.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-z0-9_\-]*$`   
Required: No

 ** [MaxResults](#API_SSMContacts_ListContacts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListContacts-request-MaxResults"></a>
The maximum number of contacts and escalation plans per page of results.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1024.  
Required: No

 ** [NextToken](#API_SSMContacts_ListContacts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListContacts-request-NextToken"></a>
The pagination token to continue to the next page of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$`   
Required: No

 ** [Type](#API_SSMContacts_ListContacts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListContacts-request-Type"></a>
The type of contact.  
Type: String  
Valid Values: `PERSONAL | ESCALATION | ONCALL_SCHEDULE`   
Required: No

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

```
{
   "Contacts": [ 
      { 
         "Alias": "string",
         "ContactArn": "string",
         "DisplayName": "string",
         "Type": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_SSMContacts_ListContacts_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.

 ** [Contacts](#API_SSMContacts_ListContacts_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListContacts-response-Contacts"></a>
A list of the contacts and escalation plans in your Incident Manager account.  
Type: Array of [Contact](API_SSMContacts_Contact.md) objects

 ** [NextToken](#API_SSMContacts_ListContacts_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListContacts-response-NextToken"></a>
The pagination token to continue to the next page of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$` 

## Errors
<a name="API_SSMContacts_ListContacts_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of ListContacts.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.ListContacts
Content-Type: application/x-amz-json-1.1
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-contacts.list-contacts
X-Amz-Date: 20220816T215005Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220816/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 2

{}
```

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

```
{
    "Contacts": [
        {
            "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
            "Alias": "akuam",
            "DisplayName": "Akua Mansa",
            "Type": "PERSONAL"
        },
        {
            "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/test_escalation_plan",
            "Alias": "test_escalation_plan",
            "DisplayName": "Test Escalation Plan",
            "Type": "ESCALATION"
        }
    ]
}
```

## See Also
<a name="API_SSMContacts_ListContacts_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-contacts-2021-05-03/ListContacts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/ListContacts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/ListContacts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/ListContacts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/ListContacts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/ListContacts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/ListContacts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/ListContacts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/ListContacts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/ListContacts) 

# ListEngagements
<a name="API_SSMContacts_ListEngagements"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Lists all engagements that have happened in an incident.

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

```
{
   "IncidentId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "TimeRangeValue": { 
      "EndTime": number,
      "StartTime": number
   }
}
```

## Request Parameters
<a name="API_SSMContacts_ListEngagements_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [IncidentId](#API_SSMContacts_ListEngagements_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListEngagements-request-IncidentId"></a>
The Amazon Resource Name (ARN) of the incident you're listing engagements for.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `^[\\a-zA-Z0-9_@#%*+=:?.\/!\s-]*$`   
Required: No

 ** [MaxResults](#API_SSMContacts_ListEngagements_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListEngagements-request-MaxResults"></a>
The maximum number of engagements per page of results.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1024.  
Required: No

 ** [NextToken](#API_SSMContacts_ListEngagements_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListEngagements-request-NextToken"></a>
The pagination token to continue to the next page of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$`   
Required: No

 ** [TimeRangeValue](#API_SSMContacts_ListEngagements_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListEngagements-request-TimeRangeValue"></a>
The time range to lists engagements for an incident.  
Type: [TimeRange](API_SSMContacts_TimeRange.md) object  
Required: No

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

```
{
   "Engagements": [ 
      { 
         "ContactArn": "string",
         "EngagementArn": "string",
         "IncidentId": "string",
         "Sender": "string",
         "StartTime": number,
         "StopTime": number
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_SSMContacts_ListEngagements_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.

 ** [Engagements](#API_SSMContacts_ListEngagements_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListEngagements-response-Engagements"></a>
A list of each engagement that occurred during the specified time range of an incident.  
Type: Array of [Engagement](API_SSMContacts_Engagement.md) objects

 ** [NextToken](#API_SSMContacts_ListEngagements_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListEngagements-response-NextToken"></a>
The pagination token to continue to the next page of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$` 

## Errors
<a name="API_SSMContacts_ListEngagements_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of ListEngagements.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.ListEngagements
Content-Type: application/x-amz-json-1.1
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-contacts.list-engagements
X-Amz-Date: 20220816T191844Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220816/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 2

{}
```

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

```
{
    "Engagements": [
        {
            "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/test_escalation_plan/27bd86cf-6d50-49d2-a9ab-da39bEXAMPLE",
            "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/test_escalation_plan",
            "Sender": "cli",
            "StartTime": "2022-08-16T18:48:50.153000+00:00"
        }
    ]
}
```

## See Also
<a name="API_SSMContacts_ListEngagements_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-contacts-2021-05-03/ListEngagements) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/ListEngagements) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/ListEngagements) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/ListEngagements) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/ListEngagements) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/ListEngagements) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/ListEngagements) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/ListEngagements) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/ListEngagements) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/ListEngagements) 

# ListPageReceipts
<a name="API_SSMContacts_ListPageReceipts"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Lists all of the engagements to contact channels that have been acknowledged.

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

```
{
   "MaxResults": number,
   "NextToken": "string",
   "PageId": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_ListPageReceipts_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_SSMContacts_ListPageReceipts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListPageReceipts-request-MaxResults"></a>
The maximum number of acknowledgements per page of results.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1024.  
Required: No

 ** [NextToken](#API_SSMContacts_ListPageReceipts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListPageReceipts-request-NextToken"></a>
The pagination token to continue to the next page of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$`   
Required: No

 ** [PageId](#API_SSMContacts_ListPageReceipts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListPageReceipts-request-PageId"></a>
The Amazon Resource Name (ARN) of the engagement to a specific contact channel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

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

```
{
   "NextToken": "string",
   "Receipts": [ 
      { 
         "ContactChannelArn": "string",
         "ReceiptInfo": "string",
         "ReceiptTime": number,
         "ReceiptType": "string"
      }
   ]
}
```

## Response Elements
<a name="API_SSMContacts_ListPageReceipts_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_SSMContacts_ListPageReceipts_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListPageReceipts-response-NextToken"></a>
The pagination token to continue to the next page of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$` 

 ** [Receipts](#API_SSMContacts_ListPageReceipts_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListPageReceipts-response-Receipts"></a>
A list of each acknowledgement.  
Type: Array of [Receipt](API_SSMContacts_Receipt.md) objects

## Errors
<a name="API_SSMContacts_ListPageReceipts_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of ListPageReceipts.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.ListPageReceipts
Content-Type: application/x-amz-json-1.1
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-contacts.list-page-receipts
X-Amz-Date: 20220816T223512Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220816/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 105

{
	"PageId": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/2f92b456-2350-442b-95e7-ed8b09c0b4ac"
}
```

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

```
{
    "Receipts": [
        {
            "ReceiptType": "READ",
            "ReceiptTime": "2022-08-16T19:11:58.746000+00:00"
        },
        {
            "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/e5bd2c57-406a-487f-8d26-7c032EXAMPLE",
            "ReceiptType": "SENT",
            "ReceiptTime": "2022-08-16T18:54:50.952000+00:00"
        },
        {
            "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/e5bd2c57-406a-487f-8d26-7c032EXAMPLE",
            "ReceiptType": "SENT",
            "ReceiptTime": "2022-08-16T18:57:52.058000+00:00"
        },
        {
            "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/e5bd2c57-406a-487f-8d26-7c032EXAMPLE",
            "ReceiptType": "SENT",
            "ReceiptTime": "2022-08-16T18:56:51.688000+00:00"
        },
        {
            "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/e5bd2c57-406a-487f-8d26-7c032EXAMPLE",
            "ReceiptType": "SENT",
            "ReceiptTime": "2022-08-16T18:55:51.265000+00:00"
        },
        {
            "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/e5bd2c57-406a-487f-8d26-7c032EXAMPLE",
            "ReceiptType": "SENT",
            "ReceiptTime": "2022-08-16T18:53:50.469000+00:00"
        }
    ]
}
```

## See Also
<a name="API_SSMContacts_ListPageReceipts_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-contacts-2021-05-03/ListPageReceipts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/ListPageReceipts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/ListPageReceipts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/ListPageReceipts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/ListPageReceipts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/ListPageReceipts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/ListPageReceipts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/ListPageReceipts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/ListPageReceipts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/ListPageReceipts) 

# ListPageResolutions
<a name="API_SSMContacts_ListPageResolutions"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Returns the resolution path of an engagement. For example, the escalation plan engaged in an incident might target an on-call schedule that includes several contacts in a rotation, but just one contact on-call when the incident starts. The resolution path indicates the hierarchy of *escalation plan > on-call schedule > contact*.

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

```
{
   "NextToken": "string",
   "PageId": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_ListPageResolutions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [NextToken](#API_SSMContacts_ListPageResolutions_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListPageResolutions-request-NextToken"></a>
A token to start the list. Use this token to get the next set of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$`   
Required: No

 ** [PageId](#API_SSMContacts_ListPageResolutions_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListPageResolutions-request-PageId"></a>
The Amazon Resource Name (ARN) of the contact engaged for the incident.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

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

```
{
   "NextToken": "string",
   "PageResolutions": [ 
      { 
         "ContactArn": "string",
         "StageIndex": number,
         "Type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_SSMContacts_ListPageResolutions_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_SSMContacts_ListPageResolutions_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListPageResolutions-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$` 

 ** [PageResolutions](#API_SSMContacts_ListPageResolutions_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListPageResolutions-response-PageResolutions"></a>
Information about the resolution for an engagement.  
Type: Array of [ResolutionContact](API_SSMContacts_ResolutionContact.md) objects

## Errors
<a name="API_SSMContacts_ListPageResolutions_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_SSMContacts_ListPageResolutions_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-contacts-2021-05-03/ListPageResolutions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/ListPageResolutions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/ListPageResolutions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/ListPageResolutions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/ListPageResolutions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/ListPageResolutions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/ListPageResolutions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/ListPageResolutions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/ListPageResolutions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/ListPageResolutions) 

# ListPagesByContact
<a name="API_SSMContacts_ListPagesByContact"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Lists the engagements to a contact's contact channels.

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

```
{
   "ContactId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_ListPagesByContact_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ContactId](#API_SSMContacts_ListPagesByContact_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListPagesByContact-request-ContactId"></a>
The Amazon Resource Name (ARN) of the contact you are retrieving engagements for.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

 ** [MaxResults](#API_SSMContacts_ListPagesByContact_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListPagesByContact-request-MaxResults"></a>
The maximum number of engagements to contact channels to list per page of results.   
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1024.  
Required: No

 ** [NextToken](#API_SSMContacts_ListPagesByContact_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListPagesByContact-request-NextToken"></a>
The pagination token to continue to the next page of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$`   
Required: No

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

```
{
   "NextToken": "string",
   "Pages": [ 
      { 
         "ContactArn": "string",
         "DeliveryTime": number,
         "EngagementArn": "string",
         "IncidentId": "string",
         "PageArn": "string",
         "ReadTime": number,
         "Sender": "string",
         "SentTime": number
      }
   ]
}
```

## Response Elements
<a name="API_SSMContacts_ListPagesByContact_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_SSMContacts_ListPagesByContact_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListPagesByContact-response-NextToken"></a>
The pagination token to continue to the next page of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$` 

 ** [Pages](#API_SSMContacts_ListPagesByContact_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListPagesByContact-response-Pages"></a>
The list of engagements to a contact's contact channel.  
Type: Array of [Page](API_SSMContacts_Page.md) objects

## Errors
<a name="API_SSMContacts_ListPagesByContact_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of ListPagesByContact.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.ListPagesByContact
Content-Type: application/x-amz-json-1.1
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-contacts.list-pages-by-contact
X-Amz-Date: 20220816T190403Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220816/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 74

{
	"ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
}
```

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

```
{
    "Pages": [
        {
            "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/2f92b456-2350-442b-95e7-ed8b0EXAMPLE",
            "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/test_escalation_plan/27bd86cf-6d50-49d2-a9ab-da39bEXAMPLE",
            "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
            "Sender": "cli",
            "SentTime": "2022-08-16T18:57:52.058000+00:00"
        }
    ]
}
```

## See Also
<a name="API_SSMContacts_ListPagesByContact_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-contacts-2021-05-03/ListPagesByContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/ListPagesByContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/ListPagesByContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/ListPagesByContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/ListPagesByContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/ListPagesByContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/ListPagesByContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/ListPagesByContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/ListPagesByContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/ListPagesByContact) 

# ListPagesByEngagement
<a name="API_SSMContacts_ListPagesByEngagement"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Lists the engagements to contact channels that occurred by engaging a contact.

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

```
{
   "EngagementId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_ListPagesByEngagement_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EngagementId](#API_SSMContacts_ListPagesByEngagement_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListPagesByEngagement-request-EngagementId"></a>
The Amazon Resource Name (ARN) of the engagement.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

 ** [MaxResults](#API_SSMContacts_ListPagesByEngagement_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListPagesByEngagement-request-MaxResults"></a>
The maximum number of engagements to contact channels to list per page of results.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1024.  
Required: No

 ** [NextToken](#API_SSMContacts_ListPagesByEngagement_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListPagesByEngagement-request-NextToken"></a>
The pagination token to continue to the next page of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$`   
Required: No

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

```
{
   "NextToken": "string",
   "Pages": [ 
      { 
         "ContactArn": "string",
         "DeliveryTime": number,
         "EngagementArn": "string",
         "IncidentId": "string",
         "PageArn": "string",
         "ReadTime": number,
         "Sender": "string",
         "SentTime": number
      }
   ]
}
```

## Response Elements
<a name="API_SSMContacts_ListPagesByEngagement_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_SSMContacts_ListPagesByEngagement_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListPagesByEngagement-response-NextToken"></a>
The pagination token to continue to the next page of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$` 

 ** [Pages](#API_SSMContacts_ListPagesByEngagement_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListPagesByEngagement-response-Pages"></a>
The list of engagements to contact channels.  
Type: Array of [Page](API_SSMContacts_Page.md) objects

## Errors
<a name="API_SSMContacts_ListPagesByEngagement_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of ListPagesByEngagement.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.ListPagesByEngagement
Content-Type: application/x-amz-json-1.1
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-contacts.list-pages-by-engagement
X-Amz-Date: 20220817T181950Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220817/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 132

{
	"EngagementId": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/test_escalation_plan/27bd86cf-6d50-49d2-a9ab-da39bEXAMPLE"
}
```

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

```
{
    "Pages": [
        {
            "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/2f92b456-2350-442b-95e7-ed8b0EXAMPLE",
            "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/test_escalation_plan/27bd86cf-6d50-49d2-a9ab-da39bEXAMPLE",
            "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
            "Sender": "cli",
            "SentTime": "2022-08-16T18:57:52.058000+00:00",
            "ReadTime": "2022-08-16T19:11:58.746000+00:00"
        }
    ]
}
```

## See Also
<a name="API_SSMContacts_ListPagesByEngagement_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-contacts-2021-05-03/ListPagesByEngagement) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/ListPagesByEngagement) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/ListPagesByEngagement) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/ListPagesByEngagement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/ListPagesByEngagement) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/ListPagesByEngagement) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/ListPagesByEngagement) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/ListPagesByEngagement) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/ListPagesByEngagement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/ListPagesByEngagement) 

# ListPreviewRotationShifts
<a name="API_SSMContacts_ListPreviewRotationShifts"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Returns a list of shifts based on rotation configuration parameters.

**Note**  
The Incident Manager primarily uses this operation to populate the **Preview** calendar. It is not typically run by end users.

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

```
{
   "EndTime": number,
   "MaxResults": number,
   "Members": [ "string" ],
   "NextToken": "string",
   "Overrides": [ 
      { 
         "EndTime": number,
         "NewMembers": [ "string" ],
         "StartTime": number
      }
   ],
   "Recurrence": { 
      "DailySettings": [ 
         { 
            "HourOfDay": number,
            "MinuteOfHour": number
         }
      ],
      "MonthlySettings": [ 
         { 
            "DayOfMonth": number,
            "HandOffTime": { 
               "HourOfDay": number,
               "MinuteOfHour": number
            }
         }
      ],
      "NumberOfOnCalls": number,
      "RecurrenceMultiplier": number,
      "ShiftCoverages": { 
         "string" : [ 
            { 
               "End": { 
                  "HourOfDay": number,
                  "MinuteOfHour": number
               },
               "Start": { 
                  "HourOfDay": number,
                  "MinuteOfHour": number
               }
            }
         ]
      },
      "WeeklySettings": [ 
         { 
            "DayOfWeek": "string",
            "HandOffTime": { 
               "HourOfDay": number,
               "MinuteOfHour": number
            }
         }
      ]
   },
   "RotationStartTime": number,
   "StartTime": number,
   "TimeZoneId": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_ListPreviewRotationShifts_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EndTime](#API_SSMContacts_ListPreviewRotationShifts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListPreviewRotationShifts-request-EndTime"></a>
The date and time a rotation shift would end.  
Type: Timestamp  
Required: Yes

 ** [MaxResults](#API_SSMContacts_ListPreviewRotationShifts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListPreviewRotationShifts-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that can be specified in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1024.  
Required: No

 ** [Members](#API_SSMContacts_ListPreviewRotationShifts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListPreviewRotationShifts-request-Members"></a>
The contacts that would be assigned to a rotation.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 30 items.  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `.*\S.*`   
Required: Yes

 ** [NextToken](#API_SSMContacts_ListPreviewRotationShifts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListPreviewRotationShifts-request-NextToken"></a>
A token to start the list. This token is used to get the next set of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$`   
Required: No

 ** [Overrides](#API_SSMContacts_ListPreviewRotationShifts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListPreviewRotationShifts-request-Overrides"></a>
Information about changes that would be made in a rotation override.  
Type: Array of [PreviewOverride](API_SSMContacts_PreviewOverride.md) objects  
Required: No

 ** [Recurrence](#API_SSMContacts_ListPreviewRotationShifts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListPreviewRotationShifts-request-Recurrence"></a>
Information about how long a rotation would last before restarting at the beginning of the shift order.  
Type: [RecurrenceSettings](API_SSMContacts_RecurrenceSettings.md) object  
Required: Yes

 ** [RotationStartTime](#API_SSMContacts_ListPreviewRotationShifts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListPreviewRotationShifts-request-RotationStartTime"></a>
The date and time a rotation would begin. The first shift is calculated from this date and time.  
Type: Timestamp  
Required: No

 ** [StartTime](#API_SSMContacts_ListPreviewRotationShifts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListPreviewRotationShifts-request-StartTime"></a>
Used to filter the range of calculated shifts before sending the response back to the user.   
Type: Timestamp  
Required: No

 ** [TimeZoneId](#API_SSMContacts_ListPreviewRotationShifts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListPreviewRotationShifts-request-TimeZoneId"></a>
The time zone the rotation’s activity would be based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los\$1Angeles", "UTC", or "Asia/Seoul".   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[:a-zA-Z0-9_\-\s\.\\/]*$`   
Required: Yes

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

```
{
   "NextToken": "string",
   "RotationShifts": [ 
      { 
         "ContactIds": [ "string" ],
         "EndTime": number,
         "ShiftDetails": { 
            "OverriddenContactIds": [ "string" ]
         },
         "StartTime": number,
         "Type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_SSMContacts_ListPreviewRotationShifts_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_SSMContacts_ListPreviewRotationShifts_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListPreviewRotationShifts-response-NextToken"></a>
The token for the next set of items to return. This token is used to get the next set of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$` 

 ** [RotationShifts](#API_SSMContacts_ListPreviewRotationShifts_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListPreviewRotationShifts-response-RotationShifts"></a>
Details about a rotation shift, including times, types, and contacts.  
Type: Array of [RotationShift](API_SSMContacts_RotationShift.md) objects

## Errors
<a name="API_SSMContacts_ListPreviewRotationShifts_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_SSMContacts_ListPreviewRotationShifts_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-contacts-2021-05-03/ListPreviewRotationShifts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/ListPreviewRotationShifts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/ListPreviewRotationShifts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/ListPreviewRotationShifts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/ListPreviewRotationShifts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/ListPreviewRotationShifts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/ListPreviewRotationShifts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/ListPreviewRotationShifts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/ListPreviewRotationShifts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/ListPreviewRotationShifts) 

# ListRotationOverrides
<a name="API_SSMContacts_ListRotationOverrides"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Retrieves a list of overrides currently specified for an on-call rotation.

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

```
{
   "EndTime": number,
   "MaxResults": number,
   "NextToken": "string",
   "RotationId": "string",
   "StartTime": number
}
```

## Request Parameters
<a name="API_SSMContacts_ListRotationOverrides_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EndTime](#API_SSMContacts_ListRotationOverrides_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListRotationOverrides-request-EndTime"></a>
The date and time for the end of a time range for listing overrides.  
Type: Timestamp  
Required: Yes

 ** [MaxResults](#API_SSMContacts_ListRotationOverrides_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListRotationOverrides-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1024.  
Required: No

 ** [NextToken](#API_SSMContacts_ListRotationOverrides_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListRotationOverrides-request-NextToken"></a>
A token to start the list. Use this token to get the next set of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$`   
Required: No

 ** [RotationId](#API_SSMContacts_ListRotationOverrides_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListRotationOverrides-request-RotationId"></a>
The Amazon Resource Name (ARN) of the rotation to retrieve information about.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

 ** [StartTime](#API_SSMContacts_ListRotationOverrides_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListRotationOverrides-request-StartTime"></a>
The date and time for the beginning of a time range for listing overrides.  
Type: Timestamp  
Required: Yes

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

```
{
   "NextToken": "string",
   "RotationOverrides": [ 
      { 
         "CreateTime": number,
         "EndTime": number,
         "NewContactIds": [ "string" ],
         "RotationOverrideId": "string",
         "StartTime": number
      }
   ]
}
```

## Response Elements
<a name="API_SSMContacts_ListRotationOverrides_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_SSMContacts_ListRotationOverrides_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListRotationOverrides-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$` 

 ** [RotationOverrides](#API_SSMContacts_ListRotationOverrides_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListRotationOverrides-response-RotationOverrides"></a>
A list of rotation overrides in the specified time range.  
Type: Array of [RotationOverride](API_SSMContacts_RotationOverride.md) objects

## Errors
<a name="API_SSMContacts_ListRotationOverrides_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_SSMContacts_ListRotationOverrides_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-contacts-2021-05-03/ListRotationOverrides) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/ListRotationOverrides) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/ListRotationOverrides) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/ListRotationOverrides) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/ListRotationOverrides) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/ListRotationOverrides) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/ListRotationOverrides) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/ListRotationOverrides) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/ListRotationOverrides) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/ListRotationOverrides) 

# ListRotations
<a name="API_SSMContacts_ListRotations"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Retrieves a list of on-call rotations.

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

```
{
   "MaxResults": number,
   "NextToken": "string",
   "RotationNamePrefix": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_ListRotations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_SSMContacts_ListRotations_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListRotations-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1024.  
Required: No

 ** [NextToken](#API_SSMContacts_ListRotations_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListRotations-request-NextToken"></a>
A token to start the list. Use this token to get the next set of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$`   
Required: No

 ** [RotationNamePrefix](#API_SSMContacts_ListRotations_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListRotations-request-RotationNamePrefix"></a>
A filter to include rotations in list results based on their common prefix. For example, entering prod returns a list of all rotation names that begin with `prod`, such as `production` and `prod-1`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9_\-\s\.]*$`   
Required: No

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

```
{
   "NextToken": "string",
   "Rotations": [ 
      { 
         "ContactIds": [ "string" ],
         "Name": "string",
         "Recurrence": { 
            "DailySettings": [ 
               { 
                  "HourOfDay": number,
                  "MinuteOfHour": number
               }
            ],
            "MonthlySettings": [ 
               { 
                  "DayOfMonth": number,
                  "HandOffTime": { 
                     "HourOfDay": number,
                     "MinuteOfHour": number
                  }
               }
            ],
            "NumberOfOnCalls": number,
            "RecurrenceMultiplier": number,
            "ShiftCoverages": { 
               "string" : [ 
                  { 
                     "End": { 
                        "HourOfDay": number,
                        "MinuteOfHour": number
                     },
                     "Start": { 
                        "HourOfDay": number,
                        "MinuteOfHour": number
                     }
                  }
               ]
            },
            "WeeklySettings": [ 
               { 
                  "DayOfWeek": "string",
                  "HandOffTime": { 
                     "HourOfDay": number,
                     "MinuteOfHour": number
                  }
               }
            ]
         },
         "RotationArn": "string",
         "StartTime": number,
         "TimeZoneId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_SSMContacts_ListRotations_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_SSMContacts_ListRotations_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListRotations-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$` 

 ** [Rotations](#API_SSMContacts_ListRotations_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListRotations-response-Rotations"></a>
Information about rotations that meet the filter criteria.  
Type: Array of [Rotation](API_SSMContacts_Rotation.md) objects

## Errors
<a name="API_SSMContacts_ListRotations_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_SSMContacts_ListRotations_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-contacts-2021-05-03/ListRotations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/ListRotations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/ListRotations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/ListRotations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/ListRotations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/ListRotations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/ListRotations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/ListRotations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/ListRotations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/ListRotations) 

# ListRotationShifts
<a name="API_SSMContacts_ListRotationShifts"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Returns a list of shifts generated by an existing rotation in the system.

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

```
{
   "EndTime": number,
   "MaxResults": number,
   "NextToken": "string",
   "RotationId": "string",
   "StartTime": number
}
```

## Request Parameters
<a name="API_SSMContacts_ListRotationShifts_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EndTime](#API_SSMContacts_ListRotationShifts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListRotationShifts-request-EndTime"></a>
The date and time for the end of the time range to list shifts for.  
Type: Timestamp  
Required: Yes

 ** [MaxResults](#API_SSMContacts_ListRotationShifts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListRotationShifts-request-MaxResults"></a>
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1024.  
Required: No

 ** [NextToken](#API_SSMContacts_ListRotationShifts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListRotationShifts-request-NextToken"></a>
A token to start the list. Use this token to get the next set of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$`   
Required: No

 ** [RotationId](#API_SSMContacts_ListRotationShifts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListRotationShifts-request-RotationId"></a>
The Amazon Resource Name (ARN) of the rotation to retrieve shift information about.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

 ** [StartTime](#API_SSMContacts_ListRotationShifts_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListRotationShifts-request-StartTime"></a>
The date and time for the beginning of the time range to list shifts for.  
Type: Timestamp  
Required: No

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

```
{
   "NextToken": "string",
   "RotationShifts": [ 
      { 
         "ContactIds": [ "string" ],
         "EndTime": number,
         "ShiftDetails": { 
            "OverriddenContactIds": [ "string" ]
         },
         "StartTime": number,
         "Type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_SSMContacts_ListRotationShifts_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_SSMContacts_ListRotationShifts_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListRotationShifts-response-NextToken"></a>
The token for the next set of items to return. Use this token to get the next set of results.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$` 

 ** [RotationShifts](#API_SSMContacts_ListRotationShifts_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListRotationShifts-response-RotationShifts"></a>
Information about shifts that meet the filter criteria.  
Type: Array of [RotationShift](API_SSMContacts_RotationShift.md) objects

## Errors
<a name="API_SSMContacts_ListRotationShifts_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: 400

 ** ConflictException **   
Updating or deleting a resource causes an inconsistent state.  
HTTP Status Code: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_SSMContacts_ListRotationShifts_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-contacts-2021-05-03/ListRotationShifts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/ListRotationShifts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/ListRotationShifts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/ListRotationShifts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/ListRotationShifts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/ListRotationShifts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/ListRotationShifts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/ListRotationShifts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/ListRotationShifts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/ListRotationShifts) 

# ListTagsForResource
<a name="API_SSMContacts_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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Lists the tags of a contact, escalation plan, rotation, or on-call schedule.

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

```
{
   "ResourceARN": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_ListTagsForResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_SSMContacts_ListTagsForResource_RequestSyntax) **   <a name="IncidentManager-SSMContacts_ListTagsForResource-request-ResourceARN"></a>
The Amazon Resource Name (ARN) of the contact, escalation plan, rotation, or on-call schedule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

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

```
{
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_SSMContacts_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_SSMContacts_ListTagsForResource_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_ListTagsForResource-response-Tags"></a>
The tags related to the contact or escalation plan.  
Type: Array of [Tag](API_SSMContacts_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

## Errors
<a name="API_SSMContacts_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of ListTagsForResource.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.ListTagsForResource
Content-Type: application/x-amz-json-1.1
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-contacts.list-tags-for-resource
X-Amz-Date: 20220817T183318Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220817/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 76

{
	"ResourceARN": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
}
```

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

```
{
    "Tags": [
        {
            "Key": "group1",
            "Value": "1"
        }
    ]
}
```

## See Also
<a name="API_SSMContacts_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-contacts-2021-05-03/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/ListTagsForResource) 

# PutContactPolicy
<a name="API_SSMContacts_PutContactPolicy"></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 [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 contact or escalation plan. The resource policy is used to share the contact or escalation plan using AWS Resource Access Manager (AWS RAM). For more information about cross-account sharing, see [Setting up cross-account functionality](https://docs.aws.amazon.com/incident-manager/latest/userguide/xa.html).

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

```
{
   "ContactArn": "string",
   "Policy": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_PutContactPolicy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ContactArn](#API_SSMContacts_PutContactPolicy_RequestSyntax) **   <a name="IncidentManager-SSMContacts_PutContactPolicy-request-ContactArn"></a>
The Amazon Resource Name (ARN) of the contact or escalation plan.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

 ** [Policy](#API_SSMContacts_PutContactPolicy_RequestSyntax) **   <a name="IncidentManager-SSMContacts_PutContactPolicy-request-Policy"></a>
Details of the resource policy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 395000.  
Pattern: `.*\S.*`   
Required: Yes

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

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

## Errors
<a name="API_SSMContacts_PutContactPolicy_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: 400

 ** ConflictException **   
Updating or deleting a resource causes an inconsistent state.  
HTTP Status Code: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of PutContactPolicy.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.PutContactPolicy
Content-Type: application/x-amz-json-1.1
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-contacts.put-contact-policy
X-Amz-Date: 20220816T212604Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220816/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 546

{
	"ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
	"Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"ExampleResourcePolicy\",\"Action\":[\"ssm-contacts:GetContact\",\"ssm-contacts:StartEngagement\",\"ssm-contacts:DescribeEngagement\",\"ssm-contacts:ListPagesByEngagement\",\"ssm-contacts:StopEngagement\"],\"Principal\":{\"AWS\":\"444455556666\"},\"Effect\":\"Allow\",\"Resource\":[\"arn:aws:ssm-contacts:*:111122223333:contact\\/akuam\",\"arn:aws:ssm-contacts:*:111122223333:engagement\\/akuam\\/*\"]}]}"
}
```

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

```
{}
```

## See Also
<a name="API_SSMContacts_PutContactPolicy_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-contacts-2021-05-03/PutContactPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/PutContactPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/PutContactPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/PutContactPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/PutContactPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/PutContactPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/PutContactPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/PutContactPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/PutContactPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/PutContactPolicy) 

# SendActivationCode
<a name="API_SSMContacts_SendActivationCode"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Sends an activation code to a contact channel. The contact can use this code to activate the contact channel in the console or with the `ActivateChannel` operation. Incident Manager can't engage a contact channel until it has been activated.

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

```
{
   "ContactChannelId": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_SendActivationCode_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ContactChannelId](#API_SSMContacts_SendActivationCode_RequestSyntax) **   <a name="IncidentManager-SSMContacts_SendActivationCode-request-ContactChannelId"></a>
The Amazon Resource Name (ARN) of the contact channel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

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

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

## Errors
<a name="API_SSMContacts_SendActivationCode_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: 400

 ** DataEncryptionException **   
The operation failed to due an encryption key error.  
HTTP Status Code: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
Request would cause a service quota to be exceeded.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of SendActivationCode.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.SendActivationCode
Content-Type: application/x-amz-json-1.1
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-contacts.send-activation-code
X-Amz-Date: 20220812T183251Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220812/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 126

{
	"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/e5bd2c57-406a-487f-8d26-7c032EXAMPLE"
}
```

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

```
{}
```

## See Also
<a name="API_SSMContacts_SendActivationCode_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-contacts-2021-05-03/SendActivationCode) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/SendActivationCode) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/SendActivationCode) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/SendActivationCode) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/SendActivationCode) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/SendActivationCode) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/SendActivationCode) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/SendActivationCode) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/SendActivationCode) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/SendActivationCode) 

# StartEngagement
<a name="API_SSMContacts_StartEngagement"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.

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

```
{
   "ContactId": "string",
   "Content": "string",
   "IdempotencyToken": "string",
   "IncidentId": "string",
   "PublicContent": "string",
   "PublicSubject": "string",
   "Sender": "string",
   "Subject": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_StartEngagement_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ContactId](#API_SSMContacts_StartEngagement_RequestSyntax) **   <a name="IncidentManager-SSMContacts_StartEngagement-request-ContactId"></a>
The Amazon Resource Name (ARN) of the contact being engaged.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

 ** [Content](#API_SSMContacts_StartEngagement_RequestSyntax) **   <a name="IncidentManager-SSMContacts_StartEngagement-request-Content"></a>
The secure content of the message that was sent to the contact. Use this field for engagements to `VOICE` or `EMAIL`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Pattern: `^[.\s\S]*$`   
Required: Yes

 ** [IdempotencyToken](#API_SSMContacts_StartEngagement_RequestSyntax) **   <a name="IncidentManager-SSMContacts_StartEngagement-request-IdempotencyToken"></a>
A token ensuring that the operation is called only once with the specified details.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$`   
Required: No

 ** [IncidentId](#API_SSMContacts_StartEngagement_RequestSyntax) **   <a name="IncidentManager-SSMContacts_StartEngagement-request-IncidentId"></a>
The ARN of the incident that the engagement is part of.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `^[\\a-zA-Z0-9_@#%*+=:?.\/!\s-]*$`   
Required: No

 ** [PublicContent](#API_SSMContacts_StartEngagement_RequestSyntax) **   <a name="IncidentManager-SSMContacts_StartEngagement-request-PublicContent"></a>
The insecure content of the message that was sent to the contact. Use this field for engagements to `SMS`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Pattern: `^[.\s\S]*$`   
Required: No

 ** [PublicSubject](#API_SSMContacts_StartEngagement_RequestSyntax) **   <a name="IncidentManager-SSMContacts_StartEngagement-request-PublicSubject"></a>
The insecure subject of the message that was sent to the contact. Use this field for engagements to `SMS`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[.\s\S]*$`   
Required: No

 ** [Sender](#API_SSMContacts_StartEngagement_RequestSyntax) **   <a name="IncidentManager-SSMContacts_StartEngagement-request-Sender"></a>
The user that started the engagement.  
Type: String  
Length Constraints: Maximum length of 255.  
Pattern: `^[\\a-zA-Z0-9_@#%*+=:?.\/!\s-]*$`   
Required: Yes

 ** [Subject](#API_SSMContacts_StartEngagement_RequestSyntax) **   <a name="IncidentManager-SSMContacts_StartEngagement-request-Subject"></a>
The secure subject of the message that was sent to the contact. Use this field for engagements to `VOICE` or `EMAIL`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[.\s\S]*$`   
Required: Yes

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

```
{
   "EngagementArn": "string"
}
```

## Response Elements
<a name="API_SSMContacts_StartEngagement_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.

 ** [EngagementArn](#API_SSMContacts_StartEngagement_ResponseSyntax) **   <a name="IncidentManager-SSMContacts_StartEngagement-response-EngagementArn"></a>
The ARN of the engagement.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*` 

## Errors
<a name="API_SSMContacts_StartEngagement_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: 400

 ** DataEncryptionException **   
The operation failed to due an encryption key error.  
HTTP Status Code: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of StartEngagement.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.StartEngagement
Content-Type: application/x-amz-json-1.1
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-contacts.start-engagement
X-Amz-Date: 20220816T184849Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220816/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 307

{
	"ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/test_escalation_plan", 
	"Sender": "cli", 
	"Subject": "cli-test", 
	"Content": "Testing engagements via CLI", 
	"PublicSubject": "cli-test", 
	"PublicContent": "Testing engagements via CLI", 
	"IdempotencyToken": "23a2a9b9-f63b-49b1-80c6-b21dfEXAMPLE"
}
```

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

```
{
    "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/test_escalation_plan/27bd86cf-6d50-49d2-a9ab-da39bEXAMPLE"
}
```

## See Also
<a name="API_SSMContacts_StartEngagement_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-contacts-2021-05-03/StartEngagement) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/StartEngagement) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/StartEngagement) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/StartEngagement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/StartEngagement) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/StartEngagement) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/StartEngagement) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/StartEngagement) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/StartEngagement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/StartEngagement) 

# StopEngagement
<a name="API_SSMContacts_StopEngagement"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.

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

```
{
   "EngagementId": "string",
   "Reason": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_StopEngagement_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EngagementId](#API_SSMContacts_StopEngagement_RequestSyntax) **   <a name="IncidentManager-SSMContacts_StopEngagement-request-EngagementId"></a>
The Amazon Resource Name (ARN) of the engagement.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

 ** [Reason](#API_SSMContacts_StopEngagement_RequestSyntax) **   <a name="IncidentManager-SSMContacts_StopEngagement-request-Reason"></a>
The reason that you're stopping the engagement.  
Type: String  
Length Constraints: Maximum length of 255.  
Pattern: `^[.\s\S]*$`   
Required: No

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

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

## Errors
<a name="API_SSMContacts_StopEngagement_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of StopEngagement.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.StopEngagement
Content-Type: application/x-amz-json-1.1
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-contacts.stop-engagement
X-Amz-Date: 20220817T183804Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220817/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 132

{
	"EngagementId": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/test_escalation_plan/27bd86cf-6d50-49d2-a9ab-da39bEXAMPLE"
}
```

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

```
{}
```

## See Also
<a name="API_SSMContacts_StopEngagement_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-contacts-2021-05-03/StopEngagement) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/StopEngagement) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/StopEngagement) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/StopEngagement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/StopEngagement) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/StopEngagement) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/StopEngagement) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/StopEngagement) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/StopEngagement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/StopEngagement) 

# TagResource
<a name="API_SSMContacts_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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.

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

```
{
   "ResourceARN": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_SSMContacts_TagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_SSMContacts_TagResource_RequestSyntax) **   <a name="IncidentManager-SSMContacts_TagResource-request-ResourceARN"></a>
The Amazon Resource Name (ARN) of the contact or escalation plan.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

 ** [Tags](#API_SSMContacts_TagResource_RequestSyntax) **   <a name="IncidentManager-SSMContacts_TagResource-request-Tags"></a>
A list of tags that you are adding to the contact or escalation plan.  
Type: Array of [Tag](API_SSMContacts_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: Yes

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

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

## Errors
<a name="API_SSMContacts_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
Request would cause a service quota to be exceeded.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of TagResource.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.TagResource
Content-Type: application/x-amz-json-1.1
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-contacts.tag-resource
X-Amz-Date: 20220817T183028Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220817/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 119

{
	"ResourceARN": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
	"Tags": [
		{
			"Key": "group1", 
			"Value": "1"
		}
	]
}
```

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

```
{}
```

## See Also
<a name="API_SSMContacts_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-contacts-2021-05-03/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/TagResource) 

# UntagResource
<a name="API_SSMContacts_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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Removes tags from the specified resource.

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

```
{
   "ResourceARN": "string",
   "TagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_SSMContacts_UntagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_SSMContacts_UntagResource_RequestSyntax) **   <a name="IncidentManager-SSMContacts_UntagResource-request-ResourceARN"></a>
The Amazon Resource Name (ARN) of the contact or escalation plan.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

 ** [TagKeys](#API_SSMContacts_UntagResource_RequestSyntax) **   <a name="IncidentManager-SSMContacts_UntagResource-request-TagKeys"></a>
The key of the tag that you want to remove.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\\\/a-zA-Z0-9_+=\-]*$`   
Required: Yes

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

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

## Errors
<a name="API_SSMContacts_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: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of UntagResource.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.UntagResource
Content-Type: application/x-amz-json-1.1
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-contacts.untag-resource
X-Amz-Date: 20220817T184036Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220817/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 99

{
	"ResourceARN": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
	"TagKeys": ["group1"]
}
```

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

```
{}
```

## See Also
<a name="API_SSMContacts_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-contacts-2021-05-03/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/UntagResource) 

# UpdateContact
<a name="API_SSMContacts_UpdateContact"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Updates the contact or escalation plan specified.

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

```
{
   "ContactId": "string",
   "DisplayName": "string",
   "Plan": { 
      "RotationIds": [ "string" ],
      "Stages": [ 
         { 
            "DurationInMinutes": number,
            "Targets": [ 
               { 
                  "ChannelTargetInfo": { 
                     "ContactChannelId": "string",
                     "RetryIntervalInMinutes": number
                  },
                  "ContactTargetInfo": { 
                     "ContactId": "string",
                     "IsEssential": boolean
                  }
               }
            ]
         }
      ]
   }
}
```

## Request Parameters
<a name="API_SSMContacts_UpdateContact_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ContactId](#API_SSMContacts_UpdateContact_RequestSyntax) **   <a name="IncidentManager-SSMContacts_UpdateContact-request-ContactId"></a>
The Amazon Resource Name (ARN) of the contact or escalation plan you're updating.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

 ** [DisplayName](#API_SSMContacts_UpdateContact_RequestSyntax) **   <a name="IncidentManager-SSMContacts_UpdateContact-request-DisplayName"></a>
The full name of the contact or escalation plan.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `^[\p{L}\p{Z}\p{N}_.\-]*$`   
Required: No

 ** [Plan](#API_SSMContacts_UpdateContact_RequestSyntax) **   <a name="IncidentManager-SSMContacts_UpdateContact-request-Plan"></a>
A list of stages. A contact has an engagement plan with stages for specified contact channels. An escalation plan uses these stages to contact specified contacts.  
Type: [Plan](API_SSMContacts_Plan.md) object  
Required: No

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

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

## Errors
<a name="API_SSMContacts_UpdateContact_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: 400

 ** DataEncryptionException **   
The operation failed to due an encryption key error.  
HTTP Status Code: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
Request would cause a service quota to be exceeded.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of UpdateContact.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.UpdateContact
Content-Type: application/x-amz-json-1.1
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-contacts.update-contact
X-Amz-Date: 20220812T181127Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220812/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 534

{
	"ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
	"Plan": {
		"Stages": [
			{
				"DurationInMinutes": 5, 
				"Targets": [
					{
						"ChannelTargetInfo": {
							"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/31111aa5-9b84-4591-a5a6-5a8f9EXAMPLE", 
							"RetryIntervalInMinutes": 1
						}
					}
				]
			}, 
			{
				"DurationInMinutes": 5, 
				"Targets": [
					{
						"ChannelTargetInfo": {
							"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/e5bd2c57-406a-487f-8d26-7c032EXAMPLE", 
							"RetryIntervalInMinutes": 1
						}
					}
				]
			}
		]
	}
}
```

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

```
{}
```

## See Also
<a name="API_SSMContacts_UpdateContact_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-contacts-2021-05-03/UpdateContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/UpdateContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/UpdateContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/UpdateContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/UpdateContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/UpdateContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/UpdateContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/UpdateContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/UpdateContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/UpdateContact) 

# UpdateContactChannel
<a name="API_SSMContacts_UpdateContactChannel"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Updates a contact's contact channel.

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

```
{
   "ContactChannelId": "string",
   "DeliveryAddress": { 
      "SimpleAddress": "string"
   },
   "Name": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_UpdateContactChannel_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ContactChannelId](#API_SSMContacts_UpdateContactChannel_RequestSyntax) **   <a name="IncidentManager-SSMContacts_UpdateContactChannel-request-ContactChannelId"></a>
The Amazon Resource Name (ARN) of the contact channel you want to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

 ** [DeliveryAddress](#API_SSMContacts_UpdateContactChannel_RequestSyntax) **   <a name="IncidentManager-SSMContacts_UpdateContactChannel-request-DeliveryAddress"></a>
The details that Incident Manager uses when trying to engage the contact channel.  
Type: [ContactChannelAddress](API_SSMContacts_ContactChannelAddress.md) object  
Required: No

 ** [Name](#API_SSMContacts_UpdateContactChannel_RequestSyntax) **   <a name="IncidentManager-SSMContacts_UpdateContactChannel-request-Name"></a>
The name of the contact channel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[\p{L}\p{Z}\p{N}_.\-]*$`   
Required: No

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

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

## Errors
<a name="API_SSMContacts_UpdateContactChannel_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: 400

 ** ConflictException **   
Updating or deleting a resource causes an inconsistent state.  
HTTP Status Code: 400

 ** DataEncryptionException **   
The operation failed to due an encryption key error.  
HTTP Status Code: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

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

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

This example illustrates one usage of UpdateContactChannel.

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

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.UpdateContactChannel
Content-Type: application/x-amz-json-1.1
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-contacts.update-contact-channel
X-Amz-Date: 20220812T182356Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220812/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 211

{
	"ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/e5bd2c57-406a-487f-8d26-7c032EXAMPLE", 
	"Name": "akuas voice channel", 
	"DeliveryAddress": {
		"SimpleAddress": "+15005550198"
	}
}
```

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

```
{}
```

## See Also
<a name="API_SSMContacts_UpdateContactChannel_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-contacts-2021-05-03/UpdateContactChannel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/UpdateContactChannel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/UpdateContactChannel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/UpdateContactChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/UpdateContactChannel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/UpdateContactChannel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/UpdateContactChannel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/UpdateContactChannel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/UpdateContactChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/UpdateContactChannel) 

# UpdateRotation
<a name="API_SSMContacts_UpdateRotation"></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 [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

Updates the information specified for an on-call rotation.

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

```
{
   "ContactIds": [ "string" ],
   "Recurrence": { 
      "DailySettings": [ 
         { 
            "HourOfDay": number,
            "MinuteOfHour": number
         }
      ],
      "MonthlySettings": [ 
         { 
            "DayOfMonth": number,
            "HandOffTime": { 
               "HourOfDay": number,
               "MinuteOfHour": number
            }
         }
      ],
      "NumberOfOnCalls": number,
      "RecurrenceMultiplier": number,
      "ShiftCoverages": { 
         "string" : [ 
            { 
               "End": { 
                  "HourOfDay": number,
                  "MinuteOfHour": number
               },
               "Start": { 
                  "HourOfDay": number,
                  "MinuteOfHour": number
               }
            }
         ]
      },
      "WeeklySettings": [ 
         { 
            "DayOfWeek": "string",
            "HandOffTime": { 
               "HourOfDay": number,
               "MinuteOfHour": number
            }
         }
      ]
   },
   "RotationId": "string",
   "StartTime": number,
   "TimeZoneId": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_UpdateRotation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ContactIds](#API_SSMContacts_UpdateRotation_RequestSyntax) **   <a name="IncidentManager-SSMContacts_UpdateRotation-request-ContactIds"></a>
The Amazon Resource Names (ARNs) of the contacts to include in the updated rotation.   
Only the `PERSONAL` contact type is supported. The contact types `ESCALATION` and `ONCALL_SCHEDULE` are not supported for this operation. 
The order in which you list the contacts is their shift order in the rotation schedule.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 30 items.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: No

 ** [Recurrence](#API_SSMContacts_UpdateRotation_RequestSyntax) **   <a name="IncidentManager-SSMContacts_UpdateRotation-request-Recurrence"></a>
Information about how long the updated rotation lasts before restarting at the beginning of the shift order.  
Type: [RecurrenceSettings](API_SSMContacts_RecurrenceSettings.md) object  
Required: Yes

 ** [RotationId](#API_SSMContacts_UpdateRotation_RequestSyntax) **   <a name="IncidentManager-SSMContacts_UpdateRotation-request-RotationId"></a>
The Amazon Resource Name (ARN) of the rotation to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

 ** [StartTime](#API_SSMContacts_UpdateRotation_RequestSyntax) **   <a name="IncidentManager-SSMContacts_UpdateRotation-request-StartTime"></a>
The date and time the rotation goes into effect.  
Type: Timestamp  
Required: No

 ** [TimeZoneId](#API_SSMContacts_UpdateRotation_RequestSyntax) **   <a name="IncidentManager-SSMContacts_UpdateRotation-request-TimeZoneId"></a>
The time zone to base the updated rotation’s activity on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los\$1Angeles", "UTC", or "Asia/Seoul". For more information, see the [Time Zone Database](https://www.iana.org/time-zones) on the IANA website.  
Designators for time zones that don’t support Daylight Savings Time Rules, such as Pacific Standard Time (PST), aren't supported.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[:a-zA-Z0-9_\-\s\.\\/]*$`   
Required: No

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

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

## Errors
<a name="API_SSMContacts_UpdateRotation_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: 400

 ** ConflictException **   
Updating or deleting a resource causes an inconsistent state.  
HTTP Status Code: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_SSMContacts_UpdateRotation_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-contacts-2021-05-03/UpdateRotation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/UpdateRotation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/UpdateRotation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/UpdateRotation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/UpdateRotation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/UpdateRotation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/UpdateRotation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/UpdateRotation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/UpdateRotation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/UpdateRotation)