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) –

  If this is included, it filters the results to only the workspaces with names that start with the value that you specify here.

  Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.

• 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': [
        {
            'alias': 'string',
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'kmsKeyArn': 'string',
            'status': {
                'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'
            },
            'tags': {
                'string': 'string'
            },
            'workspaceId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Represents the output of a ListWorkspaces operation.

  • workspaces (list) –

    An array of WorkspaceSummary structures containing information about the workspaces requested.

    • (dict) –

      The information about one Amazon Managed Service for Prometheus workspace in your account.

      • alias (string) –

        The alias that is assigned to this workspace to help identify it. It does not need to be unique.

      • arn (string) –

        The ARN of the workspace.

      • createdAt (datetime) –

        The date and time that the workspace was created.

      • kmsKeyArn (string) –

        (optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.

      • status (dict) –

        The current status of the workspace.

        • statusCode (string) –

          The current status of the workspace.

      • tags (dict) –

        The list of tag keys and values that are associated with the workspace.

        • (string) –

          The key of the tag. Must not begin with aws:.

          • (string) –

            The value of the tag.

      • workspaceId (string) –

        The unique ID for the workspace.

  • NextToken (string) –

    A token to resume pagination.