Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

get_destination

get_destination(**kwargs)

Grants permission to get a destination

See also: AWS API Documentation

Request Syntax

response = client.get_destination(
    id='string'
)
Parameters
id (string) --

[REQUIRED]

Destination ARN.

Return type
dict
Returns
Response Syntax
{
    'arn': 'string',
    'id': 'string',
    'name': 'string',
    'site': 'string',
    'createdAt': datetime(2015, 1, 1),
    '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.

    • site (string) --

      Site ARN.

    • createdAt (datetime) --

      Timestamp at which the resource was created.

    • 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