POST
/ListChannels
http://ivs.{region}.amazonaws.com/ListChannelsGets 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).
Access Token Required: API Key
Query Params
maxResultsstring
Pagination limit
nextTokenstring
Pagination token
Body Params
nextTokenstring
The first channel to retrieve. This is used for pagination; see the <code>nextToken</code> response field.
maxResultsinteger
Maximum number of channels to return. Default: 100.
filterByNamestring
Filters the channel list to match the specified name.
filterByRecordingConfigurationArnstring
Filters the channel list to match the specified recording-configuration ARN.
Responses
{
"success": true,
"data": {
"id": "abc123",
"created_at": "2025-01-01T00:00:00Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters"
}
}Language
CredentialsAPI KEY
API Key
Enter token below to save for later
cURL Request
1curl --request POST \2 --url 'http://ivs.{region}.amazonaws.com/ListChannels' \3 --header 'accept: application/json' \4 --header 'content-type: application/json'Response
1{2 "success": true,3 "data": {4 "id": "abc123",5 "created_at": "2025-01-01T00:00:00Z"6 }7}