Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Preferences
Contact Us
Feedback
AWS Documentation
Create an AWS Account
Channels id - AWS Elemental MediaPackage
URIHTTP methodsSchemasPropertiesSee also

Channels id

PDF

URI

/channels/id

HTTP methods

GET

Operation ID: DescribeChannel

Provides details about a channel.

Path parameters
NameTypeRequiredDescription
idStringTrue

Identifier for the object that you are working on.

Responses
Status codeResponse modelDescription
200Channel

200 OK response

Channel details are returned successfully.

403None

403 Forbidden response

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

404None

404 Not Found response

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

422None

422 Unprocessable Entity response

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

429None

429 Too Many Requests response

One of these two error conditions:

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

Your account has exceeded the quota allotted for the resource that you're creating.

500None

500 Internal Server Error response

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

503None

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.

Path parameters
NameTypeRequiredDescription
idStringTrue

Identifier for the object that you are working on.

Responses
Status codeResponse modelDescription
200Channel

200 OK response

The channel is updated successfully.

403None

403 Forbidden response

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

404None

404 Not Found response

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

422None

422 Unprocessable Entity response

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

429None

429 Too Many Requests response

One of these two error conditions:

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

Your account has exceeded the quota allotted for the resource that you're creating.

500None

500 Internal Server Error response

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

503None

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.

Path parameters
NameTypeRequiredDescription
idStringTrue

Identifier for the object that you are working on.

Responses
Status codeResponse modelDescription
202None

202 Accepted response

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

403None

403 Forbidden response

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

404None

404 Not Found response

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

422None

422 Unprocessable Entity response

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

429None

429 Too Many Requests response

One of these two error conditions:

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

Your account has exceeded the quota allotted for the resource that you're creating.

500None

500 Internal Server Error response

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

503None

Service unavailable response

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

OPTIONS

Enable CORS by returning correct headers.

Path parameters
NameTypeRequiredDescription
idStringTrue

Identifier for the object that you are working on.

Responses
Status codeResponse modelDescription
200None

Default response for CORS method.

Schemas

Request bodies

{
  "description": "string"
}

PUT schema

{
  "description": "string"
}

Response bodies

{
  "createdAt": "string",
  "ingressAccessLogs": {
    "logGroupName": "string"
  },
  "egressAccessLogs": {
    "logGroupName": "string"
  },
  "description": "string",
  "hlsIngest": {
    "ingestEndpoints": [
      {
        "password": "string",
        "id": "string",
        "url": "string",
        "username": "string"
      }
    ]
  },
  "id": "string",
  "arn": "string",
  "tags": {
  }
}

Channel schema

{
  "createdAt": "string",
  "ingressAccessLogs": {
    "logGroupName": "string"
  },
  "egressAccessLogs": {
    "logGroupName": "string"
  },
  "description": "string",
  "hlsIngest": {
    "ingestEndpoints": [
      {
        "password": "string",
        "id": "string",
        "url": "string",
        "username": "string"
      }
    ]
  },
  "id": "string",
  "arn": "string",
  "tags": {
  }
}

Properties

Channel

Channel configuration.

PropertyTypeRequiredDescription
arn

string

False

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

createdAt

string

False

The date and time the Channel was created.

description

string

False

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

egressAccessLogs

EgressAccessLogs

False

Configures egress access logs.

hlsIngest

HlsIngest

False

System-generated information about the channel.

id

string

False

Unique identifier that you assign to the channel.

ingressAccessLogs

IngressAccessLogs

False

Configures ingress access logs.

tags

Tags

False

The tags assigned to the channel.

ChannelUpdateParameters

Channel configuration.

PropertyTypeRequiredDescription
description

string

False

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

EgressAccessLogs

Egress access log configuration parameters.

PropertyTypeRequiredDescription
logGroupName

string

False

Sets a custom AWS CloudWatch log group name for egress logs. If a log group name isn't specified, the default name is used: /aws/MediaPackage/EgressAccessLogs.

HlsIngest

HLS ingest configuration.

PropertyTypeRequiredDescription
ingestEndpoints

Array of type IngestEndpoint

False

The input URL where the source stream should be sent.

IngestEndpoint

An endpoint for ingesting source content for a channel.

PropertyTypeRequiredDescription
id

string

False

The system-generated unique identifier for the IngestEndpoint.

password

string

False

The system-generated password for WebDAV input authentication.

url

string

False

The input URL where the source stream should be sent.

username

string

False

The system-generated username for WebDAV input authentication.

IngressAccessLogs

Ingress access log configuration parameters.

PropertyTypeRequiredDescription
logGroupName

string

False

Sets a custom AWS CloudWatch log group name for ingress logs. If a log group name isn't specified, the default name is used: /aws/MediaPackage/IngressAccessLogs.

Tags

A collection of tags associated with a resource.

Value description:

  • Property: "key1": "value1"

  • Type: string

  • Required: True

  • Description: A comma-separated list of tag key:value pairs that you define. For example:

     {
   "Key1": "Value1",
   "Key2": "Value2"
 }
PropertyTypeRequiredDescription

*

string

False

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

DescribeChannel

UpdateChannel

DeleteChannel

Previous topic:

Channels

Need help?

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.