list_sites

list_sites(**kwargs)

Grants permission to list sites

See also: AWS API Documentation

Request Syntax

response = client.list_sites(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- Maximum number of results to retrieve in a single ListSites 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.
Return type

dict

Returns

Response Syntax

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

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.

    • 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.

Exceptions

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