MediaConnect / Client / get_router_input

get_router_input

MediaConnect.Client.get_router_input(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_router_input(
    Arn='string'
)
Parameters:

Arn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'RouterInput': {
        'Name': 'string',
        'Arn': 'string',
        'Id': 'string',
        'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
        'InputType': 'STANDARD'|'FAILOVER'|'MERGE'|'MEDIACONNECT_FLOW',
        'Configuration': {
            'Standard': {
                'NetworkInterfaceArn': 'string',
                'ProtocolConfiguration': {
                    'Rtp': {
                        'Port': 123,
                        'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
                    },
                    'Rist': {
                        'Port': 123,
                        'RecoveryLatencyMilliseconds': 123
                    },
                    'SrtListener': {
                        'Port': 123,
                        'MinimumLatencyMilliseconds': 123,
                        'DecryptionConfiguration': {
                            'EncryptionKey': {
                                'SecretArn': 'string',
                                'RoleArn': 'string'
                            }
                        }
                    },
                    'SrtCaller': {
                        'SourceAddress': 'string',
                        'SourcePort': 123,
                        'MinimumLatencyMilliseconds': 123,
                        'StreamId': 'string',
                        'DecryptionConfiguration': {
                            'EncryptionKey': {
                                'SecretArn': 'string',
                                'RoleArn': 'string'
                            }
                        }
                    }
                },
                'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
            },
            'Failover': {
                'NetworkInterfaceArn': 'string',
                'ProtocolConfigurations': [
                    {
                        'Rtp': {
                            'Port': 123,
                            'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
                        },
                        'Rist': {
                            'Port': 123,
                            'RecoveryLatencyMilliseconds': 123
                        },
                        'SrtListener': {
                            'Port': 123,
                            'MinimumLatencyMilliseconds': 123,
                            'DecryptionConfiguration': {
                                'EncryptionKey': {
                                    'SecretArn': 'string',
                                    'RoleArn': 'string'
                                }
                            }
                        },
                        'SrtCaller': {
                            'SourceAddress': 'string',
                            'SourcePort': 123,
                            'MinimumLatencyMilliseconds': 123,
                            'StreamId': 'string',
                            'DecryptionConfiguration': {
                                'EncryptionKey': {
                                    'SecretArn': 'string',
                                    'RoleArn': 'string'
                                }
                            }
                        }
                    },
                ],
                'SourcePriorityMode': 'NO_PRIORITY'|'PRIMARY_SECONDARY',
                'PrimarySourceIndex': 123
            },
            'Merge': {
                'NetworkInterfaceArn': 'string',
                'ProtocolConfigurations': [
                    {
                        'Rtp': {
                            'Port': 123,
                            'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
                        },
                        'Rist': {
                            'Port': 123,
                            'RecoveryLatencyMilliseconds': 123
                        }
                    },
                ],
                'MergeRecoveryWindowMilliseconds': 123
            },
            'MediaConnectFlow': {
                'FlowArn': 'string',
                'FlowOutputArn': 'string',
                'SourceTransitDecryption': {
                    'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
                    'EncryptionKeyConfiguration': {
                        'SecretsManager': {
                            'SecretArn': 'string',
                            'RoleArn': 'string'
                        },
                        'Automatic': {}
                    }
                }
            }
        },
        'RoutedOutputs': 123,
        'MaximumRoutedOutputs': 123,
        'RegionName': 'string',
        'AvailabilityZone': 'string',
        'MaximumBitrate': 123,
        'Tier': 'INPUT_100'|'INPUT_50'|'INPUT_20',
        'RoutingScope': 'REGIONAL'|'GLOBAL',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'Messages': [
            {
                'Code': 'string',
                'Message': 'string'
            },
        ],
        'TransitEncryption': {
            'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
            'EncryptionKeyConfiguration': {
                'SecretsManager': {
                    'SecretArn': 'string',
                    'RoleArn': 'string'
                },
                'Automatic': {}
            }
        },
        'Tags': {
            'string': 'string'
        },
        'StreamDetails': {
            'Standard': {
                'SourceIpAddress': 'string'
            },
            'Failover': {
                'SourceIndexZeroStreamDetails': {
                    'SourceIndex': 123,
                    'SourceIpAddress': 'string'
                },
                'SourceIndexOneStreamDetails': {
                    'SourceIndex': 123,
                    'SourceIpAddress': 'string'
                }
            },
            'Merge': {
                'SourceIndexZeroStreamDetails': {
                    'SourceIndex': 123,
                    'SourceIpAddress': 'string'
                },
                'SourceIndexOneStreamDetails': {
                    'SourceIndex': 123,
                    'SourceIpAddress': 'string'
                }
            },
            'MediaConnectFlow': {}
        },
        'IpAddress': 'string',
        'MaintenanceType': 'PREFERRED_DAY_TIME'|'DEFAULT',
        'MaintenanceConfiguration': {
            'PreferredDayTime': {
                'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
                'Time': 'string'
            },
            'Default': {}
        },
        'MaintenanceScheduleType': 'WINDOW',
        'MaintenanceSchedule': {
            'Window': {
                'Start': datetime(2015, 1, 1),
                'End': datetime(2015, 1, 1),
                'ScheduledTime': datetime(2015, 1, 1)
            }
        }
    }
}

Response Structure

  • (dict) –

    • RouterInput (dict) –

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

      • Name (string) –

        The name of the router input.

      • Arn (string) –

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

      • Id (string) –

        The unique identifier of the router input.

      • State (string) –

        The current state of the router input.

      • InputType (string) –

        The type of the router input.

      • Configuration (dict) –

        The configuration settings for a router input.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, Failover, Merge, MediaConnectFlow. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

        • Standard (dict) –

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

          • NetworkInterfaceArn (string) –

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

          • ProtocolConfiguration (dict) –

            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 will be set: Rtp, Rist, SrtListener, SrtCaller. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

            • Rtp (dict) –

              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) –

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

              • ForwardErrorCorrection (string) –

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

            • Rist (dict) –

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

              • Port (integer) –

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

              • RecoveryLatencyMilliseconds (integer) –

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

            • SrtListener (dict) –

              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) –

                The port number for the SRT protocol in listener mode.

              • MinimumLatencyMilliseconds (integer) –

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

              • DecryptionConfiguration (dict) –

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

                • EncryptionKey (dict) –

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

                  • SecretArn (string) –

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

                  • RoleArn (string) –

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

            • SrtCaller (dict) –

              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) –

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

              • SourcePort (integer) –

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

              • MinimumLatencyMilliseconds (integer) –

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

              • StreamId (string) –

                The stream ID for the SRT protocol in caller mode.

              • DecryptionConfiguration (dict) –

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

                • EncryptionKey (dict) –

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

                  • SecretArn (string) –

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

                  • RoleArn (string) –

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

          • Protocol (string) –

            The protocol used by the standard router input.

        • Failover (dict) –

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

          • NetworkInterfaceArn (string) –

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

          • ProtocolConfigurations (list) –

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

            • (dict) –

              Protocol configuration settings for failover router inputs.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: Rtp, Rist, SrtListener, SrtCaller. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

              • Rtp (dict) –

                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) –

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

                • ForwardErrorCorrection (string) –

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

              • Rist (dict) –

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

                • Port (integer) –

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

                • RecoveryLatencyMilliseconds (integer) –

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

              • SrtListener (dict) –

                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) –

                  The port number for the SRT protocol in listener mode.

                • MinimumLatencyMilliseconds (integer) –

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

                • DecryptionConfiguration (dict) –

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

                  • EncryptionKey (dict) –

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

                    • SecretArn (string) –

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

                    • RoleArn (string) –

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

              • SrtCaller (dict) –

                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) –

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

                • SourcePort (integer) –

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

                • MinimumLatencyMilliseconds (integer) –

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

                • StreamId (string) –

                  The stream ID for the SRT protocol in caller mode.

                • DecryptionConfiguration (dict) –

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

                  • EncryptionKey (dict) –

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

                    • SecretArn (string) –

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

                    • RoleArn (string) –

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

          • SourcePriorityMode (string) –

            The mode for determining source priority in failover configurations.

          • 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

        • Merge (dict) –

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

          • NetworkInterfaceArn (string) –

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

          • ProtocolConfigurations (list) –

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

            • (dict) –

              Protocol configuration settings for merge router inputs.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: Rtp, Rist. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

              • Rtp (dict) –

                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) –

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

                • ForwardErrorCorrection (string) –

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

              • Rist (dict) –

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

                • Port (integer) –

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

                • RecoveryLatencyMilliseconds (integer) –

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

          • MergeRecoveryWindowMilliseconds (integer) –

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

        • MediaConnectFlow (dict) –

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

          • FlowArn (string) –

            The ARN of the flow to connect to.

          • FlowOutputArn (string) –

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

          • SourceTransitDecryption (dict) –

            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.

            • EncryptionKeyConfiguration (dict) –

              The configuration details for the encryption key.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

              • SecretsManager (dict) –

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

                • SecretArn (string) –

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

                • RoleArn (string) –

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

              • Automatic (dict) –

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

      • RoutedOutputs (integer) –

        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) –

        The AWS Region where the router input is located.

      • AvailabilityZone (string) –

        The Availability Zone of the router input.

      • MaximumBitrate (integer) –

        The maximum bitrate for the router input.

      • Tier (string) –

        The tier level of the router input.

      • RoutingScope (string) –

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

      • CreatedAt (datetime) –

        The timestamp when the router input was created.

      • UpdatedAt (datetime) –

        The timestamp when the router input was last updated.

      • Messages (list) –

        The messages associated with the router input.

        • (dict) –

          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.

      • TransitEncryption (dict) –

        The transit encryption settings for a router input.

        • EncryptionKeyType (string) –

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

        • EncryptionKeyConfiguration (dict) –

          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 will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • SecretsManager (dict) –

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

            • SecretArn (string) –

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

            • RoleArn (string) –

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

          • Automatic (dict) –

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

      • Tags (dict) –

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

        • (string) –

          • (string) –

      • StreamDetails (dict) –

        Configuration details for the router input stream.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, Failover, Merge, MediaConnectFlow. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

        • Standard (dict) –

          Configuration details for a standard router input stream type.

          • SourceIpAddress (string) –

            The source IP address for the standard router input stream.

        • Failover (dict) –

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

          • SourceIndexZeroStreamDetails (dict) –

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

            • SourceIndex (integer) –

              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 (dict) –

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

            • SourceIndex (integer) –

              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 (dict) –

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

          • SourceIndexZeroStreamDetails (dict) –

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

            • SourceIndex (integer) –

              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 (dict) –

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

            • SourceIndex (integer) –

              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 (dict) –

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

      • IpAddress (string) –

        The IP address of the router input.

      • MaintenanceType (string) –

        The type of maintenance configuration applied to this router input.

      • MaintenanceConfiguration (dict) –

        The maintenance configuration settings applied to this router input.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: PreferredDayTime, Default. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

        • PreferredDayTime (dict) –

          Preferred day and time maintenance configuration settings.

          • Day (string) –

            The preferred day for maintenance operations.

          • Time (string) –

            The preferred time for maintenance operations.

        • Default (dict) –

          Default maintenance configuration settings.

      • MaintenanceScheduleType (string) –

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

      • MaintenanceSchedule (dict) –

        The current maintenance schedule details for this router input.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: Window. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

        • Window (dict) –

          Defines a specific time window for maintenance operations.

          • Start (datetime) –

            The start time of the maintenance window.

          • End (datetime) –

            The end time of the maintenance window.

          • ScheduledTime (datetime) –

            The date and time when the maintenance window is scheduled to occur.

Exceptions