MediaConnect / Client / register_destination_endpoint

register_destination_endpoint¶

MediaConnect.Client.register_destination_endpoint(**kwargs)¶

Registers a new destination endpoint in MediaConnect.

Request Syntax

response = 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'
)

Parameters:

Description (string) – A description to help you identify the destination endpoint.
Configuration (dict) –
[REQUIRED]

The configuration settings for the destination endpoint.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: Standard, RouterInput.
- 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.
RegionName (string) – The name of the Amazon Web Services Region in which to register the destination endpoint. Defaults to the current region if not specified.
Tags (dict) –
The tags to apply to the destination endpoint. Each tag is a key-value pair.
- (string) –
  - (string) –
ClientToken (string) –
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.

Return type:

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

register_destination_endpoint¶

Request Syntax

Note

Note

Note

Response Syntax

Response Structure

Note

Note

Note

Note

Note

Note

Note

Note

Note

Exceptions