MediaConnect / Client / batch_get_source_endpoint

batch_get_source_endpoint

MediaConnect.Client.batch_get_source_endpoint(**kwargs)

Retrieves information about multiple source endpoints in a single request.

See also: AWS API Documentation

Request Syntax

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

Arns (list) –

[REQUIRED]

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

  • (string) –

Return type:

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.

Exceptions