Connect / Client / list_workspaces

list_workspaces

Connect.Client.list_workspaces(**kwargs)

Lists the workspaces in an Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

response = client.list_workspaces(
    InstanceId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • NextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • MaxResults (integer) – The maximum number of results to return per page.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'WorkspaceSummaryList': [
        {
            'Id': 'string',
            'Name': 'string',
            'Arn': 'string',
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedRegion': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      If there are additional results, this is the token for the next set of results.

    • WorkspaceSummaryList (list) –

      A summary list of workspaces.

      • (dict) –

        Contains summary information about a workspace.

        • Id (string) –

          The unique identifier of the workspace.

        • Name (string) –

          The name of the workspace.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the workspace.

        • LastModifiedTime (datetime) –

          The timestamp when the workspace was last modified.

        • LastModifiedRegion (string) –

          The AWS Region where the workspace was last modified.

Exceptions