MediaConnect / Client / get_router_output

get_router_output

MediaConnect.Client.get_router_output(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Arn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the router output that you want to retrieve information about.

Return type:

dict

Returns:

Response Syntax

{
    'RouterOutput': {
        'Name': 'string',
        'Arn': 'string',
        'Id': 'string',
        'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
        'OutputType': 'STANDARD'|'MEDIACONNECT_FLOW'|'MEDIALIVE_INPUT',
        'Configuration': {
            'Standard': {
                'NetworkInterfaceArn': 'string',
                'ProtocolConfiguration': {
                    'Rtp': {
                        'DestinationAddress': 'string',
                        'DestinationPort': 123,
                        'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
                    },
                    'Rist': {
                        'DestinationAddress': 'string',
                        'DestinationPort': 123
                    },
                    'SrtListener': {
                        'Port': 123,
                        'MinimumLatencyMilliseconds': 123,
                        'EncryptionConfiguration': {
                            'EncryptionKey': {
                                'SecretArn': 'string',
                                'RoleArn': 'string'
                            }
                        }
                    },
                    'SrtCaller': {
                        'DestinationAddress': 'string',
                        'DestinationPort': 123,
                        'MinimumLatencyMilliseconds': 123,
                        'StreamId': 'string',
                        'EncryptionConfiguration': {
                            'EncryptionKey': {
                                'SecretArn': 'string',
                                'RoleArn': 'string'
                            }
                        }
                    }
                },
                'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
            },
            'MediaConnectFlow': {
                'FlowArn': 'string',
                'FlowSourceArn': 'string',
                'DestinationTransitEncryption': {
                    'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
                    'EncryptionKeyConfiguration': {
                        'SecretsManager': {
                            'SecretArn': 'string',
                            'RoleArn': 'string'
                        },
                        'Automatic': {}
                    }
                }
            },
            'MediaLiveInput': {
                'MediaLiveInputArn': 'string',
                'MediaLivePipelineId': 'PIPELINE_0'|'PIPELINE_1',
                'DestinationTransitEncryption': {
                    'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
                    'EncryptionKeyConfiguration': {
                        'SecretsManager': {
                            'SecretArn': 'string',
                            'RoleArn': 'string'
                        },
                        'Automatic': {}
                    }
                }
            }
        },
        'RoutedState': 'ROUTED'|'ROUTING'|'UNROUTED',
        'RegionName': 'string',
        'AvailabilityZone': 'string',
        'MaximumBitrate': 123,
        'RoutingScope': 'REGIONAL'|'GLOBAL',
        'Tier': 'OUTPUT_100'|'OUTPUT_50'|'OUTPUT_20',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'Messages': [
            {
                'Code': 'string',
                'Message': 'string'
            },
        ],
        'Tags': {
            'string': 'string'
        },
        'StreamDetails': {
            'Standard': {
                'DestinationIpAddress': 'string'
            },
            'MediaConnectFlow': {},
            'MediaLiveInput': {}
        },
        'IpAddress': 'string',
        'RoutedInputArn': '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) –

    • RouterOutput (dict) –

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

      • Name (string) –

        The name of the router output.

      • Arn (string) –

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

      • Id (string) –

        The unique identifier of the router output.

      • State (string) –

        The overall state of the router output.

      • OutputType (string) –

        The type of the router output.

      • Configuration (dict) –

        The configuration settings for a router output.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, MediaConnectFlow, MediaLiveInput. 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 output, 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 output.

          • ProtocolConfiguration (dict) –

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

            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 output using the RTP (Real-Time Transport Protocol) protocol, including the destination address and port, and forward error correction state.

              • DestinationAddress (string) –

                The destination IP address for the RTP protocol in the router output configuration.

              • DestinationPort (integer) –

                The destination port number for the RTP protocol in the router output configuration.

              • ForwardErrorCorrection (string) –

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

            • Rist (dict) –

              The configuration settings for a router output using the RIST (Reliable Internet Stream Transport) protocol, including the destination address and port.

              • DestinationAddress (string) –

                The destination IP address for the RIST protocol in the router output configuration.

              • DestinationPort (integer) –

                The destination port number for the RIST protocol in the router output configuration.

            • SrtListener (dict) –

              The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and encryption 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.

              • EncryptionConfiguration (dict) –

                Defines the encryption settings for an SRT listener output, including the encryption key configuration and associated parameters.

                • EncryptionKey (dict) –

                  Specifies the encryption key configuration used for encrypting 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 output using the SRT (Secure Reliable Transport) protocol in caller mode, including the destination address and port, minimum latency, stream ID, and encryption key configuration.

              • DestinationAddress (string) –

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

              • DestinationPort (integer) –

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

              • EncryptionConfiguration (dict) –

                Defines the encryption settings for an SRT caller output, including the encryption key configuration and associated parameters.

                • EncryptionKey (dict) –

                  Specifies the encryption key configuration used for encrypting 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 output.

        • MediaConnectFlow (dict) –

          Configuration settings for connecting a router output to a MediaConnect flow source.

          • FlowArn (string) –

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

          • FlowSourceArn (string) –

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

          • DestinationTransitEncryption (dict) –

            The encryption configuration for the flow destination when connected to this router output.

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

        • MediaLiveInput (dict) –

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

          • MediaLiveInputArn (string) –

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

          • MediaLivePipelineId (string) –

            The index of the MediaLive pipeline to connect to this router output.

          • DestinationTransitEncryption (dict) –

            The encryption configuration for the MediaLive input when connected to this router output.

            • EncryptionKeyType (string) –

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

            • EncryptionKeyConfiguration (dict) –

              The configuration details for the MediaLive 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.

      • RoutedState (string) –

        The current state of the association between the router output and its input.

      • RegionName (string) –

        The AWS Region where the router output is located.

      • AvailabilityZone (string) –

        The Availability Zone of the router output.

      • MaximumBitrate (integer) –

        The maximum bitrate for the router output.

      • RoutingScope (string) –

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

      • Tier (string) –

        The tier level of the router output.

      • CreatedAt (datetime) –

        The timestamp when the router output was created.

      • UpdatedAt (datetime) –

        The timestamp when the router output was last updated.

      • Messages (list) –

        The messages associated with the router output.

        • (dict) –

          A message associated with a router output.

          • Code (string) –

            The code associated with the router output message.

          • Message (string) –

            The message text associated with the router output message.

      • Tags (dict) –

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

        • (string) –

          • (string) –

      • StreamDetails (dict) –

        Information about the router output’s stream, including connection state and destination details. The specific details provided vary based on the router output type.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, MediaConnectFlow, MediaLiveInput. 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 output stream type. Contains information about the destination IP address and connection state for basic output routing.

          • DestinationIpAddress (string) –

            The IP address where the output stream will be sent. This is the destination address that will receive the routed media content.

        • MediaConnectFlow (dict) –

          Configuration details for a MediaConnect flow when used as a router output destination.

        • MediaLiveInput (dict) –

          Configuration details for a MediaLive input when used as a router output destination.

      • IpAddress (string) –

        The IP address of the router output.

      • RoutedInputArn (string) –

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

      • MaintenanceType (string) –

        The type of maintenance configuration applied to this router output.

      • MaintenanceConfiguration (dict) –

        The maintenance configuration settings applied to this router output.

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

      • MaintenanceSchedule (dict) –

        The current maintenance schedule details for this router output.

        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