UpdateBridgeState
Updates the bridge state.
Request Syntax
PUT /v1/bridges/bridgeArn/state HTTP/1.1
Content-type: application/json
{
"desiredState": "string"
}URI Request Parameters
The request uses the following URI parameters.
- bridgeArn
-
The Amazon Resource Name (ARN) of the bridge that you want to update the state of.
Pattern:
arn:.+:mediaconnect.+:bridge:.+Required: Yes
Request Body
The request accepts the following data in JSON format.
- desiredState
-
The desired state for the bridge.
Type: String
Valid Values:
ACTIVE | STANDBY | DELETEDRequired: Yes
Response Syntax
HTTP/1.1 202
Content-type: application/json
{
"bridgeArn": "string",
"desiredState": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
- bridgeArn
-
The ARN of the updated bridge.
Type: String
- desiredState
-
The new state of the bridge.
Type: String
Valid Values:
ACTIVE | STANDBY | DELETED
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
HTTP Status Code: 400
- ConflictException
-
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
HTTP Status Code: 409
- ForbiddenException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerErrorException
-
The server encountered an internal error and is unable to complete the request.
HTTP Status Code: 500
- NotFoundException
-
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404
- ServiceUnavailableException
-
The service is currently unavailable or busy.
HTTP Status Code: 503
- TooManyRequestsException
-
The request was denied due to request throttling.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
