URI HTTP methods Schemas Properties See also

Channels

URI

/channels

HTTP methods

GET

Operation ID: ListChannels

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

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	Upper bound on number of records to return.

Responses
Status code	Response model	Description
`200`	`ChannelList`	`200 OK` response The list of channels is 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 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.
`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.

POST

Operation ID: CreateChannel

Creates a channel to receive content.

Once created, a channel provides static input 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.

Responses
Status code	Response model	Description
`200`	`Channel`	`200 OK` response The channel is created 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 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.
`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.

OPTIONS

Enable CORS by returning correct headers.

Responses
Status code	Response model	Description
`200`	None	Default response for CORS method.

Schemas

Request bodies


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

Response bodies


{
  "channels": [
    {
      "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": {
      }
    }
  ],
  "nextToken": "string"
}


{
  "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.

Property	Type	Required	Description
`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.

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. Supported characters are numbers, letters, underscores (_), and dashes (-) with a length of 1 to 256 characters.
`tags`	Tags	False	The tags to assign to the channel.

ChannelList

A collection of Channel records.

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.

EgressAccessLogs

Egress access log configuration parameters.

Property	Type	Required	Description
`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.

Property	Type	Required	Description
`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.

Property	Type	Required	Description
`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.

Property	Type	Required	Description
`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`.