AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . mediaconnect ]

get-router-input-source-metadata

Description

Retrieves detailed metadata information about a specific router input source, including stream details and connection state.

See also: AWS API Documentation

Synopsis

  get-router-input-source-metadata
--arn <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>]
[--v2-debug]

Options

--arn (string)

The Amazon Resource Name (ARN) of the router input to retrieve metadata for.

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

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

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

Arn -> (string)

The Amazon Resource Name (ARN) of the router input.

Name -> (string)

The name of the router input.

SourceMetadataDetails -> (structure)

Detailed metadata information about the router input source, including connection state, timestamps, and stream configuration.

SourceMetadataMessages -> (list)

Collection of metadata messages associated with the router input source.

(structure)

A message associated with a router input, including a code and a message.

Code -> (string)

The code associated with the router input message.

Message -> (string)

The message text associated with the router input message.

Timestamp -> (timestamp)

The timestamp when the metadata was last updated.

RouterInputMetadata -> (tagged union structure)

Metadata information specific to the router input configuration and state.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: TransportStreamMediaInfo.

TransportStreamMediaInfo -> (structure)

The metadata of the transport stream in the current flow’s source.

Programs -> (list)

The list of transport stream programs in the current flow’s source.

(structure)

The metadata of a single transport stream program.

PcrPid -> (integer)

The Program Clock Reference (PCR) Packet ID (PID) as it is reported in the Program Association Table.

ProgramName -> (string)

The program name as it is reported in the Program Association Table.

ProgramNumber -> (integer)

The program number as it is reported in the Program Association Table.

ProgramPid -> (integer)

The program Packet ID (PID) as it is reported in the Program Association Table.

Streams -> (list)

The list of elementary transport streams in the program. The list includes video, audio, and data streams.

(structure)

The metadata of an elementary transport stream.

Channels -> (integer)

The number of channels in the audio stream.

Codec -> (string)

The codec used by the stream.

FrameRate -> (string)

The frame rate used by the video stream.

FrameResolution -> (structure)

The frame resolution used by the video stream.

FrameHeight -> (integer)

The number of pixels in the height of the video frame.

FrameWidth -> (integer)

The number of pixels in the width of the video frame.

Pid -> (integer)

The Packet ID (PID) as it is reported in the Program Map Table.

SampleRate -> (integer)

The sample rate used by the audio stream.

SampleSize -> (integer)

The sample bit size used by the audio stream.

StreamType -> (string)

The Stream Type as it is reported in the Program Map Table.