ListChannels - Amazon Interactive Video Service

ListChannels

Gets summary information about all channels in your account, in the AWS region where the API request is processed. This list can be filtered to match a specified string.

Request Syntax

POST /ListChannels HTTP/1.1 Content-type: application/json { "filterByName": "string", "maxResults": number, "nextToken": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

filterByName

Filters the channel list to match the specified name.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: ^[a-zA-Z0-9-_]*$

Required: No

maxResults

Maximum number of channels to return.

Type: Integer

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

Required: No

nextToken

The first channel to retrieve. This is used for pagination; see the nextToken response field.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "channels": [ { "arn": "string", "authorized": boolean, "latencyMode": "string", "name": "string", "tags": { "string" : "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.

channels

List of the matching channels.

Type: Array of ChannelSummary objects

nextToken

If there are more channels than maxResults, use nextToken in the request to get the next set.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Errors

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

AccessDeniedException

HTTP Status Code: 403

ValidationException

HTTP Status Code: 400

See Also

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