Gateway bridge sources: update, remove - AWS Elemental MediaConnect

Gateway bridge sources: update, remove

URI

/v1/bridges/bridgeArn/sources/sourceName

HTTP methods

PUT

Operation ID: UpdateBridgeSource

Updates an existing bridge source.

Path parameters
NameTypeRequiredDescription
bridgeArnStringTrue

The ARN of the bridge that you want to describe.

sourceNameStringTrue

The name of the source that you want to update.

Responses
Status codeResponse modelDescription
202UpdateBridgeSourceResponse

MediaConnect is starting the flow.

400ResponseError

The request that you submitted is not valid.

403ResponseError

You don't have the required permissions to perform this operation.

404ResponseError

MediaConnect did not find the resource that you specified in the request.

409ResponseError

There was a conflict when trying to add the requested output

429ResponseError

You have exceeded the service request rate limit for your MediaConnect account.

500ResponseError

MediaConnect can't fulfill your request because it encountered an unexpected condition.

503ResponseError

MediaConnect is currently unavailable. Try again later.

DELETE

Operation ID: RemoveBridgeSource

Removes a source from a bridge.

Path parameters
NameTypeRequiredDescription
bridgeArnStringTrue

The ARN of the bridge that you want to describe.

sourceNameStringTrue

The name of the source that you want to update.

Responses
Status codeResponse modelDescription
202RemoveBridgeSourceResponse

MediaConnect is starting the flow.

400ResponseError

The request that you submitted is not valid.

403ResponseError

You don't have the required permissions to perform this operation.

404ResponseError

MediaConnect did not find the resource that you specified in the request.

409ResponseError

There was a conflict when trying to add the requested output

429ResponseError

You have exceeded the service request rate limit for your MediaConnect account.

500ResponseError

MediaConnect can't fulfill your request because it encountered an unexpected condition.

503ResponseError

MediaConnect is currently unavailable. Try again later.

Schemas

Request bodies

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

Response bodies

{ "bridgeArn": "string", "source": { "networkSource": { "protocol": enum, "port": integer, "name": "string", "networkName": "string", "multicastIp": "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.

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

PropertyTypeRequiredDescription
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 | udp

True

The network source protocol.

BridgeSource

The bridge's source.

PropertyTypeRequiredDescription
flowSource

BridgeFlowSource

False
networkSource

BridgeNetworkSource

False

RemoveBridgeSourceResponse

The bridge source has been successfully removed.

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

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

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

PropertyTypeRequiredDescription
multicastIp

string

False

The network source multicast IP.

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.

PropertyTypeRequiredDescription
flowSource

UpdateBridgeFlowSourceRequest

False
networkSource

UpdateBridgeNetworkSourceRequest

False

UpdateBridgeSourceResponse

The bridge source has been successfully updated.

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

PropertyTypeRequiredDescription
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:

UpdateBridgeSource

RemoveBridgeSource