[ aws . mediapackagev2 ]

create-channel

Description

Create a channel to start receiving content streams. The channel represents the input to MediaPackage for incoming live content from an encoder such as AWS Elemental MediaLive. The channel receives content, and after packaging it, outputs it through an origin endpoint to downstream devices (such as video players or CDNs) that request the content. You can create only one channel with each request. We recommend that you spread out channels between channel groups, such as putting redundant channels in the same AWS Region in different channel groups.

See also: AWS API Documentation

Synopsis

  create-channel
--channel-group-name <value>
--channel-name <value>
[--client-token <value>]
[--input-type <value>]
[--description <value>]
[--input-switch-configuration <value>]
[--output-header-configuration <value>]
[--multiview-configuration <value>]
[--output-locking-mode <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--channel-group-name (string) [required]

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.

Constraints:

• min: 1
• max: 256
• pattern: [a-zA-Z0-9_-]+

--channel-name (string) [required]

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. You can’t change the name after you create the channel.

Constraints:

• min: 1
• max: 256
• pattern: [a-zA-Z0-9_-]+

--client-token (string)

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

Constraints:

• min: 1
• max: 256
• pattern: [\S]+

--input-type (string)

The input type is an immutable field. It defines whether the channel allows CMAF ingest, HLS ingest, or server-side multiview output. Multiview channels receive no ingest of their own. If unprovided, the value defaults to HLS.

The allowed values are:

• HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
• CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
• MULTIVIEW – Server-side multiview. The channel receives no ingest of its own. Instead, it composites video from the source channels in its MultiviewConfiguration into a single tiled output stream.

Possible values:

• HLS
• CMAF
• MULTIVIEW

--description (string)

Enter any descriptive text that helps you to identify the channel.

Constraints:

• min: 0
• max: 1024

--input-switch-configuration (structure)

The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when InputType is CMAF .

MQCSInputSwitching -> (boolean)

When true, AWS Elemental MediaPackage performs input switching based on the MQCS. Default is false. This setting is valid only when InputType is CMAF .

PreferredInput -> (integer)

For CMAF inputs, indicates which input MediaPackage should prefer when both inputs have equal MQCS scores. Select 1 to prefer the first ingest endpoint, or 2 to prefer the second ingest endpoint. If you don’t specify a preferred input, MediaPackage uses its default switching behavior when MQCS scores are equal.

Constraints:

• min: 1
• max: 2

Shorthand Syntax:

MQCSInputSwitching=boolean,PreferredInput=integer

JSON Syntax:

{
  "MQCSInputSwitching": true|false,
  "PreferredInput": integer
}

--output-header-configuration (structure)

The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when InputType is CMAF .

PublishMQCS -> (boolean)

When true, AWS Elemental MediaPackage includes the MQCS in responses to the CDN. This setting is valid only when InputType is CMAF .

Shorthand Syntax:

PublishMQCS=boolean

JSON Syntax:

{
  "PublishMQCS": true|false
}

--multiview-configuration (structure)

The multiview configuration for the channel. This setting is required when InputType is MULTIVIEW , and can’t be set for any other input type.

AvailableSources -> (list) [required]

The channels that players can use as tiles in this multiview channel’s output. Each source channel must be in the same channel group as the multiview channel, and must have an InputType of CMAF . Only the channels that you list here are available as tiles.

Constraints:

• min: 1
• max: 10

(string)

Constraints:

• min: 1
• max: 256
• pattern: [a-zA-Z0-9_-]+

AvailableLayouts -> (list) [required]

The tile layouts that players can request from this multiview channel’s origin endpoints. Only the layouts that you list here are available. Each layout must appear at most once.

Constraints:

• min: 1
• max: 6

(string)

A tile layout for a multiview channel. Each layout determines how many source tiles are composited into the output and how those tiles are arranged.

The allowed values are:

• LAYOUT_SINGLE – One tile at full resolution. Use this to serve a single source as a standard stream.
• LAYOUT_2EH – Two tiles of equal size, arranged horizontally.
• LAYOUT_2PL – Two tiles, with one larger primary tile.
• LAYOUT_3EB – Three tiles of equal size, with two on top and one below.
• LAYOUT_3EL – Three tiles of equal size, arranged in two columns.
• LAYOUT_3PL – Three tiles, with one larger primary tile on the left and two stacked on the right.
• LAYOUT_4E – Four tiles of equal size, arranged in a two-by-two grid.
• LAYOUT_4PL – Four tiles, with one larger primary tile on the left and three stacked on the right.

Possible values:

• LAYOUT_2EH
• LAYOUT_2PL
• LAYOUT_3EL
• LAYOUT_3PL
• LAYOUT_4E
• LAYOUT_4PL

Shorthand Syntax:

AvailableSources=string,string,AvailableLayouts=string,string

JSON Syntax:

{
  "AvailableSources": ["string", ...],
  "AvailableLayouts": ["LAYOUT_2EH"|"LAYOUT_2PL"|"LAYOUT_3EL"|"LAYOUT_3PL"|"LAYOUT_4E"|"LAYOUT_4PL", ...]
}

--output-locking-mode (string)

The output locking mode for the channel. This setting is only valid when InputType is CMAF . This value is immutable after channel creation. If you don’t specify a value, the default is EPOCH_LOCKED .

The allowed values are:

• EPOCH_LOCKED - The channel uses epoch-locked behavior with deterministic sequence numbering and fixed segment boundaries aligned to epoch time. This mode supports cross-region synchronization and failover.
• NON_EPOCH_LOCKED - The channel uses non-epoch-locked behavior with duration-based segment combining and monotonically increasing sequence numbers starting from 0. This mode does not support cross-region synchronization or failover.

Possible values:

• EPOCH_LOCKED
• NON_EPOCH_LOCKED

--tags (map)

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

"Key1": "Value1",

"Key2": "Value2"

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream
• off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

MultiviewConfiguration -> (structure)

The multiview configuration for the channel. This is present only when InputType is MULTIVIEW .

AvailableSources -> (list) [required]

The channels that players can use as tiles in this multiview channel’s output. Each source channel must be in the same channel group as the multiview channel, and must have an InputType of CMAF . Only the channels that you list here are available as tiles.

Constraints:

• min: 1
• max: 10

(string)

Constraints:

• min: 1
• max: 256
• pattern: [a-zA-Z0-9_-]+

AvailableLayouts -> (list) [required]

The tile layouts that players can request from this multiview channel’s origin endpoints. Only the layouts that you list here are available. Each layout must appear at most once.

Constraints:

• min: 1
• max: 6

(string)

A tile layout for a multiview channel. Each layout determines how many source tiles are composited into the output and how those tiles are arranged.

The allowed values are:

• LAYOUT_SINGLE – One tile at full resolution. Use this to serve a single source as a standard stream.
• LAYOUT_2EH – Two tiles of equal size, arranged horizontally.
• LAYOUT_2PL – Two tiles, with one larger primary tile.
• LAYOUT_3EB – Three tiles of equal size, with two on top and one below.
• LAYOUT_3EL – Three tiles of equal size, arranged in two columns.
• LAYOUT_3PL – Three tiles, with one larger primary tile on the left and two stacked on the right.
• LAYOUT_4E – Four tiles of equal size, arranged in a two-by-two grid.
• LAYOUT_4PL – Four tiles, with one larger primary tile on the left and three stacked on the right.

Possible values:

• LAYOUT_2EH
• LAYOUT_2PL
• LAYOUT_3EL
• LAYOUT_3PL
• LAYOUT_4E
• LAYOUT_4PL

AttachedMultiviewChannels -> (list)

The multiview channels, in the same channel group, that list this channel as an available source. This is a read-only field. You can’t delete a channel while any multiview channel still lists it as a source. Use this field to find the multiview channels that you need to update first.

(string)

Constraints:

• min: 1
• max: 256
• pattern: [a-zA-Z0-9_-]+

Arn -> (string)

The Amazon Resource Name (ARN) associated with the resource.

ChannelName -> (string)

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

ChannelGroupName -> (string)

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.

CreatedAt -> (timestamp)

The date and time the channel was created.

ModifiedAt -> (timestamp)

The date and time the channel was modified.

Description -> (string)

The description for your channel.

Constraints:

• min: 0
• max: 1024

IngestEndpoints -> (list)

The list of ingest endpoints.

(structure)

The ingest domain URL where the source stream should be sent.

Id -> (string)

The system-generated unique identifier for the IngestEndpoint.

Url -> (string)

The ingest domain URL where the source stream should be sent.

InputType -> (string)

The input type is an immutable field. It defines whether the channel allows CMAF ingest, HLS ingest, or server-side multiview output. Multiview channels receive no ingest of their own. If unprovided, the value defaults to HLS.

The allowed values are:

• HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
• CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
• MULTIVIEW – Server-side multiview. The channel receives no ingest of its own. Instead, it composites video from the source channels in its MultiviewConfiguration into a single tiled output stream.

Possible values:

• HLS
• CMAF
• MULTIVIEW

ETag -> (string)

The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

Constraints:

• min: 1
• max: 256
• pattern: [\S]+

Tags -> (map)

The comma-separated list of tag key:value pairs assigned to the channel.

key -> (string)

value -> (string)

InputSwitchConfiguration -> (structure)

The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when InputType is CMAF .

MQCSInputSwitching -> (boolean)

When true, AWS Elemental MediaPackage performs input switching based on the MQCS. Default is false. This setting is valid only when InputType is CMAF .

PreferredInput -> (integer)

For CMAF inputs, indicates which input MediaPackage should prefer when both inputs have equal MQCS scores. Select 1 to prefer the first ingest endpoint, or 2 to prefer the second ingest endpoint. If you don’t specify a preferred input, MediaPackage uses its default switching behavior when MQCS scores are equal.

Constraints:

• min: 1
• max: 2

OutputHeaderConfiguration -> (structure)

The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when InputType is CMAF .

PublishMQCS -> (boolean)

When true, AWS Elemental MediaPackage includes the MQCS in responses to the CDN. This setting is valid only when InputType is CMAF .

OutputLockingMode -> (string)

The output locking mode configured for the channel.

The allowed values are:

• EPOCH_LOCKED - The channel uses epoch-locked behavior with deterministic sequence numbering and fixed segment boundaries aligned to epoch time.
• NON_EPOCH_LOCKED - The channel uses non-epoch-locked behavior with duration-based segment combining and monotonically increasing sequence numbers starting from 0.

Possible values:

• EPOCH_LOCKED
• NON_EPOCH_LOCKED