IoTSiteWise / Paginator / ListWorkspaces

ListWorkspaces

class IoTSiteWise.Paginator.ListWorkspaces

paginator = client.get_paginator('list_workspaces')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_workspaces().

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

{
    'workspaceSummaries': [
        {
            'name': 'string',
            'arn': 'string',
            'status': {
                'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
                'error': {
                    'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
                    'message': 'string'
                }
            },
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • workspaceSummaries (list) –

    A list that summarizes each workspace.

    • (dict) –

      Contains summary information about a workspace, including its name, ARN, status, and creation and update timestamps.

      • name (string) –

        The name of the workspace.

      • arn (string) –

        The ARN of the workspace.

      • status (dict) –

        The status of the workspace.

        • state (string) –

          The current state of the workspace.

        • error (dict) –

          Contains associated error information, if any.

          • code (string) –

            The error code.

          • message (string) –

            The error message.

      • createdAt (datetime) –

        The date the workspace was created, in Unix epoch time.

      • updatedAt (datetime) –

        The date the workspace was last updated, in Unix epoch time.

  • NextToken (string) –

    A token to resume pagination.