AWS CLI Command Reference

[ aws . mediaconnect ]

get-router-input

Description

Retrieves information about a specific router input in AWS Elemental MediaConnect.

See also: AWS API Documentation

Synopsis

  get-router-input
--arn <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--arn (string) [required]

The Amazon Resource Name (ARN) of the router input to retrieve information about.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:routerInput:[a-z0-9]{12}

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

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
  • yaml
  • yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

RouterInput -> (structure)

The details of the requested router input, including its configuration, state, and other attributes.

Name -> (string) [required]

The name of the router input.

Arn -> (string) [required]

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

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:routerInput:[a-z0-9]{12}

Id -> (string) [required]

The unique identifier of the router input.

State -> (string) [required]

The current state of the router input.

Possible values:

  • CREATING
  • STANDBY
  • STARTING
  • ACTIVE
  • STOPPING
  • DELETING
  • UPDATING
  • ERROR
  • RECOVERING
  • MIGRATING

InputType -> (string) [required]

The type of the router input.

Possible values:

  • STANDARD
  • FAILOVER
  • MERGE
  • MEDIACONNECT_FLOW

Configuration -> (tagged union structure) [required]

The configuration settings for a router input.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Standard, Failover, Merge, MediaConnectFlow.

Standard -> (structure)

The configuration settings for a standard router input, including the protocol, protocol-specific configuration, network interface, and availability zone.

NetworkInterfaceArn -> (string) [required]

The Amazon Resource Name (ARN) of the network interface associated with the standard router input.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:routerNetworkInterface:[a-z0-9]{12}

ProtocolConfiguration -> (tagged union structure) [required]

The configuration settings for the protocol used by the standard router input.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Rtp, Rist, SrtListener, SrtCaller.

Rtp -> (structure)

The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.

Port -> (integer) [required]

The port number used for the RTP protocol in the router input configuration.

Constraints:

  • min: 3000
  • max: 30000

ForwardErrorCorrection -> (string)

The state of forward error correction for the RTP protocol in the router input configuration.

Possible values:

  • ENABLED
  • DISABLED

Rist -> (structure)

The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.

Port -> (integer) [required]

The port number used for the RIST protocol in the router input configuration.

Constraints:

  • min: 3000
  • max: 30000

RecoveryLatencyMilliseconds -> (long) [required]

The recovery latency in milliseconds for the RIST protocol in the router input configuration.

Constraints:

  • min: 10
  • max: 10000

SrtListener -> (structure)

The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.

Port -> (integer) [required]

The port number for the SRT protocol in listener mode.

Constraints:

  • min: 3000
  • max: 30000

MinimumLatencyMilliseconds -> (long) [required]

The minimum latency in milliseconds for the SRT protocol in listener mode.

Constraints:

  • min: 10
  • max: 10000

DecryptionConfiguration -> (structure)

Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.

EncryptionKey -> (structure) [required]

Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.

SecretArn -> (string) [required]

The ARN of the AWS Secrets Manager secret used for transit encryption.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+

RoleArn -> (string) [required]

The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@-]+

SrtCaller -> (structure)

The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.

SourceAddress -> (string) [required]

The source IP address for the SRT protocol in caller mode.

SourcePort -> (integer) [required]

The source port number for the SRT protocol in caller mode.

Constraints:

  • min: 0
  • max: 65535

MinimumLatencyMilliseconds -> (long) [required]

The minimum latency in milliseconds for the SRT protocol in caller mode.

Constraints:

  • min: 10
  • max: 10000

StreamId -> (string)

The stream ID for the SRT protocol in caller mode.

DecryptionConfiguration -> (structure)

Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.

EncryptionKey -> (structure) [required]

Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.

SecretArn -> (string) [required]

The ARN of the AWS Secrets Manager secret used for transit encryption.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+

RoleArn -> (string) [required]

The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@-]+

Protocol -> (string)

The protocol used by the standard router input.

Possible values:

  • RTP
  • RIST
  • SRT_CALLER
  • SRT_LISTENER

Failover -> (structure)

Configuration settings for a failover router input that allows switching between two input sources.

NetworkInterfaceArn -> (string) [required]

The ARN of the network interface to use for this failover router input.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:routerNetworkInterface:[a-z0-9]{12}

ProtocolConfigurations -> (list) [required]

A list of exactly two protocol configurations for the failover input sources. Both must use the same protocol type.

(tagged union structure)

Protocol configuration settings for failover router inputs.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Rtp, Rist, SrtListener, SrtCaller.

Rtp -> (structure)

The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.

Port -> (integer) [required]

The port number used for the RTP protocol in the router input configuration.

Constraints:

  • min: 3000
  • max: 30000

ForwardErrorCorrection -> (string)

The state of forward error correction for the RTP protocol in the router input configuration.

Possible values:

  • ENABLED
  • DISABLED

Rist -> (structure)

The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.

Port -> (integer) [required]

The port number used for the RIST protocol in the router input configuration.

Constraints:

  • min: 3000
  • max: 30000

RecoveryLatencyMilliseconds -> (long) [required]

The recovery latency in milliseconds for the RIST protocol in the router input configuration.

Constraints:

  • min: 10
  • max: 10000

SrtListener -> (structure)

The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.

Port -> (integer) [required]

The port number for the SRT protocol in listener mode.

Constraints:

  • min: 3000
  • max: 30000

MinimumLatencyMilliseconds -> (long) [required]

The minimum latency in milliseconds for the SRT protocol in listener mode.

Constraints:

  • min: 10
  • max: 10000

DecryptionConfiguration -> (structure)

Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.

EncryptionKey -> (structure) [required]

Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.

SecretArn -> (string) [required]

The ARN of the AWS Secrets Manager secret used for transit encryption.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+

RoleArn -> (string) [required]

The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@-]+

SrtCaller -> (structure)

The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.

SourceAddress -> (string) [required]

The source IP address for the SRT protocol in caller mode.

SourcePort -> (integer) [required]

The source port number for the SRT protocol in caller mode.

Constraints:

  • min: 0
  • max: 65535

MinimumLatencyMilliseconds -> (long) [required]

The minimum latency in milliseconds for the SRT protocol in caller mode.

Constraints:

  • min: 10
  • max: 10000

StreamId -> (string)

The stream ID for the SRT protocol in caller mode.

DecryptionConfiguration -> (structure)

Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.

EncryptionKey -> (structure) [required]

Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.

SecretArn -> (string) [required]

The ARN of the AWS Secrets Manager secret used for transit encryption.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+

RoleArn -> (string) [required]

The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@-]+

SourcePriorityMode -> (string) [required]

The mode for determining source priority in failover configurations.

Possible values:

  • NO_PRIORITY
  • PRIMARY_SECONDARY

PrimarySourceIndex -> (integer)

The index (0 or 1) that specifies which source in the protocol configurations list is currently active. Used to control which of the two failover sources is currently selected. This field is ignored when sourcePriorityMode is set to NO_PRIORITY

Constraints:

  • min: 0
  • max: 1

Merge -> (structure)

Configuration settings for a merge router input that combines two input sources.

NetworkInterfaceArn -> (string) [required]

The ARN of the network interface to use for this merge router input.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:routerNetworkInterface:[a-z0-9]{12}

ProtocolConfigurations -> (list) [required]

A list of exactly two protocol configurations for the merge input sources. Both must use the same protocol type.

(tagged union structure)

Protocol configuration settings for merge router inputs.

Note

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

Rtp -> (structure)

The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.

Port -> (integer) [required]

The port number used for the RTP protocol in the router input configuration.

Constraints:

  • min: 3000
  • max: 30000

ForwardErrorCorrection -> (string)

The state of forward error correction for the RTP protocol in the router input configuration.

Possible values:

  • ENABLED
  • DISABLED

Rist -> (structure)

The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.

Port -> (integer) [required]

The port number used for the RIST protocol in the router input configuration.

Constraints:

  • min: 3000
  • max: 30000

RecoveryLatencyMilliseconds -> (long) [required]

The recovery latency in milliseconds for the RIST protocol in the router input configuration.

Constraints:

  • min: 10
  • max: 10000

MergeRecoveryWindowMilliseconds -> (long) [required]

The time window in milliseconds for merging the two input sources.

MediaConnectFlow -> (structure)

Configuration settings for connecting a router input to a flow output.

FlowArn -> (string)

The ARN of the flow to connect to.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:flow:[a-zA-Z0-9-]+:[a-zA-Z0-9_-]+

FlowOutputArn -> (string)

The ARN of the flow output to connect to this router input.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:output:[a-zA-Z0-9-]+:[a-zA-Z0-9_-]+

SourceTransitDecryption -> (structure) [required]

The decryption configuration for the flow source when connected to this router input.

EncryptionKeyType -> (string)

The type of encryption key to use for flow transit encryption.

Possible values:

  • SECRETS_MANAGER
  • AUTOMATIC

EncryptionKeyConfiguration -> (tagged union structure) [required]

The configuration details for the encryption key.

Note

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

SecretsManager -> (structure)

The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.

SecretArn -> (string) [required]

The ARN of the AWS Secrets Manager secret used for transit encryption.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+

RoleArn -> (string) [required]

The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@-]+

Automatic -> (structure)

Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.

RoutedOutputs -> (integer) [required]

The number of router outputs associated with the router input.

MaximumRoutedOutputs -> (integer)

The maximum number of outputs that can be simultaneously routed to this input.

RegionName -> (string) [required]

The AWS Region where the router input is located.

AvailabilityZone -> (string) [required]

The Availability Zone of the router input.

MaximumBitrate -> (long) [required]

The maximum bitrate for the router input.

Tier -> (string) [required]

The tier level of the router input.

Possible values:

  • INPUT_100
  • INPUT_50
  • INPUT_20

RoutingScope -> (string) [required]

Indicates whether the router input is configured for Regional or global routing.

Possible values:

  • REGIONAL
  • GLOBAL

CreatedAt -> (timestamp) [required]

The timestamp when the router input was created.

UpdatedAt -> (timestamp) [required]

The timestamp when the router input was last updated.

Messages -> (list) [required]

The messages associated with the router input.

(structure)

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

Code -> (string) [required]

The code associated with the router input message.

Message -> (string) [required]

The message text associated with the router input message.

TransitEncryption -> (structure) [required]

The transit encryption settings for a router input.

EncryptionKeyType -> (string)

Specifies the type of encryption key to use for transit encryption.

Possible values:

  • SECRETS_MANAGER
  • AUTOMATIC

EncryptionKeyConfiguration -> (tagged union structure) [required]

Contains the configuration details for the encryption key used in transit encryption, including the key source and associated parameters.

Note

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

SecretsManager -> (structure)

The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.

SecretArn -> (string) [required]

The ARN of the AWS Secrets Manager secret used for transit encryption.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+

RoleArn -> (string) [required]

The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.

Constraints:

  • pattern: arn:(aws[a-zA-Z-]*):iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@-]+

Automatic -> (structure)

Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.

Tags -> (map) [required]

Key-value pairs that can be used to tag and organize this router input.

key -> (string)

value -> (string)

StreamDetails -> (tagged union structure) [required]

Configuration details for the router input stream.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Standard, Failover, Merge, MediaConnectFlow.

Standard -> (structure)

Configuration details for a standard router input stream type.

SourceIpAddress -> (string)

The source IP address for the standard router input stream.

Failover -> (structure)

Configuration details for a failover router input that can automatically switch between two sources.

SourceIndexZeroStreamDetails -> (structure) [required]

Configuration details for the primary source (index 0) in the failover setup.

SourceIndex -> (integer) [required]

The index number (0 or 1) assigned to this source in the failover configuration.

SourceIpAddress -> (string)

The IP address of the source for this indexed stream.

SourceIndexOneStreamDetails -> (structure) [required]

Configuration details for the secondary source (index 1) in the failover setup.

SourceIndex -> (integer) [required]

The index number (0 or 1) assigned to this source in the failover configuration.

SourceIpAddress -> (string)

The IP address of the source for this indexed stream.

Merge -> (structure)

Configuration details for a merge router input that combines two input sources.

SourceIndexZeroStreamDetails -> (structure) [required]

Configuration details for the first source (index 0) in the merge setup.

SourceIndex -> (integer) [required]

The index number (0 or 1) assigned to this source in the merge configuration.

SourceIpAddress -> (string)

The IP address of the source for this indexed stream in the merge setup.

SourceIndexOneStreamDetails -> (structure) [required]

Configuration details for the second source (index 1) in the merge setup.

SourceIndex -> (integer) [required]

The index number (0 or 1) assigned to this source in the merge configuration.

SourceIpAddress -> (string)

The IP address of the source for this indexed stream in the merge setup.

MediaConnectFlow -> (structure)

Configuration details for a MediaConnect flow when used as a router input source.

IpAddress -> (string)

The IP address of the router input.

MaintenanceType -> (string) [required]

The type of maintenance configuration applied to this router input.

Possible values:

  • PREFERRED_DAY_TIME
  • DEFAULT

MaintenanceConfiguration -> (tagged union structure) [required]

The maintenance configuration settings applied to this router input.

Note

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

PreferredDayTime -> (structure)

Preferred day and time maintenance configuration settings.

Day -> (string) [required]

The preferred day for maintenance operations.

Possible values:

  • MONDAY
  • TUESDAY
  • WEDNESDAY
  • THURSDAY
  • FRIDAY
  • SATURDAY
  • SUNDAY

Time -> (string) [required]

The preferred time for maintenance operations.

Default -> (structure)

Default maintenance configuration settings.

MaintenanceScheduleType -> (string)

The type of maintenance schedule currently in effect for this router input.

Possible values:

  • WINDOW

MaintenanceSchedule -> (tagged union structure)

The current maintenance schedule details for this router input.

Note

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

Window -> (structure)

Defines a specific time window for maintenance operations.

Start -> (timestamp) [required]

The start time of the maintenance window.

End -> (timestamp) [required]

The end time of the maintenance window.

ScheduledTime -> (timestamp) [required]

The date and time when the maintenance window is scheduled to occur.
© Copyright 2025, Amazon Web Services. Created using Sphinx.