Menu
AWS Elemental MediaPackage
API Reference

Channels

URI

/channels

HTTP Methods

GET

Operation ID: ListChannels

Lists channels that match a set of filters that you define.

AWS CLI Request Syntax

Copy
aws mediapackage list-channels [--starting-token <value>] [--page-size <value>] [--max-items <value>]

Use pagination to limit the number of entries you receive in the response. For more how to use pagination, see Using the AWS Command Line Interface's Pagination Options.

Query Parameters

Name Type Required Description
nextToken String False

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

maxResults String False

Maximum number of records to return.

Responses

Status Code Response Model Description
200 ChannelList

200 OK response

The list of channels is returned successfully.

422 None

422 Unprocessable Entity response

AWS Elemental MediaPackage could not process the instructions in the body of the request.

500 None

500 Internal Server Error response

An unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request.

403 None

403 Forbidden response

AWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials.

503 None

Service unavailable response

AWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance.

404 None

404 Not Found response

AWS Elemental MediaPackage did not find a representation of the target resource.

429 None

429 Too Many Requests response

Too many requests have been sent in a given amount of time.

POST

Operation ID: CreateChannel

Creates a channel to ingest content.

Once created, a channel provides static ingest URLs. These URLs remain the same throughout the lifetime of the channel, regardless of any failures or upgrades that might occur. Use these URLs to configure the outputs of your upstream encoder.

AWS CLI Request Syntax

Copy
aws mediapackage create-channel -id <value> [--description <value>]

For a complete list of channel attributes, see the ChannelCreateParameters property.

Example POST Channel Request Body

Copy
{ "id": "sportschannel", "description": "24x7 sports" }

Responses

Status Code Response Model Description
200 Channel

200 OK response

The channel is created successfully.

422 None

422 Unprocessable Entity response

AWS Elemental MediaPackage could not process the instructions in the body of the request.

500 None

500 Internal Server Error response

An unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request.

403 None

403 Forbidden response

AWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials.

503 None

Service unavailable response

AWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance.

404 None

404 Not Found response

AWS Elemental MediaPackage did not find a representation of the target resource.

429 None

429 Too Many Requests response

Too many requests have been sent in a given amount of time.

Schemas

Request Bodies

Example POST

Copy
{ "description": "string", "id": "string" }

Response Bodies

Example ChannelList

Copy
{ "channels": [ { "description": "string", "id": "string", "hlsIngest": { "ingestEndpoints": [ { "password": "string", "url": "string", "username": "string" } ] }, "arn": "string" } ], "nextToken": "string" }

Example Channel

Copy
{ "description": "string", "id": "string", "hlsIngest": { "ingestEndpoints": [ { "password": "string", "url": "string", "username": "string" } ] }, "arn": "string" }

Properties

Channel

Channel configuration.

Property Type Required Description
description

string

False

Any descriptive information that you want to add to the channel for future identification purposes.

id

string

False

Unique identifier that you assign to the channel.

hlsIngest

HlsIngest

False

System-generated information about the channel.

arn

string

False

The channel's unique system-generated resource name, based on the AWS record.

ChannelCreateParameters

Channel configuration.

Property Type Required Description
description

string

False

Any descriptive information that you want to add to the channel for future identification purposes.

id

string

True

Unique identifier that you assign to the channel.

ChannelList

Property Type Required Description
channels

Array of type Channel

False

List of channel objects that are configured on this account.

nextToken

string

False

Pagination token. Use this token to request the next page of channel results.

HlsIngest

HLS ingest configuration.

Property Type Required Description
ingestEndpoints

Array of type IngestEndpoint

False

The ingest URL where the source stream should be sent.

IngestEndpoint

An endpoint for ingesting source content for a channel

Property Type Required Description
password

string

False

The system-generated password for WebDAV ingest authentication.

url

string

False

The ingest URL where the source stream should be sent.

username

string

False

The system-generated username for WebDAV ingest authentication.