AWS MediaConnect

2024/12/13 - AWS MediaConnect - 5 updated api methods

Changes  AWS Elemental MediaConnect Gateway now supports Source Specific Multicast (SSM) for ingress bridges. This enables you to specify a source IP address in addition to a multicast IP when creating or updating an ingress bridge source.

AddBridgeSources (updated) Link ¶
Changes (both)
{'Sources': {'NetworkSource': {'MulticastSourceSettings': {'MulticastSourceIp': 'string'}}}}

Adds sources to an existing bridge.

See also: AWS API Documentation

Request Syntax

client.add_bridge_sources(
    BridgeArn='string',
    Sources=[
        {
            'FlowSource': {
                'FlowArn': 'string',
                'FlowVpcInterfaceAttachment': {
                    'VpcInterfaceName': 'string'
                },
                'Name': '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'
            }
        },
    ]
)
type BridgeArn:

string

param BridgeArn:

[REQUIRED] The ARN of the bridge that you want to update.

type Sources:

list

param Sources:

[REQUIRED] The sources that you want to add to this bridge.

  • (dict) -- Add a source to an existing bridge.

    • FlowSource (dict) -- Add a flow source to an existing bridge.

      • FlowArn (string) -- [REQUIRED] The Amazon Resource Number (ARN) of the cloud flow to use 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) -- [REQUIRED] The name of the flow source. This name is used to reference the source and must be unique among sources in this bridge.

    • NetworkSource (dict) -- Add a network source to an existing bridge.

      • MulticastIp (string) -- [REQUIRED] 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) -- [REQUIRED] The name of the network source. This name is used to reference the source and must be unique among sources in this bridge.

      • NetworkName (string) -- [REQUIRED] The network source's gateway network name.

      • Port (integer) -- [REQUIRED] The network source port.

      • Protocol (string) -- [REQUIRED] The network source protocol.

rtype:

dict

returns:

Response Syntax

{
    'BridgeArn': 'string',
    '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 added the bridge sources successfully.

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

    • Sources (list) -- The sources that you added to 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.

CreateBridge (updated) Link ¶
Changes (request, response)
Request
{'Sources': {'NetworkSource': {'MulticastSourceSettings': {'MulticastSourceIp': 'string'}}}}
Response
{'Bridge': {'Sources': {'NetworkSource': {'MulticastSourceSettings': {'MulticastSourceIp': 'string'}}}}}

Creates a new bridge. The request must include one source.

See also: AWS API Documentation

Request Syntax

client.create_bridge(
    EgressGatewayBridge={
        'MaxBitrate': 123
    },
    IngressGatewayBridge={
        'MaxBitrate': 123,
        'MaxOutputs': 123
    },
    Name='string',
    Outputs=[
        {
            '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'
            },
            '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'
            }
        },
    ]
)
type EgressGatewayBridge:

dict

param EgressGatewayBridge:

Create a bridge with the egress bridge type. An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.

  • MaxBitrate (integer) -- [REQUIRED] The maximum expected bitrate (in bps).

type IngressGatewayBridge:

dict

param IngressGatewayBridge:

Create a bridge with the ingress bridge type. An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.

  • MaxBitrate (integer) -- [REQUIRED] The maximum expected bitrate (in bps).

  • MaxOutputs (integer) -- [REQUIRED] The maximum number of expected outputs.

type Name:

string

param Name:

[REQUIRED] The name of the bridge. This name can not be modified after the bridge is created.

type Outputs:

list

param Outputs:

The outputs that you want to add to this bridge.

  • (dict) -- Add an output to a bridge.

    • NetworkOutput (dict) -- Add a network output to an existing bridge.

      • IpAddress (string) -- [REQUIRED] The network output IP Address.

      • Name (string) -- [REQUIRED] The network output name. This name is used to reference the output and must be unique among outputs in this bridge.

      • NetworkName (string) -- [REQUIRED] The network output's gateway network name.

      • Port (integer) -- [REQUIRED] The network output port.

      • Protocol (string) -- [REQUIRED] The network output protocol.

      • Ttl (integer) -- [REQUIRED] The network output TTL.

type PlacementArn:

string

param PlacementArn:

[REQUIRED] The bridge placement Amazon Resource Number (ARN).

type SourceFailoverConfig:

dict

param SourceFailoverConfig:

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

type Sources:

list

param Sources:

[REQUIRED] The sources that you want to add to this bridge.

  • (dict) -- Add a source to an existing bridge.

    • FlowSource (dict) -- Add a flow source to an existing bridge.

      • FlowArn (string) -- [REQUIRED] The Amazon Resource Number (ARN) of the cloud flow to use 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) -- [REQUIRED] The name of the flow source. This name is used to reference the source and must be unique among sources in this bridge.

    • NetworkSource (dict) -- Add a network source to an existing bridge.

      • MulticastIp (string) -- [REQUIRED] 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) -- [REQUIRED] The name of the network source. This name is used to reference the source and must be unique among sources in this bridge.

      • NetworkName (string) -- [REQUIRED] The network source's gateway network name.

      • Port (integer) -- [REQUIRED] The network source port.

      • Protocol (string) -- [REQUIRED] The network source protocol.

rtype:

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 created the new bridge 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.

DescribeBridge (updated) Link ¶
Changes (response)
{'Bridge': {'Sources': {'NetworkSource': {'MulticastSourceSettings': {'MulticastSourceIp': 'string'}}}}}

Displays the details of a bridge.

See also: AWS API Documentation

Request Syntax

client.describe_bridge(
    BridgeArn='string'
)
type BridgeArn:

string

param BridgeArn:

[REQUIRED] The ARN of the bridge that you want to describe.

rtype:

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.

UpdateBridge (updated) Link ¶
Changes (response)
{'Bridge': {'Sources': {'NetworkSource': {'MulticastSourceSettings': {'MulticastSourceIp': 'string'}}}}}

Updates the bridge

See also: AWS API Documentation

Request Syntax

client.update_bridge(
    BridgeArn='string',
    EgressGatewayBridge={
        'MaxBitrate': 123
    },
    IngressGatewayBridge={
        'MaxBitrate': 123,
        'MaxOutputs': 123
    },
    SourceFailoverConfig={
        'FailoverMode': 'MERGE'|'FAILOVER',
        'RecoveryWindow': 123,
        'SourcePriority': {
            'PrimarySource': 'string'
        },
        'State': 'ENABLED'|'DISABLED'
    }
)
type BridgeArn:

string

param BridgeArn:

[REQUIRED] The Amazon Resource Number (ARN) of the bridge that you want to update.

type EgressGatewayBridge:

dict

param EgressGatewayBridge:
  • MaxBitrate (integer) -- Update an existing egress-type bridge.

type IngressGatewayBridge:

dict

param IngressGatewayBridge:
  • MaxBitrate (integer) -- The maximum expected bitrate (in bps).

  • MaxOutputs (integer) -- The maximum number of expected outputs.

type SourceFailoverConfig:

dict

param SourceFailoverConfig:

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

rtype:

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 updated the bridge 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.

UpdateBridgeSource (updated) Link ¶
Changes (request, response)
Request
{'NetworkSource': {'MulticastSourceSettings': {'MulticastSourceIp': 'string'}}}
Response
{'Source': {'NetworkSource': {'MulticastSourceSettings': {'MulticastSourceIp': 'string'}}}}

Updates an existing bridge source.

See also: AWS API Documentation

Request Syntax

client.update_bridge_source(
    BridgeArn='string',
    FlowSource={
        'FlowArn': 'string',
        'FlowVpcInterfaceAttachment': {
            'VpcInterfaceName': 'string'
        }
    },
    NetworkSource={
        'MulticastIp': 'string',
        'MulticastSourceSettings': {
            'MulticastSourceIp': 'string'
        },
        'NetworkName': 'string',
        'Port': 123,
        'Protocol': 'zixi-push'|'rtp-fec'|'rtp'|'zixi-pull'|'rist'|'st2110-jpegxs'|'cdi'|'srt-listener'|'srt-caller'|'fujitsu-qos'|'udp'
    },
    SourceName='string'
)
type BridgeArn:

string

param BridgeArn:

[REQUIRED] The ARN of the bridge that you want to update.

type FlowSource:

dict

param FlowSource:

Update the flow source of the bridge.

  • FlowArn (string) -- The ARN of the cloud flow to use 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.

type NetworkSource:

dict

param NetworkSource:

Update the network source of the bridge.

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

  • NetworkName (string) -- The network source's gateway network name.

  • Port (integer) -- The network source port.

  • Protocol (string) -- The network source protocol.

type SourceName:

string

param SourceName:

[REQUIRED] The name of the source that you want to update.

rtype:

dict

returns:

Response Syntax

{
    'BridgeArn': 'string',
    'Source': {
        '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) -- MediaConnect is updating the bridge source.

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

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