[ aws . mediapackage ]

rotate-ingest-endpoint-credentials

Description

Rotate the IngestEndpoint’s username and password, as specified by the IngestEndpoint’s id.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  rotate-ingest-endpoint-credentials
--id <value>
--ingest-endpoint-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--id (string) The ID of the channel the IngestEndpoint is on.

--ingest-endpoint-id (string) The id of the IngestEndpoint whose credentials should be rotated

--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 rotate ingest credentials

The following rotate-ingest-endpoint-credentials command rotates the WebDAV username and password for the specified ingest endpoint.

aws mediapackage rotate-ingest-endpoint-credentials \
    --id test \
    --ingest-endpoint-id 584797f1740548c389a273585dd22a63

Output:

{
    "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/584797f1740548c389a273585dd22a63",
    "HlsIngest": {
        "IngestEndpoints": [
            {
                "Id": "584797f1740548c389a273585dd22a63",
                "Password": "webdavregeneratedpassword1",
                "Url": "https://9be9c4405c474882.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/584797f1740548c389a273585dd22a63/channel",
                "Username": "webdavregeneratedusername1"
            },
            {
                "Id": "7d187c8616fd455f88aaa5a9fcf74442",
                "Password": "webdavgeneratedpassword2",
                "Url": "https://7bf454c57220328d.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/7d187c8616fd455f88aaa5a9fcf74442/channel",
                "Username": "webdavgeneratedusername2"
            }
        ]
    },
    "Id": "test",
    "Tags": {}
}

For more information, see Rotating Credentials on an Input URL 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)