:doc:`PrometheusService <../../amp>` / Paginator / ListRuleGroupsNamespaces

************************
ListRuleGroupsNamespaces
************************



.. py:class:: PrometheusService.Paginator.ListRuleGroupsNamespaces

  ::

    
    paginator = client.get_paginator('list_rule_groups_namespaces')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`PrometheusService.Client.list_rule_groups_namespaces`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListRuleGroupsNamespaces>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          workspaceId='string',
          name='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type workspaceId: string
    :param workspaceId: **[REQUIRED]** 

      The ID of the workspace containing the rule groups namespaces.

      

    
    :type name: string
    :param name: 

      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.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'ruleGroupsNamespaces': [
                {
                    'arn': 'string',
                    'name': 'string',
                    'status': {
                        'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
                        'statusReason': 'string'
                    },
                    'createdAt': datetime(2015, 1, 1),
                    'modifiedAt': datetime(2015, 1, 1),
                    '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.

              
            

            - **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.

                
          
            

            - **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.

              
            

            - **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.

          
    