list_destinations

IoTRoboRunner.Client.list_destinations(**kwargs)

Grants permission to list destinations

See also: AWS API Documentation

Request Syntax

response = client.list_destinations(
    site='string',
    maxResults=123,
    nextToken='string',
    state='ENABLED'|'DISABLED'|'DECOMMISSIONED'
)

Parameters

• site (string) --

  [REQUIRED]

  Site ARN.

• maxResults (integer) -- Maximum number of results to retrieve in a single call.
• nextToken (string) -- Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.
• state (string) -- State of the destination.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'destinations': [
        {
            '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) --

  • nextToken (string) --

    Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.

  • destinations (list) --

    List of destinations.

    • (dict) --

      Area within a facility where work can be performed.

      • 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