PrometheusService / Paginator / ListWorkspaces

ListWorkspaces

class PrometheusService.Paginator.ListWorkspaces

paginator = client.get_paginator('list_workspaces')

paginate(**kwargs)

Creates an iterator that will paginate through responses from PrometheusService.Client.list_workspaces().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    alias='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• alias (string) – Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  Represents the output of a ListWorkspaces operation.

  • workspaces (list) –

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

    • (dict) –

      Represents a summary of the properties of a workspace.

      • workspaceId (string) –

        Unique string identifying this workspace.

      • alias (string) –

        Alias of this workspace.

      • arn (string) –

        The AmazonResourceName of this workspace.

      • status (dict) –

        The status of this workspace.

        • statusCode (string) –

          Status code of this workspace.

      • createdAt (datetime) –

        The time when the workspace was created.

      • 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: _ . : / = + - @

  • NextToken (string) –

    A token to resume pagination.