:doc:`WAFRegional <../../waf-regional>` / Client / list_subscribed_rule_groups

***************************
list_subscribed_rule_groups
***************************



.. py:method:: WAFRegional.Client.list_subscribed_rule_groups(**kwargs)

  

  .. note::

    

    This is **AWS WAF Classic** documentation. For more information, see `AWS WAF Classic <https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html>`__ in the developer guide.

     

    **For the latest version of AWS WAF**, use the AWS WAFV2 API and see the `AWS WAF Developer Guide <https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html>`__. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

    

   

  Returns an array of  RuleGroup objects that you are subscribed to.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/ListSubscribedRuleGroups>`_  


  **Request Syntax**
  ::

    response = client.list_subscribed_rule_groups(
        NextMarker='string',
        Limit=123
    )
    
  :type NextMarker: string
  :param NextMarker: 

    If you specify a value for ``Limit`` and you have more ``ByteMatchSets``subscribed rule groups than the value of ``Limit``, AWS WAF returns a ``NextMarker`` value in the response that allows you to list another group of subscribed rule groups. For the second and subsequent ``ListSubscribedRuleGroupsRequest`` requests, specify the value of ``NextMarker`` from the previous response to get information about another batch of subscribed rule groups.

    

  
  :type Limit: integer
  :param Limit: 

    Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more objects than the number you specify for ``Limit``, the response includes a ``NextMarker`` value that you can use to get another batch of objects.

    

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

    
    ::

      {
          'NextMarker': 'string',
          'RuleGroups': [
              {
                  'RuleGroupId': 'string',
                  'Name': 'string',
                  'MetricName': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **NextMarker** *(string) --* 

        If you have more objects than the number that you specified for ``Limit`` in the request, the response includes a ``NextMarker`` value. To list more objects, submit another ``ListSubscribedRuleGroups`` request, and specify the ``NextMarker`` value from the response in the ``NextMarker`` value in the next request.

        
      

      - **RuleGroups** *(list) --* 

        An array of  RuleGroup objects.

        
        

        - *(dict) --* 

          .. note::

            

            This is **AWS WAF Classic** documentation. For more information, see `AWS WAF Classic <https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html>`__ in the developer guide.

             

            **For the latest version of AWS WAF**, use the AWS WAFV2 API and see the `AWS WAF Developer Guide <https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html>`__. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

            

           

          A summary of the rule groups you are subscribed to.

          
          

          - **RuleGroupId** *(string) --* 

            A unique identifier for a ``RuleGroup``.

            
          

          - **Name** *(string) --* 

            A friendly name or description of the ``RuleGroup``. You can't change the name of a ``RuleGroup`` after you create it.

            
          

          - **MetricName** *(string) --* 

            A friendly name or description for the metrics for this ``RuleGroup``. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the ``RuleGroup``.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`WAFRegional.Client.exceptions.WAFNonexistentItemException`

  
  *   :py:class:`WAFRegional.Client.exceptions.WAFInternalErrorException`

  