PrometheusService / Paginator / ListRuleGroupsNamespaces

ListRuleGroupsNamespaces#

class PrometheusService.Paginator.ListRuleGroupsNamespaces#

paginator = client.get_paginator('list_rule_groups_namespaces')

paginate(**kwargs)#

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

Request Syntax

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

Parameters:

name (string) – Use this parameter to filter the rule groups namespaces that are returned. Only the namespaces with names that begin with the value that you specify are returned.
workspaceId (string) –
[REQUIRED]

The ID of the workspace containing the rule groups namespaces.
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

{
    'ruleGroupsNamespaces': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'modifiedAt': datetime(2015, 1, 1),
            'name': 'string',
            'status': {
                'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
                'statusReason': 'string'
            },
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –

Represents the output of a ListRuleGroupsNamespaces operation.
- ruleGroupsNamespaces (list) –
  
  The returned list of rule groups namespaces.
  - (dict) –
    
    The high-level information about a rule groups namespace. To retrieve more information, use DescribeRuleGroupsNamespace.
    - arn (string) –
      
      The ARN of the rule groups namespace.
    - createdAt (datetime) –
      
      The date and time that the rule groups namespace was created.
    - modifiedAt (datetime) –
      
      The date and time that the rule groups namespace was most recently changed.
    - name (string) –
      
      The name of the rule groups namespace.
    - status (dict) –
      
      A structure that displays the current status of the rule groups namespace.
      - statusCode (string) –
        
        The current status of the namespace.
      - statusReason (string) –
        
        The reason for the failure, if any.
    - tags (dict) –
      
      The list of tag keys and values that are associated with the rule groups namespace.
      - (string) –
        
        The key of the tag. Must not begin with aws:.
        
        (string) –
        
        The value of the tag.
- NextToken (string) –
  
  A token to resume pagination.