WorkspacesInstances / Paginator / ListWorkspaceInstances

ListWorkspaceInstances

class WorkspacesInstances.Paginator.ListWorkspaceInstances

paginator = client.get_paginator('list_workspace_instances')

paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkspacesInstances.Client.list_workspace_instances().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ProvisionStates=[
        'ALLOCATING'|'ALLOCATED'|'DEALLOCATING'|'DEALLOCATED'|'ERROR_ALLOCATING'|'ERROR_DEALLOCATING',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ProvisionStates (list) –

  Filter WorkSpaces Instances by their current provisioning states.

  • (string) –

• 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

{
    'WorkspaceInstances': [
        {
            'ProvisionState': 'ALLOCATING'|'ALLOCATED'|'DEALLOCATING'|'DEALLOCATED'|'ERROR_ALLOCATING'|'ERROR_DEALLOCATING',
            'WorkspaceInstanceId': 'string',
            'EC2ManagedInstance': {
                'InstanceId': 'string'
            }
        },
    ],

}

Response Structure

• (dict) –

  Contains the list of WorkSpaces Instances matching the specified criteria.

  • WorkspaceInstances (list) –

    Collection of WorkSpaces Instances returned by the query.

    • (dict) –

      Represents a single WorkSpace Instance.

      • ProvisionState (string) –

        Current provisioning state of the WorkSpace Instance.

      • WorkspaceInstanceId (string) –

        Unique identifier for the WorkSpace Instance.

      • EC2ManagedInstance (dict) –

        Details of the associated EC2 managed instance.

        • InstanceId (string) –

          Unique identifier of the managed EC2 instance.