AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . mediapackagev2 ]
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
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>]
[--tags <value>]
[--cli-input-json <value>]
[--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>]
--channel-group-name
(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.
--channel-name
(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. You can't change the name after you create the channel.
--client-token
(string)
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
--input-type
(string)
The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
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).Possible values:
HLS
CMAF
--description
(string)
Enter any descriptive text that helps you to identify the channel.
--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
isCMAF
.MQCSInputSwitching -> (boolean)
When true, AWS Elemental MediaPackage performs input switching based on the MQCS. Default is true. This setting is valid only whenInputType
isCMAF
.
Shorthand Syntax:
MQCSInputSwitching=boolean
JSON Syntax:
{
"MQCSInputSwitching": true|false
}
--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
isCMAF
.PublishMQCS -> (boolean)
When true, AWS Elemental MediaPackage includes the MQCS in responses to the CDN. This setting is valid only whenInputType
isCMAF
.
Shorthand Syntax:
PublishMQCS=boolean
JSON Syntax:
{
"PublishMQCS": true|false
}
--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
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI 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.
--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
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--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.
--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.
--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.
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.
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 will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.
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).
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.
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
isCMAF
.MQCSInputSwitching -> (boolean)
When true, AWS Elemental MediaPackage performs input switching based on the MQCS. Default is true. This setting is valid only whenInputType
isCMAF
.
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
isCMAF
.PublishMQCS -> (boolean)
When true, AWS Elemental MediaPackage includes the MQCS in responses to the CDN. This setting is valid only whenInputType
isCMAF
.