ListContactChannels - AWS Systems Manager Incident Manager

ListContactChannels

Lists all contact channels for the specified contact.

Request Syntax

{ "ContactId": "string", "MaxResults": number, "NextToken": "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.

ContactId

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

The maximum number of contact channels per page.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1024.

Required: No

NextToken

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

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

Response Elements

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

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

ContactChannels

A list of contact channels related to the specified contact.

Type: Array of ContactChannel objects

NextToken

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

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

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

Example

This example illustrates one usage of ListContactChannels.

Sample Request

POST / HTTP/1.1 Host: ssm-contacts.us-east-1.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: 20210812T180323Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210812/us-east-1/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-1:111122223333:contact/akuam" }

Sample Response

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: