IoTSiteWise / Client / list_workspaces

list_workspaces¶

IoTSiteWise.Client.list_workspaces(**kwargs)¶

Retrieves a paginated list of workspaces. Use the nextToken parameter to retrieve additional results.

Request Syntax

response = client.list_workspaces(
    nextToken='string',
    maxResults=123
)

Parameters:

nextToken (string) – The token to be used for the next set of paginated results.
maxResults (integer) – The maximum number of results to return for each paginated request. Default: 50.

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) –
  
  The token for the next set of results, or null if there are no additional results.

Exceptions

IoTSiteWise.Client.exceptions.AccessDeniedException
IoTSiteWise.Client.exceptions.InvalidRequestException
IoTSiteWise.Client.exceptions.ThrottlingException
IoTSiteWise.Client.exceptions.InternalFailureException