AWS Elemental MediaPackage API Reference
API Reference

Channels id

URI

/channels/ id

HTTP Methods

GET

Operation ID: DescribeChannel

Provides details about a channel.

AWS CLI Request Syntax

aws mediapackage describe-channel --id <channelId>

Path Parameters

Name Type Required Description
id String True

Identifier for the object that you are working on.

Responses

Status Code Response Model Description
200 Channel

200 OK response

Channel details are returned successfully.

403 None

403 Forbidden response

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

404 None

404 Not Found response

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

422 None

422 Unprocessable Entity response

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

429 None

429 Too Many Requests response

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

500 None

500 Internal Server Error response

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

503 None

Service unavailable response

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

PUT

Operation ID: UpdateChannel

Updates a specific channel. You can't change the id attribute or any other system-generated attributes.

AWS CLI Request Syntax

aws mediapackage update-channel --id <channelId> [--description <value>]

Pass in the updated description as an argument in the AWS CLI request.

Path Parameters

Name Type Required Description
id String True

Identifier for the object that you are working on.

Responses

Status Code Response Model Description
200 Channel

200 OK response

The channel is updated successfully.

403 None

403 Forbidden response

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

404 None

404 Not Found response

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

422 None

422 Unprocessable Entity response

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

429 None

429 Too Many Requests response

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

500 None

500 Internal Server Error response

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

503 None

Service unavailable response

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

DELETE

Operation ID: DeleteChannel

Permanently deletes a channel.

AWS CLI Request Syntax

aws mediapackage delete-channel --id <channelId>

Path Parameters

Name Type Required Description
id String True

Identifier for the object that you are working on.

Responses

Status Code Response Model Description
202 None

202 Accepted response

AWS Elemental MediaPackage accepted the request but has not processed it yet.

403 None

403 Forbidden response

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

404 None

404 Not Found response

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

422 None

422 Unprocessable Entity response

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

429 None

429 Too Many Requests response

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

500 None

500 Internal Server Error response

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

503 None

Service unavailable response

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

Schemas

Request Bodies

Example PUT

{ "description": "string" }

Response Bodies

Example Channel

{ "description": "string", "id": "string", "hlsIngest": { "ingestEndpoints": [ { "password": "string", "id": "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.

ChannelUpdateParameters

Channel configuration.

Property Type Required Description
description

string

False

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

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.

id

string

False

The system-generated unique identifier for the IngestEndpoint.

url

string

False

The ingest URL where the source stream should be sent.

username

string

False

The system-generated username for WebDAV ingest authentication.