Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

UpdateSafetyLeverState

Updates the specified safety lever state.

Request Syntax


PATCH /safetyLevers/id/state HTTP/1.1
Content-type: application/json

{
   "state": { 
      "reason": "string",
      "status": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

id

The ID of the safety lever.

Length Constraints: Maximum length of 64.

Pattern: [\S]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

state

The state of the safety lever.

Type: UpdateSafetyLeverStateInput object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "safetyLever": { 
      "arn": "string",
      "id": "string",
      "state": { 
         "reason": "string",
         "status": "string"
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

safetyLever

Information about the safety lever.

Type: SafetyLever object

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

The request could not be processed because of a conflict.

HTTP Status Code: 409

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ValidationException

The specified input is not valid, or fails to satisfy the constraints for the request.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of UpdateSafetyLeverState.


{
    "id": "default",
    "state": {
        "status": "engaged",
        "reason": "Blocked days"
    }
}