IoTTwinMaker / Client / list_workspaces

list_workspaces#

IoTTwinMaker.Client.list_workspaces(**kwargs)#

Retrieves information about workspaces in the current account.

See also: AWS API Documentation

Request Syntax

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

  • maxResults (integer) –

    The maximum number of results to return at one time. The default is 25.

    Valid Range: Minimum value of 1. Maximum value of 250.

  • nextToken (string) – The string that specifies the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'workspaceSummaries': [
        {
            'workspaceId': 'string',
            'arn': 'string',
            'description': 'string',
            'linkedServices': [
                'string',
            ],
            'creationDateTime': datetime(2015, 1, 1),
            'updateDateTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • workspaceSummaries (list) –

      A list of objects that contain information about the workspaces.

      • (dict) –

        An object that contains information about a workspace.

        • workspaceId (string) –

          The ID of the workspace.

        • arn (string) –

          The ARN of the workspace.

        • description (string) –

          The description of the workspace.

        • linkedServices (list) –

          A list of services that are linked to the workspace.

          • (string) –

        • creationDateTime (datetime) –

          The date and time when the workspace was created.

        • updateDateTime (datetime) –

          The date and time when the workspace was last updated.

    • nextToken (string) –

      The string that specifies the next page of results.

Exceptions