URI HTTP methods Schemas Properties See also

Gateway bridge outputs: update, remove

URI

/v1/bridges/bridgeArn/outputs/outputName

HTTP methods

PUT

Operation ID: UpdateBridgeOutput

Updates an existing bridge output.

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

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

Removes an output from a bridge.

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

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


{
  "networkOutput": {
    "protocol": enum,
    "port": integer,
    "ipAddress": "string",
    "networkName": "string",
    "ttl": integer
  }
}

Response bodies


{
  "output": {
    "flowOutput": {
      "flowArn": "string",
      "name": "string",
      "flowSourceArn": "string"
    },
    "networkOutput": {
      "protocol": enum,
      "port": integer,
      "ipAddress": "string",
      "name": "string",
      "networkName": "string",
      "ttl": integer
    }
  },
  "bridgeArn": "string"
}


{
  "bridgeArn": "string",
  "outputName": "string"
}


{
  "message": "string"
}

Properties

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.

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.

BridgeOutput

The output of the bridge.

Property	Type	Required	Description
`flowOutput`	BridgeFlowOutput	False
`networkOutput`	BridgeNetworkOutput	False

RemoveBridgeOutputResponse

The bridge output was successfully removed.

Property	Type	Required	Description
`bridgeArn`	string	True
`outputName`	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.

UpdateBridgeNetworkOutputRequest

Update an existing network output.

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

UpdateBridgeOutputRequest

Update an existing bridge output.

Property	Type	Required	Description
`networkOutput`	UpdateBridgeNetworkOutputRequest	False

UpdateBridgeOutputResponse

The bridge output was successfully updated.

Property	Type	Required	Description
`bridgeArn`	string	True	The Amazon Resource Number (ARN) of the bridge.
`output`	BridgeOutput	True	The output that you updated.