WorkspacesInstances / Client / list_workspace_instances

list_workspace_instances¶

WorkspacesInstances.Client.list_workspace_instances(**kwargs)¶

Retrieves a collection of WorkSpaces Instances based on specified filters.

Request Syntax

response = client.list_workspace_instances(
    ProvisionStates=[
        'ALLOCATING'|'ALLOCATED'|'DEALLOCATING'|'DEALLOCATED'|'ERROR_ALLOCATING'|'ERROR_DEALLOCATING',
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters:

ProvisionStates (list) –
Filter WorkSpaces Instances by their current provisioning states.
- (string) –
MaxResults (integer) – Maximum number of WorkSpaces Instances to return in a single response.
NextToken (string) – Pagination token for retrieving subsequent pages of WorkSpaces Instances.

Return type:

dict

Returns:

Response Syntax

{
    'WorkspaceInstances': [
        {
            'ProvisionState': 'ALLOCATING'|'ALLOCATED'|'DEALLOCATING'|'DEALLOCATED'|'ERROR_ALLOCATING'|'ERROR_DEALLOCATING',
            'WorkspaceInstanceId': 'string',
            'EC2ManagedInstance': {
                'InstanceId': 'string'
            }
        },
    ],
    'NextToken': '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.
- NextToken (string) –
  
  Token for retrieving additional WorkSpaces Instances if the result set is paginated.

Exceptions

WorkspacesInstances.Client.exceptions.ValidationException
WorkspacesInstances.Client.exceptions.AccessDeniedException
WorkspacesInstances.Client.exceptions.ThrottlingException
WorkspacesInstances.Client.exceptions.InternalServerException