Gateway bridge outputs: add
URI
/v1/bridges/
bridgeArn
/outputs
HTTP methods
POST
Operation ID: AddBridgeOutputs
Adds outputs to an existing 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
202 | AddBridgeOutputsResponse | 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
{ "outputs": [ { "networkOutput": { "protocol": enum, "port": integer, "ipAddress": "string", "name": "string", "networkName": "string", "ttl": integer } } ] }
Response bodies
{ "outputs": [ { "flowOutput": { "flowArn": "string", "name": "string", "flowSourceArn": "string" }, "networkOutput": { "protocol": enum, "port": integer, "ipAddress": "string", "name": "string", "networkName": "string", "ttl": integer } } ], "bridgeArn": "string" }
{ "message": "string" }
Properties
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: | True | The network output protocol. |
ttl | integer | True | The network output TTL. |
AddBridgeOutputRequest
Add an output to a bridge.
Property | Type | Required | Description |
---|---|---|---|
networkOutput | False |
AddBridgeOutputsRequest
Adds outputs to an existing bridge.
Property | Type | Required | Description |
---|---|---|---|
outputs | Array of type AddBridgeOutputRequest | True | The outputs that you want to add to this bridge. |
AddBridgeOutputsResponse
The outputs were successfully added to the bridge.
Property | Type | Required | Description |
---|---|---|---|
bridgeArn | string | True | The Amazon Resource Number (ARN) of the bridge. |
outputs | Array of type BridgeOutput | True | The outputs that you added to 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. |
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: | True | The network output protocol. |
ttl | integer | True | The network output TTL. |
BridgeOutput
The output of the bridge.
Property | Type | Required | Description |
---|---|---|---|
flowOutput | False | ||
networkOutput | False |
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. |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: