list_workspaces

PrometheusService.Client.list_workspaces(**kwargs)

Lists all AMP workspaces, including workspaces being created or deleted.

See also: AWS API Documentation

Request Syntax

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

Parameters

• alias (string) -- Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.
• maxResults (integer) -- Maximum results to return in response (default=100, maximum=1000).
• nextToken (string) -- Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'workspaces': [
        {
            'alias': 'string',
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'status': {
                'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'
            },
            'tags': {
                'string': 'string'
            },
            'workspaceId': 'string'
        },
    ]
}

Response Structure

• (dict) --

  Represents the output of a ListWorkspaces operation.

  • nextToken (string) --

    Pagination token to use when requesting the next page in this list.

  • workspaces (list) --

    The list of existing workspaces, including those undergoing creation or deletion.

    • (dict) --

      Represents a summary of the properties of a workspace.

      • alias (string) --

        Alias of this workspace.

      • arn (string) --

        The AmazonResourceName of this workspace.

      • createdAt (datetime) --

        The time when the workspace was created.

      • status (dict) --

        The status of this workspace.

        • statusCode (string) --

          Status code of this workspace.

      • tags (dict) --

        The tags of this workspace.

        • (string) --

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with aws: .

          • (string) --

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @

      • workspaceId (string) --

        Unique string identifying this workspace.

Exceptions

• PrometheusService.Client.exceptions.ThrottlingException
• PrometheusService.Client.exceptions.ValidationException
• PrometheusService.Client.exceptions.AccessDeniedException
• PrometheusService.Client.exceptions.InternalServerException