AWS API Changes

2026/10/26 - AWS MediaConnect - 14 new 10 updated api methods

Changes This release adds support for managing and sharing endpoint across accounts in AWS Elemental MediaConnect. You can now register endpoints to represent external or service-managed sources and destinations, and share them across AWS accounts.

ListSourceEndpoints (new)

Link ¶

Retrieves a list of the source endpoints in your account. The results are paginated. Use the NextToken value that's returned to retrieve additional results.

See also: AWS API Documentation

Request Syntax

client.list_source_endpoints(
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'RegionNames': [
                'string',
            ],
            'SourceTypes': [
                'STANDARD'|'ROUTER_OUTPUT',
            ],
            'NameContains': [
                'string',
            ]
        },
    ]
)

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in a single request. The valid range is 1 to 100. If you don't specify a value, the service returns up to 100 results.

type NextToken:

string

param NextToken:

The token that identifies the next page of results to return. Use the token that a previous request returned.

type Filters:

list

param Filters:

The filters to apply to the list of source endpoints.

(dict) --

A filter to apply when listing source endpoints. This is a union type, so exactly one of its members is set.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: RegionNames, SourceTypes, NameContains.
- RegionNames (list) --
  
  Filters the results to source endpoints in the specified Amazon Web Services Regions.
  - (string) --
- SourceTypes (list) --
  
  Filters the results to source endpoints of the specified types.
  - (string) --
- NameContains (list) --
  
  Filters the results to source endpoints whose names contain the specified strings.
  - (string) --

rtype:

dict

returns:

Response Syntax

{
    'SourceEndpoints': [
        {
            'Name': 'string',
            'Arn': 'string',
            'Id': 'string',
            'SourceType': 'STANDARD'|'ROUTER_OUTPUT',
            'RegionName': 'string',
            'AvailabilityZone': 'string',
            'AvailabilityZoneId': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'LifecycleManagement': 'MANAGED'|'UNMANAGED',
            'MessageCount': 123,
            'ResourceShareOwnership': 'OWNED'|'CONSUMED',
            'ResourceShareState': 'SHARED'|'UNSHARED',
            'RegistrationState': 'REGISTERED'|'REGISTERING'|'DEREGISTERING'|'REGISTRATION_FAILED',
            'ConnectionState': 'CONNECTED'|'DISCONNECTED'|'CONNECTING'|'DISCONNECTING',
            'EncryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
            'ConnectedDestinationCount': 123,
            'AssociatedResourceArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- SourceEndpoints (list) --
  
  The source endpoints that match the request.
  - (dict) --
    
    A summary of a source endpoint that the ListSourceEndpoints operation returns.
    - Name (string) --
      
      The name of the source endpoint.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the source endpoint.
    - Id (string) --
      
      The unique identifier of the source endpoint.
    - SourceType (string) --
      
      The type of the source endpoint. Valid values include the following:
      - STANDARD – A source endpoint that represents an external source over a standard protocol, such as RTP, RIST, or SRT.
      - ROUTER_OUTPUT – A source endpoint that represents a router output.
    - RegionName (string) --
      
      The name of the Amazon Web Services Region in which the source endpoint is located.
    - AvailabilityZone (string) --
      
      The Availability Zone in which the source endpoint is located.
    - AvailabilityZoneId (string) --
      
      The ID of the Availability Zone in which the source endpoint is located.
    - CreatedAt (datetime) --
      
      The date and time when the source endpoint was created.
    - UpdatedAt (datetime) --
      
      The date and time when the source endpoint was last updated.
    - LifecycleManagement (string) --
      
      The entity that manages the lifecycle of the source endpoint.
    - MessageCount (integer) --
      
      The number of status messages for the source endpoint.
    - ResourceShareOwnership (string) --
      
      Indicates whether this account owns the source endpoint or consumes it from another account through RAM.
    - ResourceShareState (string) --
      
      The sharing state of the source endpoint.
    - RegistrationState (string) --
      
      The registration state of the source endpoint. Valid values include the following:
      - REGISTERED – The source endpoint is registered and ready to use.
      - REGISTERING – MediaConnect is registering the source endpoint.
      - DEREGISTERING – MediaConnect is deregistering the source endpoint.
      - REGISTRATION_FAILED – MediaConnect couldn't register the source endpoint.
    - ConnectionState (string) --
      
      The connection state of the source endpoint. Valid values include the following:
      - CONNECTED – The source endpoint is connected to a destination endpoint.
      - DISCONNECTED – The source endpoint isn't connected to a destination endpoint.
      - CONNECTING – The source endpoint is connecting to a destination endpoint.
      - DISCONNECTING – The source endpoint is disconnecting from a destination endpoint.
    - EncryptionType (string) --
      
      The type of encryption used for the source endpoint connection.
    - ConnectedDestinationCount (integer) --
      
      The number of destination endpoints that are connected to the source endpoint.
    - AssociatedResourceArn (string) --
      
      The Amazon Resource Name (ARN) of the resource that is associated with the source endpoint.
- NextToken (string) --
  
  The token to use in the next request to retrieve the next page of results. This value is null when there are no more results to return.

UpdateSourceEndpoint (new)

Link ¶

Updates the configuration of a source endpoint.

See also: AWS API Documentation

Request Syntax

client.update_source_endpoint(
    Arn='string',
    Description='string',
    Configuration={
        'Standard': {
            'Name': 'string',
            'SourceNetworkingConfiguration': {
                'Public': {
                    'SourceAllowRules': [
                        {
                            'Cidr': 'string'
                        },
                    ]
                },
                'Vpc': {
                    'SecurityGroupIds': [
                        'string',
                    ],
                    'SubnetId': 'string'
                }
            },
            'ProtocolConfiguration': {
                'Rist': {
                    'DestinationIngestPort': 123,
                    'RecoveryLatencyMilliseconds': 123
                },
                'SrtListener': {
                    'SourceListenerPort': 123,
                    'SourceAddress': 'string',
                    'MinimumLatencyMilliseconds': 123,
                    'StreamId': 'string',
                    'EncryptionPassphrase': {
                        'SecretArn': 'string'
                    }
                },
                'SrtCaller': {
                    'DestinationIngestPort': 123,
                    'MinimumLatencyMilliseconds': 123,
                    'EncryptionPassphrase': {
                        'SecretArn': 'string'
                    }
                },
                'Rtp': {
                    'DestinationIngestPort': 123,
                    'ForwardErrorCorrectionState': 'ENABLED'|'DISABLED'
                }
            },
            'SourceNetworkingType': 'PUBLIC'|'VPC',
            'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
        },
        'RouterOutput': {
            'RouterOutputArn': 'string'
        }
    }
)

type Arn:

string

param Arn:

[REQUIRED]

The Amazon Resource Name (ARN) of the source endpoint to update.

type Description:

string

param Description:

A description to help you identify the source endpoint.

type Configuration:

dict

param Configuration:

The updated configuration settings for the source endpoint.

Standard (dict) --

The configuration settings for a standard source endpoint, which represents an external source.
- Name (string) -- [REQUIRED]
  
  The name of the source endpoint.
- SourceNetworkingConfiguration (dict) -- [REQUIRED]
  
  The networking configuration for the source endpoint, which determines whether it is publicly accessible or in a virtual private cloud (VPC).
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: Public, Vpc.
  - Public (dict) --
    
    The configuration for a publicly accessible source endpoint.
    - SourceAllowRules (list) -- [REQUIRED]
      
      The rules that specify which CIDR blocks can connect to the source endpoint. You can specify up to 10 rules.
      - (dict) --
        
        A rule that allows a specific CIDR block to connect to the public source endpoint.
        
        Cidr (string) -- [REQUIRED]
        
        The CIDR block that is allowed to connect to the source endpoint, in CIDR notation.
  - Vpc (dict) --
    
    The configuration for a source endpoint in a virtual private cloud (VPC).
    - SecurityGroupIds (list) -- [REQUIRED]
      
      The IDs of the security groups to associate with the source endpoint. You can specify from 1 to 5 security groups.
      - (string) --
    - SubnetId (string) -- [REQUIRED]
      
      The ID of the subnet to use for the source endpoint.
- ProtocolConfiguration (dict) -- [REQUIRED]
  
  The protocol configuration for the source endpoint.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: Rist, SrtListener, SrtCaller, Rtp.
  - Rist (dict) --
    
    The configuration settings for a source endpoint that uses the RIST protocol.
    - DestinationIngestPort (integer) -- [REQUIRED]
      
      The port on the destination that receives the content. The valid range is 3000 to 30000.
    - RecoveryLatencyMilliseconds (integer) -- [REQUIRED]
      
      The amount of time, in milliseconds, that the source endpoint allows for recovering lost packets. The valid range is 10 to 10000.
  - SrtListener (dict) --
    
    The configuration settings for a source endpoint that uses SRT in listener mode.
    - SourceListenerPort (integer) -- [REQUIRED]
      
      The port that the source endpoint listens on for incoming connections. The valid range is 1024 to 65535.
    - SourceAddress (string) -- [REQUIRED]
      
      The IP address that the source endpoint listens on for incoming connections.
    - MinimumLatencyMilliseconds (integer) -- [REQUIRED]
      
      The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
    - StreamId (string) --
      
      The stream ID that identifies the content for the SRT connection.
    - EncryptionPassphrase (dict) --
      
      The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
      - SecretArn (string) -- [REQUIRED]
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
  - SrtCaller (dict) --
    
    The configuration settings for a source endpoint that uses SRT in caller mode.
    - DestinationIngestPort (integer) -- [REQUIRED]
      
      The port on which the destination listens for the connection. The valid range is 3000 to 30000.
    - MinimumLatencyMilliseconds (integer) -- [REQUIRED]
      
      The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
    - EncryptionPassphrase (dict) --
      
      The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
      - SecretArn (string) -- [REQUIRED]
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
  - Rtp (dict) --
    
    The configuration settings for a source endpoint that uses the RTP protocol.
    - DestinationIngestPort (integer) -- [REQUIRED]
      
      The port on the destination that receives the content. The valid range is 3000 to 30000.
    - ForwardErrorCorrectionState (string) -- [REQUIRED]
      
      Indicates whether forward error correction (FEC) is enabled for the source endpoint.
- SourceNetworkingType (string) --
  
  The networking type of the source endpoint. Valid values include the following:
  - PUBLIC – The source endpoint is publicly accessible.
  - VPC – The source endpoint is in a virtual private cloud (VPC).
- Protocol (string) --
  
  The protocol used by the source endpoint. Valid values include the following:
  - RTP – Real-time Transport Protocol.
  - RIST – Reliable Internet Stream Transport.
  - SRT_CALLER – Secure Reliable Transport (SRT) in caller mode.
  - SRT_LISTENER – Secure Reliable Transport (SRT) in listener mode.
RouterOutput (dict) --

The configuration settings for a source endpoint that represents a router output.
- RouterOutputArn (string) -- [REQUIRED]
  
  The Amazon Resource Name (ARN) of the router output that the source endpoint represents.

rtype:

dict

returns:

Response Syntax

{
    'SourceEndpoint': {
        'Name': 'string',
        'Arn': 'string',
        'Id': 'string',
        'Description': 'string',
        'RegionName': 'string',
        'AvailabilityZone': 'string',
        'AvailabilityZoneId': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'LifecycleManagement': 'MANAGED'|'UNMANAGED',
        'Messages': [
            {
                'Code': 'string',
                'Message': 'string'
            },
        ],
        'SourceType': 'STANDARD'|'ROUTER_OUTPUT',
        'Configuration': {
            'Standard': {
                'Name': 'string',
                'SourceNetworkingConfiguration': {
                    'Public': {
                        'SourceAllowRules': [
                            {
                                'Cidr': 'string'
                            },
                        ]
                    },
                    'Vpc': {
                        'SecurityGroupIds': [
                            'string',
                        ],
                        'SubnetId': 'string'
                    }
                },
                'ProtocolConfiguration': {
                    'Rist': {
                        'DestinationIngestPort': 123,
                        'RecoveryLatencyMilliseconds': 123
                    },
                    'SrtListener': {
                        'SourceListenerPort': 123,
                        'SourceAddress': 'string',
                        'MinimumLatencyMilliseconds': 123,
                        'StreamId': 'string',
                        'EncryptionPassphrase': {
                            'SecretArn': 'string'
                        }
                    },
                    'SrtCaller': {
                        'DestinationIngestPort': 123,
                        'MinimumLatencyMilliseconds': 123,
                        'EncryptionPassphrase': {
                            'SecretArn': 'string'
                        }
                    },
                    'Rtp': {
                        'DestinationIngestPort': 123,
                        'ForwardErrorCorrectionState': 'ENABLED'|'DISABLED'
                    }
                },
                'SourceNetworkingType': 'PUBLIC'|'VPC',
                'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
            },
            'RouterOutput': {
                'RouterOutputArn': 'string'
            }
        },
        'ResourceShareOwnership': 'OWNED'|'CONSUMED',
        'ResourceShareDetails': {
            'Owned': {
                'ShareState': 'SHARED'|'UNSHARED'
            },
            'Consumed': {
                'OwnerAccountId': 'string'
            }
        },
        'RegistrationState': 'REGISTERED'|'REGISTERING'|'DEREGISTERING'|'REGISTRATION_FAILED',
        'ConnectionState': 'CONNECTED'|'DISCONNECTED'|'CONNECTING'|'DISCONNECTING',
        'ConnectionDetails': {
            'Standard': {
                'DestinationIpAddress': 'string',
                'DestinationIngestPort': 123,
                'DestinationDecryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                'DestinationDecryptionConfiguration': {
                    'SecretsManager': {
                        'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                        'EncryptionSecret': {
                            'SecretArn': 'string'
                        }
                    },
                    'Automatic': {}
                },
                'DestinationEndpointType': 'STANDARD'|'ROUTER_INPUT'
            },
            'RouterOutput': {
                'DestinationDecryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                'DestinationDecryptionConfiguration': {
                    'SecretsManager': {
                        'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                        'EncryptionSecret': {
                            'SecretArn': 'string'
                        }
                    },
                    'Automatic': {}
                },
                'DestinationEndpointType': 'STANDARD'|'ROUTER_INPUT'
            }
        },
        'ConnectedDestinations': [
            'string',
        ],
        'EncryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
        'EncryptionConfiguration': {
            'SecretsManager': {
                'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                'EncryptionSecret': {
                    'SecretArn': 'string'
                }
            },
            'Automatic': {}
        },
        'AssociatedResourceDetails': {
            'Standard': {},
            'RouterOutput': {
                'Name': 'string',
                'MaximumBitrate': 123,
                'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
                'Messages': [
                    {
                        'Code': 'string',
                        'Message': 'string'
                    },
                ]
            }
        },
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- SourceEndpoint (dict) --
  
  The details of the updated source endpoint.
  - Name (string) --
    
    The name of the source endpoint.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of the source endpoint.
  - Id (string) --
    
    The unique identifier of the source endpoint.
  - Description (string) --
    
    The description of the source endpoint.
  - RegionName (string) --
    
    The name of the Amazon Web Services Region in which the source endpoint is located.
  - AvailabilityZone (string) --
    
    The Availability Zone in which the source endpoint is located.
  - AvailabilityZoneId (string) --
    
    The ID of the Availability Zone in which the source endpoint is located.
  - CreatedAt (datetime) --
    
    The date and time when the source endpoint was created.
  - UpdatedAt (datetime) --
    
    The date and time when the source endpoint was last updated.
  - LifecycleManagement (string) --
    
    The entity that manages the lifecycle of the source endpoint.
  - Messages (list) --
    
    The status messages for the source endpoint.
    - (dict) --
      
      A status message for a source endpoint.
      - Code (string) --
        
        The message code.
      - Message (string) --
        
        The message text.
  - SourceType (string) --
    
    The type of the source endpoint. Valid values include the following:
    - STANDARD – A source endpoint that represents an external source over a standard protocol, such as RTP, RIST, or SRT.
    - ROUTER_OUTPUT – A source endpoint that represents a router output.
  - Configuration (dict) --
    
    The configuration settings for the source endpoint.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterOutput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The configuration settings for a standard source endpoint, which represents an external source.
      - Name (string) --
        
        The name of the source endpoint.
      - SourceNetworkingConfiguration (dict) --
        
        The networking configuration for the source endpoint, which determines whether it is publicly accessible or in a virtual private cloud (VPC).
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Public, Vpc. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Public (dict) --
        
        The configuration for a publicly accessible source endpoint.
        
        SourceAllowRules (list) --
        
        The rules that specify which CIDR blocks can connect to the source endpoint. You can specify up to 10 rules.
        
        (dict) --
        
        A rule that allows a specific CIDR block to connect to the public source endpoint.
        
        Cidr (string) --
        
        The CIDR block that is allowed to connect to the source endpoint, in CIDR notation.
        
        Vpc (dict) --
        
        The configuration for a source endpoint in a virtual private cloud (VPC).
        
        SecurityGroupIds (list) --
        
        The IDs of the security groups to associate with the source endpoint. You can specify from 1 to 5 security groups.
        
        (string) --
        
        SubnetId (string) --
        
        The ID of the subnet to use for the source endpoint.
      - ProtocolConfiguration (dict) --
        
        The protocol configuration for the source endpoint.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rist, SrtListener, SrtCaller, Rtp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Rist (dict) --
        
        The configuration settings for a source endpoint that uses the RIST protocol.
        
        DestinationIngestPort (integer) --
        
        The port on the destination that receives the content. The valid range is 3000 to 30000.
        
        RecoveryLatencyMilliseconds (integer) --
        
        The amount of time, in milliseconds, that the source endpoint allows for recovering lost packets. The valid range is 10 to 10000.
        
        SrtListener (dict) --
        
        The configuration settings for a source endpoint that uses SRT in listener mode.
        
        SourceListenerPort (integer) --
        
        The port that the source endpoint listens on for incoming connections. The valid range is 1024 to 65535.
        
        SourceAddress (string) --
        
        The IP address that the source endpoint listens on for incoming connections.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
        
        StreamId (string) --
        
        The stream ID that identifies the content for the SRT connection.
        
        EncryptionPassphrase (dict) --
        
        The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        SrtCaller (dict) --
        
        The configuration settings for a source endpoint that uses SRT in caller mode.
        
        DestinationIngestPort (integer) --
        
        The port on which the destination listens for the connection. The valid range is 3000 to 30000.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
        
        EncryptionPassphrase (dict) --
        
        The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Rtp (dict) --
        
        The configuration settings for a source endpoint that uses the RTP protocol.
        
        DestinationIngestPort (integer) --
        
        The port on the destination that receives the content. The valid range is 3000 to 30000.
        
        ForwardErrorCorrectionState (string) --
        
        Indicates whether forward error correction (FEC) is enabled for the source endpoint.
      - SourceNetworkingType (string) --
        
        The networking type of the source endpoint. Valid values include the following:
        
        PUBLIC – The source endpoint is publicly accessible.
        
        VPC – The source endpoint is in a virtual private cloud (VPC).
      - Protocol (string) --
        
        The protocol used by the source endpoint. Valid values include the following:
        
        RTP – Real-time Transport Protocol.
        
        RIST – Reliable Internet Stream Transport.
        
        SRT_CALLER – Secure Reliable Transport (SRT) in caller mode.
        
        SRT_LISTENER – Secure Reliable Transport (SRT) in listener mode.
    - RouterOutput (dict) --
      
      The configuration settings for a source endpoint that represents a router output.
      - RouterOutputArn (string) --
        
        The Amazon Resource Name (ARN) of the router output that the source endpoint represents.
  - ResourceShareOwnership (string) --
    
    Indicates whether this account owns the source endpoint or consumes it from another account through RAM.
  - ResourceShareDetails (dict) --
    
    The cross-account sharing details for an endpoint. Endpoints are shared through Resource Access Manager (RAM). This is a union type, so exactly one of its members is set: owned when this account owns the endpoint and shares it with other accounts, or consumed when this account consumes an endpoint that another account shares. To change how an endpoint is shared, use RAM.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Owned, Consumed. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Owned (dict) --
      
      The sharing details for an endpoint that this account owns and shares with other accounts through RAM.
      - ShareState (string) --
        
        The sharing state of the endpoint. Valid values include the following:
        
        SHARED – The endpoint is shared with one or more accounts.
        
        UNSHARED – The endpoint is not shared with other accounts.
    - Consumed (dict) --
      
      The sharing details for an endpoint that another account shares with this account through RAM.
      - OwnerAccountId (string) --
        
        The ID of the Amazon Web Services account that owns the shared endpoint.
  - RegistrationState (string) --
    
    The registration state of the source endpoint. Valid values include the following:
    - REGISTERED – The source endpoint is registered and ready to use.
    - REGISTERING – MediaConnect is registering the source endpoint.
    - DEREGISTERING – MediaConnect is deregistering the source endpoint.
    - REGISTRATION_FAILED – MediaConnect couldn't register the source endpoint.
  - ConnectionState (string) --
    
    The connection state of the source endpoint. Valid values include the following:
    - CONNECTED – The source endpoint is connected to a destination endpoint.
    - DISCONNECTED – The source endpoint isn't connected to a destination endpoint.
    - CONNECTING – The source endpoint is connecting to a destination endpoint.
    - DISCONNECTING – The source endpoint is disconnecting from a destination endpoint.
  - ConnectionDetails (dict) --
    
    The connection details for the source endpoint.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterOutput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The connection details for a standard source endpoint.
      - DestinationIpAddress (string) --
        
        The IP address of the destination that receives the content.
      - DestinationIngestPort (integer) --
        
        The port on the destination that receives the content.
      - DestinationDecryptionType (string) --
        
        The type of decryption that the destination uses for the connection.
      - DestinationDecryptionConfiguration (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
      - DestinationEndpointType (string) --
        
        The type of the connected destination endpoint.
    - RouterOutput (dict) --
      
      The connection details for a source endpoint that represents a router output.
      - DestinationDecryptionType (string) --
        
        The type of decryption that the destination uses for the connection.
      - DestinationDecryptionConfiguration (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
      - DestinationEndpointType (string) --
        
        The type of the connected destination endpoint.
  - ConnectedDestinations (list) --
    
    The Amazon Resource Names (ARNs) of the destination endpoints that are connected to the source endpoint.
    - (string) --
  - EncryptionType (string) --
    
    The type of encryption used for the source endpoint connection.
  - EncryptionConfiguration (dict) --
    
    The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - SecretsManager (dict) --
      
      The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
      - EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
      - EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
    - Automatic (dict) --
      
      The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
  - AssociatedResourceDetails (dict) --
    
    The details of the resource that is associated with the source endpoint.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterOutput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The associated resource details for a standard source endpoint.
    - RouterOutput (dict) --
      
      The associated resource details for a source endpoint that represents a router output.
      - Name (string) --
        
        The name of the router output.
      - MaximumBitrate (integer) --
        
        The maximum bitrate of the router output, in bits per second.
      - State (string) --
        
        The state of the router output.
      - Messages (list) --
        
        The status messages for 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) --
    
    The tags associated with the source endpoint. Each tag is a key-value pair.
    - (string) --
      - (string) --

DisconnectEndpoints (new)

Link ¶

Disconnects a source endpoint from a destination endpoint.

See also: AWS API Documentation

Request Syntax

client.disconnect_endpoints(
    DestinationEndpointArn='string',
    SourceEndpointArn='string'
)

type DestinationEndpointArn:

string

param DestinationEndpointArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the destination endpoint to disconnect.

type SourceEndpointArn:

string

param SourceEndpointArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the source endpoint to disconnect.

rtype:

dict

returns:

Response Syntax

{
    'DestinationEndpointArn': 'string',
    'DestinationEndpointName': 'string',
    'SourceEndpointArn': 'string',
    'SourceEndpointName': 'string'
}

Response Structure

(dict) --
- DestinationEndpointArn (string) --
  
  The Amazon Resource Name (ARN) of the disconnected destination endpoint.
- DestinationEndpointName (string) --
  
  The name of the disconnected destination endpoint.
- SourceEndpointArn (string) --
  
  The Amazon Resource Name (ARN) of the disconnected source endpoint.
- SourceEndpointName (string) --
  
  The name of the disconnected source endpoint.

UpdateDestinationEndpoint (new)

Link ¶

Updates the configuration of a destination endpoint.

See also: AWS API Documentation

Request Syntax

client.update_destination_endpoint(
    Arn='string',
    Description='string',
    Configuration={
        'Standard': {
            'Name': 'string',
            'DestinationNetworkingConfiguration': {
                'Public': {
                    'DestinationAllowRules': [
                        {
                            'Cidr': 'string'
                        },
                    ]
                },
                'Vpc': {
                    'SecurityGroupIds': [
                        'string',
                    ],
                    'SubnetId': 'string'
                }
            },
            'ProtocolConfiguration': {
                'Rist': {
                    'DestinationAddress': 'string',
                    'DestinationIngestPort': 123
                },
                'SrtListener': {
                    'DestinationAddress': 'string',
                    'DestinationIngestPort': 123,
                    'MinimumLatencyMilliseconds': 123,
                    'StreamId': 'string',
                    'EncryptionPassphrase': {
                        'SecretArn': 'string'
                    }
                },
                'SrtCaller': {
                    'SourceListenerPort': 123,
                    'MinimumLatencyMilliseconds': 123,
                    'EncryptionPassphrase': {
                        'SecretArn': 'string'
                    }
                },
                'Rtp': {
                    'DestinationAddress': 'string',
                    'DestinationIngestPort': 123,
                    'ForwardErrorCorrectionState': 'ENABLED'|'DISABLED'
                }
            },
            'DestinationNetworkingType': 'PUBLIC'|'VPC',
            'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
        },
        'RouterInput': {
            'RouterInputArn': 'string'
        }
    }
)

type Arn:

string

param Arn:

[REQUIRED]

The Amazon Resource Name (ARN) of the destination endpoint to update.

type Description:

string

param Description:

A description to help you identify the destination endpoint.

type Configuration:

dict

param Configuration:

The updated configuration settings for the destination endpoint.

Standard (dict) --

The configuration settings for a standard destination endpoint, which represents an external destination.
- Name (string) -- [REQUIRED]
  
  The name of the destination endpoint.
- DestinationNetworkingConfiguration (dict) -- [REQUIRED]
  
  The networking configuration for the destination endpoint, which determines whether it is publicly accessible or in a virtual private cloud (VPC).
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: Public, Vpc.
  - Public (dict) --
    
    The configuration for a publicly accessible destination endpoint.
    - DestinationAllowRules (list) -- [REQUIRED]
      
      The rules that specify which CIDR blocks can connect to the destination endpoint. You can specify up to 10 rules.
      - (dict) --
        
        A rule that allows a specific CIDR block to connect to the public destination endpoint.
        
        Cidr (string) -- [REQUIRED]
        
        The CIDR block that is allowed to connect to the destination endpoint, in CIDR notation.
  - Vpc (dict) --
    
    The configuration for a destination endpoint in a virtual private cloud (VPC).
    - SecurityGroupIds (list) -- [REQUIRED]
      
      The IDs of the security groups to associate with the destination endpoint. You can specify from 1 to 5 security groups.
      - (string) --
    - SubnetId (string) -- [REQUIRED]
      
      The ID of the subnet to use for the destination endpoint.
- ProtocolConfiguration (dict) -- [REQUIRED]
  
  The protocol configuration for the destination endpoint.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: Rist, SrtListener, SrtCaller, Rtp.
  - Rist (dict) --
    
    The configuration settings for a destination endpoint that uses the RIST protocol.
    - DestinationAddress (string) -- [REQUIRED]
      
      The IP address on which the destination endpoint receives content.
    - DestinationIngestPort (integer) -- [REQUIRED]
      
      The port on which the destination endpoint receives content. The valid range is 1024 to 65531.
  - SrtListener (dict) --
    
    The configuration settings for a destination endpoint that uses SRT in listener mode.
    - DestinationAddress (string) -- [REQUIRED]
      
      The IP address on which the destination endpoint listens for incoming connections.
    - DestinationIngestPort (integer) -- [REQUIRED]
      
      The port on which the destination endpoint listens for incoming connections. The valid range is 0 to 65531.
    - MinimumLatencyMilliseconds (integer) -- [REQUIRED]
      
      The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
    - StreamId (string) --
      
      The stream ID that identifies the content for the SRT connection.
    - EncryptionPassphrase (dict) --
      
      The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
      - SecretArn (string) -- [REQUIRED]
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
  - SrtCaller (dict) --
    
    The configuration settings for a destination endpoint that uses SRT in caller mode.
    - SourceListenerPort (integer) -- [REQUIRED]
      
      The port on which the source listens for the connection. The valid range is 3000 to 30000.
    - MinimumLatencyMilliseconds (integer) -- [REQUIRED]
      
      The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
    - EncryptionPassphrase (dict) --
      
      The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
      - SecretArn (string) -- [REQUIRED]
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
  - Rtp (dict) --
    
    The configuration settings for a destination endpoint that uses the RTP protocol.
    - DestinationAddress (string) -- [REQUIRED]
      
      The IP address on which the destination endpoint receives content.
    - DestinationIngestPort (integer) -- [REQUIRED]
      
      The port on which the destination endpoint receives content. The valid range is 1024 to 65531.
    - ForwardErrorCorrectionState (string) -- [REQUIRED]
      
      Indicates whether forward error correction (FEC) is enabled for the destination endpoint.
- DestinationNetworkingType (string) --
  
  The networking type of the destination endpoint. Valid values include the following:
  - PUBLIC – The destination endpoint is publicly accessible.
  - VPC – The destination endpoint is in a virtual private cloud (VPC).
- Protocol (string) --
  
  The protocol used by the destination endpoint. Valid values include the following:
  - RTP – Real-time Transport Protocol.
  - RIST – Reliable Internet Stream Transport.
  - SRT_CALLER – Secure Reliable Transport (SRT) in caller mode.
  - SRT_LISTENER – Secure Reliable Transport (SRT) in listener mode.
RouterInput (dict) --

The configuration settings for a destination endpoint that represents a router input.
- RouterInputArn (string) -- [REQUIRED]
  
  The Amazon Resource Name (ARN) of the router input that the destination endpoint represents.

rtype:

dict

returns:

Response Syntax

{
    'DestinationEndpoint': {
        'Name': 'string',
        'Arn': 'string',
        'Id': 'string',
        'Description': 'string',
        'RegionName': 'string',
        'AvailabilityZone': 'string',
        'AvailabilityZoneId': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'LifecycleManagement': 'MANAGED'|'UNMANAGED',
        'Messages': [
            {
                'Code': 'string',
                'Message': 'string'
            },
        ],
        'DestinationType': 'STANDARD'|'ROUTER_INPUT',
        'Configuration': {
            'Standard': {
                'Name': 'string',
                'DestinationNetworkingConfiguration': {
                    'Public': {
                        'DestinationAllowRules': [
                            {
                                'Cidr': 'string'
                            },
                        ]
                    },
                    'Vpc': {
                        'SecurityGroupIds': [
                            'string',
                        ],
                        'SubnetId': 'string'
                    }
                },
                'ProtocolConfiguration': {
                    'Rist': {
                        'DestinationAddress': 'string',
                        'DestinationIngestPort': 123
                    },
                    'SrtListener': {
                        'DestinationAddress': 'string',
                        'DestinationIngestPort': 123,
                        'MinimumLatencyMilliseconds': 123,
                        'StreamId': 'string',
                        'EncryptionPassphrase': {
                            'SecretArn': 'string'
                        }
                    },
                    'SrtCaller': {
                        'SourceListenerPort': 123,
                        'MinimumLatencyMilliseconds': 123,
                        'EncryptionPassphrase': {
                            'SecretArn': 'string'
                        }
                    },
                    'Rtp': {
                        'DestinationAddress': 'string',
                        'DestinationIngestPort': 123,
                        'ForwardErrorCorrectionState': 'ENABLED'|'DISABLED'
                    }
                },
                'DestinationNetworkingType': 'PUBLIC'|'VPC',
                'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
            },
            'RouterInput': {
                'RouterInputArn': 'string'
            }
        },
        'ResourceShareOwnership': 'OWNED'|'CONSUMED',
        'ResourceShareDetails': {
            'Owned': {
                'ShareState': 'SHARED'|'UNSHARED'
            },
            'Consumed': {
                'OwnerAccountId': 'string'
            }
        },
        'RegistrationState': 'REGISTERED'|'REGISTERING'|'DEREGISTERING'|'REGISTRATION_FAILED',
        'ConnectionDetails': {
            'Standard': {
                'SourceIpAddress': 'string',
                'SourceListenerPort': 123,
                'SourceEncryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                'SourceEncryptionConfiguration': {
                    'SecretsManager': {
                        'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                        'EncryptionSecret': {
                            'SecretArn': 'string'
                        }
                    },
                    'Automatic': {}
                },
                'SourceEndpointType': 'STANDARD'|'ROUTER_OUTPUT'
            },
            'RouterInput': {
                'SourceEncryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                'SourceEncryptionConfiguration': {
                    'SecretsManager': {
                        'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                        'EncryptionSecret': {
                            'SecretArn': 'string'
                        }
                    },
                    'Automatic': {}
                },
                'SourceEndpointType': 'STANDARD'|'ROUTER_OUTPUT'
            }
        },
        'ConnectionState': 'CONNECTED'|'DISCONNECTED'|'CONNECTING'|'DISCONNECTING',
        'ConnectedSource': 'string',
        'DecryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
        'DecryptionConfiguration': {
            'SecretsManager': {
                'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                'EncryptionSecret': {
                    'SecretArn': 'string'
                }
            },
            'Automatic': {}
        },
        'AssociatedResourceDetails': {
            'Standard': {},
            'RouterInput': {
                'Name': 'string',
                'MaximumBitrate': 123,
                'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
                'Messages': [
                    {
                        'Code': 'string',
                        'Message': 'string'
                    },
                ]
            }
        },
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- DestinationEndpoint (dict) --
  
  The details of the updated destination endpoint.
  - Name (string) --
    
    The name of the destination endpoint.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of the destination endpoint.
  - Id (string) --
    
    The unique identifier of the destination endpoint.
  - Description (string) --
    
    The description of the destination endpoint.
  - RegionName (string) --
    
    The name of the Amazon Web Services Region in which the destination endpoint is located.
  - AvailabilityZone (string) --
    
    The Availability Zone in which the destination endpoint is located.
  - AvailabilityZoneId (string) --
    
    The ID of the Availability Zone in which the destination endpoint is located.
  - CreatedAt (datetime) --
    
    The date and time when the destination endpoint was created.
  - UpdatedAt (datetime) --
    
    The date and time when the destination endpoint was last updated.
  - LifecycleManagement (string) --
    
    The entity that manages the lifecycle of the destination endpoint.
  - Messages (list) --
    
    The status messages for the destination endpoint.
    - (dict) --
      
      A status message for a destination endpoint.
      - Code (string) --
        
        The message code.
      - Message (string) --
        
        The message text.
  - DestinationType (string) --
    
    The type of the destination endpoint. Valid values include the following:
    - STANDARD – A destination endpoint that represents an external destination over a standard protocol, such as RTP, RIST, or SRT.
    - ROUTER_INPUT – A destination endpoint that represents a router input.
  - Configuration (dict) --
    
    The configuration settings for the destination endpoint.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterInput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The configuration settings for a standard destination endpoint, which represents an external destination.
      - Name (string) --
        
        The name of the destination endpoint.
      - DestinationNetworkingConfiguration (dict) --
        
        The networking configuration for the destination endpoint, which determines whether it is publicly accessible or in a virtual private cloud (VPC).
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Public, Vpc. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Public (dict) --
        
        The configuration for a publicly accessible destination endpoint.
        
        DestinationAllowRules (list) --
        
        The rules that specify which CIDR blocks can connect to the destination endpoint. You can specify up to 10 rules.
        
        (dict) --
        
        A rule that allows a specific CIDR block to connect to the public destination endpoint.
        
        Cidr (string) --
        
        The CIDR block that is allowed to connect to the destination endpoint, in CIDR notation.
        
        Vpc (dict) --
        
        The configuration for a destination endpoint in a virtual private cloud (VPC).
        
        SecurityGroupIds (list) --
        
        The IDs of the security groups to associate with the destination endpoint. You can specify from 1 to 5 security groups.
        
        (string) --
        
        SubnetId (string) --
        
        The ID of the subnet to use for the destination endpoint.
      - ProtocolConfiguration (dict) --
        
        The protocol configuration for the destination endpoint.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rist, SrtListener, SrtCaller, Rtp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Rist (dict) --
        
        The configuration settings for a destination endpoint that uses the RIST protocol.
        
        DestinationAddress (string) --
        
        The IP address on which the destination endpoint receives content.
        
        DestinationIngestPort (integer) --
        
        The port on which the destination endpoint receives content. The valid range is 1024 to 65531.
        
        SrtListener (dict) --
        
        The configuration settings for a destination endpoint that uses SRT in listener mode.
        
        DestinationAddress (string) --
        
        The IP address on which the destination endpoint listens for incoming connections.
        
        DestinationIngestPort (integer) --
        
        The port on which the destination endpoint listens for incoming connections. The valid range is 0 to 65531.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
        
        StreamId (string) --
        
        The stream ID that identifies the content for the SRT connection.
        
        EncryptionPassphrase (dict) --
        
        The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        SrtCaller (dict) --
        
        The configuration settings for a destination endpoint that uses SRT in caller mode.
        
        SourceListenerPort (integer) --
        
        The port on which the source listens for the connection. The valid range is 3000 to 30000.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
        
        EncryptionPassphrase (dict) --
        
        The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Rtp (dict) --
        
        The configuration settings for a destination endpoint that uses the RTP protocol.
        
        DestinationAddress (string) --
        
        The IP address on which the destination endpoint receives content.
        
        DestinationIngestPort (integer) --
        
        The port on which the destination endpoint receives content. The valid range is 1024 to 65531.
        
        ForwardErrorCorrectionState (string) --
        
        Indicates whether forward error correction (FEC) is enabled for the destination endpoint.
      - DestinationNetworkingType (string) --
        
        The networking type of the destination endpoint. Valid values include the following:
        
        PUBLIC – The destination endpoint is publicly accessible.
        
        VPC – The destination endpoint is in a virtual private cloud (VPC).
      - Protocol (string) --
        
        The protocol used by the destination endpoint. Valid values include the following:
        
        RTP – Real-time Transport Protocol.
        
        RIST – Reliable Internet Stream Transport.
        
        SRT_CALLER – Secure Reliable Transport (SRT) in caller mode.
        
        SRT_LISTENER – Secure Reliable Transport (SRT) in listener mode.
    - RouterInput (dict) --
      
      The configuration settings for a destination endpoint that represents a router input.
      - RouterInputArn (string) --
        
        The Amazon Resource Name (ARN) of the router input that the destination endpoint represents.
  - ResourceShareOwnership (string) --
    
    Indicates whether this account owns the destination endpoint or consumes it from another account through RAM.
  - ResourceShareDetails (dict) --
    
    The cross-account sharing details for an endpoint. Endpoints are shared through Resource Access Manager (RAM). This is a union type, so exactly one of its members is set: owned when this account owns the endpoint and shares it with other accounts, or consumed when this account consumes an endpoint that another account shares. To change how an endpoint is shared, use RAM.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Owned, Consumed. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Owned (dict) --
      
      The sharing details for an endpoint that this account owns and shares with other accounts through RAM.
      - ShareState (string) --
        
        The sharing state of the endpoint. Valid values include the following:
        
        SHARED – The endpoint is shared with one or more accounts.
        
        UNSHARED – The endpoint is not shared with other accounts.
    - Consumed (dict) --
      
      The sharing details for an endpoint that another account shares with this account through RAM.
      - OwnerAccountId (string) --
        
        The ID of the Amazon Web Services account that owns the shared endpoint.
  - RegistrationState (string) --
    
    The registration state of the destination endpoint. Valid values include the following:
    - REGISTERED – The destination endpoint is registered and ready to use.
    - REGISTERING – MediaConnect is registering the destination endpoint.
    - DEREGISTERING – MediaConnect is deregistering the destination endpoint.
    - REGISTRATION_FAILED – MediaConnect couldn't register the destination endpoint.
  - ConnectionDetails (dict) --
    
    The connection details for the destination endpoint.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterInput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The connection details for a standard destination endpoint.
      - SourceIpAddress (string) --
        
        The IP address of the source that is connected to the destination endpoint.
      - SourceListenerPort (integer) --
        
        The port on which the source listens for the connection.
      - SourceEncryptionType (string) --
        
        The type of encryption that the source uses for the connection.
      - SourceEncryptionConfiguration (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
      - SourceEndpointType (string) --
        
        The type of the connected source endpoint.
    - RouterInput (dict) --
      
      The connection details for a destination endpoint that represents a router input.
      - SourceEncryptionType (string) --
        
        The type of encryption that the source uses for the connection.
      - SourceEncryptionConfiguration (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
      - SourceEndpointType (string) --
        
        The type of the connected source endpoint.
  - ConnectionState (string) --
    
    The connection state of the destination endpoint. Valid values include the following:
    - CONNECTED – The destination endpoint is connected to a source endpoint.
    - DISCONNECTED – The destination endpoint isn't connected to a source endpoint.
    - CONNECTING – The destination endpoint is connecting to a source endpoint.
    - DISCONNECTING – The destination endpoint is disconnecting from a source endpoint.
  - ConnectedSource (string) --
    
    The Amazon Resource Name (ARN) of the source endpoint that is connected to the destination endpoint.
  - DecryptionType (string) --
    
    The type of decryption used for the destination endpoint connection.
  - DecryptionConfiguration (dict) --
    
    The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - SecretsManager (dict) --
      
      The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
      - EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
      - EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
    - Automatic (dict) --
      
      The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
  - AssociatedResourceDetails (dict) --
    
    The details of the resource that is associated with the destination endpoint.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterInput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The associated resource details for a standard destination endpoint.
    - RouterInput (dict) --
      
      The associated resource details for a destination endpoint that represents a router input.
      - Name (string) --
        
        The name of the router input.
      - MaximumBitrate (integer) --
        
        The maximum bitrate of the router input, in bits per second.
      - State (string) --
        
        The state of the router input.
      - Messages (list) --
        
        The status messages for the router input.
        
        (dict) --
        
        A message associated with a router input, including a code and a message.
        
        Code (string) --
        
        The code associated with the router input message.
        
        Message (string) --
        
        The message text associated with the router input message.
  - Tags (dict) --
    
    The tags associated with the destination endpoint. Each tag is a key-value pair.
    - (string) --
      - (string) --

GetSourceEndpoint (new)

Link ¶

Retrieves information about a source endpoint.

See also: AWS API Documentation

Request Syntax

client.get_source_endpoint(
    Arn='string'
)

type Arn:

string

param Arn:

[REQUIRED]

The Amazon Resource Name (ARN) of the source endpoint to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'SourceEndpoint': {
        'Name': 'string',
        'Arn': 'string',
        'Id': 'string',
        'Description': 'string',
        'RegionName': 'string',
        'AvailabilityZone': 'string',
        'AvailabilityZoneId': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'LifecycleManagement': 'MANAGED'|'UNMANAGED',
        'Messages': [
            {
                'Code': 'string',
                'Message': 'string'
            },
        ],
        'SourceType': 'STANDARD'|'ROUTER_OUTPUT',
        'Configuration': {
            'Standard': {
                'Name': 'string',
                'SourceNetworkingConfiguration': {
                    'Public': {
                        'SourceAllowRules': [
                            {
                                'Cidr': 'string'
                            },
                        ]
                    },
                    'Vpc': {
                        'SecurityGroupIds': [
                            'string',
                        ],
                        'SubnetId': 'string'
                    }
                },
                'ProtocolConfiguration': {
                    'Rist': {
                        'DestinationIngestPort': 123,
                        'RecoveryLatencyMilliseconds': 123
                    },
                    'SrtListener': {
                        'SourceListenerPort': 123,
                        'SourceAddress': 'string',
                        'MinimumLatencyMilliseconds': 123,
                        'StreamId': 'string',
                        'EncryptionPassphrase': {
                            'SecretArn': 'string'
                        }
                    },
                    'SrtCaller': {
                        'DestinationIngestPort': 123,
                        'MinimumLatencyMilliseconds': 123,
                        'EncryptionPassphrase': {
                            'SecretArn': 'string'
                        }
                    },
                    'Rtp': {
                        'DestinationIngestPort': 123,
                        'ForwardErrorCorrectionState': 'ENABLED'|'DISABLED'
                    }
                },
                'SourceNetworkingType': 'PUBLIC'|'VPC',
                'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
            },
            'RouterOutput': {
                'RouterOutputArn': 'string'
            }
        },
        'ResourceShareOwnership': 'OWNED'|'CONSUMED',
        'ResourceShareDetails': {
            'Owned': {
                'ShareState': 'SHARED'|'UNSHARED'
            },
            'Consumed': {
                'OwnerAccountId': 'string'
            }
        },
        'RegistrationState': 'REGISTERED'|'REGISTERING'|'DEREGISTERING'|'REGISTRATION_FAILED',
        'ConnectionState': 'CONNECTED'|'DISCONNECTED'|'CONNECTING'|'DISCONNECTING',
        'ConnectionDetails': {
            'Standard': {
                'DestinationIpAddress': 'string',
                'DestinationIngestPort': 123,
                'DestinationDecryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                'DestinationDecryptionConfiguration': {
                    'SecretsManager': {
                        'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                        'EncryptionSecret': {
                            'SecretArn': 'string'
                        }
                    },
                    'Automatic': {}
                },
                'DestinationEndpointType': 'STANDARD'|'ROUTER_INPUT'
            },
            'RouterOutput': {
                'DestinationDecryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                'DestinationDecryptionConfiguration': {
                    'SecretsManager': {
                        'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                        'EncryptionSecret': {
                            'SecretArn': 'string'
                        }
                    },
                    'Automatic': {}
                },
                'DestinationEndpointType': 'STANDARD'|'ROUTER_INPUT'
            }
        },
        'ConnectedDestinations': [
            'string',
        ],
        'EncryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
        'EncryptionConfiguration': {
            'SecretsManager': {
                'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                'EncryptionSecret': {
                    'SecretArn': 'string'
                }
            },
            'Automatic': {}
        },
        'AssociatedResourceDetails': {
            'Standard': {},
            'RouterOutput': {
                'Name': 'string',
                'MaximumBitrate': 123,
                'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
                'Messages': [
                    {
                        'Code': 'string',
                        'Message': 'string'
                    },
                ]
            }
        },
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- SourceEndpoint (dict) --
  
  The details of the source endpoint.
  - Name (string) --
    
    The name of the source endpoint.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of the source endpoint.
  - Id (string) --
    
    The unique identifier of the source endpoint.
  - Description (string) --
    
    The description of the source endpoint.
  - RegionName (string) --
    
    The name of the Amazon Web Services Region in which the source endpoint is located.
  - AvailabilityZone (string) --
    
    The Availability Zone in which the source endpoint is located.
  - AvailabilityZoneId (string) --
    
    The ID of the Availability Zone in which the source endpoint is located.
  - CreatedAt (datetime) --
    
    The date and time when the source endpoint was created.
  - UpdatedAt (datetime) --
    
    The date and time when the source endpoint was last updated.
  - LifecycleManagement (string) --
    
    The entity that manages the lifecycle of the source endpoint.
  - Messages (list) --
    
    The status messages for the source endpoint.
    - (dict) --
      
      A status message for a source endpoint.
      - Code (string) --
        
        The message code.
      - Message (string) --
        
        The message text.
  - SourceType (string) --
    
    The type of the source endpoint. Valid values include the following:
    - STANDARD – A source endpoint that represents an external source over a standard protocol, such as RTP, RIST, or SRT.
    - ROUTER_OUTPUT – A source endpoint that represents a router output.
  - Configuration (dict) --
    
    The configuration settings for the source endpoint.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterOutput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The configuration settings for a standard source endpoint, which represents an external source.
      - Name (string) --
        
        The name of the source endpoint.
      - SourceNetworkingConfiguration (dict) --
        
        The networking configuration for the source endpoint, which determines whether it is publicly accessible or in a virtual private cloud (VPC).
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Public, Vpc. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Public (dict) --
        
        The configuration for a publicly accessible source endpoint.
        
        SourceAllowRules (list) --
        
        The rules that specify which CIDR blocks can connect to the source endpoint. You can specify up to 10 rules.
        
        (dict) --
        
        A rule that allows a specific CIDR block to connect to the public source endpoint.
        
        Cidr (string) --
        
        The CIDR block that is allowed to connect to the source endpoint, in CIDR notation.
        
        Vpc (dict) --
        
        The configuration for a source endpoint in a virtual private cloud (VPC).
        
        SecurityGroupIds (list) --
        
        The IDs of the security groups to associate with the source endpoint. You can specify from 1 to 5 security groups.
        
        (string) --
        
        SubnetId (string) --
        
        The ID of the subnet to use for the source endpoint.
      - ProtocolConfiguration (dict) --
        
        The protocol configuration for the source endpoint.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rist, SrtListener, SrtCaller, Rtp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Rist (dict) --
        
        The configuration settings for a source endpoint that uses the RIST protocol.
        
        DestinationIngestPort (integer) --
        
        The port on the destination that receives the content. The valid range is 3000 to 30000.
        
        RecoveryLatencyMilliseconds (integer) --
        
        The amount of time, in milliseconds, that the source endpoint allows for recovering lost packets. The valid range is 10 to 10000.
        
        SrtListener (dict) --
        
        The configuration settings for a source endpoint that uses SRT in listener mode.
        
        SourceListenerPort (integer) --
        
        The port that the source endpoint listens on for incoming connections. The valid range is 1024 to 65535.
        
        SourceAddress (string) --
        
        The IP address that the source endpoint listens on for incoming connections.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
        
        StreamId (string) --
        
        The stream ID that identifies the content for the SRT connection.
        
        EncryptionPassphrase (dict) --
        
        The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        SrtCaller (dict) --
        
        The configuration settings for a source endpoint that uses SRT in caller mode.
        
        DestinationIngestPort (integer) --
        
        The port on which the destination listens for the connection. The valid range is 3000 to 30000.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
        
        EncryptionPassphrase (dict) --
        
        The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Rtp (dict) --
        
        The configuration settings for a source endpoint that uses the RTP protocol.
        
        DestinationIngestPort (integer) --
        
        The port on the destination that receives the content. The valid range is 3000 to 30000.
        
        ForwardErrorCorrectionState (string) --
        
        Indicates whether forward error correction (FEC) is enabled for the source endpoint.
      - SourceNetworkingType (string) --
        
        The networking type of the source endpoint. Valid values include the following:
        
        PUBLIC – The source endpoint is publicly accessible.
        
        VPC – The source endpoint is in a virtual private cloud (VPC).
      - Protocol (string) --
        
        The protocol used by the source endpoint. Valid values include the following:
        
        RTP – Real-time Transport Protocol.
        
        RIST – Reliable Internet Stream Transport.
        
        SRT_CALLER – Secure Reliable Transport (SRT) in caller mode.
        
        SRT_LISTENER – Secure Reliable Transport (SRT) in listener mode.
    - RouterOutput (dict) --
      
      The configuration settings for a source endpoint that represents a router output.
      - RouterOutputArn (string) --
        
        The Amazon Resource Name (ARN) of the router output that the source endpoint represents.
  - ResourceShareOwnership (string) --
    
    Indicates whether this account owns the source endpoint or consumes it from another account through RAM.
  - ResourceShareDetails (dict) --
    
    The cross-account sharing details for an endpoint. Endpoints are shared through Resource Access Manager (RAM). This is a union type, so exactly one of its members is set: owned when this account owns the endpoint and shares it with other accounts, or consumed when this account consumes an endpoint that another account shares. To change how an endpoint is shared, use RAM.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Owned, Consumed. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Owned (dict) --
      
      The sharing details for an endpoint that this account owns and shares with other accounts through RAM.
      - ShareState (string) --
        
        The sharing state of the endpoint. Valid values include the following:
        
        SHARED – The endpoint is shared with one or more accounts.
        
        UNSHARED – The endpoint is not shared with other accounts.
    - Consumed (dict) --
      
      The sharing details for an endpoint that another account shares with this account through RAM.
      - OwnerAccountId (string) --
        
        The ID of the Amazon Web Services account that owns the shared endpoint.
  - RegistrationState (string) --
    
    The registration state of the source endpoint. Valid values include the following:
    - REGISTERED – The source endpoint is registered and ready to use.
    - REGISTERING – MediaConnect is registering the source endpoint.
    - DEREGISTERING – MediaConnect is deregistering the source endpoint.
    - REGISTRATION_FAILED – MediaConnect couldn't register the source endpoint.
  - ConnectionState (string) --
    
    The connection state of the source endpoint. Valid values include the following:
    - CONNECTED – The source endpoint is connected to a destination endpoint.
    - DISCONNECTED – The source endpoint isn't connected to a destination endpoint.
    - CONNECTING – The source endpoint is connecting to a destination endpoint.
    - DISCONNECTING – The source endpoint is disconnecting from a destination endpoint.
  - ConnectionDetails (dict) --
    
    The connection details for the source endpoint.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterOutput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The connection details for a standard source endpoint.
      - DestinationIpAddress (string) --
        
        The IP address of the destination that receives the content.
      - DestinationIngestPort (integer) --
        
        The port on the destination that receives the content.
      - DestinationDecryptionType (string) --
        
        The type of decryption that the destination uses for the connection.
      - DestinationDecryptionConfiguration (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
      - DestinationEndpointType (string) --
        
        The type of the connected destination endpoint.
    - RouterOutput (dict) --
      
      The connection details for a source endpoint that represents a router output.
      - DestinationDecryptionType (string) --
        
        The type of decryption that the destination uses for the connection.
      - DestinationDecryptionConfiguration (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
      - DestinationEndpointType (string) --
        
        The type of the connected destination endpoint.
  - ConnectedDestinations (list) --
    
    The Amazon Resource Names (ARNs) of the destination endpoints that are connected to the source endpoint.
    - (string) --
  - EncryptionType (string) --
    
    The type of encryption used for the source endpoint connection.
  - EncryptionConfiguration (dict) --
    
    The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - SecretsManager (dict) --
      
      The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
      - EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
      - EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
    - Automatic (dict) --
      
      The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
  - AssociatedResourceDetails (dict) --
    
    The details of the resource that is associated with the source endpoint.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterOutput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The associated resource details for a standard source endpoint.
    - RouterOutput (dict) --
      
      The associated resource details for a source endpoint that represents a router output.
      - Name (string) --
        
        The name of the router output.
      - MaximumBitrate (integer) --
        
        The maximum bitrate of the router output, in bits per second.
      - State (string) --
        
        The state of the router output.
      - Messages (list) --
        
        The status messages for 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) --
    
    The tags associated with the source endpoint. Each tag is a key-value pair.
    - (string) --
      - (string) --

RegisterDestinationEndpoint (new)

Link ¶

Registers a new destination endpoint in MediaConnect.

See also: AWS API Documentation

Request Syntax

client.register_destination_endpoint(
    Description='string',
    Configuration={
        'Standard': {
            'Name': 'string',
            'DestinationNetworkingConfiguration': {
                'Public': {
                    'DestinationAllowRules': [
                        {
                            'Cidr': 'string'
                        },
                    ]
                },
                'Vpc': {
                    'SecurityGroupIds': [
                        'string',
                    ],
                    'SubnetId': 'string'
                }
            },
            'ProtocolConfiguration': {
                'Rist': {
                    'DestinationAddress': 'string',
                    'DestinationIngestPort': 123
                },
                'SrtListener': {
                    'DestinationAddress': 'string',
                    'DestinationIngestPort': 123,
                    'MinimumLatencyMilliseconds': 123,
                    'StreamId': 'string',
                    'EncryptionPassphrase': {
                        'SecretArn': 'string'
                    }
                },
                'SrtCaller': {
                    'SourceListenerPort': 123,
                    'MinimumLatencyMilliseconds': 123,
                    'EncryptionPassphrase': {
                        'SecretArn': 'string'
                    }
                },
                'Rtp': {
                    'DestinationAddress': 'string',
                    'DestinationIngestPort': 123,
                    'ForwardErrorCorrectionState': 'ENABLED'|'DISABLED'
                }
            },
            'DestinationNetworkingType': 'PUBLIC'|'VPC',
            'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
        },
        'RouterInput': {
            'RouterInputArn': 'string'
        }
    },
    RegionName='string',
    Tags={
        'string': 'string'
    },
    ClientToken='string'
)

type Description:

string

param Description:

A description to help you identify the destination endpoint.

type Configuration:

dict

param Configuration:

[REQUIRED]

The configuration settings for the destination endpoint.

Standard (dict) --

The configuration settings for a standard destination endpoint, which represents an external destination.
- Name (string) -- [REQUIRED]
  
  The name of the destination endpoint.
- DestinationNetworkingConfiguration (dict) -- [REQUIRED]
  
  The networking configuration for the destination endpoint, which determines whether it is publicly accessible or in a virtual private cloud (VPC).
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: Public, Vpc.
  - Public (dict) --
    
    The configuration for a publicly accessible destination endpoint.
    - DestinationAllowRules (list) -- [REQUIRED]
      
      The rules that specify which CIDR blocks can connect to the destination endpoint. You can specify up to 10 rules.
      - (dict) --
        
        A rule that allows a specific CIDR block to connect to the public destination endpoint.
        
        Cidr (string) -- [REQUIRED]
        
        The CIDR block that is allowed to connect to the destination endpoint, in CIDR notation.
  - Vpc (dict) --
    
    The configuration for a destination endpoint in a virtual private cloud (VPC).
    - SecurityGroupIds (list) -- [REQUIRED]
      
      The IDs of the security groups to associate with the destination endpoint. You can specify from 1 to 5 security groups.
      - (string) --
    - SubnetId (string) -- [REQUIRED]
      
      The ID of the subnet to use for the destination endpoint.
- ProtocolConfiguration (dict) -- [REQUIRED]
  
  The protocol configuration for the destination endpoint.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: Rist, SrtListener, SrtCaller, Rtp.
  - Rist (dict) --
    
    The configuration settings for a destination endpoint that uses the RIST protocol.
    - DestinationAddress (string) -- [REQUIRED]
      
      The IP address on which the destination endpoint receives content.
    - DestinationIngestPort (integer) -- [REQUIRED]
      
      The port on which the destination endpoint receives content. The valid range is 1024 to 65531.
  - SrtListener (dict) --
    
    The configuration settings for a destination endpoint that uses SRT in listener mode.
    - DestinationAddress (string) -- [REQUIRED]
      
      The IP address on which the destination endpoint listens for incoming connections.
    - DestinationIngestPort (integer) -- [REQUIRED]
      
      The port on which the destination endpoint listens for incoming connections. The valid range is 0 to 65531.
    - MinimumLatencyMilliseconds (integer) -- [REQUIRED]
      
      The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
    - StreamId (string) --
      
      The stream ID that identifies the content for the SRT connection.
    - EncryptionPassphrase (dict) --
      
      The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
      - SecretArn (string) -- [REQUIRED]
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
  - SrtCaller (dict) --
    
    The configuration settings for a destination endpoint that uses SRT in caller mode.
    - SourceListenerPort (integer) -- [REQUIRED]
      
      The port on which the source listens for the connection. The valid range is 3000 to 30000.
    - MinimumLatencyMilliseconds (integer) -- [REQUIRED]
      
      The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
    - EncryptionPassphrase (dict) --
      
      The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
      - SecretArn (string) -- [REQUIRED]
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
  - Rtp (dict) --
    
    The configuration settings for a destination endpoint that uses the RTP protocol.
    - DestinationAddress (string) -- [REQUIRED]
      
      The IP address on which the destination endpoint receives content.
    - DestinationIngestPort (integer) -- [REQUIRED]
      
      The port on which the destination endpoint receives content. The valid range is 1024 to 65531.
    - ForwardErrorCorrectionState (string) -- [REQUIRED]
      
      Indicates whether forward error correction (FEC) is enabled for the destination endpoint.
- DestinationNetworkingType (string) --
  
  The networking type of the destination endpoint. Valid values include the following:
  - PUBLIC – The destination endpoint is publicly accessible.
  - VPC – The destination endpoint is in a virtual private cloud (VPC).
- Protocol (string) --
  
  The protocol used by the destination endpoint. Valid values include the following:
  - RTP – Real-time Transport Protocol.
  - RIST – Reliable Internet Stream Transport.
  - SRT_CALLER – Secure Reliable Transport (SRT) in caller mode.
  - SRT_LISTENER – Secure Reliable Transport (SRT) in listener mode.
RouterInput (dict) --

The configuration settings for a destination endpoint that represents a router input.
- RouterInputArn (string) -- [REQUIRED]
  
  The Amazon Resource Name (ARN) of the router input that the destination endpoint represents.

type RegionName:

string

param RegionName:

The name of the Amazon Web Services Region in which to register the destination endpoint. Defaults to the current region if not specified.

type Tags:

dict

param Tags:

The tags to apply to the destination endpoint. Each tag is a key-value pair.

(string) --
- (string) --

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If this token matches a previous request, the service ignores the request, but does not return an error.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'DestinationEndpoint': {
        'Name': 'string',
        'Arn': 'string',
        'Id': 'string',
        'Description': 'string',
        'RegionName': 'string',
        'AvailabilityZone': 'string',
        'AvailabilityZoneId': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'LifecycleManagement': 'MANAGED'|'UNMANAGED',
        'Messages': [
            {
                'Code': 'string',
                'Message': 'string'
            },
        ],
        'DestinationType': 'STANDARD'|'ROUTER_INPUT',
        'Configuration': {
            'Standard': {
                'Name': 'string',
                'DestinationNetworkingConfiguration': {
                    'Public': {
                        'DestinationAllowRules': [
                            {
                                'Cidr': 'string'
                            },
                        ]
                    },
                    'Vpc': {
                        'SecurityGroupIds': [
                            'string',
                        ],
                        'SubnetId': 'string'
                    }
                },
                'ProtocolConfiguration': {
                    'Rist': {
                        'DestinationAddress': 'string',
                        'DestinationIngestPort': 123
                    },
                    'SrtListener': {
                        'DestinationAddress': 'string',
                        'DestinationIngestPort': 123,
                        'MinimumLatencyMilliseconds': 123,
                        'StreamId': 'string',
                        'EncryptionPassphrase': {
                            'SecretArn': 'string'
                        }
                    },
                    'SrtCaller': {
                        'SourceListenerPort': 123,
                        'MinimumLatencyMilliseconds': 123,
                        'EncryptionPassphrase': {
                            'SecretArn': 'string'
                        }
                    },
                    'Rtp': {
                        'DestinationAddress': 'string',
                        'DestinationIngestPort': 123,
                        'ForwardErrorCorrectionState': 'ENABLED'|'DISABLED'
                    }
                },
                'DestinationNetworkingType': 'PUBLIC'|'VPC',
                'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
            },
            'RouterInput': {
                'RouterInputArn': 'string'
            }
        },
        'ResourceShareOwnership': 'OWNED'|'CONSUMED',
        'ResourceShareDetails': {
            'Owned': {
                'ShareState': 'SHARED'|'UNSHARED'
            },
            'Consumed': {
                'OwnerAccountId': 'string'
            }
        },
        'RegistrationState': 'REGISTERED'|'REGISTERING'|'DEREGISTERING'|'REGISTRATION_FAILED',
        'ConnectionDetails': {
            'Standard': {
                'SourceIpAddress': 'string',
                'SourceListenerPort': 123,
                'SourceEncryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                'SourceEncryptionConfiguration': {
                    'SecretsManager': {
                        'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                        'EncryptionSecret': {
                            'SecretArn': 'string'
                        }
                    },
                    'Automatic': {}
                },
                'SourceEndpointType': 'STANDARD'|'ROUTER_OUTPUT'
            },
            'RouterInput': {
                'SourceEncryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                'SourceEncryptionConfiguration': {
                    'SecretsManager': {
                        'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                        'EncryptionSecret': {
                            'SecretArn': 'string'
                        }
                    },
                    'Automatic': {}
                },
                'SourceEndpointType': 'STANDARD'|'ROUTER_OUTPUT'
            }
        },
        'ConnectionState': 'CONNECTED'|'DISCONNECTED'|'CONNECTING'|'DISCONNECTING',
        'ConnectedSource': 'string',
        'DecryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
        'DecryptionConfiguration': {
            'SecretsManager': {
                'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                'EncryptionSecret': {
                    'SecretArn': 'string'
                }
            },
            'Automatic': {}
        },
        'AssociatedResourceDetails': {
            'Standard': {},
            'RouterInput': {
                'Name': 'string',
                'MaximumBitrate': 123,
                'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
                'Messages': [
                    {
                        'Code': 'string',
                        'Message': 'string'
                    },
                ]
            }
        },
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- DestinationEndpoint (dict) --
  
  The details of the destination endpoint that was registered.
  - Name (string) --
    
    The name of the destination endpoint.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of the destination endpoint.
  - Id (string) --
    
    The unique identifier of the destination endpoint.
  - Description (string) --
    
    The description of the destination endpoint.
  - RegionName (string) --
    
    The name of the Amazon Web Services Region in which the destination endpoint is located.
  - AvailabilityZone (string) --
    
    The Availability Zone in which the destination endpoint is located.
  - AvailabilityZoneId (string) --
    
    The ID of the Availability Zone in which the destination endpoint is located.
  - CreatedAt (datetime) --
    
    The date and time when the destination endpoint was created.
  - UpdatedAt (datetime) --
    
    The date and time when the destination endpoint was last updated.
  - LifecycleManagement (string) --
    
    The entity that manages the lifecycle of the destination endpoint.
  - Messages (list) --
    
    The status messages for the destination endpoint.
    - (dict) --
      
      A status message for a destination endpoint.
      - Code (string) --
        
        The message code.
      - Message (string) --
        
        The message text.
  - DestinationType (string) --
    
    The type of the destination endpoint. Valid values include the following:
    - STANDARD – A destination endpoint that represents an external destination over a standard protocol, such as RTP, RIST, or SRT.
    - ROUTER_INPUT – A destination endpoint that represents a router input.
  - Configuration (dict) --
    
    The configuration settings for the destination endpoint.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterInput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The configuration settings for a standard destination endpoint, which represents an external destination.
      - Name (string) --
        
        The name of the destination endpoint.
      - DestinationNetworkingConfiguration (dict) --
        
        The networking configuration for the destination endpoint, which determines whether it is publicly accessible or in a virtual private cloud (VPC).
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Public, Vpc. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Public (dict) --
        
        The configuration for a publicly accessible destination endpoint.
        
        DestinationAllowRules (list) --
        
        The rules that specify which CIDR blocks can connect to the destination endpoint. You can specify up to 10 rules.
        
        (dict) --
        
        A rule that allows a specific CIDR block to connect to the public destination endpoint.
        
        Cidr (string) --
        
        The CIDR block that is allowed to connect to the destination endpoint, in CIDR notation.
        
        Vpc (dict) --
        
        The configuration for a destination endpoint in a virtual private cloud (VPC).
        
        SecurityGroupIds (list) --
        
        The IDs of the security groups to associate with the destination endpoint. You can specify from 1 to 5 security groups.
        
        (string) --
        
        SubnetId (string) --
        
        The ID of the subnet to use for the destination endpoint.
      - ProtocolConfiguration (dict) --
        
        The protocol configuration for the destination endpoint.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rist, SrtListener, SrtCaller, Rtp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Rist (dict) --
        
        The configuration settings for a destination endpoint that uses the RIST protocol.
        
        DestinationAddress (string) --
        
        The IP address on which the destination endpoint receives content.
        
        DestinationIngestPort (integer) --
        
        The port on which the destination endpoint receives content. The valid range is 1024 to 65531.
        
        SrtListener (dict) --
        
        The configuration settings for a destination endpoint that uses SRT in listener mode.
        
        DestinationAddress (string) --
        
        The IP address on which the destination endpoint listens for incoming connections.
        
        DestinationIngestPort (integer) --
        
        The port on which the destination endpoint listens for incoming connections. The valid range is 0 to 65531.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
        
        StreamId (string) --
        
        The stream ID that identifies the content for the SRT connection.
        
        EncryptionPassphrase (dict) --
        
        The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        SrtCaller (dict) --
        
        The configuration settings for a destination endpoint that uses SRT in caller mode.
        
        SourceListenerPort (integer) --
        
        The port on which the source listens for the connection. The valid range is 3000 to 30000.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
        
        EncryptionPassphrase (dict) --
        
        The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Rtp (dict) --
        
        The configuration settings for a destination endpoint that uses the RTP protocol.
        
        DestinationAddress (string) --
        
        The IP address on which the destination endpoint receives content.
        
        DestinationIngestPort (integer) --
        
        The port on which the destination endpoint receives content. The valid range is 1024 to 65531.
        
        ForwardErrorCorrectionState (string) --
        
        Indicates whether forward error correction (FEC) is enabled for the destination endpoint.
      - DestinationNetworkingType (string) --
        
        The networking type of the destination endpoint. Valid values include the following:
        
        PUBLIC – The destination endpoint is publicly accessible.
        
        VPC – The destination endpoint is in a virtual private cloud (VPC).
      - Protocol (string) --
        
        The protocol used by the destination endpoint. Valid values include the following:
        
        RTP – Real-time Transport Protocol.
        
        RIST – Reliable Internet Stream Transport.
        
        SRT_CALLER – Secure Reliable Transport (SRT) in caller mode.
        
        SRT_LISTENER – Secure Reliable Transport (SRT) in listener mode.
    - RouterInput (dict) --
      
      The configuration settings for a destination endpoint that represents a router input.
      - RouterInputArn (string) --
        
        The Amazon Resource Name (ARN) of the router input that the destination endpoint represents.
  - ResourceShareOwnership (string) --
    
    Indicates whether this account owns the destination endpoint or consumes it from another account through RAM.
  - ResourceShareDetails (dict) --
    
    The cross-account sharing details for an endpoint. Endpoints are shared through Resource Access Manager (RAM). This is a union type, so exactly one of its members is set: owned when this account owns the endpoint and shares it with other accounts, or consumed when this account consumes an endpoint that another account shares. To change how an endpoint is shared, use RAM.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Owned, Consumed. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Owned (dict) --
      
      The sharing details for an endpoint that this account owns and shares with other accounts through RAM.
      - ShareState (string) --
        
        The sharing state of the endpoint. Valid values include the following:
        
        SHARED – The endpoint is shared with one or more accounts.
        
        UNSHARED – The endpoint is not shared with other accounts.
    - Consumed (dict) --
      
      The sharing details for an endpoint that another account shares with this account through RAM.
      - OwnerAccountId (string) --
        
        The ID of the Amazon Web Services account that owns the shared endpoint.
  - RegistrationState (string) --
    
    The registration state of the destination endpoint. Valid values include the following:
    - REGISTERED – The destination endpoint is registered and ready to use.
    - REGISTERING – MediaConnect is registering the destination endpoint.
    - DEREGISTERING – MediaConnect is deregistering the destination endpoint.
    - REGISTRATION_FAILED – MediaConnect couldn't register the destination endpoint.
  - ConnectionDetails (dict) --
    
    The connection details for the destination endpoint.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterInput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The connection details for a standard destination endpoint.
      - SourceIpAddress (string) --
        
        The IP address of the source that is connected to the destination endpoint.
      - SourceListenerPort (integer) --
        
        The port on which the source listens for the connection.
      - SourceEncryptionType (string) --
        
        The type of encryption that the source uses for the connection.
      - SourceEncryptionConfiguration (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
      - SourceEndpointType (string) --
        
        The type of the connected source endpoint.
    - RouterInput (dict) --
      
      The connection details for a destination endpoint that represents a router input.
      - SourceEncryptionType (string) --
        
        The type of encryption that the source uses for the connection.
      - SourceEncryptionConfiguration (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
      - SourceEndpointType (string) --
        
        The type of the connected source endpoint.
  - ConnectionState (string) --
    
    The connection state of the destination endpoint. Valid values include the following:
    - CONNECTED – The destination endpoint is connected to a source endpoint.
    - DISCONNECTED – The destination endpoint isn't connected to a source endpoint.
    - CONNECTING – The destination endpoint is connecting to a source endpoint.
    - DISCONNECTING – The destination endpoint is disconnecting from a source endpoint.
  - ConnectedSource (string) --
    
    The Amazon Resource Name (ARN) of the source endpoint that is connected to the destination endpoint.
  - DecryptionType (string) --
    
    The type of decryption used for the destination endpoint connection.
  - DecryptionConfiguration (dict) --
    
    The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - SecretsManager (dict) --
      
      The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
      - EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
      - EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
    - Automatic (dict) --
      
      The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
  - AssociatedResourceDetails (dict) --
    
    The details of the resource that is associated with the destination endpoint.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterInput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The associated resource details for a standard destination endpoint.
    - RouterInput (dict) --
      
      The associated resource details for a destination endpoint that represents a router input.
      - Name (string) --
        
        The name of the router input.
      - MaximumBitrate (integer) --
        
        The maximum bitrate of the router input, in bits per second.
      - State (string) --
        
        The state of the router input.
      - Messages (list) --
        
        The status messages for the router input.
        
        (dict) --
        
        A message associated with a router input, including a code and a message.
        
        Code (string) --
        
        The code associated with the router input message.
        
        Message (string) --
        
        The message text associated with the router input message.
  - Tags (dict) --
    
    The tags associated with the destination endpoint. Each tag is a key-value pair.
    - (string) --
      - (string) --

ListDestinationEndpoints (new)

Link ¶

Retrieves a list of the destination endpoints in your account. The results are paginated. Use the NextToken value that's returned to retrieve additional results.

See also: AWS API Documentation

Request Syntax

client.list_destination_endpoints(
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'RegionNames': [
                'string',
            ],
            'DestinationTypes': [
                'STANDARD'|'ROUTER_INPUT',
            ],
            'NameContains': [
                'string',
            ]
        },
    ]
)

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in a single request. The valid range is 1 to 100. If you don't specify a value, the service returns up to 100 results.

type NextToken:

string

param NextToken:

The token that identifies the next page of results to return. Use the token that a previous request returned.

type Filters:

list

param Filters:

The filters to apply to the list of destination endpoints.

(dict) --

A filter to apply when listing destination endpoints. This is a union type, so exactly one of its members is set.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: RegionNames, DestinationTypes, NameContains.
- RegionNames (list) --
  
  Filters the results to destination endpoints in the specified Amazon Web Services Regions.
  - (string) --
- DestinationTypes (list) --
  
  Filters the results to destination endpoints of the specified types.
  - (string) --
- NameContains (list) --
  
  Filters the results to destination endpoints whose names contain the specified strings.
  - (string) --

rtype:

dict

returns:

Response Syntax

{
    'DestinationEndpoints': [
        {
            'Name': 'string',
            'Arn': 'string',
            'Id': 'string',
            'DestinationType': 'STANDARD'|'ROUTER_INPUT',
            'RegionName': 'string',
            'AvailabilityZone': 'string',
            'AvailabilityZoneId': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'LifecycleManagement': 'MANAGED'|'UNMANAGED',
            'MessageCount': 123,
            'ResourceShareOwnership': 'OWNED'|'CONSUMED',
            'ResourceShareState': 'SHARED'|'UNSHARED',
            'RegistrationState': 'REGISTERED'|'REGISTERING'|'DEREGISTERING'|'REGISTRATION_FAILED',
            'ConnectionState': 'CONNECTED'|'DISCONNECTED'|'CONNECTING'|'DISCONNECTING',
            'DecryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
            'ConnectedSource': 'string',
            'AssociatedResourceArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- DestinationEndpoints (list) --
  
  The destination endpoints that match the request.
  - (dict) --
    
    A summary of a destination endpoint that the ListDestinationEndpoints operation returns.
    - Name (string) --
      
      The name of the destination endpoint.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the destination endpoint.
    - Id (string) --
      
      The unique identifier of the destination endpoint.
    - DestinationType (string) --
      
      The type of the destination endpoint. Valid values include the following:
      - STANDARD – A destination endpoint that represents an external destination over a standard protocol, such as RTP, RIST, or SRT.
      - ROUTER_INPUT – A destination endpoint that represents a router input.
    - RegionName (string) --
      
      The name of the Amazon Web Services Region in which the destination endpoint is located.
    - AvailabilityZone (string) --
      
      The Availability Zone in which the destination endpoint is located.
    - AvailabilityZoneId (string) --
      
      The ID of the Availability Zone in which the destination endpoint is located.
    - CreatedAt (datetime) --
      
      The date and time when the destination endpoint was created.
    - UpdatedAt (datetime) --
      
      The date and time when the destination endpoint was last updated.
    - LifecycleManagement (string) --
      
      The entity that manages the lifecycle of the destination endpoint.
    - MessageCount (integer) --
      
      The number of status messages for the destination endpoint.
    - ResourceShareOwnership (string) --
      
      Indicates whether this account owns the destination endpoint or consumes it from another account through RAM.
    - ResourceShareState (string) --
      
      The sharing state of the destination endpoint.
    - RegistrationState (string) --
      
      The registration state of the destination endpoint. Valid values include the following:
      - REGISTERED – The destination endpoint is registered and ready to use.
      - REGISTERING – MediaConnect is registering the destination endpoint.
      - DEREGISTERING – MediaConnect is deregistering the destination endpoint.
      - REGISTRATION_FAILED – MediaConnect couldn't register the destination endpoint.
    - ConnectionState (string) --
      
      The connection state of the destination endpoint. Valid values include the following:
      - CONNECTED – The destination endpoint is connected to a source endpoint.
      - DISCONNECTED – The destination endpoint isn't connected to a source endpoint.
      - CONNECTING – The destination endpoint is connecting to a source endpoint.
      - DISCONNECTING – The destination endpoint is disconnecting from a source endpoint.
    - DecryptionType (string) --
      
      The type of decryption used for the destination endpoint connection.
    - ConnectedSource (string) --
      
      The Amazon Resource Name (ARN) of the source endpoint that is connected to the destination endpoint.
    - AssociatedResourceArn (string) --
      
      The Amazon Resource Name (ARN) of the resource that is associated with the destination endpoint.
- NextToken (string) --
  
  The token to use in the next request to retrieve the next page of results. This value is null when there are no more results to return.

DeregisterDestinationEndpoint (new)

Link ¶

Deregisters a destination endpoint from MediaConnect.

See also: AWS API Documentation

Request Syntax

client.deregister_destination_endpoint(
    Arn='string'
)

type Arn:

string

param Arn:

[REQUIRED]

The Amazon Resource Name (ARN) of the destination endpoint to deregister.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Name': 'string'
}

Response Structure

(dict) --
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the destination endpoint that was deregistered.
- Name (string) --
  
  The name of the destination endpoint that was deregistered.

GetDestinationEndpoint (new)

Link ¶

Retrieves information about a destination endpoint.

See also: AWS API Documentation

Request Syntax

client.get_destination_endpoint(
    Arn='string'
)

type Arn:

string

param Arn:

[REQUIRED]

The Amazon Resource Name (ARN) of the destination endpoint to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'DestinationEndpoint': {
        'Name': 'string',
        'Arn': 'string',
        'Id': 'string',
        'Description': 'string',
        'RegionName': 'string',
        'AvailabilityZone': 'string',
        'AvailabilityZoneId': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'LifecycleManagement': 'MANAGED'|'UNMANAGED',
        'Messages': [
            {
                'Code': 'string',
                'Message': 'string'
            },
        ],
        'DestinationType': 'STANDARD'|'ROUTER_INPUT',
        'Configuration': {
            'Standard': {
                'Name': 'string',
                'DestinationNetworkingConfiguration': {
                    'Public': {
                        'DestinationAllowRules': [
                            {
                                'Cidr': 'string'
                            },
                        ]
                    },
                    'Vpc': {
                        'SecurityGroupIds': [
                            'string',
                        ],
                        'SubnetId': 'string'
                    }
                },
                'ProtocolConfiguration': {
                    'Rist': {
                        'DestinationAddress': 'string',
                        'DestinationIngestPort': 123
                    },
                    'SrtListener': {
                        'DestinationAddress': 'string',
                        'DestinationIngestPort': 123,
                        'MinimumLatencyMilliseconds': 123,
                        'StreamId': 'string',
                        'EncryptionPassphrase': {
                            'SecretArn': 'string'
                        }
                    },
                    'SrtCaller': {
                        'SourceListenerPort': 123,
                        'MinimumLatencyMilliseconds': 123,
                        'EncryptionPassphrase': {
                            'SecretArn': 'string'
                        }
                    },
                    'Rtp': {
                        'DestinationAddress': 'string',
                        'DestinationIngestPort': 123,
                        'ForwardErrorCorrectionState': 'ENABLED'|'DISABLED'
                    }
                },
                'DestinationNetworkingType': 'PUBLIC'|'VPC',
                'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
            },
            'RouterInput': {
                'RouterInputArn': 'string'
            }
        },
        'ResourceShareOwnership': 'OWNED'|'CONSUMED',
        'ResourceShareDetails': {
            'Owned': {
                'ShareState': 'SHARED'|'UNSHARED'
            },
            'Consumed': {
                'OwnerAccountId': 'string'
            }
        },
        'RegistrationState': 'REGISTERED'|'REGISTERING'|'DEREGISTERING'|'REGISTRATION_FAILED',
        'ConnectionDetails': {
            'Standard': {
                'SourceIpAddress': 'string',
                'SourceListenerPort': 123,
                'SourceEncryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                'SourceEncryptionConfiguration': {
                    'SecretsManager': {
                        'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                        'EncryptionSecret': {
                            'SecretArn': 'string'
                        }
                    },
                    'Automatic': {}
                },
                'SourceEndpointType': 'STANDARD'|'ROUTER_OUTPUT'
            },
            'RouterInput': {
                'SourceEncryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                'SourceEncryptionConfiguration': {
                    'SecretsManager': {
                        'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                        'EncryptionSecret': {
                            'SecretArn': 'string'
                        }
                    },
                    'Automatic': {}
                },
                'SourceEndpointType': 'STANDARD'|'ROUTER_OUTPUT'
            }
        },
        'ConnectionState': 'CONNECTED'|'DISCONNECTED'|'CONNECTING'|'DISCONNECTING',
        'ConnectedSource': 'string',
        'DecryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
        'DecryptionConfiguration': {
            'SecretsManager': {
                'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                'EncryptionSecret': {
                    'SecretArn': 'string'
                }
            },
            'Automatic': {}
        },
        'AssociatedResourceDetails': {
            'Standard': {},
            'RouterInput': {
                'Name': 'string',
                'MaximumBitrate': 123,
                'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
                'Messages': [
                    {
                        'Code': 'string',
                        'Message': 'string'
                    },
                ]
            }
        },
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- DestinationEndpoint (dict) --
  
  The details of the destination endpoint.
  - Name (string) --
    
    The name of the destination endpoint.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of the destination endpoint.
  - Id (string) --
    
    The unique identifier of the destination endpoint.
  - Description (string) --
    
    The description of the destination endpoint.
  - RegionName (string) --
    
    The name of the Amazon Web Services Region in which the destination endpoint is located.
  - AvailabilityZone (string) --
    
    The Availability Zone in which the destination endpoint is located.
  - AvailabilityZoneId (string) --
    
    The ID of the Availability Zone in which the destination endpoint is located.
  - CreatedAt (datetime) --
    
    The date and time when the destination endpoint was created.
  - UpdatedAt (datetime) --
    
    The date and time when the destination endpoint was last updated.
  - LifecycleManagement (string) --
    
    The entity that manages the lifecycle of the destination endpoint.
  - Messages (list) --
    
    The status messages for the destination endpoint.
    - (dict) --
      
      A status message for a destination endpoint.
      - Code (string) --
        
        The message code.
      - Message (string) --
        
        The message text.
  - DestinationType (string) --
    
    The type of the destination endpoint. Valid values include the following:
    - STANDARD – A destination endpoint that represents an external destination over a standard protocol, such as RTP, RIST, or SRT.
    - ROUTER_INPUT – A destination endpoint that represents a router input.
  - Configuration (dict) --
    
    The configuration settings for the destination endpoint.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterInput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The configuration settings for a standard destination endpoint, which represents an external destination.
      - Name (string) --
        
        The name of the destination endpoint.
      - DestinationNetworkingConfiguration (dict) --
        
        The networking configuration for the destination endpoint, which determines whether it is publicly accessible or in a virtual private cloud (VPC).
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Public, Vpc. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Public (dict) --
        
        The configuration for a publicly accessible destination endpoint.
        
        DestinationAllowRules (list) --
        
        The rules that specify which CIDR blocks can connect to the destination endpoint. You can specify up to 10 rules.
        
        (dict) --
        
        A rule that allows a specific CIDR block to connect to the public destination endpoint.
        
        Cidr (string) --
        
        The CIDR block that is allowed to connect to the destination endpoint, in CIDR notation.
        
        Vpc (dict) --
        
        The configuration for a destination endpoint in a virtual private cloud (VPC).
        
        SecurityGroupIds (list) --
        
        The IDs of the security groups to associate with the destination endpoint. You can specify from 1 to 5 security groups.
        
        (string) --
        
        SubnetId (string) --
        
        The ID of the subnet to use for the destination endpoint.
      - ProtocolConfiguration (dict) --
        
        The protocol configuration for the destination endpoint.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rist, SrtListener, SrtCaller, Rtp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Rist (dict) --
        
        The configuration settings for a destination endpoint that uses the RIST protocol.
        
        DestinationAddress (string) --
        
        The IP address on which the destination endpoint receives content.
        
        DestinationIngestPort (integer) --
        
        The port on which the destination endpoint receives content. The valid range is 1024 to 65531.
        
        SrtListener (dict) --
        
        The configuration settings for a destination endpoint that uses SRT in listener mode.
        
        DestinationAddress (string) --
        
        The IP address on which the destination endpoint listens for incoming connections.
        
        DestinationIngestPort (integer) --
        
        The port on which the destination endpoint listens for incoming connections. The valid range is 0 to 65531.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
        
        StreamId (string) --
        
        The stream ID that identifies the content for the SRT connection.
        
        EncryptionPassphrase (dict) --
        
        The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        SrtCaller (dict) --
        
        The configuration settings for a destination endpoint that uses SRT in caller mode.
        
        SourceListenerPort (integer) --
        
        The port on which the source listens for the connection. The valid range is 3000 to 30000.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
        
        EncryptionPassphrase (dict) --
        
        The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Rtp (dict) --
        
        The configuration settings for a destination endpoint that uses the RTP protocol.
        
        DestinationAddress (string) --
        
        The IP address on which the destination endpoint receives content.
        
        DestinationIngestPort (integer) --
        
        The port on which the destination endpoint receives content. The valid range is 1024 to 65531.
        
        ForwardErrorCorrectionState (string) --
        
        Indicates whether forward error correction (FEC) is enabled for the destination endpoint.
      - DestinationNetworkingType (string) --
        
        The networking type of the destination endpoint. Valid values include the following:
        
        PUBLIC – The destination endpoint is publicly accessible.
        
        VPC – The destination endpoint is in a virtual private cloud (VPC).
      - Protocol (string) --
        
        The protocol used by the destination endpoint. Valid values include the following:
        
        RTP – Real-time Transport Protocol.
        
        RIST – Reliable Internet Stream Transport.
        
        SRT_CALLER – Secure Reliable Transport (SRT) in caller mode.
        
        SRT_LISTENER – Secure Reliable Transport (SRT) in listener mode.
    - RouterInput (dict) --
      
      The configuration settings for a destination endpoint that represents a router input.
      - RouterInputArn (string) --
        
        The Amazon Resource Name (ARN) of the router input that the destination endpoint represents.
  - ResourceShareOwnership (string) --
    
    Indicates whether this account owns the destination endpoint or consumes it from another account through RAM.
  - ResourceShareDetails (dict) --
    
    The cross-account sharing details for an endpoint. Endpoints are shared through Resource Access Manager (RAM). This is a union type, so exactly one of its members is set: owned when this account owns the endpoint and shares it with other accounts, or consumed when this account consumes an endpoint that another account shares. To change how an endpoint is shared, use RAM.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Owned, Consumed. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Owned (dict) --
      
      The sharing details for an endpoint that this account owns and shares with other accounts through RAM.
      - ShareState (string) --
        
        The sharing state of the endpoint. Valid values include the following:
        
        SHARED – The endpoint is shared with one or more accounts.
        
        UNSHARED – The endpoint is not shared with other accounts.
    - Consumed (dict) --
      
      The sharing details for an endpoint that another account shares with this account through RAM.
      - OwnerAccountId (string) --
        
        The ID of the Amazon Web Services account that owns the shared endpoint.
  - RegistrationState (string) --
    
    The registration state of the destination endpoint. Valid values include the following:
    - REGISTERED – The destination endpoint is registered and ready to use.
    - REGISTERING – MediaConnect is registering the destination endpoint.
    - DEREGISTERING – MediaConnect is deregistering the destination endpoint.
    - REGISTRATION_FAILED – MediaConnect couldn't register the destination endpoint.
  - ConnectionDetails (dict) --
    
    The connection details for the destination endpoint.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterInput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The connection details for a standard destination endpoint.
      - SourceIpAddress (string) --
        
        The IP address of the source that is connected to the destination endpoint.
      - SourceListenerPort (integer) --
        
        The port on which the source listens for the connection.
      - SourceEncryptionType (string) --
        
        The type of encryption that the source uses for the connection.
      - SourceEncryptionConfiguration (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
      - SourceEndpointType (string) --
        
        The type of the connected source endpoint.
    - RouterInput (dict) --
      
      The connection details for a destination endpoint that represents a router input.
      - SourceEncryptionType (string) --
        
        The type of encryption that the source uses for the connection.
      - SourceEncryptionConfiguration (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
      - SourceEndpointType (string) --
        
        The type of the connected source endpoint.
  - ConnectionState (string) --
    
    The connection state of the destination endpoint. Valid values include the following:
    - CONNECTED – The destination endpoint is connected to a source endpoint.
    - DISCONNECTED – The destination endpoint isn't connected to a source endpoint.
    - CONNECTING – The destination endpoint is connecting to a source endpoint.
    - DISCONNECTING – The destination endpoint is disconnecting from a source endpoint.
  - ConnectedSource (string) --
    
    The Amazon Resource Name (ARN) of the source endpoint that is connected to the destination endpoint.
  - DecryptionType (string) --
    
    The type of decryption used for the destination endpoint connection.
  - DecryptionConfiguration (dict) --
    
    The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - SecretsManager (dict) --
      
      The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
      - EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
      - EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
    - Automatic (dict) --
      
      The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
  - AssociatedResourceDetails (dict) --
    
    The details of the resource that is associated with the destination endpoint.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterInput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The associated resource details for a standard destination endpoint.
    - RouterInput (dict) --
      
      The associated resource details for a destination endpoint that represents a router input.
      - Name (string) --
        
        The name of the router input.
      - MaximumBitrate (integer) --
        
        The maximum bitrate of the router input, in bits per second.
      - State (string) --
        
        The state of the router input.
      - Messages (list) --
        
        The status messages for the router input.
        
        (dict) --
        
        A message associated with a router input, including a code and a message.
        
        Code (string) --
        
        The code associated with the router input message.
        
        Message (string) --
        
        The message text associated with the router input message.
  - Tags (dict) --
    
    The tags associated with the destination endpoint. Each tag is a key-value pair.
    - (string) --
      - (string) --

BatchGetSourceEndpoint (new)

Link ¶

Retrieves information about multiple source endpoints in a single request.

See also: AWS API Documentation

Request Syntax

client.batch_get_source_endpoint(
    Arns=[
        'string',
    ]
)

type Arns:

list

param Arns:

[REQUIRED]

The Amazon Resource Names (ARNs) of one or more source endpoints to retrieve. You can specify from 1 to 20 ARNs.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'SourceEndpoints': [
        {
            'Name': 'string',
            'Arn': 'string',
            'Id': 'string',
            'Description': 'string',
            'RegionName': 'string',
            'AvailabilityZone': 'string',
            'AvailabilityZoneId': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'LifecycleManagement': 'MANAGED'|'UNMANAGED',
            'Messages': [
                {
                    'Code': 'string',
                    'Message': 'string'
                },
            ],
            'SourceType': 'STANDARD'|'ROUTER_OUTPUT',
            'Configuration': {
                'Standard': {
                    'Name': 'string',
                    'SourceNetworkingConfiguration': {
                        'Public': {
                            'SourceAllowRules': [
                                {
                                    'Cidr': 'string'
                                },
                            ]
                        },
                        'Vpc': {
                            'SecurityGroupIds': [
                                'string',
                            ],
                            'SubnetId': 'string'
                        }
                    },
                    'ProtocolConfiguration': {
                        'Rist': {
                            'DestinationIngestPort': 123,
                            'RecoveryLatencyMilliseconds': 123
                        },
                        'SrtListener': {
                            'SourceListenerPort': 123,
                            'SourceAddress': 'string',
                            'MinimumLatencyMilliseconds': 123,
                            'StreamId': 'string',
                            'EncryptionPassphrase': {
                                'SecretArn': 'string'
                            }
                        },
                        'SrtCaller': {
                            'DestinationIngestPort': 123,
                            'MinimumLatencyMilliseconds': 123,
                            'EncryptionPassphrase': {
                                'SecretArn': 'string'
                            }
                        },
                        'Rtp': {
                            'DestinationIngestPort': 123,
                            'ForwardErrorCorrectionState': 'ENABLED'|'DISABLED'
                        }
                    },
                    'SourceNetworkingType': 'PUBLIC'|'VPC',
                    'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
                },
                'RouterOutput': {
                    'RouterOutputArn': 'string'
                }
            },
            'ResourceShareOwnership': 'OWNED'|'CONSUMED',
            'ResourceShareDetails': {
                'Owned': {
                    'ShareState': 'SHARED'|'UNSHARED'
                },
                'Consumed': {
                    'OwnerAccountId': 'string'
                }
            },
            'RegistrationState': 'REGISTERED'|'REGISTERING'|'DEREGISTERING'|'REGISTRATION_FAILED',
            'ConnectionState': 'CONNECTED'|'DISCONNECTED'|'CONNECTING'|'DISCONNECTING',
            'ConnectionDetails': {
                'Standard': {
                    'DestinationIpAddress': 'string',
                    'DestinationIngestPort': 123,
                    'DestinationDecryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                    'DestinationDecryptionConfiguration': {
                        'SecretsManager': {
                            'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                            'EncryptionSecret': {
                                'SecretArn': 'string'
                            }
                        },
                        'Automatic': {}
                    },
                    'DestinationEndpointType': 'STANDARD'|'ROUTER_INPUT'
                },
                'RouterOutput': {
                    'DestinationDecryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                    'DestinationDecryptionConfiguration': {
                        'SecretsManager': {
                            'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                            'EncryptionSecret': {
                                'SecretArn': 'string'
                            }
                        },
                        'Automatic': {}
                    },
                    'DestinationEndpointType': 'STANDARD'|'ROUTER_INPUT'
                }
            },
            'ConnectedDestinations': [
                'string',
            ],
            'EncryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
            'EncryptionConfiguration': {
                'SecretsManager': {
                    'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                    'EncryptionSecret': {
                        'SecretArn': 'string'
                    }
                },
                'Automatic': {}
            },
            'AssociatedResourceDetails': {
                'Standard': {},
                'RouterOutput': {
                    'Name': 'string',
                    'MaximumBitrate': 123,
                    'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
                    'Messages': [
                        {
                            'Code': 'string',
                            'Message': 'string'
                        },
                    ]
                }
            },
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'Errors': [
        {
            'Arn': 'string',
            'Code': 'string',
            'Message': 'string'
        },
    ]
}

Response Structure

(dict) --
- SourceEndpoints (list) --
  
  The source endpoints that MediaConnect successfully retrieved.
  - (dict) --
    
    The details of a source endpoint in MediaConnect, including its configuration, state, and connection details.
    - Name (string) --
      
      The name of the source endpoint.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the source endpoint.
    - Id (string) --
      
      The unique identifier of the source endpoint.
    - Description (string) --
      
      The description of the source endpoint.
    - RegionName (string) --
      
      The name of the Amazon Web Services Region in which the source endpoint is located.
    - AvailabilityZone (string) --
      
      The Availability Zone in which the source endpoint is located.
    - AvailabilityZoneId (string) --
      
      The ID of the Availability Zone in which the source endpoint is located.
    - CreatedAt (datetime) --
      
      The date and time when the source endpoint was created.
    - UpdatedAt (datetime) --
      
      The date and time when the source endpoint was last updated.
    - LifecycleManagement (string) --
      
      The entity that manages the lifecycle of the source endpoint.
    - Messages (list) --
      
      The status messages for the source endpoint.
      - (dict) --
        
        A status message for a source endpoint.
        
        Code (string) --
        
        The message code.
        
        Message (string) --
        
        The message text.
    - SourceType (string) --
      
      The type of the source endpoint. Valid values include the following:
      - STANDARD – A source endpoint that represents an external source over a standard protocol, such as RTP, RIST, or SRT.
      - ROUTER_OUTPUT – A source endpoint that represents a router output.
    - Configuration (dict) --
      
      The configuration settings for the source endpoint.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterOutput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - Standard (dict) --
        
        The configuration settings for a standard source endpoint, which represents an external source.
        
        Name (string) --
        
        The name of the source endpoint.
        
        SourceNetworkingConfiguration (dict) --
        
        The networking configuration for the source endpoint, which determines whether it is publicly accessible or in a virtual private cloud (VPC).
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Public, Vpc. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Public (dict) --
        
        The configuration for a publicly accessible source endpoint.
        
        SourceAllowRules (list) --
        
        The rules that specify which CIDR blocks can connect to the source endpoint. You can specify up to 10 rules.
        
        (dict) --
        
        A rule that allows a specific CIDR block to connect to the public source endpoint.
        
        Cidr (string) --
        
        The CIDR block that is allowed to connect to the source endpoint, in CIDR notation.
        
        Vpc (dict) --
        
        The configuration for a source endpoint in a virtual private cloud (VPC).
        
        SecurityGroupIds (list) --
        
        The IDs of the security groups to associate with the source endpoint. You can specify from 1 to 5 security groups.
        
        (string) --
        
        SubnetId (string) --
        
        The ID of the subnet to use for the source endpoint.
        
        ProtocolConfiguration (dict) --
        
        The protocol configuration for the source endpoint.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rist, SrtListener, SrtCaller, Rtp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Rist (dict) --
        
        The configuration settings for a source endpoint that uses the RIST protocol.
        
        DestinationIngestPort (integer) --
        
        The port on the destination that receives the content. The valid range is 3000 to 30000.
        
        RecoveryLatencyMilliseconds (integer) --
        
        The amount of time, in milliseconds, that the source endpoint allows for recovering lost packets. The valid range is 10 to 10000.
        
        SrtListener (dict) --
        
        The configuration settings for a source endpoint that uses SRT in listener mode.
        
        SourceListenerPort (integer) --
        
        The port that the source endpoint listens on for incoming connections. The valid range is 1024 to 65535.
        
        SourceAddress (string) --
        
        The IP address that the source endpoint listens on for incoming connections.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
        
        StreamId (string) --
        
        The stream ID that identifies the content for the SRT connection.
        
        EncryptionPassphrase (dict) --
        
        The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        SrtCaller (dict) --
        
        The configuration settings for a source endpoint that uses SRT in caller mode.
        
        DestinationIngestPort (integer) --
        
        The port on which the destination listens for the connection. The valid range is 3000 to 30000.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
        
        EncryptionPassphrase (dict) --
        
        The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Rtp (dict) --
        
        The configuration settings for a source endpoint that uses the RTP protocol.
        
        DestinationIngestPort (integer) --
        
        The port on the destination that receives the content. The valid range is 3000 to 30000.
        
        ForwardErrorCorrectionState (string) --
        
        Indicates whether forward error correction (FEC) is enabled for the source endpoint.
        
        SourceNetworkingType (string) --
        
        The networking type of the source endpoint. Valid values include the following:
        
        PUBLIC – The source endpoint is publicly accessible.
        
        VPC – The source endpoint is in a virtual private cloud (VPC).
        
        Protocol (string) --
        
        The protocol used by the source endpoint. Valid values include the following:
        
        RTP – Real-time Transport Protocol.
        
        RIST – Reliable Internet Stream Transport.
        
        SRT_CALLER – Secure Reliable Transport (SRT) in caller mode.
        
        SRT_LISTENER – Secure Reliable Transport (SRT) in listener mode.
      - RouterOutput (dict) --
        
        The configuration settings for a source endpoint that represents a router output.
        
        RouterOutputArn (string) --
        
        The Amazon Resource Name (ARN) of the router output that the source endpoint represents.
    - ResourceShareOwnership (string) --
      
      Indicates whether this account owns the source endpoint or consumes it from another account through RAM.
    - ResourceShareDetails (dict) --
      
      The cross-account sharing details for an endpoint. Endpoints are shared through Resource Access Manager (RAM). This is a union type, so exactly one of its members is set: owned when this account owns the endpoint and shares it with other accounts, or consumed when this account consumes an endpoint that another account shares. To change how an endpoint is shared, use RAM.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: Owned, Consumed. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - Owned (dict) --
        
        The sharing details for an endpoint that this account owns and shares with other accounts through RAM.
        
        ShareState (string) --
        
        The sharing state of the endpoint. Valid values include the following:
        
        SHARED – The endpoint is shared with one or more accounts.
        
        UNSHARED – The endpoint is not shared with other accounts.
      - Consumed (dict) --
        
        The sharing details for an endpoint that another account shares with this account through RAM.
        
        OwnerAccountId (string) --
        
        The ID of the Amazon Web Services account that owns the shared endpoint.
    - RegistrationState (string) --
      
      The registration state of the source endpoint. Valid values include the following:
      - REGISTERED – The source endpoint is registered and ready to use.
      - REGISTERING – MediaConnect is registering the source endpoint.
      - DEREGISTERING – MediaConnect is deregistering the source endpoint.
      - REGISTRATION_FAILED – MediaConnect couldn't register the source endpoint.
    - ConnectionState (string) --
      
      The connection state of the source endpoint. Valid values include the following:
      - CONNECTED – The source endpoint is connected to a destination endpoint.
      - DISCONNECTED – The source endpoint isn't connected to a destination endpoint.
      - CONNECTING – The source endpoint is connecting to a destination endpoint.
      - DISCONNECTING – The source endpoint is disconnecting from a destination endpoint.
    - ConnectionDetails (dict) --
      
      The connection details for the source endpoint.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterOutput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - Standard (dict) --
        
        The connection details for a standard source endpoint.
        
        DestinationIpAddress (string) --
        
        The IP address of the destination that receives the content.
        
        DestinationIngestPort (integer) --
        
        The port on the destination that receives the content.
        
        DestinationDecryptionType (string) --
        
        The type of decryption that the destination uses for the connection.
        
        DestinationDecryptionConfiguration (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
        
        DestinationEndpointType (string) --
        
        The type of the connected destination endpoint.
      - RouterOutput (dict) --
        
        The connection details for a source endpoint that represents a router output.
        
        DestinationDecryptionType (string) --
        
        The type of decryption that the destination uses for the connection.
        
        DestinationDecryptionConfiguration (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
        
        DestinationEndpointType (string) --
        
        The type of the connected destination endpoint.
    - ConnectedDestinations (list) --
      
      The Amazon Resource Names (ARNs) of the destination endpoints that are connected to the source endpoint.
      - (string) --
    - EncryptionType (string) --
      
      The type of encryption used for the source endpoint connection.
    - EncryptionConfiguration (dict) --
      
      The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
      - Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
    - AssociatedResourceDetails (dict) --
      
      The details of the resource that is associated with the source endpoint.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterOutput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - Standard (dict) --
        
        The associated resource details for a standard source endpoint.
      - RouterOutput (dict) --
        
        The associated resource details for a source endpoint that represents a router output.
        
        Name (string) --
        
        The name of the router output.
        
        MaximumBitrate (integer) --
        
        The maximum bitrate of the router output, in bits per second.
        
        State (string) --
        
        The state of the router output.
        
        Messages (list) --
        
        The status messages for 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) --
      
      The tags associated with the source endpoint. Each tag is a key-value pair.
      - (string) --
        
        (string) --
- Errors (list) --
  
  The errors for any source endpoints that MediaConnect couldn't retrieve.
  - (dict) --
    
    An error for a source endpoint that MediaConnect couldn't retrieve in a BatchGetSourceEndpoint request.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the source endpoint that MediaConnect couldn't retrieve.
    - Code (string) --
      
      The error code.
    - Message (string) --
      
      A description of the error.

RegisterSourceEndpoint (new)

Link ¶

Registers a new source endpoint in MediaConnect.

See also: AWS API Documentation

Request Syntax

client.register_source_endpoint(
    RegionName='string',
    Description='string',
    Configuration={
        'Standard': {
            'Name': 'string',
            'SourceNetworkingConfiguration': {
                'Public': {
                    'SourceAllowRules': [
                        {
                            'Cidr': 'string'
                        },
                    ]
                },
                'Vpc': {
                    'SecurityGroupIds': [
                        'string',
                    ],
                    'SubnetId': 'string'
                }
            },
            'ProtocolConfiguration': {
                'Rist': {
                    'DestinationIngestPort': 123,
                    'RecoveryLatencyMilliseconds': 123
                },
                'SrtListener': {
                    'SourceListenerPort': 123,
                    'SourceAddress': 'string',
                    'MinimumLatencyMilliseconds': 123,
                    'StreamId': 'string',
                    'EncryptionPassphrase': {
                        'SecretArn': 'string'
                    }
                },
                'SrtCaller': {
                    'DestinationIngestPort': 123,
                    'MinimumLatencyMilliseconds': 123,
                    'EncryptionPassphrase': {
                        'SecretArn': 'string'
                    }
                },
                'Rtp': {
                    'DestinationIngestPort': 123,
                    'ForwardErrorCorrectionState': 'ENABLED'|'DISABLED'
                }
            },
            'SourceNetworkingType': 'PUBLIC'|'VPC',
            'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
        },
        'RouterOutput': {
            'RouterOutputArn': 'string'
        }
    },
    Tags={
        'string': 'string'
    },
    ClientToken='string'
)

type RegionName:

string

param RegionName:

The name of the Amazon Web Services Region in which to register the source endpoint. Defaults to the current region if not specified.

type Description:

string

param Description:

A description to help you identify the source endpoint.

type Configuration:

dict

param Configuration:

[REQUIRED]

The configuration settings for the source endpoint.

Standard (dict) --

The configuration settings for a standard source endpoint, which represents an external source.
- Name (string) -- [REQUIRED]
  
  The name of the source endpoint.
- SourceNetworkingConfiguration (dict) -- [REQUIRED]
  
  The networking configuration for the source endpoint, which determines whether it is publicly accessible or in a virtual private cloud (VPC).
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: Public, Vpc.
  - Public (dict) --
    
    The configuration for a publicly accessible source endpoint.
    - SourceAllowRules (list) -- [REQUIRED]
      
      The rules that specify which CIDR blocks can connect to the source endpoint. You can specify up to 10 rules.
      - (dict) --
        
        A rule that allows a specific CIDR block to connect to the public source endpoint.
        
        Cidr (string) -- [REQUIRED]
        
        The CIDR block that is allowed to connect to the source endpoint, in CIDR notation.
  - Vpc (dict) --
    
    The configuration for a source endpoint in a virtual private cloud (VPC).
    - SecurityGroupIds (list) -- [REQUIRED]
      
      The IDs of the security groups to associate with the source endpoint. You can specify from 1 to 5 security groups.
      - (string) --
    - SubnetId (string) -- [REQUIRED]
      
      The ID of the subnet to use for the source endpoint.
- ProtocolConfiguration (dict) -- [REQUIRED]
  
  The protocol configuration for the source endpoint.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: Rist, SrtListener, SrtCaller, Rtp.
  - Rist (dict) --
    
    The configuration settings for a source endpoint that uses the RIST protocol.
    - DestinationIngestPort (integer) -- [REQUIRED]
      
      The port on the destination that receives the content. The valid range is 3000 to 30000.
    - RecoveryLatencyMilliseconds (integer) -- [REQUIRED]
      
      The amount of time, in milliseconds, that the source endpoint allows for recovering lost packets. The valid range is 10 to 10000.
  - SrtListener (dict) --
    
    The configuration settings for a source endpoint that uses SRT in listener mode.
    - SourceListenerPort (integer) -- [REQUIRED]
      
      The port that the source endpoint listens on for incoming connections. The valid range is 1024 to 65535.
    - SourceAddress (string) -- [REQUIRED]
      
      The IP address that the source endpoint listens on for incoming connections.
    - MinimumLatencyMilliseconds (integer) -- [REQUIRED]
      
      The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
    - StreamId (string) --
      
      The stream ID that identifies the content for the SRT connection.
    - EncryptionPassphrase (dict) --
      
      The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
      - SecretArn (string) -- [REQUIRED]
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
  - SrtCaller (dict) --
    
    The configuration settings for a source endpoint that uses SRT in caller mode.
    - DestinationIngestPort (integer) -- [REQUIRED]
      
      The port on which the destination listens for the connection. The valid range is 3000 to 30000.
    - MinimumLatencyMilliseconds (integer) -- [REQUIRED]
      
      The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
    - EncryptionPassphrase (dict) --
      
      The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
      - SecretArn (string) -- [REQUIRED]
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
  - Rtp (dict) --
    
    The configuration settings for a source endpoint that uses the RTP protocol.
    - DestinationIngestPort (integer) -- [REQUIRED]
      
      The port on the destination that receives the content. The valid range is 3000 to 30000.
    - ForwardErrorCorrectionState (string) -- [REQUIRED]
      
      Indicates whether forward error correction (FEC) is enabled for the source endpoint.
- SourceNetworkingType (string) --
  
  The networking type of the source endpoint. Valid values include the following:
  - PUBLIC – The source endpoint is publicly accessible.
  - VPC – The source endpoint is in a virtual private cloud (VPC).
- Protocol (string) --
  
  The protocol used by the source endpoint. Valid values include the following:
  - RTP – Real-time Transport Protocol.
  - RIST – Reliable Internet Stream Transport.
  - SRT_CALLER – Secure Reliable Transport (SRT) in caller mode.
  - SRT_LISTENER – Secure Reliable Transport (SRT) in listener mode.
RouterOutput (dict) --

The configuration settings for a source endpoint that represents a router output.
- RouterOutputArn (string) -- [REQUIRED]
  
  The Amazon Resource Name (ARN) of the router output that the source endpoint represents.

type Tags:

dict

param Tags:

The tags to apply to the source endpoint. Each tag is a key-value pair.

(string) --
- (string) --

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If this token matches a previous request, the service ignores the request, but does not return an error.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'SourceEndpoint': {
        'Name': 'string',
        'Arn': 'string',
        'Id': 'string',
        'Description': 'string',
        'RegionName': 'string',
        'AvailabilityZone': 'string',
        'AvailabilityZoneId': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'LifecycleManagement': 'MANAGED'|'UNMANAGED',
        'Messages': [
            {
                'Code': 'string',
                'Message': 'string'
            },
        ],
        'SourceType': 'STANDARD'|'ROUTER_OUTPUT',
        'Configuration': {
            'Standard': {
                'Name': 'string',
                'SourceNetworkingConfiguration': {
                    'Public': {
                        'SourceAllowRules': [
                            {
                                'Cidr': 'string'
                            },
                        ]
                    },
                    'Vpc': {
                        'SecurityGroupIds': [
                            'string',
                        ],
                        'SubnetId': 'string'
                    }
                },
                'ProtocolConfiguration': {
                    'Rist': {
                        'DestinationIngestPort': 123,
                        'RecoveryLatencyMilliseconds': 123
                    },
                    'SrtListener': {
                        'SourceListenerPort': 123,
                        'SourceAddress': 'string',
                        'MinimumLatencyMilliseconds': 123,
                        'StreamId': 'string',
                        'EncryptionPassphrase': {
                            'SecretArn': 'string'
                        }
                    },
                    'SrtCaller': {
                        'DestinationIngestPort': 123,
                        'MinimumLatencyMilliseconds': 123,
                        'EncryptionPassphrase': {
                            'SecretArn': 'string'
                        }
                    },
                    'Rtp': {
                        'DestinationIngestPort': 123,
                        'ForwardErrorCorrectionState': 'ENABLED'|'DISABLED'
                    }
                },
                'SourceNetworkingType': 'PUBLIC'|'VPC',
                'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
            },
            'RouterOutput': {
                'RouterOutputArn': 'string'
            }
        },
        'ResourceShareOwnership': 'OWNED'|'CONSUMED',
        'ResourceShareDetails': {
            'Owned': {
                'ShareState': 'SHARED'|'UNSHARED'
            },
            'Consumed': {
                'OwnerAccountId': 'string'
            }
        },
        'RegistrationState': 'REGISTERED'|'REGISTERING'|'DEREGISTERING'|'REGISTRATION_FAILED',
        'ConnectionState': 'CONNECTED'|'DISCONNECTED'|'CONNECTING'|'DISCONNECTING',
        'ConnectionDetails': {
            'Standard': {
                'DestinationIpAddress': 'string',
                'DestinationIngestPort': 123,
                'DestinationDecryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                'DestinationDecryptionConfiguration': {
                    'SecretsManager': {
                        'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                        'EncryptionSecret': {
                            'SecretArn': 'string'
                        }
                    },
                    'Automatic': {}
                },
                'DestinationEndpointType': 'STANDARD'|'ROUTER_INPUT'
            },
            'RouterOutput': {
                'DestinationDecryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                'DestinationDecryptionConfiguration': {
                    'SecretsManager': {
                        'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                        'EncryptionSecret': {
                            'SecretArn': 'string'
                        }
                    },
                    'Automatic': {}
                },
                'DestinationEndpointType': 'STANDARD'|'ROUTER_INPUT'
            }
        },
        'ConnectedDestinations': [
            'string',
        ],
        'EncryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
        'EncryptionConfiguration': {
            'SecretsManager': {
                'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                'EncryptionSecret': {
                    'SecretArn': 'string'
                }
            },
            'Automatic': {}
        },
        'AssociatedResourceDetails': {
            'Standard': {},
            'RouterOutput': {
                'Name': 'string',
                'MaximumBitrate': 123,
                'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
                'Messages': [
                    {
                        'Code': 'string',
                        'Message': 'string'
                    },
                ]
            }
        },
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- SourceEndpoint (dict) --
  
  The details of the source endpoint that was registered.
  - Name (string) --
    
    The name of the source endpoint.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of the source endpoint.
  - Id (string) --
    
    The unique identifier of the source endpoint.
  - Description (string) --
    
    The description of the source endpoint.
  - RegionName (string) --
    
    The name of the Amazon Web Services Region in which the source endpoint is located.
  - AvailabilityZone (string) --
    
    The Availability Zone in which the source endpoint is located.
  - AvailabilityZoneId (string) --
    
    The ID of the Availability Zone in which the source endpoint is located.
  - CreatedAt (datetime) --
    
    The date and time when the source endpoint was created.
  - UpdatedAt (datetime) --
    
    The date and time when the source endpoint was last updated.
  - LifecycleManagement (string) --
    
    The entity that manages the lifecycle of the source endpoint.
  - Messages (list) --
    
    The status messages for the source endpoint.
    - (dict) --
      
      A status message for a source endpoint.
      - Code (string) --
        
        The message code.
      - Message (string) --
        
        The message text.
  - SourceType (string) --
    
    The type of the source endpoint. Valid values include the following:
    - STANDARD – A source endpoint that represents an external source over a standard protocol, such as RTP, RIST, or SRT.
    - ROUTER_OUTPUT – A source endpoint that represents a router output.
  - Configuration (dict) --
    
    The configuration settings for the source endpoint.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterOutput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The configuration settings for a standard source endpoint, which represents an external source.
      - Name (string) --
        
        The name of the source endpoint.
      - SourceNetworkingConfiguration (dict) --
        
        The networking configuration for the source endpoint, which determines whether it is publicly accessible or in a virtual private cloud (VPC).
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Public, Vpc. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Public (dict) --
        
        The configuration for a publicly accessible source endpoint.
        
        SourceAllowRules (list) --
        
        The rules that specify which CIDR blocks can connect to the source endpoint. You can specify up to 10 rules.
        
        (dict) --
        
        A rule that allows a specific CIDR block to connect to the public source endpoint.
        
        Cidr (string) --
        
        The CIDR block that is allowed to connect to the source endpoint, in CIDR notation.
        
        Vpc (dict) --
        
        The configuration for a source endpoint in a virtual private cloud (VPC).
        
        SecurityGroupIds (list) --
        
        The IDs of the security groups to associate with the source endpoint. You can specify from 1 to 5 security groups.
        
        (string) --
        
        SubnetId (string) --
        
        The ID of the subnet to use for the source endpoint.
      - ProtocolConfiguration (dict) --
        
        The protocol configuration for the source endpoint.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rist, SrtListener, SrtCaller, Rtp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Rist (dict) --
        
        The configuration settings for a source endpoint that uses the RIST protocol.
        
        DestinationIngestPort (integer) --
        
        The port on the destination that receives the content. The valid range is 3000 to 30000.
        
        RecoveryLatencyMilliseconds (integer) --
        
        The amount of time, in milliseconds, that the source endpoint allows for recovering lost packets. The valid range is 10 to 10000.
        
        SrtListener (dict) --
        
        The configuration settings for a source endpoint that uses SRT in listener mode.
        
        SourceListenerPort (integer) --
        
        The port that the source endpoint listens on for incoming connections. The valid range is 1024 to 65535.
        
        SourceAddress (string) --
        
        The IP address that the source endpoint listens on for incoming connections.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
        
        StreamId (string) --
        
        The stream ID that identifies the content for the SRT connection.
        
        EncryptionPassphrase (dict) --
        
        The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        SrtCaller (dict) --
        
        The configuration settings for a source endpoint that uses SRT in caller mode.
        
        DestinationIngestPort (integer) --
        
        The port on which the destination listens for the connection. The valid range is 3000 to 30000.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
        
        EncryptionPassphrase (dict) --
        
        The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Rtp (dict) --
        
        The configuration settings for a source endpoint that uses the RTP protocol.
        
        DestinationIngestPort (integer) --
        
        The port on the destination that receives the content. The valid range is 3000 to 30000.
        
        ForwardErrorCorrectionState (string) --
        
        Indicates whether forward error correction (FEC) is enabled for the source endpoint.
      - SourceNetworkingType (string) --
        
        The networking type of the source endpoint. Valid values include the following:
        
        PUBLIC – The source endpoint is publicly accessible.
        
        VPC – The source endpoint is in a virtual private cloud (VPC).
      - Protocol (string) --
        
        The protocol used by the source endpoint. Valid values include the following:
        
        RTP – Real-time Transport Protocol.
        
        RIST – Reliable Internet Stream Transport.
        
        SRT_CALLER – Secure Reliable Transport (SRT) in caller mode.
        
        SRT_LISTENER – Secure Reliable Transport (SRT) in listener mode.
    - RouterOutput (dict) --
      
      The configuration settings for a source endpoint that represents a router output.
      - RouterOutputArn (string) --
        
        The Amazon Resource Name (ARN) of the router output that the source endpoint represents.
  - ResourceShareOwnership (string) --
    
    Indicates whether this account owns the source endpoint or consumes it from another account through RAM.
  - ResourceShareDetails (dict) --
    
    The cross-account sharing details for an endpoint. Endpoints are shared through Resource Access Manager (RAM). This is a union type, so exactly one of its members is set: owned when this account owns the endpoint and shares it with other accounts, or consumed when this account consumes an endpoint that another account shares. To change how an endpoint is shared, use RAM.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Owned, Consumed. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Owned (dict) --
      
      The sharing details for an endpoint that this account owns and shares with other accounts through RAM.
      - ShareState (string) --
        
        The sharing state of the endpoint. Valid values include the following:
        
        SHARED – The endpoint is shared with one or more accounts.
        
        UNSHARED – The endpoint is not shared with other accounts.
    - Consumed (dict) --
      
      The sharing details for an endpoint that another account shares with this account through RAM.
      - OwnerAccountId (string) --
        
        The ID of the Amazon Web Services account that owns the shared endpoint.
  - RegistrationState (string) --
    
    The registration state of the source endpoint. Valid values include the following:
    - REGISTERED – The source endpoint is registered and ready to use.
    - REGISTERING – MediaConnect is registering the source endpoint.
    - DEREGISTERING – MediaConnect is deregistering the source endpoint.
    - REGISTRATION_FAILED – MediaConnect couldn't register the source endpoint.
  - ConnectionState (string) --
    
    The connection state of the source endpoint. Valid values include the following:
    - CONNECTED – The source endpoint is connected to a destination endpoint.
    - DISCONNECTED – The source endpoint isn't connected to a destination endpoint.
    - CONNECTING – The source endpoint is connecting to a destination endpoint.
    - DISCONNECTING – The source endpoint is disconnecting from a destination endpoint.
  - ConnectionDetails (dict) --
    
    The connection details for the source endpoint.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterOutput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The connection details for a standard source endpoint.
      - DestinationIpAddress (string) --
        
        The IP address of the destination that receives the content.
      - DestinationIngestPort (integer) --
        
        The port on the destination that receives the content.
      - DestinationDecryptionType (string) --
        
        The type of decryption that the destination uses for the connection.
      - DestinationDecryptionConfiguration (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
      - DestinationEndpointType (string) --
        
        The type of the connected destination endpoint.
    - RouterOutput (dict) --
      
      The connection details for a source endpoint that represents a router output.
      - DestinationDecryptionType (string) --
        
        The type of decryption that the destination uses for the connection.
      - DestinationDecryptionConfiguration (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
      - DestinationEndpointType (string) --
        
        The type of the connected destination endpoint.
  - ConnectedDestinations (list) --
    
    The Amazon Resource Names (ARNs) of the destination endpoints that are connected to the source endpoint.
    - (string) --
  - EncryptionType (string) --
    
    The type of encryption used for the source endpoint connection.
  - EncryptionConfiguration (dict) --
    
    The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - SecretsManager (dict) --
      
      The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
      - EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
      - EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
    - Automatic (dict) --
      
      The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
  - AssociatedResourceDetails (dict) --
    
    The details of the resource that is associated with the source endpoint.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterOutput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The associated resource details for a standard source endpoint.
    - RouterOutput (dict) --
      
      The associated resource details for a source endpoint that represents a router output.
      - Name (string) --
        
        The name of the router output.
      - MaximumBitrate (integer) --
        
        The maximum bitrate of the router output, in bits per second.
      - State (string) --
        
        The state of the router output.
      - Messages (list) --
        
        The status messages for 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) --
    
    The tags associated with the source endpoint. Each tag is a key-value pair.
    - (string) --
      - (string) --

ConnectEndpoints (new)

Link ¶

Connects a source endpoint to a destination endpoint.

See also: AWS API Documentation

Request Syntax

client.connect_endpoints(
    DestinationEndpointArn='string',
    SourceEndpointArn='string'
)

type DestinationEndpointArn:

string

param DestinationEndpointArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the destination endpoint to connect.

type SourceEndpointArn:

string

param SourceEndpointArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the source endpoint to connect.

rtype:

dict

returns:

Response Syntax

{
    'DestinationEndpointArn': 'string',
    'DestinationEndpointName': 'string',
    'SourceEndpointArn': 'string',
    'SourceEndpointName': 'string'
}

Response Structure

(dict) --
- DestinationEndpointArn (string) --
  
  The Amazon Resource Name (ARN) of the connected destination endpoint.
- DestinationEndpointName (string) --
  
  The name of the connected destination endpoint.
- SourceEndpointArn (string) --
  
  The Amazon Resource Name (ARN) of the connected source endpoint.
- SourceEndpointName (string) --
  
  The name of the connected source endpoint.

DeregisterSourceEndpoint (new)

Link ¶

Deregisters a source endpoint from MediaConnect.

See also: AWS API Documentation

Request Syntax

client.deregister_source_endpoint(
    Arn='string'
)

type Arn:

string

param Arn:

[REQUIRED]

The Amazon Resource Name (ARN) of the source endpoint to deregister.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Name': 'string'
}

Response Structure

(dict) --
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the source endpoint that was deregistered.
- Name (string) --
  
  The name of the source endpoint that was deregistered.

BatchGetDestinationEndpoint (new)

Link ¶

Retrieves information about multiple destination endpoints in a single request.

See also: AWS API Documentation

Request Syntax

client.batch_get_destination_endpoint(
    Arns=[
        'string',
    ]
)

type Arns:

list

param Arns:

[REQUIRED]

The Amazon Resource Names (ARNs) of one or more destination endpoints to retrieve. You can specify from 1 to 20 ARNs.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'DestinationEndpoints': [
        {
            'Name': 'string',
            'Arn': 'string',
            'Id': 'string',
            'Description': 'string',
            'RegionName': 'string',
            'AvailabilityZone': 'string',
            'AvailabilityZoneId': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'LifecycleManagement': 'MANAGED'|'UNMANAGED',
            'Messages': [
                {
                    'Code': 'string',
                    'Message': 'string'
                },
            ],
            'DestinationType': 'STANDARD'|'ROUTER_INPUT',
            'Configuration': {
                'Standard': {
                    'Name': 'string',
                    'DestinationNetworkingConfiguration': {
                        'Public': {
                            'DestinationAllowRules': [
                                {
                                    'Cidr': 'string'
                                },
                            ]
                        },
                        'Vpc': {
                            'SecurityGroupIds': [
                                'string',
                            ],
                            'SubnetId': 'string'
                        }
                    },
                    'ProtocolConfiguration': {
                        'Rist': {
                            'DestinationAddress': 'string',
                            'DestinationIngestPort': 123
                        },
                        'SrtListener': {
                            'DestinationAddress': 'string',
                            'DestinationIngestPort': 123,
                            'MinimumLatencyMilliseconds': 123,
                            'StreamId': 'string',
                            'EncryptionPassphrase': {
                                'SecretArn': 'string'
                            }
                        },
                        'SrtCaller': {
                            'SourceListenerPort': 123,
                            'MinimumLatencyMilliseconds': 123,
                            'EncryptionPassphrase': {
                                'SecretArn': 'string'
                            }
                        },
                        'Rtp': {
                            'DestinationAddress': 'string',
                            'DestinationIngestPort': 123,
                            'ForwardErrorCorrectionState': 'ENABLED'|'DISABLED'
                        }
                    },
                    'DestinationNetworkingType': 'PUBLIC'|'VPC',
                    'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
                },
                'RouterInput': {
                    'RouterInputArn': 'string'
                }
            },
            'ResourceShareOwnership': 'OWNED'|'CONSUMED',
            'ResourceShareDetails': {
                'Owned': {
                    'ShareState': 'SHARED'|'UNSHARED'
                },
                'Consumed': {
                    'OwnerAccountId': 'string'
                }
            },
            'RegistrationState': 'REGISTERED'|'REGISTERING'|'DEREGISTERING'|'REGISTRATION_FAILED',
            'ConnectionDetails': {
                'Standard': {
                    'SourceIpAddress': 'string',
                    'SourceListenerPort': 123,
                    'SourceEncryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                    'SourceEncryptionConfiguration': {
                        'SecretsManager': {
                            'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                            'EncryptionSecret': {
                                'SecretArn': 'string'
                            }
                        },
                        'Automatic': {}
                    },
                    'SourceEndpointType': 'STANDARD'|'ROUTER_OUTPUT'
                },
                'RouterInput': {
                    'SourceEncryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                    'SourceEncryptionConfiguration': {
                        'SecretsManager': {
                            'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                            'EncryptionSecret': {
                                'SecretArn': 'string'
                            }
                        },
                        'Automatic': {}
                    },
                    'SourceEndpointType': 'STANDARD'|'ROUTER_OUTPUT'
                }
            },
            'ConnectionState': 'CONNECTED'|'DISCONNECTED'|'CONNECTING'|'DISCONNECTING',
            'ConnectedSource': 'string',
            'DecryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
            'DecryptionConfiguration': {
                'SecretsManager': {
                    'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                    'EncryptionSecret': {
                        'SecretArn': 'string'
                    }
                },
                'Automatic': {}
            },
            'AssociatedResourceDetails': {
                'Standard': {},
                'RouterInput': {
                    'Name': 'string',
                    'MaximumBitrate': 123,
                    'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
                    'Messages': [
                        {
                            'Code': 'string',
                            'Message': 'string'
                        },
                    ]
                }
            },
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'Errors': [
        {
            'Arn': 'string',
            'Code': 'string',
            'Message': 'string'
        },
    ]
}

Response Structure

(dict) --
- DestinationEndpoints (list) --
  
  The destination endpoints that MediaConnect successfully retrieved.
  - (dict) --
    
    The details of a destination endpoint in MediaConnect, including its configuration, state, and connection details.
    - Name (string) --
      
      The name of the destination endpoint.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the destination endpoint.
    - Id (string) --
      
      The unique identifier of the destination endpoint.
    - Description (string) --
      
      The description of the destination endpoint.
    - RegionName (string) --
      
      The name of the Amazon Web Services Region in which the destination endpoint is located.
    - AvailabilityZone (string) --
      
      The Availability Zone in which the destination endpoint is located.
    - AvailabilityZoneId (string) --
      
      The ID of the Availability Zone in which the destination endpoint is located.
    - CreatedAt (datetime) --
      
      The date and time when the destination endpoint was created.
    - UpdatedAt (datetime) --
      
      The date and time when the destination endpoint was last updated.
    - LifecycleManagement (string) --
      
      The entity that manages the lifecycle of the destination endpoint.
    - Messages (list) --
      
      The status messages for the destination endpoint.
      - (dict) --
        
        A status message for a destination endpoint.
        
        Code (string) --
        
        The message code.
        
        Message (string) --
        
        The message text.
    - DestinationType (string) --
      
      The type of the destination endpoint. Valid values include the following:
      - STANDARD – A destination endpoint that represents an external destination over a standard protocol, such as RTP, RIST, or SRT.
      - ROUTER_INPUT – A destination endpoint that represents a router input.
    - Configuration (dict) --
      
      The configuration settings for the destination endpoint.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterInput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - Standard (dict) --
        
        The configuration settings for a standard destination endpoint, which represents an external destination.
        
        Name (string) --
        
        The name of the destination endpoint.
        
        DestinationNetworkingConfiguration (dict) --
        
        The networking configuration for the destination endpoint, which determines whether it is publicly accessible or in a virtual private cloud (VPC).
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Public, Vpc. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Public (dict) --
        
        The configuration for a publicly accessible destination endpoint.
        
        DestinationAllowRules (list) --
        
        The rules that specify which CIDR blocks can connect to the destination endpoint. You can specify up to 10 rules.
        
        (dict) --
        
        A rule that allows a specific CIDR block to connect to the public destination endpoint.
        
        Cidr (string) --
        
        The CIDR block that is allowed to connect to the destination endpoint, in CIDR notation.
        
        Vpc (dict) --
        
        The configuration for a destination endpoint in a virtual private cloud (VPC).
        
        SecurityGroupIds (list) --
        
        The IDs of the security groups to associate with the destination endpoint. You can specify from 1 to 5 security groups.
        
        (string) --
        
        SubnetId (string) --
        
        The ID of the subnet to use for the destination endpoint.
        
        ProtocolConfiguration (dict) --
        
        The protocol configuration for the destination endpoint.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rist, SrtListener, SrtCaller, Rtp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Rist (dict) --
        
        The configuration settings for a destination endpoint that uses the RIST protocol.
        
        DestinationAddress (string) --
        
        The IP address on which the destination endpoint receives content.
        
        DestinationIngestPort (integer) --
        
        The port on which the destination endpoint receives content. The valid range is 1024 to 65531.
        
        SrtListener (dict) --
        
        The configuration settings for a destination endpoint that uses SRT in listener mode.
        
        DestinationAddress (string) --
        
        The IP address on which the destination endpoint listens for incoming connections.
        
        DestinationIngestPort (integer) --
        
        The port on which the destination endpoint listens for incoming connections. The valid range is 0 to 65531.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
        
        StreamId (string) --
        
        The stream ID that identifies the content for the SRT connection.
        
        EncryptionPassphrase (dict) --
        
        The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        SrtCaller (dict) --
        
        The configuration settings for a destination endpoint that uses SRT in caller mode.
        
        SourceListenerPort (integer) --
        
        The port on which the source listens for the connection. The valid range is 3000 to 30000.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
        
        EncryptionPassphrase (dict) --
        
        The configuration for the Secrets Manager secret that holds the key or passphrase used to encrypt an endpoint connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Rtp (dict) --
        
        The configuration settings for a destination endpoint that uses the RTP protocol.
        
        DestinationAddress (string) --
        
        The IP address on which the destination endpoint receives content.
        
        DestinationIngestPort (integer) --
        
        The port on which the destination endpoint receives content. The valid range is 1024 to 65531.
        
        ForwardErrorCorrectionState (string) --
        
        Indicates whether forward error correction (FEC) is enabled for the destination endpoint.
        
        DestinationNetworkingType (string) --
        
        The networking type of the destination endpoint. Valid values include the following:
        
        PUBLIC – The destination endpoint is publicly accessible.
        
        VPC – The destination endpoint is in a virtual private cloud (VPC).
        
        Protocol (string) --
        
        The protocol used by the destination endpoint. Valid values include the following:
        
        RTP – Real-time Transport Protocol.
        
        RIST – Reliable Internet Stream Transport.
        
        SRT_CALLER – Secure Reliable Transport (SRT) in caller mode.
        
        SRT_LISTENER – Secure Reliable Transport (SRT) in listener mode.
      - RouterInput (dict) --
        
        The configuration settings for a destination endpoint that represents a router input.
        
        RouterInputArn (string) --
        
        The Amazon Resource Name (ARN) of the router input that the destination endpoint represents.
    - ResourceShareOwnership (string) --
      
      Indicates whether this account owns the destination endpoint or consumes it from another account through RAM.
    - ResourceShareDetails (dict) --
      
      The cross-account sharing details for an endpoint. Endpoints are shared through Resource Access Manager (RAM). This is a union type, so exactly one of its members is set: owned when this account owns the endpoint and shares it with other accounts, or consumed when this account consumes an endpoint that another account shares. To change how an endpoint is shared, use RAM.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: Owned, Consumed. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - Owned (dict) --
        
        The sharing details for an endpoint that this account owns and shares with other accounts through RAM.
        
        ShareState (string) --
        
        The sharing state of the endpoint. Valid values include the following:
        
        SHARED – The endpoint is shared with one or more accounts.
        
        UNSHARED – The endpoint is not shared with other accounts.
      - Consumed (dict) --
        
        The sharing details for an endpoint that another account shares with this account through RAM.
        
        OwnerAccountId (string) --
        
        The ID of the Amazon Web Services account that owns the shared endpoint.
    - RegistrationState (string) --
      
      The registration state of the destination endpoint. Valid values include the following:
      - REGISTERED – The destination endpoint is registered and ready to use.
      - REGISTERING – MediaConnect is registering the destination endpoint.
      - DEREGISTERING – MediaConnect is deregistering the destination endpoint.
      - REGISTRATION_FAILED – MediaConnect couldn't register the destination endpoint.
    - ConnectionDetails (dict) --
      
      The connection details for the destination endpoint.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterInput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - Standard (dict) --
        
        The connection details for a standard destination endpoint.
        
        SourceIpAddress (string) --
        
        The IP address of the source that is connected to the destination endpoint.
        
        SourceListenerPort (integer) --
        
        The port on which the source listens for the connection.
        
        SourceEncryptionType (string) --
        
        The type of encryption that the source uses for the connection.
        
        SourceEncryptionConfiguration (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
        
        SourceEndpointType (string) --
        
        The type of the connected source endpoint.
      - RouterInput (dict) --
        
        The connection details for a destination endpoint that represents a router input.
        
        SourceEncryptionType (string) --
        
        The type of encryption that the source uses for the connection.
        
        SourceEncryptionConfiguration (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
        
        SourceEndpointType (string) --
        
        The type of the connected source endpoint.
    - ConnectionState (string) --
      
      The connection state of the destination endpoint. Valid values include the following:
      - CONNECTED – The destination endpoint is connected to a source endpoint.
      - DISCONNECTED – The destination endpoint isn't connected to a source endpoint.
      - CONNECTING – The destination endpoint is connecting to a source endpoint.
      - DISCONNECTING – The destination endpoint is disconnecting from a source endpoint.
    - ConnectedSource (string) --
      
      The Amazon Resource Name (ARN) of the source endpoint that is connected to the destination endpoint.
    - DecryptionType (string) --
      
      The type of decryption used for the destination endpoint connection.
    - DecryptionConfiguration (dict) --
      
      The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
      - Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
    - AssociatedResourceDetails (dict) --
      
      The details of the resource that is associated with the destination endpoint.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, RouterInput. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - Standard (dict) --
        
        The associated resource details for a standard destination endpoint.
      - RouterInput (dict) --
        
        The associated resource details for a destination endpoint that represents a router input.
        
        Name (string) --
        
        The name of the router input.
        
        MaximumBitrate (integer) --
        
        The maximum bitrate of the router input, in bits per second.
        
        State (string) --
        
        The state of the router input.
        
        Messages (list) --
        
        The status messages for the router input.
        
        (dict) --
        
        A message associated with a router input, including a code and a message.
        
        Code (string) --
        
        The code associated with the router input message.
        
        Message (string) --
        
        The message text associated with the router input message.
    - Tags (dict) --
      
      The tags associated with the destination endpoint. Each tag is a key-value pair.
      - (string) --
        
        (string) --
- Errors (list) --
  
  The errors for any destination endpoints that MediaConnect couldn't retrieve.
  - (dict) --
    
    An error for a destination endpoint that MediaConnect couldn't retrieve in a BatchGetDestinationEndpoint request.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the destination endpoint that MediaConnect couldn't retrieve.
    - Code (string) --
      
      The error code.
    - Message (string) --
      
      A description of the error.

BatchGetRouterInput (updated)

Link ¶
Changes (response)

{'RouterInputs': {'AssociatedDestinationEndpointArns': ['string'],
                  'Configuration': {'DestinationEndpoint': {'EndpointLifecycleManagement': 'MANAGED '
                                                                                           '| '
                                                                                           'UNMANAGED',
                                                            'SourceTransitDecryption': {'Automatic': {},
                                                                                        'SecretsManager': {'EncryptionSecret': {'SecretArn': 'string'},
                                                                                                           'EncryptionSecretType': 'AES_128_KEY '
                                                                                                                                   '| '
                                                                                                                                   'AES_192_KEY '
                                                                                                                                   '| '
                                                                                                                                   'AES_256_KEY '
                                                                                                                                   '| '
                                                                                                                                   'SRT_PASSPHRASE'}},
                                                            'SourceTransitDecryptionType': 'SECRETS_MANAGER '
                                                                                           '| '
                                                                                           'AUTOMATIC'}},
                  'InputType': {'DESTINATION_ENDPOINT'},
                  'StreamDetails': {'DestinationEndpoint': {}}}}

Retrieves information about multiple router inputs in AWS Elemental MediaConnect.

See also: AWS API Documentation

Request Syntax

client.batch_get_router_input(
    Arns=[
        'string',
    ]
)

type Arns:

list

param Arns:

[REQUIRED]

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

(string) --

rtype:

dict

returns:

Response Syntax

{
    'RouterInputs': [
        {
            'Name': 'string',
            'Arn': 'string',
            'Id': 'string',
            'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
            'InputType': 'STANDARD'|'FAILOVER'|'MERGE'|'MEDIACONNECT_FLOW'|'MEDIALIVE_CHANNEL'|'DESTINATION_ENDPOINT',
            'Configuration': {
                'DestinationEndpoint': {
                    'EndpointLifecycleManagement': 'MANAGED'|'UNMANAGED',
                    'SourceTransitDecryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                    'SourceTransitDecryption': {
                        'SecretsManager': {
                            'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                            'EncryptionSecret': {
                                'SecretArn': 'string'
                            }
                        },
                        'Automatic': {}
                    }
                },
                'Standard': {
                    'NetworkInterfaceArn': 'string',
                    'ProtocolConfiguration': {
                        'Rist': {
                            'Port': 123,
                            'RecoveryLatencyMilliseconds': 123
                        },
                        'SrtListener': {
                            'Port': 123,
                            'MinimumLatencyMilliseconds': 123,
                            'DecryptionConfiguration': {
                                'EncryptionKey': {
                                    'SecretArn': 'string',
                                    'RoleArn': 'string'
                                }
                            }
                        },
                        'SrtCaller': {
                            'SourceAddress': 'string',
                            'SourcePort': 123,
                            'MinimumLatencyMilliseconds': 123,
                            'StreamId': 'string',
                            'DecryptionConfiguration': {
                                'EncryptionKey': {
                                    'SecretArn': 'string',
                                    'RoleArn': 'string'
                                }
                            }
                        },
                        'Rtp': {
                            'Port': 123,
                            'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
                        }
                    },
                    'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
                },
                'MediaLiveChannel': {
                    'MediaLiveChannelArn': 'string',
                    'MediaLivePipelineId': 'PIPELINE_0'|'PIPELINE_1',
                    'MediaLiveChannelOutputName': 'string',
                    'SourceTransitDecryption': {
                        'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
                        'EncryptionKeyConfiguration': {
                            'SecretsManager': {
                                'SecretArn': 'string',
                                'RoleArn': 'string'
                            },
                            'Automatic': {}
                        }
                    }
                },
                'Failover': {
                    'NetworkInterfaceArn': 'string',
                    'ProtocolConfigurations': [
                        {
                            'Rist': {
                                'Port': 123,
                                'RecoveryLatencyMilliseconds': 123
                            },
                            'SrtListener': {
                                'Port': 123,
                                'MinimumLatencyMilliseconds': 123,
                                'DecryptionConfiguration': {
                                    'EncryptionKey': {
                                        'SecretArn': 'string',
                                        'RoleArn': 'string'
                                    }
                                }
                            },
                            'SrtCaller': {
                                'SourceAddress': 'string',
                                'SourcePort': 123,
                                'MinimumLatencyMilliseconds': 123,
                                'StreamId': 'string',
                                'DecryptionConfiguration': {
                                    'EncryptionKey': {
                                        'SecretArn': 'string',
                                        'RoleArn': 'string'
                                    }
                                }
                            },
                            'Rtp': {
                                'Port': 123,
                                'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
                            }
                        },
                    ],
                    'SourcePriorityMode': 'NO_PRIORITY'|'PRIMARY_SECONDARY',
                    'PrimarySourceIndex': 123
                },
                'MediaConnectFlow': {
                    'FlowArn': 'string',
                    'FlowOutputArn': 'string',
                    'SourceTransitDecryption': {
                        'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
                        'EncryptionKeyConfiguration': {
                            'SecretsManager': {
                                'SecretArn': 'string',
                                'RoleArn': 'string'
                            },
                            'Automatic': {}
                        }
                    }
                },
                'Merge': {
                    'NetworkInterfaceArn': 'string',
                    'ProtocolConfigurations': [
                        {
                            'Rtp': {
                                'Port': 123,
                                'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
                            },
                            'Rist': {
                                'Port': 123,
                                'RecoveryLatencyMilliseconds': 123
                            }
                        },
                    ],
                    'MergeRecoveryWindowMilliseconds': 123
                }
            },
            'RoutedOutputs': 123,
            'MaximumRoutedOutputs': 123,
            'RegionName': 'string',
            'AvailabilityZone': 'string',
            'MaximumBitrate': 123,
            'Tier': 'INPUT_100'|'INPUT_50'|'INPUT_20'|'INPUT_500'|'INPUT_250',
            'RoutingScope': 'REGIONAL'|'GLOBAL',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'Messages': [
                {
                    'Code': 'string',
                    'Message': 'string'
                },
            ],
            'TransitEncryption': {
                'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
                'EncryptionKeyConfiguration': {
                    'SecretsManager': {
                        'SecretArn': 'string',
                        'RoleArn': 'string'
                    },
                    'Automatic': {}
                }
            },
            'Tags': {
                'string': 'string'
            },
            'StreamDetails': {
                'DestinationEndpoint': {},
                'Standard': {
                    'SourceIpAddress': 'string'
                },
                'MediaLiveChannel': {},
                'Failover': {
                    'SourceIndexZeroStreamDetails': {
                        'SourceIndex': 123,
                        'SourceIpAddress': 'string'
                    },
                    'SourceIndexOneStreamDetails': {
                        'SourceIndex': 123,
                        'SourceIpAddress': 'string'
                    }
                },
                'MediaConnectFlow': {},
                'Merge': {
                    'SourceIndexZeroStreamDetails': {
                        'SourceIndex': 123,
                        'SourceIpAddress': 'string'
                    },
                    'SourceIndexOneStreamDetails': {
                        'SourceIndex': 123,
                        'SourceIpAddress': 'string'
                    }
                }
            },
            'IpAddress': 'string',
            'MaintenanceType': 'PREFERRED_DAY_TIME'|'DEFAULT',
            'MaintenanceConfiguration': {
                'PreferredDayTime': {
                    'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
                    'Time': 'string'
                },
                'Default': {}
            },
            'MaintenanceScheduleType': 'WINDOW',
            'MaintenanceSchedule': {
                'Window': {
                    'Start': datetime(2015, 1, 1),
                    'End': datetime(2015, 1, 1),
                    'ScheduledTime': datetime(2015, 1, 1)
                }
            },
            'ContentQualityAnalysisType': 'CONTENT_LEVEL',
            'ContentQualityAnalysisConfiguration': {
                'ContentLevel': {
                    'BlackFrames': {
                        'State': 'ENABLED'|'DISABLED',
                        'ThresholdSeconds': 123
                    },
                    'FrozenFrames': {
                        'State': 'ENABLED'|'DISABLED',
                        'ThresholdSeconds': 123
                    },
                    'SilentAudio': {
                        'State': 'ENABLED'|'DISABLED',
                        'ThresholdSeconds': 123
                    }
                }
            },
            'AssociatedDestinationEndpointArns': [
                'string',
            ]
        },
    ],
    'Errors': [
        {
            'Arn': 'string',
            'Code': 'string',
            'Message': 'string'
        },
    ]
}

Response Structure

(dict) --
- RouterInputs (list) --
  
  An array of router inputs that were successfully retrieved.
  - (dict) --
    
    A router input in AWS Elemental MediaConnect. A router input is a source of media content that can be routed to one or more router outputs.
    - Name (string) --
      
      The name of the router input.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the router input.
    - Id (string) --
      
      The unique identifier of the router input.
    - State (string) --
      
      The current state of the router input.
    - InputType (string) --
      
      The type of the router input.
    - Configuration (dict) --
      
      The configuration settings for a router input.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: DestinationEndpoint, Standard, MediaLiveChannel, Failover, MediaConnectFlow, Merge. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - DestinationEndpoint (dict) --
        
        Configuration settings for a router input that is represented by a destination endpoint.
        
        EndpointLifecycleManagement (string) --
        
        The entity that manages the lifecycle of the associated destination endpoint. Valid values include the following:
        
        MANAGED – MediaConnect manages the lifecycle of the associated destination endpoint.
        
        UNMANAGED – You manage the lifecycle of the associated destination endpoint.
        
        SourceTransitDecryptionType (string) --
        
        The type of transit decryption applied to the source content that this router input receives. Valid values include the following:
        
        SECRETS_MANAGER – The decryption key or passphrase is stored in Secrets Manager.
        
        AUTOMATIC – MediaConnect determines the decryption key when the endpoint connects.
        
        SourceTransitDecryption (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
      - Standard (dict) --
        
        The configuration settings for a standard router input, including the protocol, protocol-specific configuration, network interface, and availability zone.
        
        NetworkInterfaceArn (string) --
        
        The Amazon Resource Name (ARN) of the network interface associated with the standard router input.
        
        ProtocolConfiguration (dict) --
        
        The configuration settings for the protocol used by the standard router input.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rist, SrtListener, SrtCaller, Rtp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Rist (dict) --
        
        The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
        
        Port (integer) --
        
        The port number used for the RIST protocol in the router input configuration.
        
        RecoveryLatencyMilliseconds (integer) --
        
        The recovery latency in milliseconds for the RIST protocol in the router input configuration.
        
        SrtListener (dict) --
        
        The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
        
        Port (integer) --
        
        The port number for the SRT protocol in listener mode.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency in milliseconds for the SRT protocol in listener mode.
        
        DecryptionConfiguration (dict) --
        
        Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
        
        EncryptionKey (dict) --
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) --
        
        The ARN of the 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 input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
        
        SourceAddress (string) --
        
        The source IP address for the SRT protocol in caller mode.
        
        SourcePort (integer) --
        
        The source port number for the SRT protocol in caller mode.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency in milliseconds for the SRT protocol in caller mode.
        
        StreamId (string) --
        
        The stream ID for the SRT protocol in caller mode.
        
        DecryptionConfiguration (dict) --
        
        Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
        
        EncryptionKey (dict) --
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) --
        
        The ARN of the 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 Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
        
        Port (integer) --
        
        The port number used for the RTP protocol in the router input configuration.
        
        ForwardErrorCorrection (string) --
        
        The state of forward error correction for the RTP protocol in the router input configuration.
        
        Protocol (string) --
        
        The protocol used by the standard router input.
      - MediaLiveChannel (dict) --
        
        Configuration settings for connecting a router input to a MediaLive channel output.
        
        To connect the router input to the MediaLive channel output, provide all three of mediaLiveChannelArn, mediaLivePipelineId, and mediaLiveChannelOutputName. To disconnect it, call the update operation and omit all three fields while keeping this configuration object.
        
        Note
        
        You can't change sourceTransitDecryption while the router input is connected to a MediaLive channel output. To change it, first disconnect the router input, then update the decryption.
        
        MediaLiveChannelArn (string) --
        
        The ARN of the MediaLive channel to connect to this router input.
        
        MediaLivePipelineId (string) --
        
        The index of the MediaLive pipeline to connect to this router input.
        
        MediaLiveChannelOutputName (string) --
        
        The name of the MediaLive channel output to connect to this router input.
        
        SourceTransitDecryption (dict) --
        
        The encryption configuration that defines how content is encrypted during transit between MediaConnect Router and MediaLive. This configuration determines whether encryption keys are automatically managed by the service or manually managed through Secrets Manager.
        
        EncryptionKeyType (string) --
        
        The type of encryption key to use for MediaLive transit encryption.
        
        EncryptionKeyConfiguration (dict) --
        
        The configuration details for the MediaLive encryption key.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The configuration settings for transit encryption using 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.
      - Failover (dict) --
        
        Configuration settings for a failover router input that allows switching between two input sources.
        
        NetworkInterfaceArn (string) --
        
        The ARN of the network interface to use for this failover router input.
        
        ProtocolConfigurations (list) --
        
        A list of exactly two protocol configurations for the failover input sources. Both must use the same protocol type.
        
        (dict) --
        
        Protocol configuration settings for failover router inputs.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rist, SrtListener, SrtCaller, Rtp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Rist (dict) --
        
        The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
        
        Port (integer) --
        
        The port number used for the RIST protocol in the router input configuration.
        
        RecoveryLatencyMilliseconds (integer) --
        
        The recovery latency in milliseconds for the RIST protocol in the router input configuration.
        
        SrtListener (dict) --
        
        The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
        
        Port (integer) --
        
        The port number for the SRT protocol in listener mode.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency in milliseconds for the SRT protocol in listener mode.
        
        DecryptionConfiguration (dict) --
        
        Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
        
        EncryptionKey (dict) --
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) --
        
        The ARN of the 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 input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
        
        SourceAddress (string) --
        
        The source IP address for the SRT protocol in caller mode.
        
        SourcePort (integer) --
        
        The source port number for the SRT protocol in caller mode.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency in milliseconds for the SRT protocol in caller mode.
        
        StreamId (string) --
        
        The stream ID for the SRT protocol in caller mode.
        
        DecryptionConfiguration (dict) --
        
        Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
        
        EncryptionKey (dict) --
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) --
        
        The ARN of the 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 Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
        
        Port (integer) --
        
        The port number used for the RTP protocol in the router input configuration.
        
        ForwardErrorCorrection (string) --
        
        The state of forward error correction for the RTP protocol in the router input configuration.
        
        SourcePriorityMode (string) --
        
        The mode for determining source priority in failover configurations.
        
        PrimarySourceIndex (integer) --
        
        The index (0 or 1) that specifies which source in the protocol configurations list is currently active. Used to control which of the two failover sources is currently selected. This field is ignored when sourcePriorityMode is set to NO_PRIORITY
      - MediaConnectFlow (dict) --
        
        Configuration settings for connecting a router input to a flow output.
        
        To connect the router input to the flow output, provide both flowArn and flowOutputArn. To disconnect it, call the update operation and omit both fields while keeping this configuration object.
        
        Note
        
        You can't change sourceTransitDecryption while the router input is connected to a flow output. To change it, first disconnect the router input, then update the decryption.
        
        FlowArn (string) --
        
        The ARN of the flow to connect to.
        
        FlowOutputArn (string) --
        
        The ARN of the flow output to connect to this router input.
        
        SourceTransitDecryption (dict) --
        
        The decryption configuration for the flow source when connected to this router input.
        
        EncryptionKeyType (string) --
        
        The type of encryption key to use for flow transit encryption.
        
        EncryptionKeyConfiguration (dict) --
        
        The configuration details for the encryption key.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The configuration settings for transit encryption using 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.
      - Merge (dict) --
        
        Configuration settings for a merge router input that combines two input sources.
        
        NetworkInterfaceArn (string) --
        
        The ARN of the network interface to use for this merge router input.
        
        ProtocolConfigurations (list) --
        
        A list of exactly two protocol configurations for the merge input sources. Both must use the same protocol type.
        
        (dict) --
        
        Protocol configuration settings for merge router inputs.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rtp, Rist. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Rtp (dict) --
        
        The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
        
        Port (integer) --
        
        The port number used for the RTP protocol in the router input configuration.
        
        ForwardErrorCorrection (string) --
        
        The state of forward error correction for the RTP protocol in the router input configuration.
        
        Rist (dict) --
        
        The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
        
        Port (integer) --
        
        The port number used for the RIST protocol in the router input configuration.
        
        RecoveryLatencyMilliseconds (integer) --
        
        The recovery latency in milliseconds for the RIST protocol in the router input configuration.
        
        MergeRecoveryWindowMilliseconds (integer) --
        
        The time window in milliseconds for merging the two input sources.
    - RoutedOutputs (integer) --
      
      The number of router outputs associated with the router input.
    - MaximumRoutedOutputs (integer) --
      
      The maximum number of outputs that can be simultaneously routed to this input.
    - RegionName (string) --
      
      The Amazon Web Services Region where the router input is located.
    - AvailabilityZone (string) --
      
      The Availability Zone of the router input.
    - MaximumBitrate (integer) --
      
      The maximum bitrate for the router input.
    - Tier (string) --
      
      The tier level for the router input. The tier sets the maximum bitrate, in Mbps, for the router input. Valid values include the following:
      - INPUT_20 – 20 Mbps
      - INPUT_50 – 50 Mbps
      - INPUT_100 – 100 Mbps
      - INPUT_250 – 250 Mbps
      - INPUT_500 – 500 Mbps
      The 250 Mbps and 500 Mbps tiers are high-bitrate tiers that support TR-07 (JPEG XS) workflows.
    - RoutingScope (string) --
      
      Indicates whether the router input is configured for Regional or global routing.
    - CreatedAt (datetime) --
      
      The timestamp when the router input was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the router input was last updated.
    - Messages (list) --
      
      The messages associated with the router input.
      - (dict) --
        
        A message associated with a router input, including a code and a message.
        
        Code (string) --
        
        The code associated with the router input message.
        
        Message (string) --
        
        The message text associated with the router input message.
    - TransitEncryption (dict) --
      
      The transit encryption settings for a router input.
      - EncryptionKeyType (string) --
        
        Specifies the type of encryption key to use for transit encryption.
      - EncryptionKeyConfiguration (dict) --
        
        Contains the configuration details for the encryption key used in transit encryption, including the key source and associated parameters.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The configuration settings for transit encryption using 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.
    - Tags (dict) --
      
      Key-value pairs that can be used to tag and organize this router input.
      - (string) --
        
        (string) --
    - StreamDetails (dict) --
      
      Configuration details for the router input stream.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: DestinationEndpoint, Standard, MediaLiveChannel, Failover, MediaConnectFlow, Merge. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - DestinationEndpoint (dict) --
        
        Configuration details for a router input stream that is represented by a destination endpoint.
      - Standard (dict) --
        
        Configuration details for a standard router input stream type.
        
        SourceIpAddress (string) --
        
        The source IP address for the standard router input stream.
      - MediaLiveChannel (dict) --
        
        Configuration details for a MediaLive channel when used as a router input source.
      - Failover (dict) --
        
        Configuration details for a failover router input that can automatically switch between two sources.
        
        SourceIndexZeroStreamDetails (dict) --
        
        Configuration details for the primary source (index 0) in the failover setup.
        
        SourceIndex (integer) --
        
        The index number (0 or 1) assigned to this source in the failover configuration.
        
        SourceIpAddress (string) --
        
        The IP address of the source for this indexed stream.
        
        SourceIndexOneStreamDetails (dict) --
        
        Configuration details for the secondary source (index 1) in the failover setup.
        
        SourceIndex (integer) --
        
        The index number (0 or 1) assigned to this source in the failover configuration.
        
        SourceIpAddress (string) --
        
        The IP address of the source for this indexed stream.
      - MediaConnectFlow (dict) --
        
        Configuration details for a MediaConnect flow when used as a router input source.
      - Merge (dict) --
        
        Configuration details for a merge router input that combines two input sources.
        
        SourceIndexZeroStreamDetails (dict) --
        
        Configuration details for the first source (index 0) in the merge setup.
        
        SourceIndex (integer) --
        
        The index number (0 or 1) assigned to this source in the merge configuration.
        
        SourceIpAddress (string) --
        
        The IP address of the source for this indexed stream in the merge setup.
        
        SourceIndexOneStreamDetails (dict) --
        
        Configuration details for the second source (index 1) in the merge setup.
        
        SourceIndex (integer) --
        
        The index number (0 or 1) assigned to this source in the merge configuration.
        
        SourceIpAddress (string) --
        
        The IP address of the source for this indexed stream in the merge setup.
    - IpAddress (string) --
      
      The IP address of the router input.
    - MaintenanceType (string) --
      
      The type of maintenance configuration applied to this router input.
    - MaintenanceConfiguration (dict) --
      
      The maintenance configuration settings applied to this router input.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: PreferredDayTime, Default. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - PreferredDayTime (dict) --
        
        Preferred day and time maintenance configuration settings.
        
        Day (string) --
        
        The preferred day for maintenance operations.
        
        Time (string) --
        
        The preferred time for maintenance operations.
      - Default (dict) --
        
        Default maintenance configuration settings.
    - MaintenanceScheduleType (string) --
      
      The type of maintenance schedule currently in effect for this router input.
    - MaintenanceSchedule (dict) --
      
      The current maintenance schedule details for this router input.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: Window. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - Window (dict) --
        
        Defines a specific time window for maintenance operations.
        
        Start (datetime) --
        
        The start time of the maintenance window.
        
        End (datetime) --
        
        The end time of the maintenance window.
        
        ScheduledTime (datetime) --
        
        The date and time when the maintenance window is scheduled to occur.
    - ContentQualityAnalysisType (string) --
      
      The type of content quality analysis applied to the router input.
    - ContentQualityAnalysisConfiguration (dict) --
      
      The content quality analysis configuration for the router input.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: ContentLevel. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - ContentLevel (dict) --
        
        The content quality analysis configuration.
        
        BlackFrames (dict) --
        
        Settings for black frames detection.
        
        State (string) --
        
        Indicates whether black frames detection is enabled or disabled.
        
        ThresholdSeconds (integer) --
        
        The number of consecutive seconds of black frames that MediaConnect must detect before it reports an issue.
        
        FrozenFrames (dict) --
        
        Settings for frozen frames detection.
        
        State (string) --
        
        Indicates whether frozen frames detection is enabled or disabled.
        
        ThresholdSeconds (integer) --
        
        The number of consecutive seconds of a frozen frame that MediaConnect must detect before it reports an issue.
        
        SilentAudio (dict) --
        
        Settings for silent audio detection.
        
        State (string) --
        
        Indicates whether silent audio detection is enabled or disabled.
        
        ThresholdSeconds (integer) --
        
        The number of consecutive seconds of silence that MediaConnect must detect before it reports an issue.
    - AssociatedDestinationEndpointArns (list) --
      
      The Amazon Resource Names (ARNs) of one or more destination endpoints that are associated with this router input.
      - (string) --
- Errors (list) --
  
  An array of errors that occurred when retrieving the requested router inputs.
  - (dict) --
    
    An error that occurred when retrieving multiple router inputs in the BatchGetRouterInput operation, including the ARN, error code, and error message.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the router input for which the error occurred.
    - Code (string) --
      
      The error code associated with the error.
    - Message (string) --
      
      A message describing the error.

BatchGetRouterOutput (updated)

Link ¶
Changes (response)

{'RouterOutputs': {'AssociatedSourceEndpointArns': ['string'],
                   'Configuration': {'SourceEndpoint': {'DestinationTransitEncryption': {'Automatic': {},
                                                                                         'SecretsManager': {'EncryptionSecret': {'SecretArn': 'string'},
                                                                                                            'EncryptionSecretType': 'AES_128_KEY '
                                                                                                                                    '| '
                                                                                                                                    'AES_192_KEY '
                                                                                                                                    '| '
                                                                                                                                    'AES_256_KEY '
                                                                                                                                    '| '
                                                                                                                                    'SRT_PASSPHRASE'}},
                                                        'DestinationTransitEncryptionType': 'SECRETS_MANAGER '
                                                                                            '| '
                                                                                            'AUTOMATIC',
                                                        'EndpointLifecycleManagement': 'MANAGED '
                                                                                       '| '
                                                                                       'UNMANAGED'}},
                   'OutputType': {'SOURCE_ENDPOINT'},
                   'StreamDetails': {'SourceEndpoint': {}}}}

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'|'SOURCE_ENDPOINT',
            'Configuration': {
                'Standard': {
                    'NetworkInterfaceArn': 'string',
                    'ProtocolConfiguration': {
                        'Rist': {
                            'DestinationAddress': 'string',
                            'DestinationPort': 123
                        },
                        'SrtListener': {
                            'Port': 123,
                            'MinimumLatencyMilliseconds': 123,
                            'EncryptionConfiguration': {
                                'EncryptionKey': {
                                    'SecretArn': 'string',
                                    'RoleArn': 'string'
                                }
                            }
                        },
                        'RtmpPush': {
                            'DestinationAddress': 'string',
                            'DestinationPort': 123,
                            'ApplicationName': 'string',
                            'StreamName': 'string',
                            'TlsEncryption': {
                                'EncryptionType': 'PUBLIC',
                                'EncryptionConfiguration': {
                                    'Public': {}
                                }
                            }
                        },
                        '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'|'RTMP_PUSH'
                },
                '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': {}
                        }
                    }
                },
                'SourceEndpoint': {
                    'EndpointLifecycleManagement': 'MANAGED'|'UNMANAGED',
                    'DestinationTransitEncryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                    'DestinationTransitEncryption': {
                        'SecretsManager': {
                            'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                            'EncryptionSecret': {
                                'SecretArn': 'string'
                            }
                        },
                        'Automatic': {}
                    }
                }
            },
            'RoutedState': 'ROUTED'|'ROUTING'|'UNROUTED',
            'RegionName': 'string',
            'AvailabilityZone': 'string',
            'MaximumBitrate': 123,
            'RoutingScope': 'REGIONAL'|'GLOBAL',
            'Tier': 'OUTPUT_100'|'OUTPUT_50'|'OUTPUT_20'|'OUTPUT_500'|'OUTPUT_250',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'Messages': [
                {
                    'Code': 'string',
                    'Message': 'string'
                },
            ],
            'Tags': {
                'string': 'string'
            },
            'StreamDetails': {
                'Standard': {
                    'DestinationIpAddress': 'string'
                },
                'MediaConnectFlow': {},
                'MediaLiveInput': {},
                'SourceEndpoint': {}
            },
            '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'
            },
            'AssociatedSourceEndpointArns': [
                'string',
            ]
        },
    ],
    '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.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, MediaConnectFlow, MediaLiveInput, SourceEndpoint. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - Standard (dict) --
        
        The configuration settings for a standard router output, including the protocol, protocol-specific configuration, network interface, and availability zone.
        
        NetworkInterfaceArn (string) --
        
        The Amazon Resource Name (ARN) of the network interface associated with the standard router output.
        
        ProtocolConfiguration (dict) --
        
        The configuration settings for the protocol used by the standard router output.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rist, SrtListener, RtmpPush, SrtCaller, Rtp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        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.
        
        RtmpPush (dict) --
        
        The configuration settings for a router output that pushes a stream to a destination using the RTMP (Real-Time Messaging Protocol) protocol, or RTMPS (RTMP over TLS) when TLS encryption is specified. These settings include the destination address and port, the application and stream names, and optional TLS encryption configuration.
        
        DestinationAddress (string) --
        
        The IP address or hostname of the destination RTMP server that the router output pushes the stream to. Provide only the server address; specify the application and stream names separately.
        
        DestinationPort (integer) --
        
        The TCP port on the destination RTMP server. For RTMP, valid values range from 1024 to 65535. For RTMPS (RTMP over TLS), valid values are 443 or 1024 to 65535. RTMP typically uses port 1935, and RTMPS typically uses port 443.
        
        ApplicationName (string) --
        
        The name of the RTMP application on the destination server. Together with the stream name, the application name forms the RTMP URL path, in the pattern rtmp://destinationAddress/applicationName/streamName.
        
        StreamName (string) --
        
        The name of the RTMP stream that the output publishes to the destination application. The stream name forms the final segment of the RTMP URL path.
        
        TlsEncryption (dict) --
        
        The TLS encryption settings for the output. When you specify these settings, the output uses RTMPS (RTMP over TLS) to establish a secure, encrypted connection to the destination server.
        
        EncryptionType (string) --
        
        The type of TLS encryption to use for the connection.
        
        EncryptionConfiguration (dict) --
        
        The configuration settings for the specified TLS encryption type.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Public. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Public (dict) --
        
        The TLS encryption configuration that validates the destination by using a publicly trusted certificate authority.
        
        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.
        
        To connect the router output to the flow source, provide both flowArn and flowSourceArn. To disconnect it, call the update operation and omit both fields while keeping this configuration object.
        
        Note
        
        You can't change destinationTransitEncryption while the router output is connected to a flow source. To change it, first disconnect the router output, then update the encryption.
        
        FlowArn (string) --
        
        The ARN of the flow to connect to this router output.
        
        FlowSourceArn (string) --
        
        The ARN of the flow source to connect to this router output.
        
        DestinationTransitEncryption (dict) --
        
        The encryption configuration for the flow destination when connected to this router output.
        
        EncryptionKeyType (string) --
        
        The type of encryption key to use for flow transit encryption.
        
        EncryptionKeyConfiguration (dict) --
        
        The configuration details for the encryption key.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The configuration settings for transit encryption using 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.
        
        To connect the router output to the MediaLive input, provide both mediaLiveInputArn and mediaLivePipelineId. To disconnect it, call the update operation and omit both fields while keeping this configuration object.
        
        Note
        
        You can't change destinationTransitEncryption while the router output is connected to a MediaLive input. To change it, first disconnect the router output, then update the encryption.
        
        MediaLiveInputArn (string) --
        
        The ARN of the MediaLive input to connect to this router output.
        
        MediaLivePipelineId (string) --
        
        The index of the MediaLive pipeline to connect to this router output.
        
        DestinationTransitEncryption (dict) --
        
        The encryption configuration for the MediaLive input when connected to this router output.
        
        EncryptionKeyType (string) --
        
        The type of encryption key to use for MediaLive transit encryption.
        
        EncryptionKeyConfiguration (dict) --
        
        The configuration details for the MediaLive encryption key.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The configuration settings for transit encryption using 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.
      - SourceEndpoint (dict) --
        
        Configuration settings for a router output that is represented by a source endpoint.
        
        EndpointLifecycleManagement (string) --
        
        The entity that manages the lifecycle of the associated source endpoint. Valid values include the following:
        
        MANAGED – MediaConnect manages the lifecycle of the associated source endpoint.
        
        UNMANAGED – You manage the lifecycle of the associated source endpoint.
        
        DestinationTransitEncryptionType (string) --
        
        The type of transit encryption applied to the destination content that this router output sends. Valid values include the following:
        
        SECRETS_MANAGER – The encryption key or passphrase is stored in Secrets Manager.
        
        AUTOMATIC – MediaConnect determines the encryption key when the endpoint connects.
        
        DestinationTransitEncryption (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
    - 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 for the router output. The tier sets the maximum bitrate, in Mbps, for the router output. Valid values include the following:
      - OUTPUT_20 – 20 Mbps
      - OUTPUT_50 – 50 Mbps
      - OUTPUT_100 – 100 Mbps
      - OUTPUT_250 – 250 Mbps
      - OUTPUT_500 – 500 Mbps
      The 250 Mbps and 500 Mbps tiers are high-bitrate tiers that support TR-07 (JPEG XS) workflows.
    - CreatedAt (datetime) --
      
      The timestamp when the router output was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the router output was last updated.
    - Messages (list) --
      
      The messages associated with the router output.
      - (dict) --
        
        A message associated with a router output.
        
        Code (string) --
        
        The code associated with the router output message.
        
        Message (string) --
        
        The message text associated with the router output message.
    - Tags (dict) --
      
      Key-value pairs that can be used to tag and organize this router output.
      - (string) --
        
        (string) --
    - StreamDetails (dict) --
      
      Information about the router output's stream, including connection state and destination details. The specific details provided vary based on the router output type.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, MediaConnectFlow, MediaLiveInput, SourceEndpoint. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - Standard (dict) --
        
        Configuration details for a standard router output stream type. Contains information about the destination IP address and connection state for basic output routing.
        
        DestinationIpAddress (string) --
        
        The IP address where the output stream will be sent. This is the destination address that will receive the routed media content.
      - MediaConnectFlow (dict) --
        
        Configuration details for a MediaConnect flow when used as a router output destination.
      - MediaLiveInput (dict) --
        
        Configuration details for a MediaLive input when used as a router output destination.
      - SourceEndpoint (dict) --
        
        Configuration details for a router output stream that is represented by a source endpoint.
    - IpAddress (string) --
      
      The IP address of the router output.
    - RoutedInputArn (string) --
      
      The Amazon Resource Name (ARN) of the router input associated with the output.
    - MaintenanceType (string) --
      
      The type of maintenance configuration applied to this router output.
    - MaintenanceConfiguration (dict) --
      
      The maintenance configuration settings applied to this router output.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: PreferredDayTime, Default. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - PreferredDayTime (dict) --
        
        Preferred day and time maintenance configuration settings.
        
        Day (string) --
        
        The preferred day for maintenance operations.
        
        Time (string) --
        
        The preferred time for maintenance operations.
      - Default (dict) --
        
        Default maintenance configuration settings.
    - MaintenanceScheduleType (string) --
      
      The type of maintenance schedule currently in effect for this router output.
    - MaintenanceSchedule (dict) --
      
      The current maintenance schedule details for this router output.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: Window. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - Window (dict) --
        
        Defines a specific time window for maintenance operations.
        
        Start (datetime) --
        
        The start time of the maintenance window.
        
        End (datetime) --
        
        The end time of the maintenance window.
        
        ScheduledTime (datetime) --
        
        The date and time when the maintenance window is scheduled to occur.
    - 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.
    - AssociatedSourceEndpointArns (list) --
      
      The Amazon Resource Names (ARNs) of one or more source endpoints that are associated with this router output.
      - (string) --
- 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.

CreateRouterInput (updated)

Link ¶
Changes (request, response)
Request

{'Configuration': {'DestinationEndpoint': {'EndpointLifecycleManagement': 'MANAGED '
                                                                          '| '
                                                                          'UNMANAGED',
                                           'SourceTransitDecryption': {'Automatic': {},
                                                                       'SecretsManager': {'EncryptionSecret': {'SecretArn': 'string'},
                                                                                          'EncryptionSecretType': 'AES_128_KEY '
                                                                                                                  '| '
                                                                                                                  'AES_192_KEY '
                                                                                                                  '| '
                                                                                                                  'AES_256_KEY '
                                                                                                                  '| '
                                                                                                                  'SRT_PASSPHRASE'}},
                                           'SourceTransitDecryptionType': 'SECRETS_MANAGER '
                                                                          '| '
                                                                          'AUTOMATIC'}}}

Response

{'RouterInput': {'AssociatedDestinationEndpointArns': ['string'],
                 'Configuration': {'DestinationEndpoint': {'EndpointLifecycleManagement': 'MANAGED '
                                                                                          '| '
                                                                                          'UNMANAGED',
                                                           'SourceTransitDecryption': {'Automatic': {},
                                                                                       'SecretsManager': {'EncryptionSecret': {'SecretArn': 'string'},
                                                                                                          'EncryptionSecretType': 'AES_128_KEY '
                                                                                                                                  '| '
                                                                                                                                  'AES_192_KEY '
                                                                                                                                  '| '
                                                                                                                                  'AES_256_KEY '
                                                                                                                                  '| '
                                                                                                                                  'SRT_PASSPHRASE'}},
                                                           'SourceTransitDecryptionType': 'SECRETS_MANAGER '
                                                                                          '| '
                                                                                          'AUTOMATIC'}},
                 'InputType': {'DESTINATION_ENDPOINT'},
                 'StreamDetails': {'DestinationEndpoint': {}}}}

Creates a new router input in AWS Elemental MediaConnect.

See also: AWS API Documentation

Request Syntax

client.create_router_input(
    Name='string',
    Configuration={
        'DestinationEndpoint': {
            'EndpointLifecycleManagement': 'MANAGED'|'UNMANAGED',
            'SourceTransitDecryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
            'SourceTransitDecryption': {
                'SecretsManager': {
                    'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                    'EncryptionSecret': {
                        'SecretArn': 'string'
                    }
                },
                'Automatic': {}

            }
        },
        'Standard': {
            'NetworkInterfaceArn': 'string',
            'ProtocolConfiguration': {
                'Rist': {
                    'Port': 123,
                    'RecoveryLatencyMilliseconds': 123
                },
                'SrtListener': {
                    'Port': 123,
                    'MinimumLatencyMilliseconds': 123,
                    'DecryptionConfiguration': {
                        'EncryptionKey': {
                            'SecretArn': 'string',
                            'RoleArn': 'string'
                        }
                    }
                },
                'SrtCaller': {
                    'SourceAddress': 'string',
                    'SourcePort': 123,
                    'MinimumLatencyMilliseconds': 123,
                    'StreamId': 'string',
                    'DecryptionConfiguration': {
                        'EncryptionKey': {
                            'SecretArn': 'string',
                            'RoleArn': 'string'
                        }
                    }
                },
                'Rtp': {
                    'Port': 123,
                    'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
                }
            },
            'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
        },
        'MediaLiveChannel': {
            'MediaLiveChannelArn': 'string',
            'MediaLivePipelineId': 'PIPELINE_0'|'PIPELINE_1',
            'MediaLiveChannelOutputName': 'string',
            'SourceTransitDecryption': {
                'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
                'EncryptionKeyConfiguration': {
                    'SecretsManager': {
                        'SecretArn': 'string',
                        'RoleArn': 'string'
                    },
                    'Automatic': {}

                }
            }
        },
        'Failover': {
            'NetworkInterfaceArn': 'string',
            'ProtocolConfigurations': [
                {
                    'Rist': {
                        'Port': 123,
                        'RecoveryLatencyMilliseconds': 123
                    },
                    'SrtListener': {
                        'Port': 123,
                        'MinimumLatencyMilliseconds': 123,
                        'DecryptionConfiguration': {
                            'EncryptionKey': {
                                'SecretArn': 'string',
                                'RoleArn': 'string'
                            }
                        }
                    },
                    'SrtCaller': {
                        'SourceAddress': 'string',
                        'SourcePort': 123,
                        'MinimumLatencyMilliseconds': 123,
                        'StreamId': 'string',
                        'DecryptionConfiguration': {
                            'EncryptionKey': {
                                'SecretArn': 'string',
                                'RoleArn': 'string'
                            }
                        }
                    },
                    'Rtp': {
                        'Port': 123,
                        'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
                    }
                },
            ],
            'SourcePriorityMode': 'NO_PRIORITY'|'PRIMARY_SECONDARY',
            'PrimarySourceIndex': 123
        },
        'MediaConnectFlow': {
            'FlowArn': 'string',
            'FlowOutputArn': 'string',
            'SourceTransitDecryption': {
                'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
                'EncryptionKeyConfiguration': {
                    'SecretsManager': {
                        'SecretArn': 'string',
                        'RoleArn': 'string'
                    },
                    'Automatic': {}

                }
            }
        },
        'Merge': {
            'NetworkInterfaceArn': 'string',
            'ProtocolConfigurations': [
                {
                    'Rtp': {
                        'Port': 123,
                        'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
                    },
                    'Rist': {
                        'Port': 123,
                        'RecoveryLatencyMilliseconds': 123
                    }
                },
            ],
            'MergeRecoveryWindowMilliseconds': 123
        }
    },
    MaximumBitrate=123,
    RoutingScope='REGIONAL'|'GLOBAL',
    Tier='INPUT_100'|'INPUT_50'|'INPUT_20'|'INPUT_500'|'INPUT_250',
    RegionName='string',
    AvailabilityZone='string',
    TransitEncryption={
        'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
        'EncryptionKeyConfiguration': {
            'SecretsManager': {
                'SecretArn': 'string',
                'RoleArn': 'string'
            },
            'Automatic': {}

        }
    },
    MaintenanceConfiguration={
        'PreferredDayTime': {
            'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
            'Time': 'string'
        },
        'Default': {}

    },
    Tags={
        'string': 'string'
    },
    ClientToken='string',
    ContentQualityAnalysisConfiguration={
        'ContentLevel': {
            'BlackFrames': {
                'State': 'ENABLED'|'DISABLED',
                'ThresholdSeconds': 123
            },
            'FrozenFrames': {
                'State': 'ENABLED'|'DISABLED',
                'ThresholdSeconds': 123
            },
            'SilentAudio': {
                'State': 'ENABLED'|'DISABLED',
                'ThresholdSeconds': 123
            }
        }
    }
)

type Name:

string

param Name:

[REQUIRED]

The name of the router input.

type Configuration:

dict

param Configuration:

[REQUIRED]

The configuration settings for the router input, which can include the protocol, network interface, and other details.

DestinationEndpoint (dict) --

Configuration settings for a router input that is represented by a destination endpoint.
- EndpointLifecycleManagement (string) -- [REQUIRED]
  
  The entity that manages the lifecycle of the associated destination endpoint. Valid values include the following:
  - MANAGED – MediaConnect manages the lifecycle of the associated destination endpoint.
  - UNMANAGED – You manage the lifecycle of the associated destination endpoint.
- SourceTransitDecryptionType (string) --
  
  The type of transit decryption applied to the source content that this router input receives. Valid values include the following:
  - SECRETS_MANAGER – The decryption key or passphrase is stored in Secrets Manager.
  - AUTOMATIC – MediaConnect determines the decryption key when the endpoint connects.
- SourceTransitDecryption (dict) -- [REQUIRED]
  
  The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.
  - SecretsManager (dict) --
    
    The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
    - EncryptionSecretType (string) --
      
      The type of secret used to encrypt the connection. Valid values include the following:
      - AES_128_KEY – A 128-bit AES encryption key.
      - AES_192_KEY – A 192-bit AES encryption key.
      - AES_256_KEY – A 256-bit AES encryption key.
      - SRT_PASSPHRASE – An SRT passphrase.
    - EncryptionSecret (dict) -- [REQUIRED]
      
      The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
      - SecretArn (string) -- [REQUIRED]
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
  - Automatic (dict) --
    
    The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
Standard (dict) --

The configuration settings for a standard router input, including the protocol, protocol-specific configuration, network interface, and availability zone.
- NetworkInterfaceArn (string) -- [REQUIRED]
  
  The Amazon Resource Name (ARN) of the network interface associated with the standard router input.
- ProtocolConfiguration (dict) -- [REQUIRED]
  
  The configuration settings for the protocol used by the standard router input.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: Rist, SrtListener, SrtCaller, Rtp.
  - Rist (dict) --
    
    The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
    - Port (integer) -- [REQUIRED]
      
      The port number used for the RIST protocol in the router input configuration.
    - RecoveryLatencyMilliseconds (integer) -- [REQUIRED]
      
      The recovery latency in milliseconds for the RIST protocol in the router input configuration.
  - SrtListener (dict) --
    
    The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
    - Port (integer) -- [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.
    - DecryptionConfiguration (dict) --
      
      Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
      - EncryptionKey (dict) -- [REQUIRED]
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) -- [REQUIRED]
        
        The ARN of the 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 input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
    - SourceAddress (string) -- [REQUIRED]
      
      The source IP address for the SRT protocol in caller mode.
    - SourcePort (integer) -- [REQUIRED]
      
      The source port number for the SRT protocol in caller mode.
    - 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.
    - DecryptionConfiguration (dict) --
      
      Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
      - EncryptionKey (dict) -- [REQUIRED]
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) -- [REQUIRED]
        
        The ARN of the 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 Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
    - Port (integer) -- [REQUIRED]
      
      The port number used for the RTP protocol in the router input configuration.
    - ForwardErrorCorrection (string) --
      
      The state of forward error correction for the RTP protocol in the router input configuration.
- Protocol (string) --
  
  The protocol used by the standard router input.
MediaLiveChannel (dict) --

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

To connect the router input to the MediaLive channel output, provide all three of mediaLiveChannelArn, mediaLivePipelineId, and mediaLiveChannelOutputName. To disconnect it, call the update operation and omit all three fields while keeping this configuration object.

Note

You can't change sourceTransitDecryption while the router input is connected to a MediaLive channel output. To change it, first disconnect the router input, then update the decryption.
- MediaLiveChannelArn (string) --
  
  The ARN of the MediaLive channel to connect to this router input.
- MediaLivePipelineId (string) --
  
  The index of the MediaLive pipeline to connect to this router input.
- MediaLiveChannelOutputName (string) --
  
  The name of the MediaLive channel output to connect to this router input.
- SourceTransitDecryption (dict) -- [REQUIRED]
  
  The encryption configuration that defines how content is encrypted during transit between MediaConnect Router and MediaLive. This configuration determines whether encryption keys are automatically managed by the service or manually managed through Secrets Manager.
  - EncryptionKeyType (string) --
    
    The type of encryption key to use for MediaLive transit encryption.
  - EncryptionKeyConfiguration (dict) -- [REQUIRED]
    
    The configuration details for the MediaLive encryption key.
    
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.
    - 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.
Failover (dict) --

Configuration settings for a failover router input that allows switching between two input sources.
- NetworkInterfaceArn (string) -- [REQUIRED]
  
  The ARN of the network interface to use for this failover router input.
- ProtocolConfigurations (list) -- [REQUIRED]
  
  A list of exactly two protocol configurations for the failover input sources. Both must use the same protocol type.
  - (dict) --
    
    Protocol configuration settings for failover router inputs.
    
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys can be set: Rist, SrtListener, SrtCaller, Rtp.
    - Rist (dict) --
      
      The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
      - Port (integer) -- [REQUIRED]
        
        The port number used for the RIST protocol in the router input configuration.
      - RecoveryLatencyMilliseconds (integer) -- [REQUIRED]
        
        The recovery latency in milliseconds for the RIST protocol in the router input configuration.
    - SrtListener (dict) --
      
      The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
      - Port (integer) -- [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.
      - DecryptionConfiguration (dict) --
        
        Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
        
        EncryptionKey (dict) -- [REQUIRED]
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) -- [REQUIRED]
        
        The ARN of the 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 input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
      - SourceAddress (string) -- [REQUIRED]
        
        The source IP address for the SRT protocol in caller mode.
      - SourcePort (integer) -- [REQUIRED]
        
        The source port number for the SRT protocol in caller mode.
      - 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.
      - DecryptionConfiguration (dict) --
        
        Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
        
        EncryptionKey (dict) -- [REQUIRED]
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) -- [REQUIRED]
        
        The ARN of the 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 Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
      - Port (integer) -- [REQUIRED]
        
        The port number used for the RTP protocol in the router input configuration.
      - ForwardErrorCorrection (string) --
        
        The state of forward error correction for the RTP protocol in the router input configuration.
- SourcePriorityMode (string) -- [REQUIRED]
  
  The mode for determining source priority in failover configurations.
- PrimarySourceIndex (integer) --
  
  The index (0 or 1) that specifies which source in the protocol configurations list is currently active. Used to control which of the two failover sources is currently selected. This field is ignored when sourcePriorityMode is set to NO_PRIORITY
MediaConnectFlow (dict) --

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

To connect the router input to the flow output, provide both flowArn and flowOutputArn. To disconnect it, call the update operation and omit both fields while keeping this configuration object.

Note

You can't change sourceTransitDecryption while the router input is connected to a flow output. To change it, first disconnect the router input, then update the decryption.
- FlowArn (string) --
  
  The ARN of the flow to connect to.
- FlowOutputArn (string) --
  
  The ARN of the flow output to connect to this router input.
- SourceTransitDecryption (dict) -- [REQUIRED]
  
  The decryption configuration for the flow source when connected to this router input.
  - EncryptionKeyType (string) --
    
    The type of encryption key to use for flow transit encryption.
  - EncryptionKeyConfiguration (dict) -- [REQUIRED]
    
    The configuration details for the encryption key.
    
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.
    - SecretsManager (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.
Merge (dict) --

Configuration settings for a merge router input that combines two input sources.
- NetworkInterfaceArn (string) -- [REQUIRED]
  
  The ARN of the network interface to use for this merge router input.
- ProtocolConfigurations (list) -- [REQUIRED]
  
  A list of exactly two protocol configurations for the merge input sources. Both must use the same protocol type.
  - (dict) --
    
    Protocol configuration settings for merge router inputs.
    
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys can be set: Rtp, Rist.
    - Rtp (dict) --
      
      The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
      - Port (integer) -- [REQUIRED]
        
        The port number used for the RTP protocol in the router input configuration.
      - ForwardErrorCorrection (string) --
        
        The state of forward error correction for the RTP protocol in the router input configuration.
    - Rist (dict) --
      
      The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
      - Port (integer) -- [REQUIRED]
        
        The port number used for the RIST protocol in the router input configuration.
      - RecoveryLatencyMilliseconds (integer) -- [REQUIRED]
        
        The recovery latency in milliseconds for the RIST protocol in the router input configuration.
- MergeRecoveryWindowMilliseconds (integer) -- [REQUIRED]
  
  The time window in milliseconds for merging the two input sources.

type MaximumBitrate:

integer

param MaximumBitrate:

[REQUIRED]

The maximum bitrate for the router input.

type RoutingScope:

string

param RoutingScope:

[REQUIRED]

Specifies whether the router input can be assigned to outputs in different Regions. REGIONAL (default) - connects only to outputs in same Region. GLOBAL - connects to outputs in any Region.

type Tier:

string

param Tier:

[REQUIRED]

The tier level for the router input. The tier sets the maximum bitrate, in Mbps, for the router input. Valid values include the following:

INPUT_20 – 20 Mbps
INPUT_50 – 50 Mbps
INPUT_100 – 100 Mbps
INPUT_250 – 250 Mbps
INPUT_500 – 500 Mbps

The 250 Mbps and 500 Mbps tiers are high-bitrate tiers that support TR-07 (JPEG XS) workflows.

type RegionName:

string

param RegionName:

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

type AvailabilityZone:

string

param AvailabilityZone:

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

type TransitEncryption:

dict

param TransitEncryption:

The transit encryption settings for the router input.

EncryptionKeyType (string) --

Specifies the type of encryption key to use for transit encryption.
EncryptionKeyConfiguration (dict) -- [REQUIRED]

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

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.
- SecretsManager (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 MaintenanceConfiguration:

dict

param MaintenanceConfiguration:

The maintenance configuration settings for the router input, 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 and organize this router input.

(string) --
- (string) --

type ClientToken:

string

param ClientToken:

A unique identifier for the request to ensure idempotency.

This field is autopopulated if not provided.

type ContentQualityAnalysisConfiguration:

dict

param ContentQualityAnalysisConfiguration:

The content quality analysis configuration for the router input.

ContentLevel (dict) --

The content quality analysis configuration.
- BlackFrames (dict) --
  
  Settings for black frames detection.
  - State (string) -- [REQUIRED]
    
    Indicates whether black frames detection is enabled or disabled.
  - ThresholdSeconds (integer) -- [REQUIRED]
    
    The number of consecutive seconds of black frames that MediaConnect must detect before it reports an issue.
- FrozenFrames (dict) --
  
  Settings for frozen frames detection.
  - State (string) -- [REQUIRED]
    
    Indicates whether frozen frames detection is enabled or disabled.
  - ThresholdSeconds (integer) -- [REQUIRED]
    
    The number of consecutive seconds of a frozen frame that MediaConnect must detect before it reports an issue.
- SilentAudio (dict) --
  
  Settings for silent audio detection.
  - State (string) -- [REQUIRED]
    
    Indicates whether silent audio detection is enabled or disabled.
  - ThresholdSeconds (integer) -- [REQUIRED]
    
    The number of consecutive seconds of silence that MediaConnect must detect before it reports an issue.

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --
- RouterInput (dict) --
  
  The newly-created router input.
  - Name (string) --
    
    The name of the router input.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of the router input.
  - Id (string) --
    
    The unique identifier of the router input.
  - State (string) --
    
    The current state of the router input.
  - InputType (string) --
    
    The type of the router input.
  - Configuration (dict) --
    
    The configuration settings for a router input.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: DestinationEndpoint, Standard, MediaLiveChannel, Failover, MediaConnectFlow, Merge. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - DestinationEndpoint (dict) --
      
      Configuration settings for a router input that is represented by a destination endpoint.
      - EndpointLifecycleManagement (string) --
        
        The entity that manages the lifecycle of the associated destination endpoint. Valid values include the following:
        
        MANAGED – MediaConnect manages the lifecycle of the associated destination endpoint.
        
        UNMANAGED – You manage the lifecycle of the associated destination endpoint.
      - SourceTransitDecryptionType (string) --
        
        The type of transit decryption applied to the source content that this router input receives. Valid values include the following:
        
        SECRETS_MANAGER – The decryption key or passphrase is stored in Secrets Manager.
        
        AUTOMATIC – MediaConnect determines the decryption key when the endpoint connects.
      - SourceTransitDecryption (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
    - Standard (dict) --
      
      The configuration settings for a standard router input, including the protocol, protocol-specific configuration, network interface, and availability zone.
      - NetworkInterfaceArn (string) --
        
        The Amazon Resource Name (ARN) of the network interface associated with the standard router input.
      - ProtocolConfiguration (dict) --
        
        The configuration settings for the protocol used by the standard router input.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rist, SrtListener, SrtCaller, Rtp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Rist (dict) --
        
        The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
        
        Port (integer) --
        
        The port number used for the RIST protocol in the router input configuration.
        
        RecoveryLatencyMilliseconds (integer) --
        
        The recovery latency in milliseconds for the RIST protocol in the router input configuration.
        
        SrtListener (dict) --
        
        The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
        
        Port (integer) --
        
        The port number for the SRT protocol in listener mode.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency in milliseconds for the SRT protocol in listener mode.
        
        DecryptionConfiguration (dict) --
        
        Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
        
        EncryptionKey (dict) --
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) --
        
        The ARN of the 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 input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
        
        SourceAddress (string) --
        
        The source IP address for the SRT protocol in caller mode.
        
        SourcePort (integer) --
        
        The source port number for the SRT protocol in caller mode.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency in milliseconds for the SRT protocol in caller mode.
        
        StreamId (string) --
        
        The stream ID for the SRT protocol in caller mode.
        
        DecryptionConfiguration (dict) --
        
        Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
        
        EncryptionKey (dict) --
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) --
        
        The ARN of the 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 Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
        
        Port (integer) --
        
        The port number used for the RTP protocol in the router input configuration.
        
        ForwardErrorCorrection (string) --
        
        The state of forward error correction for the RTP protocol in the router input configuration.
      - Protocol (string) --
        
        The protocol used by the standard router input.
    - MediaLiveChannel (dict) --
      
      Configuration settings for connecting a router input to a MediaLive channel output.
      
      To connect the router input to the MediaLive channel output, provide all three of mediaLiveChannelArn, mediaLivePipelineId, and mediaLiveChannelOutputName. To disconnect it, call the update operation and omit all three fields while keeping this configuration object.
      
      Note
      
      You can't change sourceTransitDecryption while the router input is connected to a MediaLive channel output. To change it, first disconnect the router input, then update the decryption.
      - MediaLiveChannelArn (string) --
        
        The ARN of the MediaLive channel to connect to this router input.
      - MediaLivePipelineId (string) --
        
        The index of the MediaLive pipeline to connect to this router input.
      - MediaLiveChannelOutputName (string) --
        
        The name of the MediaLive channel output to connect to this router input.
      - SourceTransitDecryption (dict) --
        
        The encryption configuration that defines how content is encrypted during transit between MediaConnect Router and MediaLive. This configuration determines whether encryption keys are automatically managed by the service or manually managed through Secrets Manager.
        
        EncryptionKeyType (string) --
        
        The type of encryption key to use for MediaLive transit encryption.
        
        EncryptionKeyConfiguration (dict) --
        
        The configuration details for the MediaLive encryption key.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The configuration settings for transit encryption using 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.
    - Failover (dict) --
      
      Configuration settings for a failover router input that allows switching between two input sources.
      - NetworkInterfaceArn (string) --
        
        The ARN of the network interface to use for this failover router input.
      - ProtocolConfigurations (list) --
        
        A list of exactly two protocol configurations for the failover input sources. Both must use the same protocol type.
        
        (dict) --
        
        Protocol configuration settings for failover router inputs.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rist, SrtListener, SrtCaller, Rtp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Rist (dict) --
        
        The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
        
        Port (integer) --
        
        The port number used for the RIST protocol in the router input configuration.
        
        RecoveryLatencyMilliseconds (integer) --
        
        The recovery latency in milliseconds for the RIST protocol in the router input configuration.
        
        SrtListener (dict) --
        
        The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
        
        Port (integer) --
        
        The port number for the SRT protocol in listener mode.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency in milliseconds for the SRT protocol in listener mode.
        
        DecryptionConfiguration (dict) --
        
        Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
        
        EncryptionKey (dict) --
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) --
        
        The ARN of the 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 input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
        
        SourceAddress (string) --
        
        The source IP address for the SRT protocol in caller mode.
        
        SourcePort (integer) --
        
        The source port number for the SRT protocol in caller mode.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency in milliseconds for the SRT protocol in caller mode.
        
        StreamId (string) --
        
        The stream ID for the SRT protocol in caller mode.
        
        DecryptionConfiguration (dict) --
        
        Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
        
        EncryptionKey (dict) --
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) --
        
        The ARN of the 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 Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
        
        Port (integer) --
        
        The port number used for the RTP protocol in the router input configuration.
        
        ForwardErrorCorrection (string) --
        
        The state of forward error correction for the RTP protocol in the router input configuration.
      - SourcePriorityMode (string) --
        
        The mode for determining source priority in failover configurations.
      - PrimarySourceIndex (integer) --
        
        The index (0 or 1) that specifies which source in the protocol configurations list is currently active. Used to control which of the two failover sources is currently selected. This field is ignored when sourcePriorityMode is set to NO_PRIORITY
    - MediaConnectFlow (dict) --
      
      Configuration settings for connecting a router input to a flow output.
      
      To connect the router input to the flow output, provide both flowArn and flowOutputArn. To disconnect it, call the update operation and omit both fields while keeping this configuration object.
      
      Note
      
      You can't change sourceTransitDecryption while the router input is connected to a flow output. To change it, first disconnect the router input, then update the decryption.
      - FlowArn (string) --
        
        The ARN of the flow to connect to.
      - FlowOutputArn (string) --
        
        The ARN of the flow output to connect to this router input.
      - SourceTransitDecryption (dict) --
        
        The decryption configuration for the flow source when connected to this router input.
        
        EncryptionKeyType (string) --
        
        The type of encryption key to use for flow transit encryption.
        
        EncryptionKeyConfiguration (dict) --
        
        The configuration details for the encryption key.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The configuration settings for transit encryption using 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.
    - Merge (dict) --
      
      Configuration settings for a merge router input that combines two input sources.
      - NetworkInterfaceArn (string) --
        
        The ARN of the network interface to use for this merge router input.
      - ProtocolConfigurations (list) --
        
        A list of exactly two protocol configurations for the merge input sources. Both must use the same protocol type.
        
        (dict) --
        
        Protocol configuration settings for merge router inputs.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rtp, Rist. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Rtp (dict) --
        
        The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
        
        Port (integer) --
        
        The port number used for the RTP protocol in the router input configuration.
        
        ForwardErrorCorrection (string) --
        
        The state of forward error correction for the RTP protocol in the router input configuration.
        
        Rist (dict) --
        
        The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
        
        Port (integer) --
        
        The port number used for the RIST protocol in the router input configuration.
        
        RecoveryLatencyMilliseconds (integer) --
        
        The recovery latency in milliseconds for the RIST protocol in the router input configuration.
      - MergeRecoveryWindowMilliseconds (integer) --
        
        The time window in milliseconds for merging the two input sources.
  - RoutedOutputs (integer) --
    
    The number of router outputs associated with the router input.
  - MaximumRoutedOutputs (integer) --
    
    The maximum number of outputs that can be simultaneously routed to this input.
  - RegionName (string) --
    
    The Amazon Web Services Region where the router input is located.
  - AvailabilityZone (string) --
    
    The Availability Zone of the router input.
  - MaximumBitrate (integer) --
    
    The maximum bitrate for the router input.
  - Tier (string) --
    
    The tier level for the router input. The tier sets the maximum bitrate, in Mbps, for the router input. Valid values include the following:
    - INPUT_20 – 20 Mbps
    - INPUT_50 – 50 Mbps
    - INPUT_100 – 100 Mbps
    - INPUT_250 – 250 Mbps
    - INPUT_500 – 500 Mbps
    The 250 Mbps and 500 Mbps tiers are high-bitrate tiers that support TR-07 (JPEG XS) workflows.
  - RoutingScope (string) --
    
    Indicates whether the router input is configured for Regional or global routing.
  - CreatedAt (datetime) --
    
    The timestamp when the router input was created.
  - UpdatedAt (datetime) --
    
    The timestamp when the router input was last updated.
  - Messages (list) --
    
    The messages associated with the router input.
    - (dict) --
      
      A message associated with a router input, including a code and a message.
      - Code (string) --
        
        The code associated with the router input message.
      - Message (string) --
        
        The message text associated with the router input message.
  - TransitEncryption (dict) --
    
    The transit encryption settings for a router input.
    - EncryptionKeyType (string) --
      
      Specifies the type of encryption key to use for transit encryption.
    - EncryptionKeyConfiguration (dict) --
      
      Contains the configuration details for the encryption key used in transit encryption, including the key source and associated parameters.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - SecretsManager (dict) --
        
        The configuration settings for transit encryption using 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.
  - Tags (dict) --
    
    Key-value pairs that can be used to tag and organize this router input.
    - (string) --
      - (string) --
  - StreamDetails (dict) --
    
    Configuration details for the router input stream.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: DestinationEndpoint, Standard, MediaLiveChannel, Failover, MediaConnectFlow, Merge. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - DestinationEndpoint (dict) --
      
      Configuration details for a router input stream that is represented by a destination endpoint.
    - Standard (dict) --
      
      Configuration details for a standard router input stream type.
      - SourceIpAddress (string) --
        
        The source IP address for the standard router input stream.
    - MediaLiveChannel (dict) --
      
      Configuration details for a MediaLive channel when used as a router input source.
    - Failover (dict) --
      
      Configuration details for a failover router input that can automatically switch between two sources.
      - SourceIndexZeroStreamDetails (dict) --
        
        Configuration details for the primary source (index 0) in the failover setup.
        
        SourceIndex (integer) --
        
        The index number (0 or 1) assigned to this source in the failover configuration.
        
        SourceIpAddress (string) --
        
        The IP address of the source for this indexed stream.
      - SourceIndexOneStreamDetails (dict) --
        
        Configuration details for the secondary source (index 1) in the failover setup.
        
        SourceIndex (integer) --
        
        The index number (0 or 1) assigned to this source in the failover configuration.
        
        SourceIpAddress (string) --
        
        The IP address of the source for this indexed stream.
    - MediaConnectFlow (dict) --
      
      Configuration details for a MediaConnect flow when used as a router input source.
    - Merge (dict) --
      
      Configuration details for a merge router input that combines two input sources.
      - SourceIndexZeroStreamDetails (dict) --
        
        Configuration details for the first source (index 0) in the merge setup.
        
        SourceIndex (integer) --
        
        The index number (0 or 1) assigned to this source in the merge configuration.
        
        SourceIpAddress (string) --
        
        The IP address of the source for this indexed stream in the merge setup.
      - SourceIndexOneStreamDetails (dict) --
        
        Configuration details for the second source (index 1) in the merge setup.
        
        SourceIndex (integer) --
        
        The index number (0 or 1) assigned to this source in the merge configuration.
        
        SourceIpAddress (string) --
        
        The IP address of the source for this indexed stream in the merge setup.
  - IpAddress (string) --
    
    The IP address of the router input.
  - MaintenanceType (string) --
    
    The type of maintenance configuration applied to this router input.
  - MaintenanceConfiguration (dict) --
    
    The maintenance configuration settings applied to this router input.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: PreferredDayTime, Default. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - PreferredDayTime (dict) --
      
      Preferred day and time maintenance configuration settings.
      - Day (string) --
        
        The preferred day for maintenance operations.
      - Time (string) --
        
        The preferred time for maintenance operations.
    - Default (dict) --
      
      Default maintenance configuration settings.
  - MaintenanceScheduleType (string) --
    
    The type of maintenance schedule currently in effect for this router input.
  - MaintenanceSchedule (dict) --
    
    The current maintenance schedule details for this router input.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Window. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Window (dict) --
      
      Defines a specific time window for maintenance operations.
      - Start (datetime) --
        
        The start time of the maintenance window.
      - End (datetime) --
        
        The end time of the maintenance window.
      - ScheduledTime (datetime) --
        
        The date and time when the maintenance window is scheduled to occur.
  - ContentQualityAnalysisType (string) --
    
    The type of content quality analysis applied to the router input.
  - ContentQualityAnalysisConfiguration (dict) --
    
    The content quality analysis configuration for the router input.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: ContentLevel. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - ContentLevel (dict) --
      
      The content quality analysis configuration.
      - BlackFrames (dict) --
        
        Settings for black frames detection.
        
        State (string) --
        
        Indicates whether black frames detection is enabled or disabled.
        
        ThresholdSeconds (integer) --
        
        The number of consecutive seconds of black frames that MediaConnect must detect before it reports an issue.
      - FrozenFrames (dict) --
        
        Settings for frozen frames detection.
        
        State (string) --
        
        Indicates whether frozen frames detection is enabled or disabled.
        
        ThresholdSeconds (integer) --
        
        The number of consecutive seconds of a frozen frame that MediaConnect must detect before it reports an issue.
      - SilentAudio (dict) --
        
        Settings for silent audio detection.
        
        State (string) --
        
        Indicates whether silent audio detection is enabled or disabled.
        
        ThresholdSeconds (integer) --
        
        The number of consecutive seconds of silence that MediaConnect must detect before it reports an issue.
  - AssociatedDestinationEndpointArns (list) --
    
    The Amazon Resource Names (ARNs) of one or more destination endpoints that are associated with this router input.
    - (string) --

CreateRouterOutput (updated)

Link ¶
Changes (request, response)
Request

{'Configuration': {'SourceEndpoint': {'DestinationTransitEncryption': {'Automatic': {},
                                                                       'SecretsManager': {'EncryptionSecret': {'SecretArn': 'string'},
                                                                                          'EncryptionSecretType': 'AES_128_KEY '
                                                                                                                  '| '
                                                                                                                  'AES_192_KEY '
                                                                                                                  '| '
                                                                                                                  'AES_256_KEY '
                                                                                                                  '| '
                                                                                                                  'SRT_PASSPHRASE'}},
                                      'DestinationTransitEncryptionType': 'SECRETS_MANAGER '
                                                                          '| '
                                                                          'AUTOMATIC',
                                      'EndpointLifecycleManagement': 'MANAGED '
                                                                     '| '
                                                                     'UNMANAGED'}}}

Response

{'RouterOutput': {'AssociatedSourceEndpointArns': ['string'],
                  'Configuration': {'SourceEndpoint': {'DestinationTransitEncryption': {'Automatic': {},
                                                                                        'SecretsManager': {'EncryptionSecret': {'SecretArn': 'string'},
                                                                                                           'EncryptionSecretType': 'AES_128_KEY '
                                                                                                                                   '| '
                                                                                                                                   'AES_192_KEY '
                                                                                                                                   '| '
                                                                                                                                   'AES_256_KEY '
                                                                                                                                   '| '
                                                                                                                                   'SRT_PASSPHRASE'}},
                                                       'DestinationTransitEncryptionType': 'SECRETS_MANAGER '
                                                                                           '| '
                                                                                           'AUTOMATIC',
                                                       'EndpointLifecycleManagement': 'MANAGED '
                                                                                      '| '
                                                                                      'UNMANAGED'}},
                  'OutputType': {'SOURCE_ENDPOINT'},
                  'StreamDetails': {'SourceEndpoint': {}}}}

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'
                        }
                    }
                },
                'RtmpPush': {
                    'DestinationAddress': 'string',
                    'DestinationPort': 123,
                    'ApplicationName': 'string',
                    'StreamName': 'string',
                    'TlsEncryption': {
                        'EncryptionType': 'PUBLIC',
                        'EncryptionConfiguration': {
                            'Public': {}

                        }
                    }
                },
                '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'|'RTMP_PUSH'
        },
        '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': {}

                }
            }
        },
        'SourceEndpoint': {
            'EndpointLifecycleManagement': 'MANAGED'|'UNMANAGED',
            'DestinationTransitEncryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
            'DestinationTransitEncryption': {
                'SecretsManager': {
                    'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                    'EncryptionSecret': {
                        'SecretArn': 'string'
                    }
                },
                'Automatic': {}

            }
        }
    },
    MaximumBitrate=123,
    RoutingScope='REGIONAL'|'GLOBAL',
    Tier='OUTPUT_100'|'OUTPUT_50'|'OUTPUT_20'|'OUTPUT_500'|'OUTPUT_250',
    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.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: Rist, SrtListener, RtmpPush, SrtCaller, Rtp.
  - 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.
  - RtmpPush (dict) --
    
    The configuration settings for a router output that pushes a stream to a destination using the RTMP (Real-Time Messaging Protocol) protocol, or RTMPS (RTMP over TLS) when TLS encryption is specified. These settings include the destination address and port, the application and stream names, and optional TLS encryption configuration.
    - DestinationAddress (string) -- [REQUIRED]
      
      The IP address or hostname of the destination RTMP server that the router output pushes the stream to. Provide only the server address; specify the application and stream names separately.
    - DestinationPort (integer) -- [REQUIRED]
      
      The TCP port on the destination RTMP server. For RTMP, valid values range from 1024 to 65535. For RTMPS (RTMP over TLS), valid values are 443 or 1024 to 65535. RTMP typically uses port 1935, and RTMPS typically uses port 443.
    - ApplicationName (string) -- [REQUIRED]
      
      The name of the RTMP application on the destination server. Together with the stream name, the application name forms the RTMP URL path, in the pattern rtmp://destinationAddress/applicationName/streamName.
    - StreamName (string) -- [REQUIRED]
      
      The name of the RTMP stream that the output publishes to the destination application. The stream name forms the final segment of the RTMP URL path.
    - TlsEncryption (dict) --
      
      The TLS encryption settings for the output. When you specify these settings, the output uses RTMPS (RTMP over TLS) to establish a secure, encrypted connection to the destination server.
      - EncryptionType (string) --
        
        The type of TLS encryption to use for the connection.
      - EncryptionConfiguration (dict) -- [REQUIRED]
        
        The configuration settings for the specified TLS encryption type.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys can be set: Public.
        
        Public (dict) --
        
        The TLS encryption configuration that validates the destination by using a publicly trusted certificate authority.
  - 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.

To connect the router output to the flow source, provide both flowArn and flowSourceArn. To disconnect it, call the update operation and omit both fields while keeping this configuration object.

Note

You can't change destinationTransitEncryption while the router output is connected to a flow source. To change it, first disconnect the router output, then update the encryption.
- 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.
    
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.
    - 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.

To connect the router output to the MediaLive input, provide both mediaLiveInputArn and mediaLivePipelineId. To disconnect it, call the update operation and omit both fields while keeping this configuration object.

Note

You can't change destinationTransitEncryption while the router output is connected to a MediaLive input. To change it, first disconnect the router output, then update the encryption.
- 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.
    
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.
    - 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.
SourceEndpoint (dict) --

Configuration settings for a router output that is represented by a source endpoint.
- EndpointLifecycleManagement (string) -- [REQUIRED]
  
  The entity that manages the lifecycle of the associated source endpoint. Valid values include the following:
  - MANAGED – MediaConnect manages the lifecycle of the associated source endpoint.
  - UNMANAGED – You manage the lifecycle of the associated source endpoint.
- DestinationTransitEncryptionType (string) --
  
  The type of transit encryption applied to the destination content that this router output sends. Valid values include the following:
  - SECRETS_MANAGER – The encryption key or passphrase is stored in Secrets Manager.
  - AUTOMATIC – MediaConnect determines the encryption key when the endpoint connects.
- DestinationTransitEncryption (dict) -- [REQUIRED]
  
  The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.
  - SecretsManager (dict) --
    
    The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
    - EncryptionSecretType (string) --
      
      The type of secret used to encrypt the connection. Valid values include the following:
      - AES_128_KEY – A 128-bit AES encryption key.
      - AES_192_KEY – A 192-bit AES encryption key.
      - AES_256_KEY – A 256-bit AES encryption key.
      - SRT_PASSPHRASE – An SRT passphrase.
    - EncryptionSecret (dict) -- [REQUIRED]
      
      The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
      - SecretArn (string) -- [REQUIRED]
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
  - Automatic (dict) --
    
    The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.

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. The tier sets the maximum bitrate, in Mbps, for the router output. Valid values include the following:

OUTPUT_20 – 20 Mbps
OUTPUT_50 – 50 Mbps
OUTPUT_100 – 100 Mbps
OUTPUT_250 – 250 Mbps
OUTPUT_500 – 500 Mbps

The 250 Mbps and 500 Mbps tiers are high-bitrate tiers that support TR-07 (JPEG XS) workflows.

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'|'SOURCE_ENDPOINT',
        'Configuration': {
            'Standard': {
                'NetworkInterfaceArn': 'string',
                'ProtocolConfiguration': {
                    'Rist': {
                        'DestinationAddress': 'string',
                        'DestinationPort': 123
                    },
                    'SrtListener': {
                        'Port': 123,
                        'MinimumLatencyMilliseconds': 123,
                        'EncryptionConfiguration': {
                            'EncryptionKey': {
                                'SecretArn': 'string',
                                'RoleArn': 'string'
                            }
                        }
                    },
                    'RtmpPush': {
                        'DestinationAddress': 'string',
                        'DestinationPort': 123,
                        'ApplicationName': 'string',
                        'StreamName': 'string',
                        'TlsEncryption': {
                            'EncryptionType': 'PUBLIC',
                            'EncryptionConfiguration': {
                                'Public': {}
                            }
                        }
                    },
                    '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'|'RTMP_PUSH'
            },
            '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': {}
                    }
                }
            },
            'SourceEndpoint': {
                'EndpointLifecycleManagement': 'MANAGED'|'UNMANAGED',
                'DestinationTransitEncryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                'DestinationTransitEncryption': {
                    'SecretsManager': {
                        'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                        'EncryptionSecret': {
                            'SecretArn': 'string'
                        }
                    },
                    'Automatic': {}
                }
            }
        },
        'RoutedState': 'ROUTED'|'ROUTING'|'UNROUTED',
        'RegionName': 'string',
        'AvailabilityZone': 'string',
        'MaximumBitrate': 123,
        'RoutingScope': 'REGIONAL'|'GLOBAL',
        'Tier': 'OUTPUT_100'|'OUTPUT_50'|'OUTPUT_20'|'OUTPUT_500'|'OUTPUT_250',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'Messages': [
            {
                'Code': 'string',
                'Message': 'string'
            },
        ],
        'Tags': {
            'string': 'string'
        },
        'StreamDetails': {
            'Standard': {
                'DestinationIpAddress': 'string'
            },
            'MediaConnectFlow': {},
            'MediaLiveInput': {},
            'SourceEndpoint': {}
        },
        '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'
        },
        'AssociatedSourceEndpointArns': [
            'string',
        ]
    }
}

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.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, MediaConnectFlow, MediaLiveInput, SourceEndpoint. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The configuration settings for a standard router output, including the protocol, protocol-specific configuration, network interface, and availability zone.
      - NetworkInterfaceArn (string) --
        
        The Amazon Resource Name (ARN) of the network interface associated with the standard router output.
      - ProtocolConfiguration (dict) --
        
        The configuration settings for the protocol used by the standard router output.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rist, SrtListener, RtmpPush, SrtCaller, Rtp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        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.
        
        RtmpPush (dict) --
        
        The configuration settings for a router output that pushes a stream to a destination using the RTMP (Real-Time Messaging Protocol) protocol, or RTMPS (RTMP over TLS) when TLS encryption is specified. These settings include the destination address and port, the application and stream names, and optional TLS encryption configuration.
        
        DestinationAddress (string) --
        
        The IP address or hostname of the destination RTMP server that the router output pushes the stream to. Provide only the server address; specify the application and stream names separately.
        
        DestinationPort (integer) --
        
        The TCP port on the destination RTMP server. For RTMP, valid values range from 1024 to 65535. For RTMPS (RTMP over TLS), valid values are 443 or 1024 to 65535. RTMP typically uses port 1935, and RTMPS typically uses port 443.
        
        ApplicationName (string) --
        
        The name of the RTMP application on the destination server. Together with the stream name, the application name forms the RTMP URL path, in the pattern rtmp://destinationAddress/applicationName/streamName.
        
        StreamName (string) --
        
        The name of the RTMP stream that the output publishes to the destination application. The stream name forms the final segment of the RTMP URL path.
        
        TlsEncryption (dict) --
        
        The TLS encryption settings for the output. When you specify these settings, the output uses RTMPS (RTMP over TLS) to establish a secure, encrypted connection to the destination server.
        
        EncryptionType (string) --
        
        The type of TLS encryption to use for the connection.
        
        EncryptionConfiguration (dict) --
        
        The configuration settings for the specified TLS encryption type.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Public. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Public (dict) --
        
        The TLS encryption configuration that validates the destination by using a publicly trusted certificate authority.
        
        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.
      
      To connect the router output to the flow source, provide both flowArn and flowSourceArn. To disconnect it, call the update operation and omit both fields while keeping this configuration object.
      
      Note
      
      You can't change destinationTransitEncryption while the router output is connected to a flow source. To change it, first disconnect the router output, then update the encryption.
      - FlowArn (string) --
        
        The ARN of the flow to connect to this router output.
      - FlowSourceArn (string) --
        
        The ARN of the flow source to connect to this router output.
      - DestinationTransitEncryption (dict) --
        
        The encryption configuration for the flow destination when connected to this router output.
        
        EncryptionKeyType (string) --
        
        The type of encryption key to use for flow transit encryption.
        
        EncryptionKeyConfiguration (dict) --
        
        The configuration details for the encryption key.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The configuration settings for transit encryption using 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.
      
      To connect the router output to the MediaLive input, provide both mediaLiveInputArn and mediaLivePipelineId. To disconnect it, call the update operation and omit both fields while keeping this configuration object.
      
      Note
      
      You can't change destinationTransitEncryption while the router output is connected to a MediaLive input. To change it, first disconnect the router output, then update the encryption.
      - MediaLiveInputArn (string) --
        
        The ARN of the MediaLive input to connect to this router output.
      - MediaLivePipelineId (string) --
        
        The index of the MediaLive pipeline to connect to this router output.
      - DestinationTransitEncryption (dict) --
        
        The encryption configuration for the MediaLive input when connected to this router output.
        
        EncryptionKeyType (string) --
        
        The type of encryption key to use for MediaLive transit encryption.
        
        EncryptionKeyConfiguration (dict) --
        
        The configuration details for the MediaLive encryption key.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The configuration settings for transit encryption using 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.
    - SourceEndpoint (dict) --
      
      Configuration settings for a router output that is represented by a source endpoint.
      - EndpointLifecycleManagement (string) --
        
        The entity that manages the lifecycle of the associated source endpoint. Valid values include the following:
        
        MANAGED – MediaConnect manages the lifecycle of the associated source endpoint.
        
        UNMANAGED – You manage the lifecycle of the associated source endpoint.
      - DestinationTransitEncryptionType (string) --
        
        The type of transit encryption applied to the destination content that this router output sends. Valid values include the following:
        
        SECRETS_MANAGER – The encryption key or passphrase is stored in Secrets Manager.
        
        AUTOMATIC – MediaConnect determines the encryption key when the endpoint connects.
      - DestinationTransitEncryption (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
  - 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 for the router output. The tier sets the maximum bitrate, in Mbps, for the router output. Valid values include the following:
    - OUTPUT_20 – 20 Mbps
    - OUTPUT_50 – 50 Mbps
    - OUTPUT_100 – 100 Mbps
    - OUTPUT_250 – 250 Mbps
    - OUTPUT_500 – 500 Mbps
    The 250 Mbps and 500 Mbps tiers are high-bitrate tiers that support TR-07 (JPEG XS) workflows.
  - CreatedAt (datetime) --
    
    The timestamp when the router output was created.
  - UpdatedAt (datetime) --
    
    The timestamp when the router output was last updated.
  - Messages (list) --
    
    The messages associated with the router output.
    - (dict) --
      
      A message associated with a router output.
      - Code (string) --
        
        The code associated with the router output message.
      - Message (string) --
        
        The message text associated with the router output message.
  - Tags (dict) --
    
    Key-value pairs that can be used to tag and organize this router output.
    - (string) --
      - (string) --
  - StreamDetails (dict) --
    
    Information about the router output's stream, including connection state and destination details. The specific details provided vary based on the router output type.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, MediaConnectFlow, MediaLiveInput, SourceEndpoint. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      Configuration details for a standard router output stream type. Contains information about the destination IP address and connection state for basic output routing.
      - DestinationIpAddress (string) --
        
        The IP address where the output stream will be sent. This is the destination address that will receive the routed media content.
    - MediaConnectFlow (dict) --
      
      Configuration details for a MediaConnect flow when used as a router output destination.
    - MediaLiveInput (dict) --
      
      Configuration details for a MediaLive input when used as a router output destination.
    - SourceEndpoint (dict) --
      
      Configuration details for a router output stream that is represented by a source endpoint.
  - IpAddress (string) --
    
    The IP address of the router output.
  - RoutedInputArn (string) --
    
    The Amazon Resource Name (ARN) of the router input associated with the output.
  - MaintenanceType (string) --
    
    The type of maintenance configuration applied to this router output.
  - MaintenanceConfiguration (dict) --
    
    The maintenance configuration settings applied to this router output.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: PreferredDayTime, Default. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - PreferredDayTime (dict) --
      
      Preferred day and time maintenance configuration settings.
      - Day (string) --
        
        The preferred day for maintenance operations.
      - Time (string) --
        
        The preferred time for maintenance operations.
    - Default (dict) --
      
      Default maintenance configuration settings.
  - MaintenanceScheduleType (string) --
    
    The type of maintenance schedule currently in effect for this router output.
  - MaintenanceSchedule (dict) --
    
    The current maintenance schedule details for this router output.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Window. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Window (dict) --
      
      Defines a specific time window for maintenance operations.
      - Start (datetime) --
        
        The start time of the maintenance window.
      - End (datetime) --
        
        The end time of the maintenance window.
      - ScheduledTime (datetime) --
        
        The date and time when the maintenance window is scheduled to occur.
  - 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.
  - AssociatedSourceEndpointArns (list) --
    
    The Amazon Resource Names (ARNs) of one or more source endpoints that are associated with this router output.
    - (string) --

GetRouterInput (updated)

Link ¶
Changes (response)

{'RouterInput': {'AssociatedDestinationEndpointArns': ['string'],
                 'Configuration': {'DestinationEndpoint': {'EndpointLifecycleManagement': 'MANAGED '
                                                                                          '| '
                                                                                          'UNMANAGED',
                                                           'SourceTransitDecryption': {'Automatic': {},
                                                                                       'SecretsManager': {'EncryptionSecret': {'SecretArn': 'string'},
                                                                                                          'EncryptionSecretType': 'AES_128_KEY '
                                                                                                                                  '| '
                                                                                                                                  'AES_192_KEY '
                                                                                                                                  '| '
                                                                                                                                  'AES_256_KEY '
                                                                                                                                  '| '
                                                                                                                                  'SRT_PASSPHRASE'}},
                                                           'SourceTransitDecryptionType': 'SECRETS_MANAGER '
                                                                                          '| '
                                                                                          'AUTOMATIC'}},
                 'InputType': {'DESTINATION_ENDPOINT'},
                 'StreamDetails': {'DestinationEndpoint': {}}}}

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

See also: AWS API Documentation

Request Syntax

client.get_router_input(
    Arn='string'
)

type Arn:

string

param Arn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --
- RouterInput (dict) --
  
  The details of the requested router input, including its configuration, state, and other attributes.
  - Name (string) --
    
    The name of the router input.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of the router input.
  - Id (string) --
    
    The unique identifier of the router input.
  - State (string) --
    
    The current state of the router input.
  - InputType (string) --
    
    The type of the router input.
  - Configuration (dict) --
    
    The configuration settings for a router input.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: DestinationEndpoint, Standard, MediaLiveChannel, Failover, MediaConnectFlow, Merge. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - DestinationEndpoint (dict) --
      
      Configuration settings for a router input that is represented by a destination endpoint.
      - EndpointLifecycleManagement (string) --
        
        The entity that manages the lifecycle of the associated destination endpoint. Valid values include the following:
        
        MANAGED – MediaConnect manages the lifecycle of the associated destination endpoint.
        
        UNMANAGED – You manage the lifecycle of the associated destination endpoint.
      - SourceTransitDecryptionType (string) --
        
        The type of transit decryption applied to the source content that this router input receives. Valid values include the following:
        
        SECRETS_MANAGER – The decryption key or passphrase is stored in Secrets Manager.
        
        AUTOMATIC – MediaConnect determines the decryption key when the endpoint connects.
      - SourceTransitDecryption (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
    - Standard (dict) --
      
      The configuration settings for a standard router input, including the protocol, protocol-specific configuration, network interface, and availability zone.
      - NetworkInterfaceArn (string) --
        
        The Amazon Resource Name (ARN) of the network interface associated with the standard router input.
      - ProtocolConfiguration (dict) --
        
        The configuration settings for the protocol used by the standard router input.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rist, SrtListener, SrtCaller, Rtp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Rist (dict) --
        
        The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
        
        Port (integer) --
        
        The port number used for the RIST protocol in the router input configuration.
        
        RecoveryLatencyMilliseconds (integer) --
        
        The recovery latency in milliseconds for the RIST protocol in the router input configuration.
        
        SrtListener (dict) --
        
        The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
        
        Port (integer) --
        
        The port number for the SRT protocol in listener mode.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency in milliseconds for the SRT protocol in listener mode.
        
        DecryptionConfiguration (dict) --
        
        Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
        
        EncryptionKey (dict) --
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) --
        
        The ARN of the 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 input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
        
        SourceAddress (string) --
        
        The source IP address for the SRT protocol in caller mode.
        
        SourcePort (integer) --
        
        The source port number for the SRT protocol in caller mode.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency in milliseconds for the SRT protocol in caller mode.
        
        StreamId (string) --
        
        The stream ID for the SRT protocol in caller mode.
        
        DecryptionConfiguration (dict) --
        
        Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
        
        EncryptionKey (dict) --
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) --
        
        The ARN of the 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 Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
        
        Port (integer) --
        
        The port number used for the RTP protocol in the router input configuration.
        
        ForwardErrorCorrection (string) --
        
        The state of forward error correction for the RTP protocol in the router input configuration.
      - Protocol (string) --
        
        The protocol used by the standard router input.
    - MediaLiveChannel (dict) --
      
      Configuration settings for connecting a router input to a MediaLive channel output.
      
      To connect the router input to the MediaLive channel output, provide all three of mediaLiveChannelArn, mediaLivePipelineId, and mediaLiveChannelOutputName. To disconnect it, call the update operation and omit all three fields while keeping this configuration object.
      
      Note
      
      You can't change sourceTransitDecryption while the router input is connected to a MediaLive channel output. To change it, first disconnect the router input, then update the decryption.
      - MediaLiveChannelArn (string) --
        
        The ARN of the MediaLive channel to connect to this router input.
      - MediaLivePipelineId (string) --
        
        The index of the MediaLive pipeline to connect to this router input.
      - MediaLiveChannelOutputName (string) --
        
        The name of the MediaLive channel output to connect to this router input.
      - SourceTransitDecryption (dict) --
        
        The encryption configuration that defines how content is encrypted during transit between MediaConnect Router and MediaLive. This configuration determines whether encryption keys are automatically managed by the service or manually managed through Secrets Manager.
        
        EncryptionKeyType (string) --
        
        The type of encryption key to use for MediaLive transit encryption.
        
        EncryptionKeyConfiguration (dict) --
        
        The configuration details for the MediaLive encryption key.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The configuration settings for transit encryption using 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.
    - Failover (dict) --
      
      Configuration settings for a failover router input that allows switching between two input sources.
      - NetworkInterfaceArn (string) --
        
        The ARN of the network interface to use for this failover router input.
      - ProtocolConfigurations (list) --
        
        A list of exactly two protocol configurations for the failover input sources. Both must use the same protocol type.
        
        (dict) --
        
        Protocol configuration settings for failover router inputs.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rist, SrtListener, SrtCaller, Rtp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Rist (dict) --
        
        The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
        
        Port (integer) --
        
        The port number used for the RIST protocol in the router input configuration.
        
        RecoveryLatencyMilliseconds (integer) --
        
        The recovery latency in milliseconds for the RIST protocol in the router input configuration.
        
        SrtListener (dict) --
        
        The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
        
        Port (integer) --
        
        The port number for the SRT protocol in listener mode.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency in milliseconds for the SRT protocol in listener mode.
        
        DecryptionConfiguration (dict) --
        
        Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
        
        EncryptionKey (dict) --
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) --
        
        The ARN of the 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 input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
        
        SourceAddress (string) --
        
        The source IP address for the SRT protocol in caller mode.
        
        SourcePort (integer) --
        
        The source port number for the SRT protocol in caller mode.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency in milliseconds for the SRT protocol in caller mode.
        
        StreamId (string) --
        
        The stream ID for the SRT protocol in caller mode.
        
        DecryptionConfiguration (dict) --
        
        Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
        
        EncryptionKey (dict) --
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) --
        
        The ARN of the 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 Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
        
        Port (integer) --
        
        The port number used for the RTP protocol in the router input configuration.
        
        ForwardErrorCorrection (string) --
        
        The state of forward error correction for the RTP protocol in the router input configuration.
      - SourcePriorityMode (string) --
        
        The mode for determining source priority in failover configurations.
      - PrimarySourceIndex (integer) --
        
        The index (0 or 1) that specifies which source in the protocol configurations list is currently active. Used to control which of the two failover sources is currently selected. This field is ignored when sourcePriorityMode is set to NO_PRIORITY
    - MediaConnectFlow (dict) --
      
      Configuration settings for connecting a router input to a flow output.
      
      To connect the router input to the flow output, provide both flowArn and flowOutputArn. To disconnect it, call the update operation and omit both fields while keeping this configuration object.
      
      Note
      
      You can't change sourceTransitDecryption while the router input is connected to a flow output. To change it, first disconnect the router input, then update the decryption.
      - FlowArn (string) --
        
        The ARN of the flow to connect to.
      - FlowOutputArn (string) --
        
        The ARN of the flow output to connect to this router input.
      - SourceTransitDecryption (dict) --
        
        The decryption configuration for the flow source when connected to this router input.
        
        EncryptionKeyType (string) --
        
        The type of encryption key to use for flow transit encryption.
        
        EncryptionKeyConfiguration (dict) --
        
        The configuration details for the encryption key.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The configuration settings for transit encryption using 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.
    - Merge (dict) --
      
      Configuration settings for a merge router input that combines two input sources.
      - NetworkInterfaceArn (string) --
        
        The ARN of the network interface to use for this merge router input.
      - ProtocolConfigurations (list) --
        
        A list of exactly two protocol configurations for the merge input sources. Both must use the same protocol type.
        
        (dict) --
        
        Protocol configuration settings for merge router inputs.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rtp, Rist. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Rtp (dict) --
        
        The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
        
        Port (integer) --
        
        The port number used for the RTP protocol in the router input configuration.
        
        ForwardErrorCorrection (string) --
        
        The state of forward error correction for the RTP protocol in the router input configuration.
        
        Rist (dict) --
        
        The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
        
        Port (integer) --
        
        The port number used for the RIST protocol in the router input configuration.
        
        RecoveryLatencyMilliseconds (integer) --
        
        The recovery latency in milliseconds for the RIST protocol in the router input configuration.
      - MergeRecoveryWindowMilliseconds (integer) --
        
        The time window in milliseconds for merging the two input sources.
  - RoutedOutputs (integer) --
    
    The number of router outputs associated with the router input.
  - MaximumRoutedOutputs (integer) --
    
    The maximum number of outputs that can be simultaneously routed to this input.
  - RegionName (string) --
    
    The Amazon Web Services Region where the router input is located.
  - AvailabilityZone (string) --
    
    The Availability Zone of the router input.
  - MaximumBitrate (integer) --
    
    The maximum bitrate for the router input.
  - Tier (string) --
    
    The tier level for the router input. The tier sets the maximum bitrate, in Mbps, for the router input. Valid values include the following:
    - INPUT_20 – 20 Mbps
    - INPUT_50 – 50 Mbps
    - INPUT_100 – 100 Mbps
    - INPUT_250 – 250 Mbps
    - INPUT_500 – 500 Mbps
    The 250 Mbps and 500 Mbps tiers are high-bitrate tiers that support TR-07 (JPEG XS) workflows.
  - RoutingScope (string) --
    
    Indicates whether the router input is configured for Regional or global routing.
  - CreatedAt (datetime) --
    
    The timestamp when the router input was created.
  - UpdatedAt (datetime) --
    
    The timestamp when the router input was last updated.
  - Messages (list) --
    
    The messages associated with the router input.
    - (dict) --
      
      A message associated with a router input, including a code and a message.
      - Code (string) --
        
        The code associated with the router input message.
      - Message (string) --
        
        The message text associated with the router input message.
  - TransitEncryption (dict) --
    
    The transit encryption settings for a router input.
    - EncryptionKeyType (string) --
      
      Specifies the type of encryption key to use for transit encryption.
    - EncryptionKeyConfiguration (dict) --
      
      Contains the configuration details for the encryption key used in transit encryption, including the key source and associated parameters.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - SecretsManager (dict) --
        
        The configuration settings for transit encryption using 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.
  - Tags (dict) --
    
    Key-value pairs that can be used to tag and organize this router input.
    - (string) --
      - (string) --
  - StreamDetails (dict) --
    
    Configuration details for the router input stream.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: DestinationEndpoint, Standard, MediaLiveChannel, Failover, MediaConnectFlow, Merge. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - DestinationEndpoint (dict) --
      
      Configuration details for a router input stream that is represented by a destination endpoint.
    - Standard (dict) --
      
      Configuration details for a standard router input stream type.
      - SourceIpAddress (string) --
        
        The source IP address for the standard router input stream.
    - MediaLiveChannel (dict) --
      
      Configuration details for a MediaLive channel when used as a router input source.
    - Failover (dict) --
      
      Configuration details for a failover router input that can automatically switch between two sources.
      - SourceIndexZeroStreamDetails (dict) --
        
        Configuration details for the primary source (index 0) in the failover setup.
        
        SourceIndex (integer) --
        
        The index number (0 or 1) assigned to this source in the failover configuration.
        
        SourceIpAddress (string) --
        
        The IP address of the source for this indexed stream.
      - SourceIndexOneStreamDetails (dict) --
        
        Configuration details for the secondary source (index 1) in the failover setup.
        
        SourceIndex (integer) --
        
        The index number (0 or 1) assigned to this source in the failover configuration.
        
        SourceIpAddress (string) --
        
        The IP address of the source for this indexed stream.
    - MediaConnectFlow (dict) --
      
      Configuration details for a MediaConnect flow when used as a router input source.
    - Merge (dict) --
      
      Configuration details for a merge router input that combines two input sources.
      - SourceIndexZeroStreamDetails (dict) --
        
        Configuration details for the first source (index 0) in the merge setup.
        
        SourceIndex (integer) --
        
        The index number (0 or 1) assigned to this source in the merge configuration.
        
        SourceIpAddress (string) --
        
        The IP address of the source for this indexed stream in the merge setup.
      - SourceIndexOneStreamDetails (dict) --
        
        Configuration details for the second source (index 1) in the merge setup.
        
        SourceIndex (integer) --
        
        The index number (0 or 1) assigned to this source in the merge configuration.
        
        SourceIpAddress (string) --
        
        The IP address of the source for this indexed stream in the merge setup.
  - IpAddress (string) --
    
    The IP address of the router input.
  - MaintenanceType (string) --
    
    The type of maintenance configuration applied to this router input.
  - MaintenanceConfiguration (dict) --
    
    The maintenance configuration settings applied to this router input.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: PreferredDayTime, Default. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - PreferredDayTime (dict) --
      
      Preferred day and time maintenance configuration settings.
      - Day (string) --
        
        The preferred day for maintenance operations.
      - Time (string) --
        
        The preferred time for maintenance operations.
    - Default (dict) --
      
      Default maintenance configuration settings.
  - MaintenanceScheduleType (string) --
    
    The type of maintenance schedule currently in effect for this router input.
  - MaintenanceSchedule (dict) --
    
    The current maintenance schedule details for this router input.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Window. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Window (dict) --
      
      Defines a specific time window for maintenance operations.
      - Start (datetime) --
        
        The start time of the maintenance window.
      - End (datetime) --
        
        The end time of the maintenance window.
      - ScheduledTime (datetime) --
        
        The date and time when the maintenance window is scheduled to occur.
  - ContentQualityAnalysisType (string) --
    
    The type of content quality analysis applied to the router input.
  - ContentQualityAnalysisConfiguration (dict) --
    
    The content quality analysis configuration for the router input.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: ContentLevel. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - ContentLevel (dict) --
      
      The content quality analysis configuration.
      - BlackFrames (dict) --
        
        Settings for black frames detection.
        
        State (string) --
        
        Indicates whether black frames detection is enabled or disabled.
        
        ThresholdSeconds (integer) --
        
        The number of consecutive seconds of black frames that MediaConnect must detect before it reports an issue.
      - FrozenFrames (dict) --
        
        Settings for frozen frames detection.
        
        State (string) --
        
        Indicates whether frozen frames detection is enabled or disabled.
        
        ThresholdSeconds (integer) --
        
        The number of consecutive seconds of a frozen frame that MediaConnect must detect before it reports an issue.
      - SilentAudio (dict) --
        
        Settings for silent audio detection.
        
        State (string) --
        
        Indicates whether silent audio detection is enabled or disabled.
        
        ThresholdSeconds (integer) --
        
        The number of consecutive seconds of silence that MediaConnect must detect before it reports an issue.
  - AssociatedDestinationEndpointArns (list) --
    
    The Amazon Resource Names (ARNs) of one or more destination endpoints that are associated with this router input.
    - (string) --

GetRouterOutput (updated)

Link ¶
Changes (response)

{'RouterOutput': {'AssociatedSourceEndpointArns': ['string'],
                  'Configuration': {'SourceEndpoint': {'DestinationTransitEncryption': {'Automatic': {},
                                                                                        'SecretsManager': {'EncryptionSecret': {'SecretArn': 'string'},
                                                                                                           'EncryptionSecretType': 'AES_128_KEY '
                                                                                                                                   '| '
                                                                                                                                   'AES_192_KEY '
                                                                                                                                   '| '
                                                                                                                                   'AES_256_KEY '
                                                                                                                                   '| '
                                                                                                                                   'SRT_PASSPHRASE'}},
                                                       'DestinationTransitEncryptionType': 'SECRETS_MANAGER '
                                                                                           '| '
                                                                                           'AUTOMATIC',
                                                       'EndpointLifecycleManagement': 'MANAGED '
                                                                                      '| '
                                                                                      'UNMANAGED'}},
                  'OutputType': {'SOURCE_ENDPOINT'},
                  'StreamDetails': {'SourceEndpoint': {}}}}

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'|'SOURCE_ENDPOINT',
        'Configuration': {
            'Standard': {
                'NetworkInterfaceArn': 'string',
                'ProtocolConfiguration': {
                    'Rist': {
                        'DestinationAddress': 'string',
                        'DestinationPort': 123
                    },
                    'SrtListener': {
                        'Port': 123,
                        'MinimumLatencyMilliseconds': 123,
                        'EncryptionConfiguration': {
                            'EncryptionKey': {
                                'SecretArn': 'string',
                                'RoleArn': 'string'
                            }
                        }
                    },
                    'RtmpPush': {
                        'DestinationAddress': 'string',
                        'DestinationPort': 123,
                        'ApplicationName': 'string',
                        'StreamName': 'string',
                        'TlsEncryption': {
                            'EncryptionType': 'PUBLIC',
                            'EncryptionConfiguration': {
                                'Public': {}
                            }
                        }
                    },
                    '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'|'RTMP_PUSH'
            },
            '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': {}
                    }
                }
            },
            'SourceEndpoint': {
                'EndpointLifecycleManagement': 'MANAGED'|'UNMANAGED',
                'DestinationTransitEncryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                'DestinationTransitEncryption': {
                    'SecretsManager': {
                        'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                        'EncryptionSecret': {
                            'SecretArn': 'string'
                        }
                    },
                    'Automatic': {}
                }
            }
        },
        'RoutedState': 'ROUTED'|'ROUTING'|'UNROUTED',
        'RegionName': 'string',
        'AvailabilityZone': 'string',
        'MaximumBitrate': 123,
        'RoutingScope': 'REGIONAL'|'GLOBAL',
        'Tier': 'OUTPUT_100'|'OUTPUT_50'|'OUTPUT_20'|'OUTPUT_500'|'OUTPUT_250',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'Messages': [
            {
                'Code': 'string',
                'Message': 'string'
            },
        ],
        'Tags': {
            'string': 'string'
        },
        'StreamDetails': {
            'Standard': {
                'DestinationIpAddress': 'string'
            },
            'MediaConnectFlow': {},
            'MediaLiveInput': {},
            'SourceEndpoint': {}
        },
        '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'
        },
        'AssociatedSourceEndpointArns': [
            'string',
        ]
    }
}

Response Structure

(dict) --
- RouterOutput (dict) --
  
  The details of the requested router output, including its configuration, state, and other attributes.
  - Name (string) --
    
    The name of the router output.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of the router output.
  - Id (string) --
    
    The unique identifier of the router output.
  - State (string) --
    
    The overall state of the router output.
  - OutputType (string) --
    
    The type of the router output.
  - Configuration (dict) --
    
    The configuration settings for a router output.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, MediaConnectFlow, MediaLiveInput, SourceEndpoint. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The configuration settings for a standard router output, including the protocol, protocol-specific configuration, network interface, and availability zone.
      - NetworkInterfaceArn (string) --
        
        The Amazon Resource Name (ARN) of the network interface associated with the standard router output.
      - ProtocolConfiguration (dict) --
        
        The configuration settings for the protocol used by the standard router output.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rist, SrtListener, RtmpPush, SrtCaller, Rtp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        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.
        
        RtmpPush (dict) --
        
        The configuration settings for a router output that pushes a stream to a destination using the RTMP (Real-Time Messaging Protocol) protocol, or RTMPS (RTMP over TLS) when TLS encryption is specified. These settings include the destination address and port, the application and stream names, and optional TLS encryption configuration.
        
        DestinationAddress (string) --
        
        The IP address or hostname of the destination RTMP server that the router output pushes the stream to. Provide only the server address; specify the application and stream names separately.
        
        DestinationPort (integer) --
        
        The TCP port on the destination RTMP server. For RTMP, valid values range from 1024 to 65535. For RTMPS (RTMP over TLS), valid values are 443 or 1024 to 65535. RTMP typically uses port 1935, and RTMPS typically uses port 443.
        
        ApplicationName (string) --
        
        The name of the RTMP application on the destination server. Together with the stream name, the application name forms the RTMP URL path, in the pattern rtmp://destinationAddress/applicationName/streamName.
        
        StreamName (string) --
        
        The name of the RTMP stream that the output publishes to the destination application. The stream name forms the final segment of the RTMP URL path.
        
        TlsEncryption (dict) --
        
        The TLS encryption settings for the output. When you specify these settings, the output uses RTMPS (RTMP over TLS) to establish a secure, encrypted connection to the destination server.
        
        EncryptionType (string) --
        
        The type of TLS encryption to use for the connection.
        
        EncryptionConfiguration (dict) --
        
        The configuration settings for the specified TLS encryption type.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Public. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Public (dict) --
        
        The TLS encryption configuration that validates the destination by using a publicly trusted certificate authority.
        
        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.
      
      To connect the router output to the flow source, provide both flowArn and flowSourceArn. To disconnect it, call the update operation and omit both fields while keeping this configuration object.
      
      Note
      
      You can't change destinationTransitEncryption while the router output is connected to a flow source. To change it, first disconnect the router output, then update the encryption.
      - FlowArn (string) --
        
        The ARN of the flow to connect to this router output.
      - FlowSourceArn (string) --
        
        The ARN of the flow source to connect to this router output.
      - DestinationTransitEncryption (dict) --
        
        The encryption configuration for the flow destination when connected to this router output.
        
        EncryptionKeyType (string) --
        
        The type of encryption key to use for flow transit encryption.
        
        EncryptionKeyConfiguration (dict) --
        
        The configuration details for the encryption key.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The configuration settings for transit encryption using 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.
      
      To connect the router output to the MediaLive input, provide both mediaLiveInputArn and mediaLivePipelineId. To disconnect it, call the update operation and omit both fields while keeping this configuration object.
      
      Note
      
      You can't change destinationTransitEncryption while the router output is connected to a MediaLive input. To change it, first disconnect the router output, then update the encryption.
      - MediaLiveInputArn (string) --
        
        The ARN of the MediaLive input to connect to this router output.
      - MediaLivePipelineId (string) --
        
        The index of the MediaLive pipeline to connect to this router output.
      - DestinationTransitEncryption (dict) --
        
        The encryption configuration for the MediaLive input when connected to this router output.
        
        EncryptionKeyType (string) --
        
        The type of encryption key to use for MediaLive transit encryption.
        
        EncryptionKeyConfiguration (dict) --
        
        The configuration details for the MediaLive encryption key.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The configuration settings for transit encryption using 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.
    - SourceEndpoint (dict) --
      
      Configuration settings for a router output that is represented by a source endpoint.
      - EndpointLifecycleManagement (string) --
        
        The entity that manages the lifecycle of the associated source endpoint. Valid values include the following:
        
        MANAGED – MediaConnect manages the lifecycle of the associated source endpoint.
        
        UNMANAGED – You manage the lifecycle of the associated source endpoint.
      - DestinationTransitEncryptionType (string) --
        
        The type of transit encryption applied to the destination content that this router output sends. Valid values include the following:
        
        SECRETS_MANAGER – The encryption key or passphrase is stored in Secrets Manager.
        
        AUTOMATIC – MediaConnect determines the encryption key when the endpoint connects.
      - DestinationTransitEncryption (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
  - 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 for the router output. The tier sets the maximum bitrate, in Mbps, for the router output. Valid values include the following:
    - OUTPUT_20 – 20 Mbps
    - OUTPUT_50 – 50 Mbps
    - OUTPUT_100 – 100 Mbps
    - OUTPUT_250 – 250 Mbps
    - OUTPUT_500 – 500 Mbps
    The 250 Mbps and 500 Mbps tiers are high-bitrate tiers that support TR-07 (JPEG XS) workflows.
  - CreatedAt (datetime) --
    
    The timestamp when the router output was created.
  - UpdatedAt (datetime) --
    
    The timestamp when the router output was last updated.
  - Messages (list) --
    
    The messages associated with the router output.
    - (dict) --
      
      A message associated with a router output.
      - Code (string) --
        
        The code associated with the router output message.
      - Message (string) --
        
        The message text associated with the router output message.
  - Tags (dict) --
    
    Key-value pairs that can be used to tag and organize this router output.
    - (string) --
      - (string) --
  - StreamDetails (dict) --
    
    Information about the router output's stream, including connection state and destination details. The specific details provided vary based on the router output type.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, MediaConnectFlow, MediaLiveInput, SourceEndpoint. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      Configuration details for a standard router output stream type. Contains information about the destination IP address and connection state for basic output routing.
      - DestinationIpAddress (string) --
        
        The IP address where the output stream will be sent. This is the destination address that will receive the routed media content.
    - MediaConnectFlow (dict) --
      
      Configuration details for a MediaConnect flow when used as a router output destination.
    - MediaLiveInput (dict) --
      
      Configuration details for a MediaLive input when used as a router output destination.
    - SourceEndpoint (dict) --
      
      Configuration details for a router output stream that is represented by a source endpoint.
  - IpAddress (string) --
    
    The IP address of the router output.
  - RoutedInputArn (string) --
    
    The Amazon Resource Name (ARN) of the router input associated with the output.
  - MaintenanceType (string) --
    
    The type of maintenance configuration applied to this router output.
  - MaintenanceConfiguration (dict) --
    
    The maintenance configuration settings applied to this router output.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: PreferredDayTime, Default. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - PreferredDayTime (dict) --
      
      Preferred day and time maintenance configuration settings.
      - Day (string) --
        
        The preferred day for maintenance operations.
      - Time (string) --
        
        The preferred time for maintenance operations.
    - Default (dict) --
      
      Default maintenance configuration settings.
  - MaintenanceScheduleType (string) --
    
    The type of maintenance schedule currently in effect for this router output.
  - MaintenanceSchedule (dict) --
    
    The current maintenance schedule details for this router output.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Window. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Window (dict) --
      
      Defines a specific time window for maintenance operations.
      - Start (datetime) --
        
        The start time of the maintenance window.
      - End (datetime) --
        
        The end time of the maintenance window.
      - ScheduledTime (datetime) --
        
        The date and time when the maintenance window is scheduled to occur.
  - 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.
  - AssociatedSourceEndpointArns (list) --
    
    The Amazon Resource Names (ARNs) of one or more source endpoints that are associated with this router output.
    - (string) --

ListRouterInputs (updated)

Link ¶
Changes (request, response)
Request

{'Filters': {'InputTypes': {'DESTINATION_ENDPOINT'}}}

Response

{'RouterInputs': {'InputType': {'DESTINATION_ENDPOINT'}}}

Retrieves a list of router inputs in AWS Elemental MediaConnect.

See also: AWS API Documentation

Request Syntax

client.list_router_inputs(
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'NameContains': [
                'string',
            ],
            'RegionNames': [
                'string',
            ],
            'NetworkInterfaceArns': [
                'string',
            ],
            'RoutingScopes': [
                'REGIONAL'|'GLOBAL',
            ],
            'InputTypes': [
                'STANDARD'|'FAILOVER'|'MERGE'|'MEDIACONNECT_FLOW'|'MEDIALIVE_CHANNEL'|'DESTINATION_ENDPOINT',
            ]
        },
    ]
)

type MaxResults:

integer

param MaxResults:

The maximum number of router inputs to return in the response.

type NextToken:

string

param NextToken:

A token used to retrieve the next page of results.

type Filters:

list

param Filters:

The filters to apply when retrieving the list of router inputs.

(dict) --

A filter that can be used to retrieve a list of router inputs.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: NameContains, RegionNames, NetworkInterfaceArns, RoutingScopes, InputTypes.
- NameContains (list) --
  
  The names of the router inputs to include in the filter.
  - (string) --
- RegionNames (list) --
  
  The AWS Regions of the router inputs to include in the filter.
  - (string) --
- NetworkInterfaceArns (list) --
  
  The Amazon Resource Names (ARNs) of the network interfaces associated with the router inputs to include in the filter.
  - (string) --
- RoutingScopes (list) --
  
  Filter criteria to list router inputs based on their routing scope (REGIONAL or GLOBAL).
  - (string) --
- InputTypes (list) --
  
  The types of router inputs to include in the filter.
  - (string) --

rtype:

dict

returns:

Response Syntax

{
    'RouterInputs': [
        {
            'Name': 'string',
            'Arn': 'string',
            'Id': 'string',
            'InputType': 'STANDARD'|'FAILOVER'|'MERGE'|'MEDIACONNECT_FLOW'|'MEDIALIVE_CHANNEL'|'DESTINATION_ENDPOINT',
            'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
            'RoutedOutputs': 123,
            'RegionName': 'string',
            'AvailabilityZone': 'string',
            'MaximumBitrate': 123,
            'RoutingScope': 'REGIONAL'|'GLOBAL',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'MessageCount': 123,
            'NetworkInterfaceArn': 'string',
            'MaintenanceScheduleType': 'WINDOW',
            'MaintenanceSchedule': {
                'Window': {
                    'Start': datetime(2015, 1, 1),
                    'End': datetime(2015, 1, 1),
                    'ScheduledTime': datetime(2015, 1, 1)
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- RouterInputs (list) --
  
  The summary information for the retrieved router inputs.
  - (dict) --
    
    A summary of a router input, including its name, type, ARN, ID, state, and other key details. This structure is used in the response of the ListRouterInputs operation.
    - Name (string) --
      
      The name of the router input.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the router input.
    - Id (string) --
      
      The unique identifier of the router input.
    - InputType (string) --
      
      The type of the router input.
    - State (string) --
      
      The overall state of the router input.
    - RoutedOutputs (integer) --
      
      The number of router outputs that are associated with this router input.
    - RegionName (string) --
      
      The Amazon Web Services Region where the router input is located.
    - AvailabilityZone (string) --
      
      The Availability Zone of the router input.
    - MaximumBitrate (integer) --
      
      The maximum bitrate of the router input.
    - RoutingScope (string) --
      
      Indicates whether the router input is configured for Regional or global routing.
    - CreatedAt (datetime) --
      
      The timestamp when the router input was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the router input was last updated.
    - MessageCount (integer) --
      
      The number of messages associated with the router input.
    - NetworkInterfaceArn (string) --
      
      The ARN of the network interface associated with the router input.
    - MaintenanceScheduleType (string) --
      
      The type of maintenance schedule currently associated with the listed router input.
    - MaintenanceSchedule (dict) --
      
      The details of the maintenance schedule for the listed router input.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: Window. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - Window (dict) --
        
        Defines a specific time window for maintenance operations.
        
        Start (datetime) --
        
        The start time of the maintenance window.
        
        End (datetime) --
        
        The end time of the maintenance window.
        
        ScheduledTime (datetime) --
        
        The date and time when the maintenance window is scheduled to occur.
- NextToken (string) --
  
  The token to use to retrieve the next page of results.

ListRouterOutputs (updated)

Link ¶
Changes (request, response)
Request

{'Filters': {'OutputTypes': {'SOURCE_ENDPOINT'}}}

Response

{'RouterOutputs': {'OutputType': {'SOURCE_ENDPOINT'}}}

Retrieves a list of router outputs in AWS Elemental MediaConnect.

See also: AWS API Documentation

Request Syntax

client.list_router_outputs(
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'RegionNames': [
                'string',
            ],
            'NetworkInterfaceArns': [
                'string',
            ],
            'RoutingScopes': [
                'REGIONAL'|'GLOBAL',
            ],
            'OutputTypes': [
                'STANDARD'|'MEDIACONNECT_FLOW'|'MEDIALIVE_INPUT'|'SOURCE_ENDPOINT',
            ],
            'RoutedInputArns': [
                'string',
            ],
            'NameContains': [
                'string',
            ]
        },
    ]
)

type MaxResults:

integer

param MaxResults:

The maximum number of router outputs to return in the response.

type NextToken:

string

param NextToken:

A token used to retrieve the next page of results.

type Filters:

list

param Filters:

The filters to apply when retrieving the list of router outputs.

(dict) --

A filter that can be used to retrieve a list of router outputs.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: RegionNames, NetworkInterfaceArns, RoutingScopes, OutputTypes, RoutedInputArns, NameContains.
- RegionNames (list) --
  
  The AWS Regions of the router outputs to include in the filter.
  - (string) --
- NetworkInterfaceArns (list) --
  
  The Amazon Resource Names (ARNs) of the network interfaces associated with the router outputs to include in the filter.
  - (string) --
- RoutingScopes (list) --
  
  Filter criteria to list router outputs based on their routing scope.
  - (string) --
- OutputTypes (list) --
  
  The types of router outputs to include in the filter.
  - (string) --
- RoutedInputArns (list) --
  
  The ARNs of the router inputs associated with the router outputs to include in the filter.
  - (string) --
- NameContains (list) --
  
  The names of the router outputs to include in the filter.
  - (string) --

rtype:

dict

returns:

Response Syntax

{
    'RouterOutputs': [
        {
            'Name': 'string',
            'Arn': 'string',
            'Id': 'string',
            'OutputType': 'STANDARD'|'MEDIACONNECT_FLOW'|'MEDIALIVE_INPUT'|'SOURCE_ENDPOINT',
            'State': 'CREATING'|'STANDBY'|'STARTING'|'ACTIVE'|'STOPPING'|'DELETING'|'UPDATING'|'ERROR'|'RECOVERING'|'MIGRATING',
            'RoutedState': 'ROUTED'|'ROUTING'|'UNROUTED',
            'RegionName': 'string',
            'AvailabilityZone': 'string',
            'MaximumBitrate': 123,
            'RoutingScope': 'REGIONAL'|'GLOBAL',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'MessageCount': 123,
            'RoutedInputArn': 'string',
            'NetworkInterfaceArn': 'string',
            'MaintenanceScheduleType': 'WINDOW',
            'MaintenanceSchedule': {
                'Window': {
                    'Start': datetime(2015, 1, 1),
                    'End': datetime(2015, 1, 1),
                    'ScheduledTime': datetime(2015, 1, 1)
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- RouterOutputs (list) --
  
  The summary information for the retrieved router outputs.
  - (dict) --
    
    A summary of a router output, including its name, type, ARN, ID, state, routed state, and other key details. This structure is used in the response of the ListRouterOutputs operation.
    - 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.
    - OutputType (string) --
      
      The type of the router output.
    - State (string) --
      
      The overall state of the router output.
    - RoutedState (string) --
      
      The current state of the association between the router output and its input.
    - RegionName (string) --
      
      The AAmazon Web Services Region where the router output is located.
    - AvailabilityZone (string) --
      
      The Availability Zone of the router output.
    - MaximumBitrate (integer) --
      
      The maximum bitrate of the router output.
    - RoutingScope (string) --
      
      Indicates whether the router output is configured for Regional or global routing.
    - CreatedAt (datetime) --
      
      The timestamp when the router output was created.
    - UpdatedAt (datetime) --
      
      The timestamp when the router output was last updated.
    - MessageCount (integer) --
      
      The number of messages associated with the router output.
    - RoutedInputArn (string) --
      
      The ARN of the router input associated with the output.
    - NetworkInterfaceArn (string) --
      
      The ARN of the network interface associated with the router output.
    - MaintenanceScheduleType (string) --
      
      The type of maintenance schedule currently associated with the listed router output.
    - MaintenanceSchedule (dict) --
      
      The details of the maintenance schedule for the listed router output.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: Window. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - Window (dict) --
        
        Defines a specific time window for maintenance operations.
        
        Start (datetime) --
        
        The start time of the maintenance window.
        
        End (datetime) --
        
        The end time of the maintenance window.
        
        ScheduledTime (datetime) --
        
        The date and time when the maintenance window is scheduled to occur.
- NextToken (string) --
  
  The token to use to retrieve the next page of results.

UpdateRouterInput (updated)

Link ¶
Changes (request, response)
Request

{'Configuration': {'DestinationEndpoint': {'EndpointLifecycleManagement': 'MANAGED '
                                                                          '| '
                                                                          'UNMANAGED',
                                           'SourceTransitDecryption': {'Automatic': {},
                                                                       'SecretsManager': {'EncryptionSecret': {'SecretArn': 'string'},
                                                                                          'EncryptionSecretType': 'AES_128_KEY '
                                                                                                                  '| '
                                                                                                                  'AES_192_KEY '
                                                                                                                  '| '
                                                                                                                  'AES_256_KEY '
                                                                                                                  '| '
                                                                                                                  'SRT_PASSPHRASE'}},
                                           'SourceTransitDecryptionType': 'SECRETS_MANAGER '
                                                                          '| '
                                                                          'AUTOMATIC'}}}

Response

{'RouterInput': {'AssociatedDestinationEndpointArns': ['string'],
                 'Configuration': {'DestinationEndpoint': {'EndpointLifecycleManagement': 'MANAGED '
                                                                                          '| '
                                                                                          'UNMANAGED',
                                                           'SourceTransitDecryption': {'Automatic': {},
                                                                                       'SecretsManager': {'EncryptionSecret': {'SecretArn': 'string'},
                                                                                                          'EncryptionSecretType': 'AES_128_KEY '
                                                                                                                                  '| '
                                                                                                                                  'AES_192_KEY '
                                                                                                                                  '| '
                                                                                                                                  'AES_256_KEY '
                                                                                                                                  '| '
                                                                                                                                  'SRT_PASSPHRASE'}},
                                                           'SourceTransitDecryptionType': 'SECRETS_MANAGER '
                                                                                          '| '
                                                                                          'AUTOMATIC'}},
                 'InputType': {'DESTINATION_ENDPOINT'},
                 'StreamDetails': {'DestinationEndpoint': {}}}}

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

See also: AWS API Documentation

Request Syntax

client.update_router_input(
    Arn='string',
    Name='string',
    Configuration={
        'DestinationEndpoint': {
            'EndpointLifecycleManagement': 'MANAGED'|'UNMANAGED',
            'SourceTransitDecryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
            'SourceTransitDecryption': {
                'SecretsManager': {
                    'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                    'EncryptionSecret': {
                        'SecretArn': 'string'
                    }
                },
                'Automatic': {}

            }
        },
        'Standard': {
            'NetworkInterfaceArn': 'string',
            'ProtocolConfiguration': {
                'Rist': {
                    'Port': 123,
                    'RecoveryLatencyMilliseconds': 123
                },
                'SrtListener': {
                    'Port': 123,
                    'MinimumLatencyMilliseconds': 123,
                    'DecryptionConfiguration': {
                        'EncryptionKey': {
                            'SecretArn': 'string',
                            'RoleArn': 'string'
                        }
                    }
                },
                'SrtCaller': {
                    'SourceAddress': 'string',
                    'SourcePort': 123,
                    'MinimumLatencyMilliseconds': 123,
                    'StreamId': 'string',
                    'DecryptionConfiguration': {
                        'EncryptionKey': {
                            'SecretArn': 'string',
                            'RoleArn': 'string'
                        }
                    }
                },
                'Rtp': {
                    'Port': 123,
                    'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
                }
            },
            'Protocol': 'RTP'|'RIST'|'SRT_CALLER'|'SRT_LISTENER'
        },
        'MediaLiveChannel': {
            'MediaLiveChannelArn': 'string',
            'MediaLivePipelineId': 'PIPELINE_0'|'PIPELINE_1',
            'MediaLiveChannelOutputName': 'string',
            'SourceTransitDecryption': {
                'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
                'EncryptionKeyConfiguration': {
                    'SecretsManager': {
                        'SecretArn': 'string',
                        'RoleArn': 'string'
                    },
                    'Automatic': {}

                }
            }
        },
        'Failover': {
            'NetworkInterfaceArn': 'string',
            'ProtocolConfigurations': [
                {
                    'Rist': {
                        'Port': 123,
                        'RecoveryLatencyMilliseconds': 123
                    },
                    'SrtListener': {
                        'Port': 123,
                        'MinimumLatencyMilliseconds': 123,
                        'DecryptionConfiguration': {
                            'EncryptionKey': {
                                'SecretArn': 'string',
                                'RoleArn': 'string'
                            }
                        }
                    },
                    'SrtCaller': {
                        'SourceAddress': 'string',
                        'SourcePort': 123,
                        'MinimumLatencyMilliseconds': 123,
                        'StreamId': 'string',
                        'DecryptionConfiguration': {
                            'EncryptionKey': {
                                'SecretArn': 'string',
                                'RoleArn': 'string'
                            }
                        }
                    },
                    'Rtp': {
                        'Port': 123,
                        'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
                    }
                },
            ],
            'SourcePriorityMode': 'NO_PRIORITY'|'PRIMARY_SECONDARY',
            'PrimarySourceIndex': 123
        },
        'MediaConnectFlow': {
            'FlowArn': 'string',
            'FlowOutputArn': 'string',
            'SourceTransitDecryption': {
                'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
                'EncryptionKeyConfiguration': {
                    'SecretsManager': {
                        'SecretArn': 'string',
                        'RoleArn': 'string'
                    },
                    'Automatic': {}

                }
            }
        },
        'Merge': {
            'NetworkInterfaceArn': 'string',
            'ProtocolConfigurations': [
                {
                    'Rtp': {
                        'Port': 123,
                        'ForwardErrorCorrection': 'ENABLED'|'DISABLED'
                    },
                    'Rist': {
                        'Port': 123,
                        'RecoveryLatencyMilliseconds': 123
                    }
                },
            ],
            'MergeRecoveryWindowMilliseconds': 123
        }
    },
    MaximumBitrate=123,
    RoutingScope='REGIONAL'|'GLOBAL',
    Tier='INPUT_100'|'INPUT_50'|'INPUT_20'|'INPUT_500'|'INPUT_250',
    TransitEncryption={
        'EncryptionKeyType': 'SECRETS_MANAGER'|'AUTOMATIC',
        'EncryptionKeyConfiguration': {
            'SecretsManager': {
                'SecretArn': 'string',
                'RoleArn': 'string'
            },
            'Automatic': {}

        }
    },
    MaintenanceConfiguration={
        'PreferredDayTime': {
            'Day': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
            'Time': 'string'
        },
        'Default': {}

    },
    ContentQualityAnalysisConfiguration={
        'ContentLevel': {
            'BlackFrames': {
                'State': 'ENABLED'|'DISABLED',
                'ThresholdSeconds': 123
            },
            'FrozenFrames': {
                'State': 'ENABLED'|'DISABLED',
                'ThresholdSeconds': 123
            },
            'SilentAudio': {
                'State': 'ENABLED'|'DISABLED',
                'ThresholdSeconds': 123
            }
        }
    }
)

type Arn:

string

param Arn:

[REQUIRED]

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

type Name:

string

param Name:

The updated name for the router input.

type Configuration:

dict

param Configuration:

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

DestinationEndpoint (dict) --

Configuration settings for a router input that is represented by a destination endpoint.
- EndpointLifecycleManagement (string) -- [REQUIRED]
  
  The entity that manages the lifecycle of the associated destination endpoint. Valid values include the following:
  - MANAGED – MediaConnect manages the lifecycle of the associated destination endpoint.
  - UNMANAGED – You manage the lifecycle of the associated destination endpoint.
- SourceTransitDecryptionType (string) --
  
  The type of transit decryption applied to the source content that this router input receives. Valid values include the following:
  - SECRETS_MANAGER – The decryption key or passphrase is stored in Secrets Manager.
  - AUTOMATIC – MediaConnect determines the decryption key when the endpoint connects.
- SourceTransitDecryption (dict) -- [REQUIRED]
  
  The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.
  - SecretsManager (dict) --
    
    The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
    - EncryptionSecretType (string) --
      
      The type of secret used to encrypt the connection. Valid values include the following:
      - AES_128_KEY – A 128-bit AES encryption key.
      - AES_192_KEY – A 192-bit AES encryption key.
      - AES_256_KEY – A 256-bit AES encryption key.
      - SRT_PASSPHRASE – An SRT passphrase.
    - EncryptionSecret (dict) -- [REQUIRED]
      
      The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
      - SecretArn (string) -- [REQUIRED]
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
  - Automatic (dict) --
    
    The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
Standard (dict) --

The configuration settings for a standard router input, including the protocol, protocol-specific configuration, network interface, and availability zone.
- NetworkInterfaceArn (string) -- [REQUIRED]
  
  The Amazon Resource Name (ARN) of the network interface associated with the standard router input.
- ProtocolConfiguration (dict) -- [REQUIRED]
  
  The configuration settings for the protocol used by the standard router input.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: Rist, SrtListener, SrtCaller, Rtp.
  - Rist (dict) --
    
    The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
    - Port (integer) -- [REQUIRED]
      
      The port number used for the RIST protocol in the router input configuration.
    - RecoveryLatencyMilliseconds (integer) -- [REQUIRED]
      
      The recovery latency in milliseconds for the RIST protocol in the router input configuration.
  - SrtListener (dict) --
    
    The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
    - Port (integer) -- [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.
    - DecryptionConfiguration (dict) --
      
      Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
      - EncryptionKey (dict) -- [REQUIRED]
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) -- [REQUIRED]
        
        The ARN of the 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 input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
    - SourceAddress (string) -- [REQUIRED]
      
      The source IP address for the SRT protocol in caller mode.
    - SourcePort (integer) -- [REQUIRED]
      
      The source port number for the SRT protocol in caller mode.
    - 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.
    - DecryptionConfiguration (dict) --
      
      Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
      - EncryptionKey (dict) -- [REQUIRED]
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) -- [REQUIRED]
        
        The ARN of the 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 Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
    - Port (integer) -- [REQUIRED]
      
      The port number used for the RTP protocol in the router input configuration.
    - ForwardErrorCorrection (string) --
      
      The state of forward error correction for the RTP protocol in the router input configuration.
- Protocol (string) --
  
  The protocol used by the standard router input.
MediaLiveChannel (dict) --

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

To connect the router input to the MediaLive channel output, provide all three of mediaLiveChannelArn, mediaLivePipelineId, and mediaLiveChannelOutputName. To disconnect it, call the update operation and omit all three fields while keeping this configuration object.

Note

You can't change sourceTransitDecryption while the router input is connected to a MediaLive channel output. To change it, first disconnect the router input, then update the decryption.
- MediaLiveChannelArn (string) --
  
  The ARN of the MediaLive channel to connect to this router input.
- MediaLivePipelineId (string) --
  
  The index of the MediaLive pipeline to connect to this router input.
- MediaLiveChannelOutputName (string) --
  
  The name of the MediaLive channel output to connect to this router input.
- SourceTransitDecryption (dict) -- [REQUIRED]
  
  The encryption configuration that defines how content is encrypted during transit between MediaConnect Router and MediaLive. This configuration determines whether encryption keys are automatically managed by the service or manually managed through Secrets Manager.
  - EncryptionKeyType (string) --
    
    The type of encryption key to use for MediaLive transit encryption.
  - EncryptionKeyConfiguration (dict) -- [REQUIRED]
    
    The configuration details for the MediaLive encryption key.
    
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.
    - 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.
Failover (dict) --

Configuration settings for a failover router input that allows switching between two input sources.
- NetworkInterfaceArn (string) -- [REQUIRED]
  
  The ARN of the network interface to use for this failover router input.
- ProtocolConfigurations (list) -- [REQUIRED]
  
  A list of exactly two protocol configurations for the failover input sources. Both must use the same protocol type.
  - (dict) --
    
    Protocol configuration settings for failover router inputs.
    
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys can be set: Rist, SrtListener, SrtCaller, Rtp.
    - Rist (dict) --
      
      The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
      - Port (integer) -- [REQUIRED]
        
        The port number used for the RIST protocol in the router input configuration.
      - RecoveryLatencyMilliseconds (integer) -- [REQUIRED]
        
        The recovery latency in milliseconds for the RIST protocol in the router input configuration.
    - SrtListener (dict) --
      
      The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
      - Port (integer) -- [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.
      - DecryptionConfiguration (dict) --
        
        Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
        
        EncryptionKey (dict) -- [REQUIRED]
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) -- [REQUIRED]
        
        The ARN of the 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 input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
      - SourceAddress (string) -- [REQUIRED]
        
        The source IP address for the SRT protocol in caller mode.
      - SourcePort (integer) -- [REQUIRED]
        
        The source port number for the SRT protocol in caller mode.
      - 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.
      - DecryptionConfiguration (dict) --
        
        Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
        
        EncryptionKey (dict) -- [REQUIRED]
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) -- [REQUIRED]
        
        The ARN of the 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 Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
      - Port (integer) -- [REQUIRED]
        
        The port number used for the RTP protocol in the router input configuration.
      - ForwardErrorCorrection (string) --
        
        The state of forward error correction for the RTP protocol in the router input configuration.
- SourcePriorityMode (string) -- [REQUIRED]
  
  The mode for determining source priority in failover configurations.
- PrimarySourceIndex (integer) --
  
  The index (0 or 1) that specifies which source in the protocol configurations list is currently active. Used to control which of the two failover sources is currently selected. This field is ignored when sourcePriorityMode is set to NO_PRIORITY
MediaConnectFlow (dict) --

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

To connect the router input to the flow output, provide both flowArn and flowOutputArn. To disconnect it, call the update operation and omit both fields while keeping this configuration object.

Note

You can't change sourceTransitDecryption while the router input is connected to a flow output. To change it, first disconnect the router input, then update the decryption.
- FlowArn (string) --
  
  The ARN of the flow to connect to.
- FlowOutputArn (string) --
  
  The ARN of the flow output to connect to this router input.
- SourceTransitDecryption (dict) -- [REQUIRED]
  
  The decryption configuration for the flow source when connected to this router input.
  - EncryptionKeyType (string) --
    
    The type of encryption key to use for flow transit encryption.
  - EncryptionKeyConfiguration (dict) -- [REQUIRED]
    
    The configuration details for the encryption key.
    
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.
    - SecretsManager (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.
Merge (dict) --

Configuration settings for a merge router input that combines two input sources.
- NetworkInterfaceArn (string) -- [REQUIRED]
  
  The ARN of the network interface to use for this merge router input.
- ProtocolConfigurations (list) -- [REQUIRED]
  
  A list of exactly two protocol configurations for the merge input sources. Both must use the same protocol type.
  - (dict) --
    
    Protocol configuration settings for merge router inputs.
    
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys can be set: Rtp, Rist.
    - Rtp (dict) --
      
      The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
      - Port (integer) -- [REQUIRED]
        
        The port number used for the RTP protocol in the router input configuration.
      - ForwardErrorCorrection (string) --
        
        The state of forward error correction for the RTP protocol in the router input configuration.
    - Rist (dict) --
      
      The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
      - Port (integer) -- [REQUIRED]
        
        The port number used for the RIST protocol in the router input configuration.
      - RecoveryLatencyMilliseconds (integer) -- [REQUIRED]
        
        The recovery latency in milliseconds for the RIST protocol in the router input configuration.
- MergeRecoveryWindowMilliseconds (integer) -- [REQUIRED]
  
  The time window in milliseconds for merging the two input sources.

type MaximumBitrate:

integer

param MaximumBitrate:

The updated maximum bitrate for the router input.

type RoutingScope:

string

param RoutingScope:

Specifies whether the router input can be assigned to outputs in different Regions. REGIONAL (default) - can be assigned only to outputs in the same Region. GLOBAL - can be assigned to outputs in any Region.

type Tier:

string

param Tier:

The updated tier level for the router input. The tier sets the maximum bitrate, in Mbps, for the router input. Valid values include the following:

INPUT_20 – 20 Mbps
INPUT_50 – 50 Mbps
INPUT_100 – 100 Mbps
INPUT_250 – 250 Mbps
INPUT_500 – 500 Mbps

The 250 Mbps and 500 Mbps tiers are high-bitrate tiers that support TR-07 (JPEG XS) workflows.

type TransitEncryption:

dict

param TransitEncryption:

The updated transit encryption settings for the router input.

EncryptionKeyType (string) --

Specifies the type of encryption key to use for transit encryption.
EncryptionKeyConfiguration (dict) -- [REQUIRED]

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

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.
- SecretsManager (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 MaintenanceConfiguration:

dict

param MaintenanceConfiguration:

The updated maintenance configuration settings for the router input, 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 ContentQualityAnalysisConfiguration:

dict

param ContentQualityAnalysisConfiguration:

The content quality analysis configuration for the router input.

ContentLevel (dict) --

The content quality analysis configuration.
- BlackFrames (dict) --
  
  Settings for black frames detection.
  - State (string) -- [REQUIRED]
    
    Indicates whether black frames detection is enabled or disabled.
  - ThresholdSeconds (integer) -- [REQUIRED]
    
    The number of consecutive seconds of black frames that MediaConnect must detect before it reports an issue.
- FrozenFrames (dict) --
  
  Settings for frozen frames detection.
  - State (string) -- [REQUIRED]
    
    Indicates whether frozen frames detection is enabled or disabled.
  - ThresholdSeconds (integer) -- [REQUIRED]
    
    The number of consecutive seconds of a frozen frame that MediaConnect must detect before it reports an issue.
- SilentAudio (dict) --
  
  Settings for silent audio detection.
  - State (string) -- [REQUIRED]
    
    Indicates whether silent audio detection is enabled or disabled.
  - ThresholdSeconds (integer) -- [REQUIRED]
    
    The number of consecutive seconds of silence that MediaConnect must detect before it reports an issue.

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --
- RouterInput (dict) --
  
  The updated router input.
  - Name (string) --
    
    The name of the router input.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of the router input.
  - Id (string) --
    
    The unique identifier of the router input.
  - State (string) --
    
    The current state of the router input.
  - InputType (string) --
    
    The type of the router input.
  - Configuration (dict) --
    
    The configuration settings for a router input.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: DestinationEndpoint, Standard, MediaLiveChannel, Failover, MediaConnectFlow, Merge. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - DestinationEndpoint (dict) --
      
      Configuration settings for a router input that is represented by a destination endpoint.
      - EndpointLifecycleManagement (string) --
        
        The entity that manages the lifecycle of the associated destination endpoint. Valid values include the following:
        
        MANAGED – MediaConnect manages the lifecycle of the associated destination endpoint.
        
        UNMANAGED – You manage the lifecycle of the associated destination endpoint.
      - SourceTransitDecryptionType (string) --
        
        The type of transit decryption applied to the source content that this router input receives. Valid values include the following:
        
        SECRETS_MANAGER – The decryption key or passphrase is stored in Secrets Manager.
        
        AUTOMATIC – MediaConnect determines the decryption key when the endpoint connects.
      - SourceTransitDecryption (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
    - Standard (dict) --
      
      The configuration settings for a standard router input, including the protocol, protocol-specific configuration, network interface, and availability zone.
      - NetworkInterfaceArn (string) --
        
        The Amazon Resource Name (ARN) of the network interface associated with the standard router input.
      - ProtocolConfiguration (dict) --
        
        The configuration settings for the protocol used by the standard router input.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rist, SrtListener, SrtCaller, Rtp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Rist (dict) --
        
        The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
        
        Port (integer) --
        
        The port number used for the RIST protocol in the router input configuration.
        
        RecoveryLatencyMilliseconds (integer) --
        
        The recovery latency in milliseconds for the RIST protocol in the router input configuration.
        
        SrtListener (dict) --
        
        The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
        
        Port (integer) --
        
        The port number for the SRT protocol in listener mode.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency in milliseconds for the SRT protocol in listener mode.
        
        DecryptionConfiguration (dict) --
        
        Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
        
        EncryptionKey (dict) --
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) --
        
        The ARN of the 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 input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
        
        SourceAddress (string) --
        
        The source IP address for the SRT protocol in caller mode.
        
        SourcePort (integer) --
        
        The source port number for the SRT protocol in caller mode.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency in milliseconds for the SRT protocol in caller mode.
        
        StreamId (string) --
        
        The stream ID for the SRT protocol in caller mode.
        
        DecryptionConfiguration (dict) --
        
        Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
        
        EncryptionKey (dict) --
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) --
        
        The ARN of the 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 Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
        
        Port (integer) --
        
        The port number used for the RTP protocol in the router input configuration.
        
        ForwardErrorCorrection (string) --
        
        The state of forward error correction for the RTP protocol in the router input configuration.
      - Protocol (string) --
        
        The protocol used by the standard router input.
    - MediaLiveChannel (dict) --
      
      Configuration settings for connecting a router input to a MediaLive channel output.
      
      To connect the router input to the MediaLive channel output, provide all three of mediaLiveChannelArn, mediaLivePipelineId, and mediaLiveChannelOutputName. To disconnect it, call the update operation and omit all three fields while keeping this configuration object.
      
      Note
      
      You can't change sourceTransitDecryption while the router input is connected to a MediaLive channel output. To change it, first disconnect the router input, then update the decryption.
      - MediaLiveChannelArn (string) --
        
        The ARN of the MediaLive channel to connect to this router input.
      - MediaLivePipelineId (string) --
        
        The index of the MediaLive pipeline to connect to this router input.
      - MediaLiveChannelOutputName (string) --
        
        The name of the MediaLive channel output to connect to this router input.
      - SourceTransitDecryption (dict) --
        
        The encryption configuration that defines how content is encrypted during transit between MediaConnect Router and MediaLive. This configuration determines whether encryption keys are automatically managed by the service or manually managed through Secrets Manager.
        
        EncryptionKeyType (string) --
        
        The type of encryption key to use for MediaLive transit encryption.
        
        EncryptionKeyConfiguration (dict) --
        
        The configuration details for the MediaLive encryption key.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The configuration settings for transit encryption using 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.
    - Failover (dict) --
      
      Configuration settings for a failover router input that allows switching between two input sources.
      - NetworkInterfaceArn (string) --
        
        The ARN of the network interface to use for this failover router input.
      - ProtocolConfigurations (list) --
        
        A list of exactly two protocol configurations for the failover input sources. Both must use the same protocol type.
        
        (dict) --
        
        Protocol configuration settings for failover router inputs.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rist, SrtListener, SrtCaller, Rtp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Rist (dict) --
        
        The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
        
        Port (integer) --
        
        The port number used for the RIST protocol in the router input configuration.
        
        RecoveryLatencyMilliseconds (integer) --
        
        The recovery latency in milliseconds for the RIST protocol in the router input configuration.
        
        SrtListener (dict) --
        
        The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
        
        Port (integer) --
        
        The port number for the SRT protocol in listener mode.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency in milliseconds for the SRT protocol in listener mode.
        
        DecryptionConfiguration (dict) --
        
        Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
        
        EncryptionKey (dict) --
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) --
        
        The ARN of the 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 input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
        
        SourceAddress (string) --
        
        The source IP address for the SRT protocol in caller mode.
        
        SourcePort (integer) --
        
        The source port number for the SRT protocol in caller mode.
        
        MinimumLatencyMilliseconds (integer) --
        
        The minimum latency in milliseconds for the SRT protocol in caller mode.
        
        StreamId (string) --
        
        The stream ID for the SRT protocol in caller mode.
        
        DecryptionConfiguration (dict) --
        
        Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
        
        EncryptionKey (dict) --
        
        Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
        
        SecretArn (string) --
        
        The ARN of the 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 Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
        
        Port (integer) --
        
        The port number used for the RTP protocol in the router input configuration.
        
        ForwardErrorCorrection (string) --
        
        The state of forward error correction for the RTP protocol in the router input configuration.
      - SourcePriorityMode (string) --
        
        The mode for determining source priority in failover configurations.
      - PrimarySourceIndex (integer) --
        
        The index (0 or 1) that specifies which source in the protocol configurations list is currently active. Used to control which of the two failover sources is currently selected. This field is ignored when sourcePriorityMode is set to NO_PRIORITY
    - MediaConnectFlow (dict) --
      
      Configuration settings for connecting a router input to a flow output.
      
      To connect the router input to the flow output, provide both flowArn and flowOutputArn. To disconnect it, call the update operation and omit both fields while keeping this configuration object.
      
      Note
      
      You can't change sourceTransitDecryption while the router input is connected to a flow output. To change it, first disconnect the router input, then update the decryption.
      - FlowArn (string) --
        
        The ARN of the flow to connect to.
      - FlowOutputArn (string) --
        
        The ARN of the flow output to connect to this router input.
      - SourceTransitDecryption (dict) --
        
        The decryption configuration for the flow source when connected to this router input.
        
        EncryptionKeyType (string) --
        
        The type of encryption key to use for flow transit encryption.
        
        EncryptionKeyConfiguration (dict) --
        
        The configuration details for the encryption key.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The configuration settings for transit encryption using 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.
    - Merge (dict) --
      
      Configuration settings for a merge router input that combines two input sources.
      - NetworkInterfaceArn (string) --
        
        The ARN of the network interface to use for this merge router input.
      - ProtocolConfigurations (list) --
        
        A list of exactly two protocol configurations for the merge input sources. Both must use the same protocol type.
        
        (dict) --
        
        Protocol configuration settings for merge router inputs.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rtp, Rist. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Rtp (dict) --
        
        The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
        
        Port (integer) --
        
        The port number used for the RTP protocol in the router input configuration.
        
        ForwardErrorCorrection (string) --
        
        The state of forward error correction for the RTP protocol in the router input configuration.
        
        Rist (dict) --
        
        The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
        
        Port (integer) --
        
        The port number used for the RIST protocol in the router input configuration.
        
        RecoveryLatencyMilliseconds (integer) --
        
        The recovery latency in milliseconds for the RIST protocol in the router input configuration.
      - MergeRecoveryWindowMilliseconds (integer) --
        
        The time window in milliseconds for merging the two input sources.
  - RoutedOutputs (integer) --
    
    The number of router outputs associated with the router input.
  - MaximumRoutedOutputs (integer) --
    
    The maximum number of outputs that can be simultaneously routed to this input.
  - RegionName (string) --
    
    The Amazon Web Services Region where the router input is located.
  - AvailabilityZone (string) --
    
    The Availability Zone of the router input.
  - MaximumBitrate (integer) --
    
    The maximum bitrate for the router input.
  - Tier (string) --
    
    The tier level for the router input. The tier sets the maximum bitrate, in Mbps, for the router input. Valid values include the following:
    - INPUT_20 – 20 Mbps
    - INPUT_50 – 50 Mbps
    - INPUT_100 – 100 Mbps
    - INPUT_250 – 250 Mbps
    - INPUT_500 – 500 Mbps
    The 250 Mbps and 500 Mbps tiers are high-bitrate tiers that support TR-07 (JPEG XS) workflows.
  - RoutingScope (string) --
    
    Indicates whether the router input is configured for Regional or global routing.
  - CreatedAt (datetime) --
    
    The timestamp when the router input was created.
  - UpdatedAt (datetime) --
    
    The timestamp when the router input was last updated.
  - Messages (list) --
    
    The messages associated with the router input.
    - (dict) --
      
      A message associated with a router input, including a code and a message.
      - Code (string) --
        
        The code associated with the router input message.
      - Message (string) --
        
        The message text associated with the router input message.
  - TransitEncryption (dict) --
    
    The transit encryption settings for a router input.
    - EncryptionKeyType (string) --
      
      Specifies the type of encryption key to use for transit encryption.
    - EncryptionKeyConfiguration (dict) --
      
      Contains the configuration details for the encryption key used in transit encryption, including the key source and associated parameters.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - SecretsManager (dict) --
        
        The configuration settings for transit encryption using 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.
  - Tags (dict) --
    
    Key-value pairs that can be used to tag and organize this router input.
    - (string) --
      - (string) --
  - StreamDetails (dict) --
    
    Configuration details for the router input stream.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: DestinationEndpoint, Standard, MediaLiveChannel, Failover, MediaConnectFlow, Merge. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - DestinationEndpoint (dict) --
      
      Configuration details for a router input stream that is represented by a destination endpoint.
    - Standard (dict) --
      
      Configuration details for a standard router input stream type.
      - SourceIpAddress (string) --
        
        The source IP address for the standard router input stream.
    - MediaLiveChannel (dict) --
      
      Configuration details for a MediaLive channel when used as a router input source.
    - Failover (dict) --
      
      Configuration details for a failover router input that can automatically switch between two sources.
      - SourceIndexZeroStreamDetails (dict) --
        
        Configuration details for the primary source (index 0) in the failover setup.
        
        SourceIndex (integer) --
        
        The index number (0 or 1) assigned to this source in the failover configuration.
        
        SourceIpAddress (string) --
        
        The IP address of the source for this indexed stream.
      - SourceIndexOneStreamDetails (dict) --
        
        Configuration details for the secondary source (index 1) in the failover setup.
        
        SourceIndex (integer) --
        
        The index number (0 or 1) assigned to this source in the failover configuration.
        
        SourceIpAddress (string) --
        
        The IP address of the source for this indexed stream.
    - MediaConnectFlow (dict) --
      
      Configuration details for a MediaConnect flow when used as a router input source.
    - Merge (dict) --
      
      Configuration details for a merge router input that combines two input sources.
      - SourceIndexZeroStreamDetails (dict) --
        
        Configuration details for the first source (index 0) in the merge setup.
        
        SourceIndex (integer) --
        
        The index number (0 or 1) assigned to this source in the merge configuration.
        
        SourceIpAddress (string) --
        
        The IP address of the source for this indexed stream in the merge setup.
      - SourceIndexOneStreamDetails (dict) --
        
        Configuration details for the second source (index 1) in the merge setup.
        
        SourceIndex (integer) --
        
        The index number (0 or 1) assigned to this source in the merge configuration.
        
        SourceIpAddress (string) --
        
        The IP address of the source for this indexed stream in the merge setup.
  - IpAddress (string) --
    
    The IP address of the router input.
  - MaintenanceType (string) --
    
    The type of maintenance configuration applied to this router input.
  - MaintenanceConfiguration (dict) --
    
    The maintenance configuration settings applied to this router input.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: PreferredDayTime, Default. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - PreferredDayTime (dict) --
      
      Preferred day and time maintenance configuration settings.
      - Day (string) --
        
        The preferred day for maintenance operations.
      - Time (string) --
        
        The preferred time for maintenance operations.
    - Default (dict) --
      
      Default maintenance configuration settings.
  - MaintenanceScheduleType (string) --
    
    The type of maintenance schedule currently in effect for this router input.
  - MaintenanceSchedule (dict) --
    
    The current maintenance schedule details for this router input.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Window. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Window (dict) --
      
      Defines a specific time window for maintenance operations.
      - Start (datetime) --
        
        The start time of the maintenance window.
      - End (datetime) --
        
        The end time of the maintenance window.
      - ScheduledTime (datetime) --
        
        The date and time when the maintenance window is scheduled to occur.
  - ContentQualityAnalysisType (string) --
    
    The type of content quality analysis applied to the router input.
  - ContentQualityAnalysisConfiguration (dict) --
    
    The content quality analysis configuration for the router input.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: ContentLevel. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - ContentLevel (dict) --
      
      The content quality analysis configuration.
      - BlackFrames (dict) --
        
        Settings for black frames detection.
        
        State (string) --
        
        Indicates whether black frames detection is enabled or disabled.
        
        ThresholdSeconds (integer) --
        
        The number of consecutive seconds of black frames that MediaConnect must detect before it reports an issue.
      - FrozenFrames (dict) --
        
        Settings for frozen frames detection.
        
        State (string) --
        
        Indicates whether frozen frames detection is enabled or disabled.
        
        ThresholdSeconds (integer) --
        
        The number of consecutive seconds of a frozen frame that MediaConnect must detect before it reports an issue.
      - SilentAudio (dict) --
        
        Settings for silent audio detection.
        
        State (string) --
        
        Indicates whether silent audio detection is enabled or disabled.
        
        ThresholdSeconds (integer) --
        
        The number of consecutive seconds of silence that MediaConnect must detect before it reports an issue.
  - AssociatedDestinationEndpointArns (list) --
    
    The Amazon Resource Names (ARNs) of one or more destination endpoints that are associated with this router input.
    - (string) --

UpdateRouterOutput (updated)

Link ¶
Changes (request, response)
Request

{'Configuration': {'SourceEndpoint': {'DestinationTransitEncryption': {'Automatic': {},
                                                                       'SecretsManager': {'EncryptionSecret': {'SecretArn': 'string'},
                                                                                          'EncryptionSecretType': 'AES_128_KEY '
                                                                                                                  '| '
                                                                                                                  'AES_192_KEY '
                                                                                                                  '| '
                                                                                                                  'AES_256_KEY '
                                                                                                                  '| '
                                                                                                                  'SRT_PASSPHRASE'}},
                                      'DestinationTransitEncryptionType': 'SECRETS_MANAGER '
                                                                          '| '
                                                                          'AUTOMATIC',
                                      'EndpointLifecycleManagement': 'MANAGED '
                                                                     '| '
                                                                     'UNMANAGED'}}}

Response

{'RouterOutput': {'AssociatedSourceEndpointArns': ['string'],
                  'Configuration': {'SourceEndpoint': {'DestinationTransitEncryption': {'Automatic': {},
                                                                                        'SecretsManager': {'EncryptionSecret': {'SecretArn': 'string'},
                                                                                                           'EncryptionSecretType': 'AES_128_KEY '
                                                                                                                                   '| '
                                                                                                                                   'AES_192_KEY '
                                                                                                                                   '| '
                                                                                                                                   'AES_256_KEY '
                                                                                                                                   '| '
                                                                                                                                   'SRT_PASSPHRASE'}},
                                                       'DestinationTransitEncryptionType': 'SECRETS_MANAGER '
                                                                                           '| '
                                                                                           'AUTOMATIC',
                                                       'EndpointLifecycleManagement': 'MANAGED '
                                                                                      '| '
                                                                                      'UNMANAGED'}},
                  'OutputType': {'SOURCE_ENDPOINT'},
                  'StreamDetails': {'SourceEndpoint': {}}}}

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'
                        }
                    }
                },
                'RtmpPush': {
                    'DestinationAddress': 'string',
                    'DestinationPort': 123,
                    'ApplicationName': 'string',
                    'StreamName': 'string',
                    'TlsEncryption': {
                        'EncryptionType': 'PUBLIC',
                        'EncryptionConfiguration': {
                            'Public': {}

                        }
                    }
                },
                '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'|'RTMP_PUSH'
        },
        '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': {}

                }
            }
        },
        'SourceEndpoint': {
            'EndpointLifecycleManagement': 'MANAGED'|'UNMANAGED',
            'DestinationTransitEncryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
            'DestinationTransitEncryption': {
                'SecretsManager': {
                    'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                    'EncryptionSecret': {
                        'SecretArn': 'string'
                    }
                },
                'Automatic': {}

            }
        }
    },
    MaximumBitrate=123,
    RoutingScope='REGIONAL'|'GLOBAL',
    Tier='OUTPUT_100'|'OUTPUT_50'|'OUTPUT_20'|'OUTPUT_500'|'OUTPUT_250',
    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.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: Rist, SrtListener, RtmpPush, SrtCaller, Rtp.
  - 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.
  - RtmpPush (dict) --
    
    The configuration settings for a router output that pushes a stream to a destination using the RTMP (Real-Time Messaging Protocol) protocol, or RTMPS (RTMP over TLS) when TLS encryption is specified. These settings include the destination address and port, the application and stream names, and optional TLS encryption configuration.
    - DestinationAddress (string) -- [REQUIRED]
      
      The IP address or hostname of the destination RTMP server that the router output pushes the stream to. Provide only the server address; specify the application and stream names separately.
    - DestinationPort (integer) -- [REQUIRED]
      
      The TCP port on the destination RTMP server. For RTMP, valid values range from 1024 to 65535. For RTMPS (RTMP over TLS), valid values are 443 or 1024 to 65535. RTMP typically uses port 1935, and RTMPS typically uses port 443.
    - ApplicationName (string) -- [REQUIRED]
      
      The name of the RTMP application on the destination server. Together with the stream name, the application name forms the RTMP URL path, in the pattern rtmp://destinationAddress/applicationName/streamName.
    - StreamName (string) -- [REQUIRED]
      
      The name of the RTMP stream that the output publishes to the destination application. The stream name forms the final segment of the RTMP URL path.
    - TlsEncryption (dict) --
      
      The TLS encryption settings for the output. When you specify these settings, the output uses RTMPS (RTMP over TLS) to establish a secure, encrypted connection to the destination server.
      - EncryptionType (string) --
        
        The type of TLS encryption to use for the connection.
      - EncryptionConfiguration (dict) -- [REQUIRED]
        
        The configuration settings for the specified TLS encryption type.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys can be set: Public.
        
        Public (dict) --
        
        The TLS encryption configuration that validates the destination by using a publicly trusted certificate authority.
  - 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.

To connect the router output to the flow source, provide both flowArn and flowSourceArn. To disconnect it, call the update operation and omit both fields while keeping this configuration object.

Note

You can't change destinationTransitEncryption while the router output is connected to a flow source. To change it, first disconnect the router output, then update the encryption.
- 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.
    
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.
    - 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.

To connect the router output to the MediaLive input, provide both mediaLiveInputArn and mediaLivePipelineId. To disconnect it, call the update operation and omit both fields while keeping this configuration object.

Note

You can't change destinationTransitEncryption while the router output is connected to a MediaLive input. To change it, first disconnect the router output, then update the encryption.
- 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.
    
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.
    - 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.
SourceEndpoint (dict) --

Configuration settings for a router output that is represented by a source endpoint.
- EndpointLifecycleManagement (string) -- [REQUIRED]
  
  The entity that manages the lifecycle of the associated source endpoint. Valid values include the following:
  - MANAGED – MediaConnect manages the lifecycle of the associated source endpoint.
  - UNMANAGED – You manage the lifecycle of the associated source endpoint.
- DestinationTransitEncryptionType (string) --
  
  The type of transit encryption applied to the destination content that this router output sends. Valid values include the following:
  - SECRETS_MANAGER – The encryption key or passphrase is stored in Secrets Manager.
  - AUTOMATIC – MediaConnect determines the encryption key when the endpoint connects.
- DestinationTransitEncryption (dict) -- [REQUIRED]
  
  The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.
  - SecretsManager (dict) --
    
    The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
    - EncryptionSecretType (string) --
      
      The type of secret used to encrypt the connection. Valid values include the following:
      - AES_128_KEY – A 128-bit AES encryption key.
      - AES_192_KEY – A 192-bit AES encryption key.
      - AES_256_KEY – A 256-bit AES encryption key.
      - SRT_PASSPHRASE – An SRT passphrase.
    - EncryptionSecret (dict) -- [REQUIRED]
      
      The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
      - SecretArn (string) -- [REQUIRED]
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
  - Automatic (dict) --
    
    The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.

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. The tier sets the maximum bitrate, in Mbps, for the router output. Valid values include the following:

OUTPUT_20 – 20 Mbps
OUTPUT_50 – 50 Mbps
OUTPUT_100 – 100 Mbps
OUTPUT_250 – 250 Mbps
OUTPUT_500 – 500 Mbps

The 250 Mbps and 500 Mbps tiers are high-bitrate tiers that support TR-07 (JPEG XS) workflows.

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'|'SOURCE_ENDPOINT',
        'Configuration': {
            'Standard': {
                'NetworkInterfaceArn': 'string',
                'ProtocolConfiguration': {
                    'Rist': {
                        'DestinationAddress': 'string',
                        'DestinationPort': 123
                    },
                    'SrtListener': {
                        'Port': 123,
                        'MinimumLatencyMilliseconds': 123,
                        'EncryptionConfiguration': {
                            'EncryptionKey': {
                                'SecretArn': 'string',
                                'RoleArn': 'string'
                            }
                        }
                    },
                    'RtmpPush': {
                        'DestinationAddress': 'string',
                        'DestinationPort': 123,
                        'ApplicationName': 'string',
                        'StreamName': 'string',
                        'TlsEncryption': {
                            'EncryptionType': 'PUBLIC',
                            'EncryptionConfiguration': {
                                'Public': {}
                            }
                        }
                    },
                    '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'|'RTMP_PUSH'
            },
            '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': {}
                    }
                }
            },
            'SourceEndpoint': {
                'EndpointLifecycleManagement': 'MANAGED'|'UNMANAGED',
                'DestinationTransitEncryptionType': 'SECRETS_MANAGER'|'AUTOMATIC',
                'DestinationTransitEncryption': {
                    'SecretsManager': {
                        'EncryptionSecretType': 'AES_128_KEY'|'AES_192_KEY'|'AES_256_KEY'|'SRT_PASSPHRASE',
                        'EncryptionSecret': {
                            'SecretArn': 'string'
                        }
                    },
                    'Automatic': {}
                }
            }
        },
        'RoutedState': 'ROUTED'|'ROUTING'|'UNROUTED',
        'RegionName': 'string',
        'AvailabilityZone': 'string',
        'MaximumBitrate': 123,
        'RoutingScope': 'REGIONAL'|'GLOBAL',
        'Tier': 'OUTPUT_100'|'OUTPUT_50'|'OUTPUT_20'|'OUTPUT_500'|'OUTPUT_250',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'Messages': [
            {
                'Code': 'string',
                'Message': 'string'
            },
        ],
        'Tags': {
            'string': 'string'
        },
        'StreamDetails': {
            'Standard': {
                'DestinationIpAddress': 'string'
            },
            'MediaConnectFlow': {},
            'MediaLiveInput': {},
            'SourceEndpoint': {}
        },
        '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'
        },
        'AssociatedSourceEndpointArns': [
            'string',
        ]
    }
}

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.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, MediaConnectFlow, MediaLiveInput, SourceEndpoint. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      The configuration settings for a standard router output, including the protocol, protocol-specific configuration, network interface, and availability zone.
      - NetworkInterfaceArn (string) --
        
        The Amazon Resource Name (ARN) of the network interface associated with the standard router output.
      - ProtocolConfiguration (dict) --
        
        The configuration settings for the protocol used by the standard router output.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Rist, SrtListener, RtmpPush, SrtCaller, Rtp. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        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.
        
        RtmpPush (dict) --
        
        The configuration settings for a router output that pushes a stream to a destination using the RTMP (Real-Time Messaging Protocol) protocol, or RTMPS (RTMP over TLS) when TLS encryption is specified. These settings include the destination address and port, the application and stream names, and optional TLS encryption configuration.
        
        DestinationAddress (string) --
        
        The IP address or hostname of the destination RTMP server that the router output pushes the stream to. Provide only the server address; specify the application and stream names separately.
        
        DestinationPort (integer) --
        
        The TCP port on the destination RTMP server. For RTMP, valid values range from 1024 to 65535. For RTMPS (RTMP over TLS), valid values are 443 or 1024 to 65535. RTMP typically uses port 1935, and RTMPS typically uses port 443.
        
        ApplicationName (string) --
        
        The name of the RTMP application on the destination server. Together with the stream name, the application name forms the RTMP URL path, in the pattern rtmp://destinationAddress/applicationName/streamName.
        
        StreamName (string) --
        
        The name of the RTMP stream that the output publishes to the destination application. The stream name forms the final segment of the RTMP URL path.
        
        TlsEncryption (dict) --
        
        The TLS encryption settings for the output. When you specify these settings, the output uses RTMPS (RTMP over TLS) to establish a secure, encrypted connection to the destination server.
        
        EncryptionType (string) --
        
        The type of TLS encryption to use for the connection.
        
        EncryptionConfiguration (dict) --
        
        The configuration settings for the specified TLS encryption type.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: Public. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        Public (dict) --
        
        The TLS encryption configuration that validates the destination by using a publicly trusted certificate authority.
        
        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.
      
      To connect the router output to the flow source, provide both flowArn and flowSourceArn. To disconnect it, call the update operation and omit both fields while keeping this configuration object.
      
      Note
      
      You can't change destinationTransitEncryption while the router output is connected to a flow source. To change it, first disconnect the router output, then update the encryption.
      - FlowArn (string) --
        
        The ARN of the flow to connect to this router output.
      - FlowSourceArn (string) --
        
        The ARN of the flow source to connect to this router output.
      - DestinationTransitEncryption (dict) --
        
        The encryption configuration for the flow destination when connected to this router output.
        
        EncryptionKeyType (string) --
        
        The type of encryption key to use for flow transit encryption.
        
        EncryptionKeyConfiguration (dict) --
        
        The configuration details for the encryption key.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The configuration settings for transit encryption using 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.
      
      To connect the router output to the MediaLive input, provide both mediaLiveInputArn and mediaLivePipelineId. To disconnect it, call the update operation and omit both fields while keeping this configuration object.
      
      Note
      
      You can't change destinationTransitEncryption while the router output is connected to a MediaLive input. To change it, first disconnect the router output, then update the encryption.
      - MediaLiveInputArn (string) --
        
        The ARN of the MediaLive input to connect to this router output.
      - MediaLivePipelineId (string) --
        
        The index of the MediaLive pipeline to connect to this router output.
      - DestinationTransitEncryption (dict) --
        
        The encryption configuration for the MediaLive input when connected to this router output.
        
        EncryptionKeyType (string) --
        
        The type of encryption key to use for MediaLive transit encryption.
        
        EncryptionKeyConfiguration (dict) --
        
        The configuration details for the MediaLive encryption key.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The configuration settings for transit encryption using 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.
    - SourceEndpoint (dict) --
      
      Configuration settings for a router output that is represented by a source endpoint.
      - EndpointLifecycleManagement (string) --
        
        The entity that manages the lifecycle of the associated source endpoint. Valid values include the following:
        
        MANAGED – MediaConnect manages the lifecycle of the associated source endpoint.
        
        UNMANAGED – You manage the lifecycle of the associated source endpoint.
      - DestinationTransitEncryptionType (string) --
        
        The type of transit encryption applied to the destination content that this router output sends. Valid values include the following:
        
        SECRETS_MANAGER – The encryption key or passphrase is stored in Secrets Manager.
        
        AUTOMATIC – MediaConnect determines the encryption key when the endpoint connects.
      - DestinationTransitEncryption (dict) --
        
        The encryption settings for an endpoint connection. This is a union type, so exactly one of its members is set: secretsManager when you store the encryption key or passphrase in Secrets Manager, or automatic when you let MediaConnect determine the encryption key when the endpoint connects.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: SecretsManager, Automatic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        SecretsManager (dict) --
        
        The encryption configuration for a connection that uses a key or passphrase that you store in Secrets Manager.
        
        EncryptionSecretType (string) --
        
        The type of secret used to encrypt the connection. Valid values include the following:
        
        AES_128_KEY – A 128-bit AES encryption key.
        
        AES_192_KEY – A 192-bit AES encryption key.
        
        AES_256_KEY – A 256-bit AES encryption key.
        
        SRT_PASSPHRASE – An SRT passphrase.
        
        EncryptionSecret (dict) --
        
        The Secrets Manager secret that holds the key or passphrase used to encrypt the connection.
        
        SecretArn (string) --
        
        The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
        
        Automatic (dict) --
        
        The configuration for automatic encryption, where MediaConnect determines the encryption key when the endpoint connects.
  - 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 for the router output. The tier sets the maximum bitrate, in Mbps, for the router output. Valid values include the following:
    - OUTPUT_20 – 20 Mbps
    - OUTPUT_50 – 50 Mbps
    - OUTPUT_100 – 100 Mbps
    - OUTPUT_250 – 250 Mbps
    - OUTPUT_500 – 500 Mbps
    The 250 Mbps and 500 Mbps tiers are high-bitrate tiers that support TR-07 (JPEG XS) workflows.
  - CreatedAt (datetime) --
    
    The timestamp when the router output was created.
  - UpdatedAt (datetime) --
    
    The timestamp when the router output was last updated.
  - Messages (list) --
    
    The messages associated with the router output.
    - (dict) --
      
      A message associated with a router output.
      - Code (string) --
        
        The code associated with the router output message.
      - Message (string) --
        
        The message text associated with the router output message.
  - Tags (dict) --
    
    Key-value pairs that can be used to tag and organize this router output.
    - (string) --
      - (string) --
  - StreamDetails (dict) --
    
    Information about the router output's stream, including connection state and destination details. The specific details provided vary based on the router output type.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Standard, MediaConnectFlow, MediaLiveInput, SourceEndpoint. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Standard (dict) --
      
      Configuration details for a standard router output stream type. Contains information about the destination IP address and connection state for basic output routing.
      - DestinationIpAddress (string) --
        
        The IP address where the output stream will be sent. This is the destination address that will receive the routed media content.
    - MediaConnectFlow (dict) --
      
      Configuration details for a MediaConnect flow when used as a router output destination.
    - MediaLiveInput (dict) --
      
      Configuration details for a MediaLive input when used as a router output destination.
    - SourceEndpoint (dict) --
      
      Configuration details for a router output stream that is represented by a source endpoint.
  - IpAddress (string) --
    
    The IP address of the router output.
  - RoutedInputArn (string) --
    
    The Amazon Resource Name (ARN) of the router input associated with the output.
  - MaintenanceType (string) --
    
    The type of maintenance configuration applied to this router output.
  - MaintenanceConfiguration (dict) --
    
    The maintenance configuration settings applied to this router output.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: PreferredDayTime, Default. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - PreferredDayTime (dict) --
      
      Preferred day and time maintenance configuration settings.
      - Day (string) --
        
        The preferred day for maintenance operations.
      - Time (string) --
        
        The preferred time for maintenance operations.
    - Default (dict) --
      
      Default maintenance configuration settings.
  - MaintenanceScheduleType (string) --
    
    The type of maintenance schedule currently in effect for this router output.
  - MaintenanceSchedule (dict) --
    
    The current maintenance schedule details for this router output.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: Window. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - Window (dict) --
      
      Defines a specific time window for maintenance operations.
      - Start (datetime) --
        
        The start time of the maintenance window.
      - End (datetime) --
        
        The end time of the maintenance window.
      - ScheduledTime (datetime) --
        
        The date and time when the maintenance window is scheduled to occur.
  - 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.
  - AssociatedSourceEndpointArns (list) --
    
    The Amazon Resource Names (ARNs) of one or more source endpoints that are associated with this router output.
    - (string) --