:doc:`ConfigService <../../config>` / Client / list_configuration_recorders

****************************
list_configuration_recorders
****************************



.. py:method:: ConfigService.Client.list_configuration_recorders(**kwargs)

  

  Returns a list of configuration recorders depending on the filters you specify.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/ListConfigurationRecorders>`_  


  **Request Syntax**
  ::

    response = client.list_configuration_recorders(
        Filters=[
            {
                'filterName': 'recordingScope',
                'filterValue': [
                    'string',
                ]
            },
        ],
        MaxResults=123,
        NextToken='string'
    )
    
  :type Filters: list
  :param Filters: 

    Filters the results based on a list of ``ConfigurationRecorderFilter`` objects that you specify.

    

  
    - *(dict) --* 

      Filters configuration recorders by recording scope.

      

    
      - **filterName** *(string) --* 

        The name of the type of filter. Currently, only ``recordingScope`` is supported.

        

      
      - **filterValue** *(list) --* 

        The value of the filter. For ``recordingScope``, valid values include: ``INTERNAL`` and ``PAID``.

         

        ``INTERNAL`` indicates that the `ConfigurationItems <https://docs.aws.amazon.com/config/latest/APIReference/API_ConfigurationItem.html>`__ in scope for the configuration recorder are recorded for free.

         

        ``PAID`` indicates that the `ConfigurationItems <https://docs.aws.amazon.com/config/latest/APIReference/API_ConfigurationItem.html>`__ in scope for the configuration recorder impact the costs to your bill.

        

      
        - *(string) --* 

        
    
    

  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to include in the response.

    

  
  :type NextToken: string
  :param NextToken: 

    The ``NextToken`` string returned on a previous page that you use to get the next page of results in a paginated response.

    

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

    
    ::

      {
          'ConfigurationRecorderSummaries': [
              {
                  'arn': 'string',
                  'name': 'string',
                  'servicePrincipal': 'string',
                  'recordingScope': 'INTERNAL'|'PAID'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ConfigurationRecorderSummaries** *(list) --* 

        A list of ``ConfigurationRecorderSummary`` objects that includes.

        
        

        - *(dict) --* 

          A summary of a configuration recorder, including the ``arn``, ``name``, ``servicePrincipal``, and ``recordingScope``.

          
          

          - **arn** *(string) --* 

            The Amazon Resource Name (ARN) of the configuration recorder.

            
          

          - **name** *(string) --* 

            The name of the configuration recorder.

            
          

          - **servicePrincipal** *(string) --* 

            For service-linked configuration recorders, indicates which Amazon Web Services service the configuration recorder is linked to.

            
          

          - **recordingScope** *(string) --* 

            Indicates whether the `ConfigurationItems <https://docs.aws.amazon.com/config/latest/APIReference/API_ConfigurationItem.html>`__ in scope for the configuration recorder are recorded for free ( ``INTERNAL``) or if you are charged a service fee for recording ( ``PAID``).

            
      
    
      

      - **NextToken** *(string) --* 

        The ``NextToken`` string returned on a previous page that you use to get the next page of results in a paginated response.

        
  
  **Exceptions**
  
  *   :py:class:`ConfigService.Client.exceptions.ValidationException`

  