URI HTTP methods Schemas Properties See also

Gateway bridge sources: update, remove

URI

/v1/bridges/bridgeArn/sources/sourceName

HTTP methods

PUT

Operation ID: UpdateBridgeSource

Updates an existing bridge source.

Path parameters
Name	Type	Required	Description
`bridgeArn`	String	True	The ARN of the bridge that you want to describe.
`sourceName`	String	True	The name of the source that you want to update.

Responses
Status code	Response model	Description
`202`	`UpdateBridgeSourceResponse`	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: RemoveBridgeSource

Removes a source from a bridge.

Path parameters
Name	Type	Required	Description
`bridgeArn`	String	True	The ARN of the bridge that you want to describe.
`sourceName`	String	True	The name of the source that you want to update.

Responses
Status code	Response model	Description
`202`	`RemoveBridgeSourceResponse`	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


{
  "networkSource": {
    "protocol": enum,
    "port": integer,
    "networkName": "string",
    "multicastIp": "string",
    "multicastSourceSettings": {
      "multicastSourceIp": "string"
    }
  },
  "flowSource": {
    "flowArn": "string",
    "flowVpcInterfaceAttachment": {
      "vpcInterfaceName": "string"
    }
  }
}

Response bodies


{
  "bridgeArn": "string",
  "source": {
    "networkSource": {
      "protocol": enum,
      "port": integer,
      "name": "string",
      "networkName": "string",
      "multicastIp": "string",
      "multicastSourceSettings": {
        "multicastSourceIp": "string"
      }
    },
    "flowSource": {
      "outputArn": "string",
      "flowArn": "string",
      "name": "string",
      "flowVpcInterfaceAttachment": {
        "vpcInterfaceName": "string"
      }
    }
  }
}


{
  "bridgeArn": "string",
  "sourceName": "string"
}


{
  "message": "string"
}

Properties

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.

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.

BridgeSource

The bridge's source.

Property	Type	Required	Description
`flowSource`	BridgeFlowSource	False
`networkSource`	BridgeNetworkSource	False

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

RemoveBridgeSourceResponse

The bridge source has been successfully removed.

Property	Type	Required	Description
`bridgeArn`	string	True
`sourceName`	string	True

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.

UpdateBridgeFlowSourceRequest

Update the flow source of the bridge.

Property	Type	Required	Description
`flowArn`	string	False	The 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.

UpdateBridgeNetworkSourceRequest

Update the network source of the bridge.

Property	Type	Required	Description
`multicastIp`	string	False	The network source multicast IP.
`multicastSourceSettings`	MulticastSourceSettings	False	The settings related to the multicast source.
`networkName`	string	False	The network source's gateway network name.
`port`	integer	False	The network source port.
`protocol`	string Values: `zixi-push \| rtp-fec \| rtp \| zixi-pull \| rist \| st2110-jpegxs \| cdi \| srt-listener \| srt-caller \| udp`	False	The network source protocol.

UpdateBridgeSourceRequest

Update the bridge source.

Property	Type	Required	Description
`flowSource`	UpdateBridgeFlowSourceRequest	False
`networkSource`	UpdateBridgeNetworkSourceRequest	False

UpdateBridgeSourceResponse

The bridge source has been successfully updated.

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

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.