Request Syntax Request Parameters Response Elements Errors Examples See Also

ActivateContactChannel

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

Request Syntax


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

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ActivationCode

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

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

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

Errors

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

AccessDeniedException

You don't have sufficient access to perform this operation.

HTTP Status Code: 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

Example

This example illustrates one usage of ActivateContactChannel.

Sample Request


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

{}