IoTRoboRunner / Paginator / ListSites

ListSites

class IoTRoboRunner.Paginator.ListSites

paginator = client.get_paginator('list_sites')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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:

dict

Returns:

Response Syntax

{
    'sites': [
        {
            'arn': 'string',
            'name': 'string',
            'countryCode': 'string',
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • sites (list) –

    List of facilities.

    • (dict) –

      Facility containing destinations, workers, activities, and tasks.

      • arn (string) –

        Site ARN.

      • name (string) –

        The name of the site. Mutable after creation and unique within a given account.

      • countryCode (string) –

        A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., US.

      • createdAt (datetime) –

        Timestamp at which the resource was created.

  • NextToken (string) –

    A token to resume pagination.