AWS MediaConnect

2026/08/12 - AWS MediaConnect - 4 updated api methods

Changes  AWS MediaConnect now supports tuning the internal recovery latency between Router Inputs and Outputs to prioritize stream quality versus end-to-end latency.

BatchGetRouterOutput (updated) Link ¶
Changes (response)
{'RouterOutputs': {'FabricConfiguration': {'RecoveryLatencyMode': 'BALANCED | '
                                                                  'LOW_LATENCY'}}}

Retrieves information about multiple router outputs in AWS Elemental MediaConnect.

See also: AWS API Documentation

Request Syntax

client.batch_get_router_output(
    Arns=[
        'string',
    ]
)
type Arns:

list

param Arns:

[REQUIRED]

The Amazon Resource Names (ARNs) of the router outputs you want to retrieve information about.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'RouterOutputs': [
        {
            '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': {
                        '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'
                                }
                            }
                        },
                        'Rtp': {
                            'DestinationAddress': 'string',
                            'DestinationPort': 123,
                            'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
                        }
                    },
                    '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)
                }
            },
            'FabricConfiguration': {
                'RecoveryLatencyMode': 'BALANCED'|'LOW_LATENCY'
            }
        },
    ],
    'Errors': [
        {
            'Arn': 'string',
            'Code': 'string',
            'Message': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • RouterOutputs (list) --

      An array of router outputs that were successfully retrieved.

      • (dict) --

        A router output in AWS Elemental MediaConnect. A router output is a destination for media content that can receive input from one or more router inputs.

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

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

              • 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 Secrets Manager secret used for transit encryption.

                    • RoleArn (string) --

                      The ARN of the IAM role assumed by MediaConnect to access the 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 Secrets Manager secret used for transit encryption.

                    • RoleArn (string) --

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

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

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

                • SecretsManager (dict) --

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

                  • SecretArn (string) --

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

                  • RoleArn (string) --

                    The ARN of the IAM role assumed by MediaConnect to access the 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.

                • SecretsManager (dict) --

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

                  • SecretArn (string) --

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

                  • RoleArn (string) --

                    The ARN of the IAM role assumed by MediaConnect to access the 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 Amazon Web Services 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.

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

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

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

        • FabricConfiguration (dict) --

          The fabric configuration settings for the router output.

          • RecoveryLatencyMode (string) --

            The recovery latency mode for the router fabric connection. Valid values include the following:

            • BALANCED (default) – Optimizes for stream quality.

            • LOW_LATENCY – Reduces latency at the potential cost of stream quality under adverse network conditions.

    • Errors (list) --

      An array of errors that occurred when retrieving the requested router outputs.

      • (dict) --

        An error that occurred when retrieving multiple router outputs in the BatchGetRouterOutput operation, including the ARN, error code, and error message.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the router output for which the error occurred.

        • Code (string) --

          The error code associated with the error.

        • Message (string) --

          A message describing the error.

CreateRouterOutput (updated) Link ¶
Changes (request, response)
Request
{'FabricConfiguration': {'RecoveryLatencyMode': 'BALANCED | LOW_LATENCY'}}
Response
{'RouterOutput': {'FabricConfiguration': {'RecoveryLatencyMode': 'BALANCED | '
                                                                 'LOW_LATENCY'}}}

Creates a new router output in AWS Elemental MediaConnect.

See also: AWS API Documentation

Request Syntax

client.create_router_output(
    Name='string',
    Configuration={
        'Standard': {
            'NetworkInterfaceArn': 'string',
            'ProtocolConfiguration': {
                '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'
                        }
                    }
                },
                'Rtp': {
                    'DestinationAddress': 'string',
                    'DestinationPort': 123,
                    'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
                }
            },
            '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': {}

                }
            }
        }
    },
    MaximumBitrate=123,
    RoutingScope='REGIONAL'|'GLOBAL',
    Tier='OUTPUT_100'|'OUTPUT_50'|'OUTPUT_20',
    RegionName='string',
    AvailabilityZone='string',
    MaintenanceConfiguration={
        'PreferredDayTime': {
            'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
            'Time': 'string'
        },
        'Default': {}

    },
    Tags={
        'string': 'string'
    },
    FabricConfiguration={
        'RecoveryLatencyMode': 'BALANCED'|'LOW_LATENCY'
    },
    ClientToken='string'
)
type Name:

string

param Name:

[REQUIRED]

The name of the router output.

type Configuration:

dict

param Configuration:

[REQUIRED]

The configuration settings for the router output.

  • Standard (dict) --

    The configuration settings for a standard router output, 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 output.

    • ProtocolConfiguration (dict) -- [REQUIRED]

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

      • 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) -- [REQUIRED]

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

        • DestinationPort (integer) -- [REQUIRED]

          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) -- [REQUIRED]

          The port number for the SRT protocol in listener mode.

        • MinimumLatencyMilliseconds (integer) -- [REQUIRED]

          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) -- [REQUIRED]

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

            • SecretArn (string) -- [REQUIRED]

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

            • RoleArn (string) -- [REQUIRED]

              The ARN of the IAM role assumed by MediaConnect to access the 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) -- [REQUIRED]

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

        • DestinationPort (integer) -- [REQUIRED]

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

        • MinimumLatencyMilliseconds (integer) -- [REQUIRED]

          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) -- [REQUIRED]

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

            • SecretArn (string) -- [REQUIRED]

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

            • RoleArn (string) -- [REQUIRED]

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

      • 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) -- [REQUIRED]

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

        • DestinationPort (integer) -- [REQUIRED]

          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.

    • 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) -- [REQUIRED]

      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) -- [REQUIRED]

        The configuration details for the encryption key.

        • SecretsManager (dict) --

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

          • SecretArn (string) -- [REQUIRED]

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

          • RoleArn (string) -- [REQUIRED]

            The ARN of the IAM role assumed by MediaConnect to access the 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) -- [REQUIRED]

      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) -- [REQUIRED]

        The configuration details for the MediaLive encryption key.

        • SecretsManager (dict) --

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

          • SecretArn (string) -- [REQUIRED]

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

          • RoleArn (string) -- [REQUIRED]

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

        • Automatic (dict) --

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

type MaximumBitrate:

integer

param MaximumBitrate:

[REQUIRED]

The maximum bitrate for the router output.

type RoutingScope:

string

param RoutingScope:

[REQUIRED]

Specifies whether the router output can take inputs that are in different Regions. REGIONAL (default) - can only take inputs from same Region. GLOBAL - can take inputs from any Region.

type Tier:

string

param Tier:

[REQUIRED]

The tier level for the router output.

type RegionName:

string

param RegionName:

The Amazon Web Services Region for the router output. Defaults to the current region if not specified.

type AvailabilityZone:

string

param AvailabilityZone:

The Availability Zone where you want to create the router output. This must be a valid Availability Zone for the region specified by regionName, or the current region if no regionName is provided.

type MaintenanceConfiguration:

dict

param MaintenanceConfiguration:

The maintenance configuration settings for the router output, including preferred maintenance windows and schedules.

  • PreferredDayTime (dict) --

    Preferred day and time maintenance configuration settings.

    • Day (string) -- [REQUIRED]

      The preferred day for maintenance operations.

    • Time (string) -- [REQUIRED]

      The preferred time for maintenance operations.

  • Default (dict) --

    Default maintenance configuration settings.

type Tags:

dict

param Tags:

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

  • (string) --

    • (string) --

type FabricConfiguration:

dict

param FabricConfiguration:

The fabric configuration settings for the router output.

  • RecoveryLatencyMode (string) -- [REQUIRED]

    The recovery latency mode for the router fabric connection. Valid values include the following:

    • BALANCED (default) – Optimizes for stream quality.

    • LOW_LATENCY – Reduces latency at the potential cost of stream quality under adverse network conditions.

type ClientToken:

string

param ClientToken:

A unique identifier for the request to ensure idempotency.

This field is autopopulated if not provided.

rtype:

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': {
                    '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'
                            }
                        }
                    },
                    'Rtp': {
                        'DestinationAddress': 'string',
                        'DestinationPort': 123,
                        'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
                    }
                },
                '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)
            }
        },
        'FabricConfiguration': {
            'RecoveryLatencyMode': 'BALANCED'|'LOW_LATENCY'
        }
    }
}

Response Structure

  • (dict) --

    • RouterOutput (dict) --

      The newly-created router output.

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

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

            • 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 Secrets Manager secret used for transit encryption.

                  • RoleArn (string) --

                    The ARN of the IAM role assumed by MediaConnect to access the 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 Secrets Manager secret used for transit encryption.

                  • RoleArn (string) --

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

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

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

              • SecretsManager (dict) --

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

                • SecretArn (string) --

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

                • RoleArn (string) --

                  The ARN of the IAM role assumed by MediaConnect to access the 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.

              • SecretsManager (dict) --

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

                • SecretArn (string) --

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

                • RoleArn (string) --

                  The ARN of the IAM role assumed by MediaConnect to access the 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 Amazon Web Services 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.

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

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

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

      • FabricConfiguration (dict) --

        The fabric configuration settings for the router output.

        • RecoveryLatencyMode (string) --

          The recovery latency mode for the router fabric connection. Valid values include the following:

          • BALANCED (default) – Optimizes for stream quality.

          • LOW_LATENCY – Reduces latency at the potential cost of stream quality under adverse network conditions.

GetRouterOutput (updated) Link ¶
Changes (response)
{'RouterOutput': {'FabricConfiguration': {'RecoveryLatencyMode': 'BALANCED | '
                                                                 'LOW_LATENCY'}}}

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

See also: AWS API Documentation

Request Syntax

client.get_router_output(
    Arn='string'
)
type Arn:

string

param Arn:

[REQUIRED]

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

rtype:

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': {
                    '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'
                            }
                        }
                    },
                    'Rtp': {
                        'DestinationAddress': 'string',
                        'DestinationPort': 123,
                        'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
                    }
                },
                '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)
            }
        },
        'FabricConfiguration': {
            'RecoveryLatencyMode': 'BALANCED'|'LOW_LATENCY'
        }
    }
}

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.

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

            • 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 Secrets Manager secret used for transit encryption.

                  • RoleArn (string) --

                    The ARN of the IAM role assumed by MediaConnect to access the 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 Secrets Manager secret used for transit encryption.

                  • RoleArn (string) --

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

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

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

              • SecretsManager (dict) --

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

                • SecretArn (string) --

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

                • RoleArn (string) --

                  The ARN of the IAM role assumed by MediaConnect to access the 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.

              • SecretsManager (dict) --

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

                • SecretArn (string) --

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

                • RoleArn (string) --

                  The ARN of the IAM role assumed by MediaConnect to access the 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 Amazon Web Services 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.

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

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

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

      • FabricConfiguration (dict) --

        The fabric configuration settings for the router output.

        • RecoveryLatencyMode (string) --

          The recovery latency mode for the router fabric connection. Valid values include the following:

          • BALANCED (default) – Optimizes for stream quality.

          • LOW_LATENCY – Reduces latency at the potential cost of stream quality under adverse network conditions.

UpdateRouterOutput (updated) Link ¶
Changes (request, response)
Request
{'FabricConfiguration': {'RecoveryLatencyMode': 'BALANCED | LOW_LATENCY'}}
Response
{'RouterOutput': {'FabricConfiguration': {'RecoveryLatencyMode': 'BALANCED | '
                                                                 'LOW_LATENCY'}}}

Updates the configuration of an existing router output in AWS Elemental MediaConnect.

See also: AWS API Documentation

Request Syntax

client.update_router_output(
    Arn='string',
    Name='string',
    Configuration={
        'Standard': {
            'NetworkInterfaceArn': 'string',
            'ProtocolConfiguration': {
                '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'
                        }
                    }
                },
                'Rtp': {
                    'DestinationAddress': 'string',
                    'DestinationPort': 123,
                    'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
                }
            },
            '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': {}

                }
            }
        }
    },
    MaximumBitrate=123,
    RoutingScope='REGIONAL'|'GLOBAL',
    Tier='OUTPUT_100'|'OUTPUT_50'|'OUTPUT_20',
    MaintenanceConfiguration={
        'PreferredDayTime': {
            'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
            'Time': 'string'
        },
        'Default': {}

    },
    FabricConfiguration={
        'RecoveryLatencyMode': 'BALANCED'|'LOW_LATENCY'
    }
)
type Arn:

string

param Arn:

[REQUIRED]

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

type Name:

string

param Name:

The updated name for the router output.

type Configuration:

dict

param Configuration:

The updated configuration settings for the router output. Changing the type of the configuration is not supported.

  • Standard (dict) --

    The configuration settings for a standard router output, 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 output.

    • ProtocolConfiguration (dict) -- [REQUIRED]

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

      • 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) -- [REQUIRED]

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

        • DestinationPort (integer) -- [REQUIRED]

          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) -- [REQUIRED]

          The port number for the SRT protocol in listener mode.

        • MinimumLatencyMilliseconds (integer) -- [REQUIRED]

          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) -- [REQUIRED]

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

            • SecretArn (string) -- [REQUIRED]

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

            • RoleArn (string) -- [REQUIRED]

              The ARN of the IAM role assumed by MediaConnect to access the 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) -- [REQUIRED]

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

        • DestinationPort (integer) -- [REQUIRED]

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

        • MinimumLatencyMilliseconds (integer) -- [REQUIRED]

          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) -- [REQUIRED]

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

            • SecretArn (string) -- [REQUIRED]

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

            • RoleArn (string) -- [REQUIRED]

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

      • 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) -- [REQUIRED]

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

        • DestinationPort (integer) -- [REQUIRED]

          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.

    • 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) -- [REQUIRED]

      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) -- [REQUIRED]

        The configuration details for the encryption key.

        • SecretsManager (dict) --

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

          • SecretArn (string) -- [REQUIRED]

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

          • RoleArn (string) -- [REQUIRED]

            The ARN of the IAM role assumed by MediaConnect to access the 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) -- [REQUIRED]

      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) -- [REQUIRED]

        The configuration details for the MediaLive encryption key.

        • SecretsManager (dict) --

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

          • SecretArn (string) -- [REQUIRED]

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

          • RoleArn (string) -- [REQUIRED]

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

        • Automatic (dict) --

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

type MaximumBitrate:

integer

param MaximumBitrate:

The updated maximum bitrate for the router output.

type RoutingScope:

string

param RoutingScope:

Specifies whether the router output can take inputs that are in different Regions. REGIONAL (default) - can only take inputs from same Region. GLOBAL - can take inputs from any Region.

type Tier:

string

param Tier:

The updated tier level for the router output.

type MaintenanceConfiguration:

dict

param MaintenanceConfiguration:

The updated maintenance configuration settings for the router output, including any changes to preferred maintenance windows and schedules.

  • PreferredDayTime (dict) --

    Preferred day and time maintenance configuration settings.

    • Day (string) -- [REQUIRED]

      The preferred day for maintenance operations.

    • Time (string) -- [REQUIRED]

      The preferred time for maintenance operations.

  • Default (dict) --

    Default maintenance configuration settings.

type FabricConfiguration:

dict

param FabricConfiguration:

The updated fabric configuration settings for the router output. You cannot update the fabric configuration while the output has an active route. You must unroute the output before updating the fabric configuration.

  • RecoveryLatencyMode (string) -- [REQUIRED]

    The recovery latency mode for the router fabric connection. Valid values include the following:

    • BALANCED (default) – Optimizes for stream quality.

    • LOW_LATENCY – Reduces latency at the potential cost of stream quality under adverse network conditions.

rtype:

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': {
                    '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'
                            }
                        }
                    },
                    'Rtp': {
                        'DestinationAddress': 'string',
                        'DestinationPort': 123,
                        'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
                    }
                },
                '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)
            }
        },
        'FabricConfiguration': {
            'RecoveryLatencyMode': 'BALANCED'|'LOW_LATENCY'
        }
    }
}

Response Structure

  • (dict) --

    • RouterOutput (dict) --

      The updated router output.

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

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

            • 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 Secrets Manager secret used for transit encryption.

                  • RoleArn (string) --

                    The ARN of the IAM role assumed by MediaConnect to access the 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 Secrets Manager secret used for transit encryption.

                  • RoleArn (string) --

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

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

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

              • SecretsManager (dict) --

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

                • SecretArn (string) --

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

                • RoleArn (string) --

                  The ARN of the IAM role assumed by MediaConnect to access the 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.

              • SecretsManager (dict) --

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

                • SecretArn (string) --

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

                • RoleArn (string) --

                  The ARN of the IAM role assumed by MediaConnect to access the 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 Amazon Web Services 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.

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

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

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

      • FabricConfiguration (dict) --

        The fabric configuration settings for the router output.

        • RecoveryLatencyMode (string) --

          The recovery latency mode for the router fabric connection. Valid values include the following:

          • BALANCED (default) – Optimizes for stream quality.

          • LOW_LATENCY – Reduces latency at the potential cost of stream quality under adverse network conditions.