Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

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 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).

Request Syntax


POST /ListChannels HTTP/1.1
Content-type: application/json

{
   "filterByName": "string",
   "filterByPlaybackRestrictionPolicyArn": "string",
   "filterByRecordingConfigurationArn": "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

filterByPlaybackRestrictionPolicyArn

Filters the channel list to match the specified policy.

Type: String

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

Pattern: ^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-restriction-policy/[a-zA-Z0-9-]+$

Required: No

filterByRecordingConfigurationArn

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

Type: String

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

Pattern: ^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$

Required: No

maxResults

Maximum number of channels to return. Default: 100.

Type: Integer

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

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 1024.

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "channels": [ 
      { 
         "arn": "string",
         "authorized": boolean,
         "insecureIngest": boolean,
         "latencyMode": "string",
         "name": "string",
         "playbackRestrictionPolicyArn": "string",
         "preset": "string",
         "recordingConfigurationArn": "string",
         "tags": { 
            "string" : "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.

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 1024.

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

Errors

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

AccessDeniedException

HTTP Status Code: 403

ConflictException

HTTP Status Code: 409

ValidationException

HTTP Status Code: 400