Gateway bridge: describe, update, delete

URI

/v1/bridges/bridgeArn

HTTP methods

GET

Operation ID: DescribeBridge

Displays the details of a bridge. The response includes the bridge ARN, name, and current state, as well as details about the sources, outputs, and failover configuration.

Path parameters

Name	Type	Required	Description
bridgeArn	String	True	The ARN of the bridge that you want to describe.

Responses

Status code	Response model	Description
200	DescribeBridgeResponse	AWS Elemental MediaConnect returned the bridge details successfully.
400	ResponseError	The request that you submitted is not valid.
403	ResponseError	You don't have the required permissions to perform this operation.
404	ResponseError	MediaConnect did not find the resource that you specified in the request.
409	ResponseError	There was a conflict when trying to add the requested output
429	ResponseError	You have exceeded the service request rate limit for your MediaConnect account.
500	ResponseError	MediaConnect can't fulfill your request because it encountered an unexpected condition.
503	ResponseError	MediaConnect is currently unavailable. Try again later.

PUT

Operation ID: UpdateBridge

Updates the bridge.

We recommend activating no more than 10 bridges at one time. If you need to activate more than 10 bridges, use multiple requests.

Path parameters

Name	Type	Required	Description
bridgeArn	String	True	The ARN of the bridge that you want to describe.

Responses

Status code	Response model	Description
202	UpdateBridgeResponse	MediaConnect is starting the flow.
400	ResponseError	The request that you submitted is not valid.
403	ResponseError	You don't have the required permissions to perform this operation.
404	ResponseError	MediaConnect did not find the resource that you specified in the request.
409	ResponseError	There was a conflict when trying to add the requested output
429	ResponseError	You have exceeded the service request rate limit for your MediaConnect account.
500	ResponseError	MediaConnect can't fulfill your request because it encountered an unexpected condition.
503	ResponseError	MediaConnect is currently unavailable. Try again later.

DELETE

Operation ID: DeleteBridge

Deletes a bridge. Before you can delete a bridge, you must stop the bridge.

Path parameters

Name	Type	Required	Description
bridgeArn	String	True	The ARN of the bridge that you want to describe.

Responses

Status code	Response model	Description
200	DeleteBridgeResponse	AWS Elemental MediaConnect deleted the bridge.
202	DeleteBridgeResponse	MediaConnect is starting the flow.
400	ResponseError	The request that you submitted is not valid.
403	ResponseError	You don't have the required permissions to perform this operation.
404	ResponseError	MediaConnect did not find the resource that you specified in the request.
409	ResponseError	There was a conflict when trying to add the requested output
429	ResponseError	You have exceeded the service request rate limit for your MediaConnect account.
500	ResponseError	MediaConnect can't fulfill your request because it encountered an unexpected condition.
503	ResponseError	MediaConnect is currently unavailable. Try again later.

Schemas

Request bodies

PUT schema

{
  "ingressGatewayBridge": {
    "maxOutputs": integer,
    "maxBitrate": integer
  },
  "egressGatewayBridge": {
    "maxBitrate": integer
  },
  "sourceFailoverConfig": {
    "failoverMode": enum,
    "recoveryWindow": integer,
    "state": enum,
    "sourcePriority": {
      "primarySource": "string"
    }
  }
}

Response bodies

DescribeBridgeResponse schema

{
  "bridge": {
    "ingressGatewayBridge": {
      "instanceId": "string",
      "maxOutputs": integer,
      "maxBitrate": integer
    },
    "outputs": [
      {
        "flowOutput": {
          "flowArn": "string",
          "name": "string",
          "flowSourceArn": "string"
        },
        "networkOutput": {
          "protocol": enum,
          "port": integer,
          "ipAddress": "string",
          "name": "string",
          "networkName": "string",
          "ttl": integer
        }
      }
    ],
    "bridgeArn": "string",
    "placementArn": "string",
    "bridgeState": enum,
    "egressGatewayBridge": {
      "instanceId": "string",
      "maxBitrate": integer
    },
    "sources": [
      {
        "networkSource": {
          "protocol": enum,
          "port": integer,
          "name": "string",
          "networkName": "string",
          "multicastIp": "string"
        },
        "flowSource": {
          "outputArn": "string",
          "flowArn": "string",
          "name": "string",
          "flowVpcInterfaceAttachment": {
            "vpcInterfaceName": "string"
          }
        }
      }
    ],
    "name": "string",
    "sourceFailoverConfig": {
      "failoverMode": enum,
      "recoveryWindow": integer,
      "state": enum,
      "sourcePriority": {
        "primarySource": "string"
      }
    },
    "bridgeMessages": [
      {
        "code": "string",
        "resourceName": "string",
        "message": "string"
      }
    ]
  }
}

DeleteBridgeResponse schema

{
  "bridgeArn": "string"
}

UpdateBridgeResponse schema

{
  "bridge": {
    "ingressGatewayBridge": {
      "instanceId": "string",
      "maxOutputs": integer,
      "maxBitrate": integer
    },
    "outputs": [
      {
        "flowOutput": {
          "flowArn": "string",
          "name": "string",
          "flowSourceArn": "string"
        },
        "networkOutput": {
          "protocol": enum,
          "port": integer,
          "ipAddress": "string",
          "name": "string",
          "networkName": "string",
          "ttl": integer
        }
      }
    ],
    "bridgeArn": "string",
    "placementArn": "string",
    "bridgeState": enum,
    "egressGatewayBridge": {
      "instanceId": "string",
      "maxBitrate": integer
    },
    "sources": [
      {
        "networkSource": {
          "protocol": enum,
          "port": integer,
          "name": "string",
          "networkName": "string",
          "multicastIp": "string"
        },
        "flowSource": {
          "outputArn": "string",
          "flowArn": "string",
          "name": "string",
          "flowVpcInterfaceAttachment": {
            "vpcInterfaceName": "string"
          }
        }
      }
    ],
    "name": "string",
    "sourceFailoverConfig": {
      "failoverMode": enum,
      "recoveryWindow": integer,
      "state": enum,
      "sourcePriority": {
        "primarySource": "string"
      }
    },
    "bridgeMessages": [
      {
        "code": "string",
        "resourceName": "string",
        "message": "string"
      }
    ]
  }
}

ResponseError schema

{
  "message": "string"
}

Properties

Bridge

A Bridge is the connection between your data center's Instances and the AWS cloud. A bridge can be used to send video from the AWS cloud to your data center or from your data center to the AWS cloud.

Property	Type	Required	Description
bridgeArn	string	True	The Amazon Resource Number (ARN) of the bridge.
bridgeMessages	Array of type MessageDetail	False
bridgeState	string Values: CREATING | STANDBY | STARTING | DEPLOYING | ACTIVE | STOPPING | DELETING | DELETED | START_FAILED | START_PENDING | STOP_FAILED | UPDATING	True
egressGatewayBridge	EgressGatewayBridge	False
ingressGatewayBridge	IngressGatewayBridge	False
name	string	True	The name of the bridge.
outputs	Array of type BridgeOutput	False	The outputs on this bridge.
placementArn	string	True	The placement ARN of the bridge.
sourceFailoverConfig	FailoverConfig	False
sources	Array of type BridgeSource	False	The sources on this bridge.

BridgeFlowOutput

The output of the bridge. A flow output is delivered to the AWS cloud.

Property	Type	Required	Description
flowArn	string	True	The Amazon Resource Number (ARN) of the cloud flow.
flowSourceArn	string	True	The Amazon Resource Number (ARN) of the flow source.
name	string	True	The name of the bridge's output.

BridgeFlowSource

The source of the bridge. A flow source originates in MediaConnect as an existing cloud flow.

Property	Type	Required	Description
flowArn	string	True	The ARN of the cloud flow used as a source of this bridge.
flowVpcInterfaceAttachment	VpcInterfaceAttachment	False	The name of the VPC interface attachment to use for this source.
name	string	True	The name of the flow source.
outputArn	string	False	The Amazon Resource Number (ARN) of the output.

BridgeNetworkOutput

The output of the bridge. A network output is delivered to your premises.

Property	Type	Required	Description
ipAddress	string	True	The network output IP Address.
name	string	True	The network output name.
networkName	string	True	The network output's gateway network name.
port	integer	True	The network output port.
protocol	string Values: zixi-push | rtp-fec | rtp | zixi-pull | rist | st2110-jpegxs | cdi | srt-listener | srt-caller | fujitsu-qos | udp	True	The network output protocol.
ttl	integer	True	The network output TTL.

BridgeNetworkSource

The source of the bridge. A network source originates at your premises.

Property	Type	Required	Description
multicastIp	string	True	The network source multicast IP.
name	string	True	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	True	The network source's gateway network name.
port	integer	True	The network source port.
protocol	string Values: zixi-push | rtp-fec | rtp | zixi-pull | rist | st2110-jpegxs | cdi | srt-listener | srt-caller | fujitsu-qos | udp	True	The network source protocol.

BridgeOutput

The output of the bridge.

Property	Type	Required	Description
flowOutput	BridgeFlowOutput	False
networkOutput	BridgeNetworkOutput	False

BridgeSource

The bridge's source.

Property	Type	Required	Description
flowSource	BridgeFlowSource	False
networkSource	BridgeNetworkSource	False

DeleteBridgeResponse

The bridge was successfully deleted.

Property	Type	Required	Description
bridgeArn	string	True	The Amazon Resource Number (ARN) of the deleted bridge.

DescribeBridgeResponse

Describe bridge was successful.

Property	Type	Required	Description
bridge	Bridge	True

EgressGatewayBridge

Property	Type	Required	Description
instanceId	string	False	The ID of the instance running this bridge.
maxBitrate	integer Format: int64	True	The maximum expected bitrate (in bps) of the egress bridge.

FailoverConfig

The settings for source failover.

Property	Type	Required	Description
failoverMode	string Values: MERGE | FAILOVER	False	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	False	The size of the buffer (delay) that the service maintains. A larger buffer means a longer delay in transmitting the stream, but more room for error correction. A smaller buffer means a shorter delay, but less room for error correction. You can choose a value from 100-500 ms. If you keep this field blank, the service uses the default value of 200 ms. This setting only applies when Failover Mode is set to MERGE.
sourcePriority	SourcePriority	False	The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams. This setting only applies when Failover Mode is set to FAILOVER.
state	string Values: ENABLED | DISABLED	False	The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.

IngressGatewayBridge

Property	Type	Required	Description
instanceId	string	False	The ID of the instance running this bridge.
maxBitrate	integer Format: int64	True	The maximum expected bitrate (in bps) of the ingress bridge.
maxOutputs	integer	True	The maximum number of outputs on the ingress bridge.

MessageDetail

Property	Type	Required	Description
code	string	True	The error code.
message	string	True	The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.
resourceName	string	False	The name of the resource.

ResponseError

An exception raised by MediaConnect when you submit a request that cannot be completed. For more information, see the error message and documentation for the operation.

Property	Type	Required	Description
message	string	True	The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.

SourcePriority

The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams. This setting only applies when Failover Mode is set to FAILOVER.

Property	Type	Required	Description
primarySource	string	False	The name of the source you choose as the primary source for this flow.

UpdateBridgeRequest

Update an existing bridge.

Property	Type	Required	Description
egressGatewayBridge	UpdateEgressGatewayBridgeRequest	False
ingressGatewayBridge	UpdateIngressGatewayBridgeRequest	False
sourceFailoverConfig	UpdateFailoverConfig	False

UpdateBridgeResponse

The bridge has been successfully updated.

Property	Type	Required	Description
bridge	Bridge	True

UpdateEgressGatewayBridgeRequest

Property	Type	Required	Description
maxBitrate	integer Format: int64	False	Update an existing egress-type bridge.

UpdateFailoverConfig

The settings for source failover.

Property	Type	Required	Description
failoverMode	string Values: MERGE | FAILOVER	False	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	False	The size of the buffer (delay) that you want the service to maintain. A larger buffer means a longer delay in transmitting the stream, but more room for error correction. A smaller buffer means a shorter delay, but less room for error correction. You can choose a value from 100-500 ms. If you keep this field blank, the service uses the default value of 200 ms. This setting only applies when Failover Mode is set to MERGE.
sourcePriority	SourcePriority	False	The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams. This setting only applies when Failover Mode is set to FAILOVER.
state	string Values: ENABLED | DISABLED	False	The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.

UpdateIngressGatewayBridgeRequest

Property	Type	Required	Description
maxBitrate	integer Format: int64	False	The maximum expected bitrate (in bps).
maxOutputs	integer	False	The maximum number of expected outputs.

VpcInterfaceAttachment

The VPC interface that you want to send your output to.

Property	Type	Required	Description
vpcInterfaceName	string	False	The name of the VPC interface that you want to send your output to.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

DescribeBridge

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

UpdateBridge

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

DeleteBridge

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3