update_destination

IoTRoboRunner.Client.update_destination(**kwargs)

Grants permission to update a destination

See also: AWS API Documentation

Request Syntax

response = client.update_destination(
    id='string',
    name='string',
    state='ENABLED'|'DISABLED'|'DECOMMISSIONED',
    additionalFixedProperties='string'
)
Parameters
  • id (string) --

    [REQUIRED]

    Destination ARN.

  • name (string) -- Human friendly name of the resource.
  • state (string) -- State of the destination.
  • additionalFixedProperties (string) -- JSON document containing additional fixed properties regarding the destination
Return type

dict

Returns

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'name': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'state': 'ENABLED'|'DISABLED'|'DECOMMISSIONED',
    'additionalFixedProperties': 'string'
}

Response Structure

  • (dict) --

    • arn (string) --

      Destination ARN.

    • id (string) --

      Filters access by the destination's identifier

    • name (string) --

      Human friendly name of the resource.

    • updatedAt (datetime) --

      Timestamp at which the resource was last updated.

    • state (string) --

      State of the destination.

    • additionalFixedProperties (string) --

      JSON document containing additional fixed properties regarding the destination

Exceptions

  • IoTRoboRunner.Client.exceptions.AccessDeniedException
  • IoTRoboRunner.Client.exceptions.ValidationException
  • IoTRoboRunner.Client.exceptions.ResourceNotFoundException
  • IoTRoboRunner.Client.exceptions.ThrottlingException
  • IoTRoboRunner.Client.exceptions.InternalServerException