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

***************************
list_logging_configurations
***************************



.. py:method:: WAFRegional.Client.list_logging_configurations(**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  LoggingConfiguration objects.

  

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


  **Request Syntax**
  ::

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

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

    

  
  :type Limit: integer
  :param Limit: 

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

    

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

    
    ::

      {
          'LoggingConfigurations': [
              {
                  'ResourceArn': 'string',
                  'LogDestinationConfigs': [
                      'string',
                  ],
                  'RedactedFields': [
                      {
                          'Type': 'URI'|'QUERY_STRING'|'HEADER'|'METHOD'|'BODY'|'SINGLE_QUERY_ARG'|'ALL_QUERY_ARGS',
                          'Data': 'string'
                      },
                  ]
              },
          ],
          'NextMarker': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **LoggingConfigurations** *(list) --* 

        An array of  LoggingConfiguration 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.

            

           

          The Amazon Kinesis Data Firehose, ``RedactedFields`` information, and the web ACL Amazon Resource Name (ARN).

          
          

          - **ResourceArn** *(string) --* 

            The Amazon Resource Name (ARN) of the web ACL that you want to associate with ``LogDestinationConfigs``.

            
          

          - **LogDestinationConfigs** *(list) --* 

            An array of Amazon Kinesis Data Firehose ARNs.

            
            

            - *(string) --* 
        
          

          - **RedactedFields** *(list) --* 

            The parts of the request that you want redacted from the logs. For example, if you redact the cookie field, the cookie field in the firehose will be ``xxx``.

            
            

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

                

               

              Specifies where in a web request to look for ``TargetString``.

              
              

              - **Type** *(string) --* 

                The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

                 

                
                * ``HEADER``: A specified request header, for example, the value of the ``User-Agent`` or ``Referer`` header. If you choose ``HEADER`` for the type, specify the name of the header in ``Data``.
                 
                * ``METHOD``: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: ``DELETE``, ``GET``, ``HEAD``, ``OPTIONS``, ``PATCH``, ``POST``, and ``PUT``.
                 
                * ``QUERY_STRING``: A query string, which is the part of a URL that appears after a ``?`` character, if any.
                 
                * ``URI``: The part of a web request that identifies a resource, for example, ``/images/daily-ad.jpg``.
                 
                * ``BODY``: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first ``8192`` bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see  CreateSizeConstraintSet.
                 
                * ``SINGLE_QUERY_ARG``: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for ``SINGLE_QUERY_ARG`` is 30 characters.
                 
                * ``ALL_QUERY_ARGS``: Similar to ``SINGLE_QUERY_ARG``, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in ``TargetString``.
                

                
              

              - **Data** *(string) --* 

                When the value of ``Type`` is ``HEADER``, enter the name of the header that you want AWS WAF to search, for example, ``User-Agent`` or ``Referer``. The name of the header is not case sensitive.

                 

                When the value of ``Type`` is ``SINGLE_QUERY_ARG``, enter the name of the parameter that you want AWS WAF to search, for example, ``UserName`` or ``SalesRegion``. The parameter name is not case sensitive.

                 

                If the value of ``Type`` is any other value, omit ``Data``.

                
          
        
      
    
      

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

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

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

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

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

  