ListChannels

Returns a list of Channels for a NotificationConfiguration.

Request Syntax


GET /channels?maxResults=maxResults&nextToken=nextToken&notificationConfigurationArn=notificationConfigurationArn HTTP/1.1

The request uses the following URI parameters.

The maximum number of results to be returned in this call. The default value is 20.

Valid Range: Minimum value of 1. Maximum value of 100.

The start token for paginated calls. Retrieved from the response of a previous ListNotificationEvents call. NextToken uses Base64 encoding.

Length Constraints: Minimum length of 1. Maximum length of 4096.

Pattern: [\w+-/=]+

The Amazon Resource Name (ARN) of the NotificationConfiguration.

Pattern: arn:aws:notifications::[0-9]{12}:configuration/[a-z0-9]{27}

Required: Yes

The request does not have a request body.


HTTP/1.1 200
Content-type: application/json

{
   "channels": [ "string" ],
   "nextToken": "string"
}

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

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

A list of Channels.

Type: Array of strings

Pattern: arn:aws:(chatbot|consoleapp|notifications-contacts):[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-_.@]+/[a-zA-Z0-9/_.@:-]+

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Pattern: [\w+-/=]+

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

AccessDeniedException

User does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

This exception is thrown when the notification event fails validation.

HTTP Status Code: 400