:doc:`ApplicationDiscoveryService <../../discovery>` / Client / list_configurations

*******************
list_configurations
*******************



.. py:method:: ApplicationDiscoveryService.Client.list_configurations(**kwargs)

  

  Retrieves a list of configuration items as specified by the value passed to the required parameter ``configurationType``. Optional filtering may be applied to refine search results.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/discovery-2015-11-01/ListConfigurations>`_  


  **Request Syntax**
  ::

    response = client.list_configurations(
        configurationType='SERVER'|'PROCESS'|'CONNECTION'|'APPLICATION',
        filters=[
            {
                'name': 'string',
                'values': [
                    'string',
                ],
                'condition': 'string'
            },
        ],
        maxResults=123,
        nextToken='string',
        orderBy=[
            {
                'fieldName': 'string',
                'sortOrder': 'ASC'|'DESC'
            },
        ]
    )
    
  :type configurationType: string
  :param configurationType: **[REQUIRED]** 

    A valid configuration identified by Application Discovery Service.

    

  
  :type filters: list
  :param filters: 

    You can filter the request using various logical operators and a *key*-*value* format. For example:

     

    ``{"key": "serverType", "value": "webServer"}``

     

    For a complete list of filter options and guidance about using them with this action, see `Using the ListConfigurations Action <https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#ListConfigurations>`__ in the *Amazon Web Services Application Discovery Service User Guide*.

    

  
    - *(dict) --* 

      A filter that can use conditional operators.

       

      For more information about filters, see `Querying Discovered Configuration Items <https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html>`__ in the *Amazon Web Services Application Discovery Service User Guide*.

      

    
      - **name** *(string) --* **[REQUIRED]** 

        The name of the filter.

        

      
      - **values** *(list) --* **[REQUIRED]** 

        A string value on which to filter. For example, if you choose the ``destinationServer.osVersion`` filter name, you could specify ``Ubuntu`` for the value.

        

      
        - *(string) --* 

        
    
      - **condition** *(string) --* **[REQUIRED]** 

        A conditional operator. The following operators are valid: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS. If you specify multiple filters, the system utilizes all filters as though concatenated by *AND*. If you specify multiple values for a particular filter, the system differentiates the values using *OR*. Calling either *DescribeConfigurations* or *ListConfigurations* returns attributes of matching configuration items.

        

      
    

  :type maxResults: integer
  :param maxResults: 

    The total number of items to return. The maximum value is 100.

    

  
  :type nextToken: string
  :param nextToken: 

    Token to retrieve the next set of results. For example, if a previous call to ListConfigurations returned 100 items, but you set ``ListConfigurationsRequest$maxResults`` to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

    

  
  :type orderBy: list
  :param orderBy: 

    Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see `Using the ListConfigurations Action <https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#ListConfigurations>`__ in the *Amazon Web Services Application Discovery Service User Guide*.

    

  
    - *(dict) --* 

      A field and direction for ordered output.

      

    
      - **fieldName** *(string) --* **[REQUIRED]** 

        The field on which to order.

        

      
      - **sortOrder** *(string) --* 

        Ordering direction.

        

      
    

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

    
    ::

      {
          'configurations': [
              {
                  'string': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **configurations** *(list) --* 

        Returns configuration details, including the configuration ID, attribute names, and attribute values.

        
        

        - *(dict) --* 
          

          - *(string) --* 
            

            - *(string) --* 
      
    
    
      

      - **nextToken** *(string) --* 

        Token to retrieve the next set of results. For example, if your call to ListConfigurations returned 100 items, but you set ``ListConfigurationsRequest$maxResults`` to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.

        
  
  **Exceptions**
  
  *   :py:class:`ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorException`

  
  *   :py:class:`ApplicationDiscoveryService.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`ApplicationDiscoveryService.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`ApplicationDiscoveryService.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`ApplicationDiscoveryService.Client.exceptions.ServerInternalErrorException`

  
  *   :py:class:`ApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetException`

  