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

ListChannels

Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.

Request Syntax


GET /channelGroup/ChannelGroupName/channel?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ChannelGroupName

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

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

Pattern: [a-zA-Z0-9_-]+

Required: Yes

MaxResults

The maximum number of results to return in the response.

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

NextToken

The pagination token from the GET list request. Use the token to fetch the next page of results.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "Arn": "string",
         "ChannelGroupName": "string",
         "ChannelName": "string",
         "CreatedAt": number,
         "Description": "string",
         "ModifiedAt": number
      }
   ],
   "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.

Items

The objects being returned.

Type: Array of ChannelListConfiguration objects

NextToken

The pagination token from the GET list request.

Type: String

Errors

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

AccessDeniedException

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

HTTP Status Code: 403

InternalServerException

Indicates that an error from the service occurred while trying to process a request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource doesn't exist.

HTTP Status Code: 404

ThrottlingException

The request throughput limit was exceeded.

HTTP Status Code: 429

ValidationException

The input failed to meet the constraints specified by the AWS service.

HTTP Status Code: 400