[ aws . medialive ]

describe-multiplex

Description

Gets details about a multiplex.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-multiplex
--multiplex-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--multiplex-id (string) The ID of the multiplex.

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

See ‘aws help’ for descriptions of global parameters.

Output

Arn -> (string)

The unique arn of the multiplex.

AvailabilityZones -> (list)

A list of availability zones for the multiplex.

(string)

Placeholder documentation for __string

Destinations -> (list)

A list of the multiplex output destinations.

(structure)

Multiplex output destination settings

MediaConnectSettings -> (structure)

Multiplex MediaConnect output destination settings.

EntitlementArn -> (string)

The MediaConnect entitlement ARN available as a Flow source.

Id -> (string)

The unique id of the multiplex.

MultiplexSettings -> (structure)

Configuration for a multiplex event.

MaximumVideoBufferDelayMilliseconds -> (integer)

Maximum video buffer delay in milliseconds.

TransportStreamBitrate -> (integer)

Transport stream bit rate.

TransportStreamId -> (integer)

Transport stream ID.

TransportStreamReservedBitrate -> (integer)

Transport stream reserved bit rate.

Name -> (string)

The name of the multiplex.

PipelinesRunningCount -> (integer)

The number of currently healthy pipelines.

ProgramCount -> (integer)

The number of programs in the multiplex.

State -> (string)

The current state of the multiplex.

Tags -> (map)

A collection of key-value pairs.

key -> (string)

Placeholder documentation for __string

value -> (string)

Placeholder documentation for __string