MediaConnect / Client / describe_bridge

describe_bridge#

MediaConnect.Client.describe_bridge(**kwargs)#

Displays the details of a bridge.

See also: AWS API Documentation

Request Syntax

response = client.describe_bridge(
    BridgeArn='string'
)
Parameters:

BridgeArn (string) – [REQUIRED] The ARN of the bridge that you want to describe.

Return type:

dict

Returns:

Response Syntax

{
    'Bridge': {
        'BridgeArn': 'string',
        'BridgeMessages': [
            {
                'Code': 'string',
                'Message': 'string',
                'ResourceName': 'string'
            },
        ],
        'BridgeState': 'CREATING'|'STANDBY'|'STARTING'|'DEPLOYING'|'ACTIVE'|'STOPPING'|'DELETING'|'DELETED'|'START_FAILED'|'START_PENDING'|'STOP_FAILED'|'UPDATING',
        'EgressGatewayBridge': {
            'InstanceId': 'string',
            'MaxBitrate': 123
        },
        'IngressGatewayBridge': {
            'InstanceId': 'string',
            'MaxBitrate': 123,
            'MaxOutputs': 123
        },
        'Name': 'string',
        'Outputs': [
            {
                'FlowOutput': {
                    'FlowArn': 'string',
                    'FlowSourceArn': 'string',
                    'Name': 'string'
                },
                'NetworkOutput': {
                    'IpAddress': 'string',
                    'Name': 'string',
                    'NetworkName': 'string',
                    'Port': 123,
                    'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp',
                    'Ttl': 123
                }
            },
        ],
        'PlacementArn': 'string',
        'SourceFailoverConfig': {
            'FailoverMode': 'MERGE'|'FAILOVER',
            'RecoveryWindow': 123,
            'SourcePriority': {
                'PrimarySource': 'string'
            },
            'State': 'ENABLED'|'DISABLED'
        },
        'Sources': [
            {
                'FlowSource': {
                    'FlowArn': 'string',
                    'FlowVpcInterfaceAttachment': {
                        'VpcInterfaceName': 'string'
                    },
                    'Name': 'string',
                    'OutputArn': 'string'
                },
                'NetworkSource': {
                    'MulticastIp': 'string',
                    'MulticastSourceSettings': {
                        'MulticastSourceIp': 'string'
                    },
                    'Name': 'string',
                    'NetworkName': 'string',
                    'Port': 123,
                    'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'
                }
            },
        ]
    }
}

Response Structure

  • (dict) – AWS Elemental MediaConnect returned the bridge details successfully.

    • Bridge (dict) – A Bridge is the connection between your datacenter’s Instances and the AWS cloud. A bridge can be used to send video from the AWS cloud to your datacenter or from your datacenter to the AWS cloud.

      • BridgeArn (string) – The Amazon Resource Number (ARN) of the bridge.

      • BridgeMessages (list) –

        • (dict) –

          • Code (string) – The error code.

          • Message (string) – The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.

          • ResourceName (string) – The name of the resource.

      • BridgeState (string) –

      • EgressGatewayBridge (dict) –

        • InstanceId (string) – The ID of the instance running this bridge.

        • MaxBitrate (integer) – The maximum expected bitrate (in bps) of the egress bridge.

      • IngressGatewayBridge (dict) –

        • InstanceId (string) – The ID of the instance running this bridge.

        • MaxBitrate (integer) – The maximum expected bitrate (in bps) of the ingress bridge.

        • MaxOutputs (integer) – The maximum number of outputs on the ingress bridge.

      • Name (string) – The name of the bridge.

      • Outputs (list) – The outputs on this bridge.

        • (dict) – The output of the bridge.

          • FlowOutput (dict) – The output of the bridge. A flow output is delivered to the AWS cloud.

            • FlowArn (string) – The Amazon Resource Number (ARN) of the cloud flow.

            • FlowSourceArn (string) – The Amazon Resource Number (ARN) of the flow source.

            • Name (string) – The name of the bridge’s output.

          • NetworkOutput (dict) – The output of the bridge. A network output is delivered to your premises.

            • IpAddress (string) – The network output IP Address.

            • Name (string) – The network output name.

            • NetworkName (string) – The network output’s gateway network name.

            • Port (integer) – The network output port.

            • Protocol (string) – The network output protocol.

            • Ttl (integer) – The network output TTL.

      • PlacementArn (string) – The placement Amazon Resource Number (ARN) of the bridge.

      • SourceFailoverConfig (dict) – The settings for source failover.

        • FailoverMode (string) – The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.

        • RecoveryWindow (integer) – Search window time to look for dash-7 packets

        • SourcePriority (dict) – The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.

          • PrimarySource (string) – The name of the source you choose as the primary source for this flow.

        • State (string) –

      • Sources (list) – The sources on this bridge.

        • (dict) – The bridge’s source.

          • FlowSource (dict) – The source of the bridge. A flow source originates in MediaConnect as an existing cloud flow.

            • FlowArn (string) – The ARN of the cloud flow used as a source of this bridge.

            • FlowVpcInterfaceAttachment (dict) – The name of the VPC interface attachment to use for this source.

              • VpcInterfaceName (string) – The name of the VPC interface to use for this resource.

            • Name (string) – The name of the flow source.

            • OutputArn (string) – The Amazon Resource Number (ARN) of the output.

          • NetworkSource (dict) – The source of the bridge. A network source originates at your premises.

            • MulticastIp (string) – The network source multicast IP.

            • MulticastSourceSettings (dict) – The settings related to the multicast source.

              • MulticastSourceIp (string) – The IP address of the source for source-specific multicast (SSM).

            • Name (string) – The name of the network source.

            • NetworkName (string) – The network source’s gateway network name.

            • Port (integer) – The network source port.

            • Protocol (string) – The network source protocol.

Exceptions