[ aws . mediapackage ]

update-channel

Description

Updates an existing Channel.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-channel
[--description <value>]
--id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--description (string) A short text description of the Channel.

--id (string) The ID of the Channel to update.

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

See ‘aws help’ for descriptions of global parameters.

Examples

To update a channel

The following update-channel command updates the channel named sportschannel to include the description 24x7 sports.

aws mediapackage update-channel \
    --id sportschannel \
    --description "24x7 sports"

Output:

{
    "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0",
    "Description": "24x7 sports",
    "HlsIngest": {
        "IngestEndpoints": [
            {
                "Id": "6d345804ec3f46c9b454a91d4a80d0e0",
                "Password": "generatedwebdavpassword1",
                "Url": "https://f31c86aed53b815a.mediapackage.us-west-2.amazonaws.com/in/v2/6d345804ec3f46c9b454a91d4a80d0e0/6d345804ec3f46c9b454a91d4a80d0e0/channel",
                "Username": "generatedwebdavusername1"
            },
            {
                "Id": "2daa32878af24803b24183727211b8ff",
                "Password": "generatedwebdavpassword2",
                "Url": "https://6ebbe7e04c4b0afa.mediapackage.us-west-2.amazonaws.com/in/v2/6d345804ec3f46c9b454a91d4a80d0e0/2daa32878af24803b24183727211b8ff/channel",
                "Username": "generatedwebdavusername2"
            }
        ]
    },
    "Id": "sportschannel",
    "Tags": {}
}

For more information, see Editing a Channel in the AWS Elemental MediaPackage User Guide.

Output

Arn -> (string)

The Amazon Resource Name (ARN) assigned to the Channel.

Description -> (string)

A short text description of the Channel.

EgressAccessLogs -> (structure)

Configure egress access logging.

LogGroupName -> (string)

Customize the log group name.

HlsIngest -> (structure)

An HTTP Live Streaming (HLS) ingest resource configuration.

IngestEndpoints -> (list)

A list of endpoints to which the source stream should be sent.

(structure)

An endpoint for ingesting source content for a Channel.

Id -> (string)

The system generated unique identifier for the IngestEndpoint

Password -> (string)

The system generated password for ingest authentication.

Url -> (string)

The ingest URL to which the source stream should be sent.

Username -> (string)

The system generated username for ingest authentication.

Id -> (string)

The ID of the Channel.

IngressAccessLogs -> (structure)

Configure ingress access logging.

LogGroupName -> (string)

Customize the log group name.

Tags -> (map)

A collection of tags associated with a resource

key -> (string)

value -> (string)