Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1428140120.9 KB

Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).

post/ListChannels

Query parameters

maxResultsstring

Pagination limit

nextTokenstring

Pagination token

Request body

filterByNamestring

Filters the channel list to match the specified name.

filterByRecordingConfigurationArnstring

Filters the channel list to match the specified recording-configuration ARN.

maxResultsinteger

Maximum number of channels to return. Default: 100.

nextTokenstring

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

Response

Success

nextTokenstring

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