Gateway bridge: create, list

URI

/v1/bridges

HTTP methods

GET

Operation ID: ListBridges

Displays a list of bridges that are associated with this account and an optionally specified Arn. This request returns a paginated result.

Query parameters

Name	Type	Required	Description
filterArn	String	False	Filter the list results to display only the bridges associated with the selected ARN.
nextToken	String	False	The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value.
maxResults	String	False	The maximum number of results to return per API request. For example, you submit a ListEntitlements request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 20 results per page.

Responses

Status code	Response model	Description
200	ListBridgesResponse	AWS Elemental MediaConnect returned the list of bridges successfully.
400	ResponseError	The request that you submitted is not valid.
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.

POST

Operation ID: CreateBridge

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

Responses

Status code	Response model	Description
201	CreateBridgeResponse	MediaConnect created the new resource successfully.
400	ResponseError	The request that you submitted is not valid.
403	ResponseError	You don't have the required permissions to perform this operation.
409	ResponseError	There was a conflict when trying to add the requested output
420	ResponseError	Your account already contains the maximum number of 20 flows per account, per Region. For more information, contact AWS Support.
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

POST schema

{
  "ingressGatewayBridge": {
    "maxOutputs": integer,
    "maxBitrate": integer
  },
  "outputs": [
    {
      "networkOutput": {
        "protocol": enum,
        "port": integer,
        "ipAddress": "string",
        "name": "string",
        "networkName": "string",
        "ttl": integer
      }
    }
  ],
  "placementArn": "string",
  "egressGatewayBridge": {
    "maxBitrate": integer
  },
  "sources": [
    {
      "networkSource": {
        "protocol": enum,
        "port": integer,
        "name": "string",
        "networkName": "string",
        "multicastIp": "string",
        "multicastSourceSettings": {
          "multicastSourceIp": "string"
        }
      },
      "flowSource": {
        "flowArn": "string",
        "name": "string",
        "flowVpcInterfaceAttachment": {
          "vpcInterfaceName": "string"
        }
      }
    }
  ],
  "name": "string",
  "sourceFailoverConfig": {
    "failoverMode": enum,
    "recoveryWindow": integer,
    "state": enum,
    "sourcePriority": {
      "primarySource": "string"
    }
  }
}

Response bodies

ListBridgesResponse schema

{
  "nextToken": "string",
  "bridges": [
    {
      "bridgeArn": "string",
      "placementArn": "string",
      "bridgeState": enum,
      "bridgeType": "string",
      "name": "string"
    }
  ]
}

CreateBridgeResponse 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",
          "multicastSourceSettings": {
            "multicastSourceIp": "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

AddBridgeFlowSourceRequest

Add a flow source to an existing bridge.

Property	Type	Required	Description
flowArn	string	True	The Amazon Resource Number (ARN) of the cloud flow to use 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. This name is used to reference the source and must be unique among sources in this bridge.

AddBridgeNetworkOutputRequest

Add a network output to an existing bridge.

Property	Type	Required	Description
ipAddress	string	True	The network output IP Address.
name	string	True	The network output name. This name is used to reference the output and must be unique among outputs in this bridge.
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 | udp	True	The network output protocol.
ttl	integer	True	The network output TTL.

AddBridgeNetworkSourceRequest

Add a network source to an existing bridge.

Property	Type	Required	Description
multicastIp	string	True	The network source multicast IP.
multicastSourceSettings	MulticastSourceSettings	False	The settings related to the multicast source.
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 | udp	True	The network source protocol.

AddBridgeOutputRequest

Add an output to a bridge.

Property	Type	Required	Description
networkOutput	AddBridgeNetworkOutputRequest	False

AddBridgeSourceRequest

Add a source to an existing bridge.

Property	Type	Required	Description
flowSource	AddBridgeFlowSourceRequest	False
networkSource	AddBridgeNetworkSourceRequest	False

AddEgressGatewayBridgeRequest

Property	Type	Required	Description
maxBitrate	integer Format: int64	True	The maximum expected bitrate (in bps).

AddIngressGatewayBridgeRequest

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

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 | 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.
multicastSourceSettings	MulticastSourceSettings	False	The settings related to the multicast source.
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 | 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

CreateBridgeRequest

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

Property	Type	Required	Description
egressGatewayBridge	AddEgressGatewayBridgeRequest	False	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.
ingressGatewayBridge	AddIngressGatewayBridgeRequest	False	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.
name	string	True	The name of the bridge. This name can not be modified after the bridge is created.
outputs	Array of type AddBridgeOutputRequest	False	The outputs that you want to add to this bridge.
placementArn	string	True	The bridge placement Amazon Resource Number (ARN).
sourceFailoverConfig	FailoverConfig	False	The settings for source failover.
sources	Array of type AddBridgeSourceRequest	True	The sources that you want to add to this bridge.

CreateBridgeResponse

The bridge was successfully created.

Property	Type	Required	Description
bridge	Bridge	False

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.

ListBridgesResponse

The result of a successful ListBridges request. The response includes bridge summaries and the NextToken to use in a subsequent ListBridges request.

Property	Type	Required	Description
bridges	Array of type ListedBridge	True	A list of bridge summaries.
nextToken	string	False	The token that identifies which batch of results that you want to see. For example, you submit a ListBridges request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListBridges request a second time and specify the NextToken value.

ListedBridge

Displays details of the selected bridge.

Property	Type	Required	Description
bridgeArn	string	True	The ARN of the bridge.
bridgeState	string Values: CREATING | STANDBY | STARTING | DEPLOYING | ACTIVE | STOPPING | DELETING | DELETED | START_FAILED | START_PENDING | STOP_FAILED | UPDATING	True
bridgeType	string	True	The type of the bridge.
name	string	True	The name of the bridge.
placementArn	string	True	The ARN of the gateway associated with the 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.

MulticastSourceSettings

The settings related to the multicast source.

Property	Type	Required	Description
multicastSourceIp	string	False	The IP address of the source for source-specific multicast (SSM).

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.

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:

ListBridges

• 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

CreateBridge

• 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