URI HTTP methods Schemas Properties See also

Gateway bridge state: update

URI

/v1/bridges/bridgeArn/state

HTTP methods

PUT

Operation ID: UpdateBridgeState

Updates the bridge state.

We recommend activating no more than 10 bridges at one time. If you need to activate more than 10 bridges, use multiple requests.

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`	`UpdateBridgeStateResponse`	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


{
  "desiredState": enum
}

Response bodies


{
  "bridgeArn": "string",
  "desiredState": enum
}


{
  "message": "string"
}

Properties

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.

UpdateBridgeStateRequest

Update the state of a bridge. ACTIVE or STANDBY.

Property Type Required Description

Property	Type	Required	Description
`desiredState`	string Values: `ACTIVE \| STANDBY \| DELETED`	True

desiredState

string

Values: ACTIVE | STANDBY | DELETED

True

UpdateBridgeStateResponse

The bridge state has been updated.

Property Type Required Description

Property	Type	Required	Description
`bridgeArn`	string	True	The Amazon Resource Number (ARN) of the bridge.
`desiredState`	string Values: `ACTIVE \| STANDBY \| DELETED`	True	The state of the bridge. ACTIVE or STANDBY.

bridgeArn

string

True

The Amazon Resource Number (ARN) of the bridge.

desiredState

string

Values: ACTIVE | STANDBY | DELETED

True

The state of the bridge. ACTIVE or STANDBY.