IoTRoboRunner / Paginator / ListDestinations


class IoTRoboRunner.Paginator.ListDestinations#
paginator = client.get_paginator('list_destinations')

Creates an iterator that will paginate through responses from IoTRoboRunner.Client.list_destinations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • site (string) –


    Site ARN.

  • state (string) – State of the destination.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    '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'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • 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

    • NextToken (string) –

      A token to resume pagination.