FIS / Client / update_safety_lever_state

update_safety_lever_state#

FIS.Client.update_safety_lever_state(**kwargs)#

Updates the specified safety lever state.

See also: AWS API Documentation

Request Syntax

response = client.update_safety_lever_state(
    id='string',
    state={
        'status': 'disengaged'|'engaged',
        'reason': 'string'
    }
)
Parameters:
  • id (string) –

    [REQUIRED]

    The ID of the safety lever.

  • state (dict) –

    [REQUIRED]

    The state of the safety lever.

    • status (string) – [REQUIRED]

      The updated state of the safety lever.

    • reason (string) – [REQUIRED]

      The reason for updating the state of the safety lever.

Return type:

dict

Returns:

Response Syntax

{
    'safetyLever': {
        'id': 'string',
        'arn': 'string',
        'state': {
            'status': 'disengaged'|'engaged'|'engaging',
            'reason': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • safetyLever (dict) –

      Information about the safety lever.

      • id (string) –

        The ID of the safety lever.

      • arn (string) –

        The Amazon Resource Name (ARN) of the safety lever.

      • state (dict) –

        The state of the safety lever.

        • status (string) –

          The state of the safety lever.

        • reason (string) –

          The reason for the state of the safety lever.

Exceptions

  • FIS.Client.exceptions.ValidationException

  • FIS.Client.exceptions.ConflictException

  • FIS.Client.exceptions.ResourceNotFoundException