:doc:`DatabaseMigrationService <../../dms>` / Client / describe_fleet_advisor_databases

********************************
describe_fleet_advisor_databases
********************************



.. py:method:: DatabaseMigrationService.Client.describe_fleet_advisor_databases(**kwargs)

  

  .. warning::

    

    End of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see `Amazon Web Services DMS Fleet Advisor end of support <https://docs.aws.amazon.com/dms/latest/userguide/dms_fleet.advisor-end-of-support.html>`__.

     

   

  Returns a list of Fleet Advisor databases in your account.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/DescribeFleetAdvisorDatabases>`_  


  **Request Syntax**
  ::

    response = client.describe_fleet_advisor_databases(
        Filters=[
            {
                'Name': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        MaxRecords=123,
        NextToken='string'
    )
    
  :type Filters: list
  :param Filters: 

    If you specify any of the following filters, the output includes information for only those databases that meet the filter criteria:

     

    
    * ``database-id`` – The ID of the database.
     
    * ``database-name`` – The name of the database.
     
    * ``database-engine`` – The name of the database engine.
     
    * ``server-ip-address`` – The IP address of the database server.
     
    * ``database-ip-address`` – The IP address of the database.
     
    * ``collector-name`` – The name of the associated Fleet Advisor collector.
    

     

    An example is: ``describe-fleet-advisor-databases --filter Name="database-id",Values="45"``

    

  
    - *(dict) --* 

      Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular ``Describe*`` call or similar operation. Filters are used as an optional parameter for certain API operations.

      

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

        The name of the filter as specified for a ``Describe*`` or similar operation.

        

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

        The filter value, which can specify one or more values used to narrow the returned results.

        

      
        - *(string) --* 

        
    
    

  :type MaxRecords: integer
  :param MaxRecords: 

    Sets the maximum number of records returned in the response.

    

  
  :type NextToken: string
  :param NextToken: 

    If ``NextToken`` is returned by a previous response, there are more results available. The value of ``NextToken`` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    

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

    
    ::

      {
          'Databases': [
              {
                  'DatabaseId': 'string',
                  'DatabaseName': 'string',
                  'IpAddress': 'string',
                  'NumberOfSchemas': 123,
                  'Server': {
                      'ServerId': 'string',
                      'IpAddress': 'string',
                      'ServerName': 'string'
                  },
                  'SoftwareDetails': {
                      'Engine': 'string',
                      'EngineVersion': 'string',
                      'EngineEdition': 'string',
                      'ServicePack': 'string',
                      'SupportLevel': 'string',
                      'OsArchitecture': 123,
                      'Tooltip': 'string'
                  },
                  'Collectors': [
                      {
                          'CollectorReferencedId': 'string',
                          'CollectorName': 'string'
                      },
                  ]
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Databases** *(list) --* 

        Provides descriptions of the Fleet Advisor collector databases, including the database's collector, ID, and name.

        
        

        - *(dict) --* 

          Describes a database in a Fleet Advisor collector inventory.

          
          

          - **DatabaseId** *(string) --* 

            The ID of a database in a Fleet Advisor collector inventory.

            
          

          - **DatabaseName** *(string) --* 

            The name of a database in a Fleet Advisor collector inventory.

            
          

          - **IpAddress** *(string) --* 

            The IP address of a database in a Fleet Advisor collector inventory.

            
          

          - **NumberOfSchemas** *(integer) --* 

            The number of schemas in a Fleet Advisor collector inventory database.

            
          

          - **Server** *(dict) --* 

            The server name of a database in a Fleet Advisor collector inventory.

            
            

            - **ServerId** *(string) --* 

              The ID of a server in a Fleet Advisor collector inventory.

              
            

            - **IpAddress** *(string) --* 

              The IP address of a server in a Fleet Advisor collector inventory.

              
            

            - **ServerName** *(string) --* 

              The name address of a server in a Fleet Advisor collector inventory.

              
        
          

          - **SoftwareDetails** *(dict) --* 

            The software details of a database in a Fleet Advisor collector inventory, such as database engine and version.

            
            

            - **Engine** *(string) --* 

              The database engine of a database in a Fleet Advisor collector inventory, for example ``Microsoft SQL Server``.

              
            

            - **EngineVersion** *(string) --* 

              The database engine version of a database in a Fleet Advisor collector inventory, for example ``2019``.

              
            

            - **EngineEdition** *(string) --* 

              The database engine edition of a database in a Fleet Advisor collector inventory, for example ``Express``.

              
            

            - **ServicePack** *(string) --* 

              The service pack level of the database.

              
            

            - **SupportLevel** *(string) --* 

              The support level of the database, for example ``Mainstream support``.

              
            

            - **OsArchitecture** *(integer) --* 

              The operating system architecture of the database.

              
            

            - **Tooltip** *(string) --* 

              Information about the database engine software, for example ``Mainstream support ends on November 14th, 2024``.

              
        
          

          - **Collectors** *(list) --* 

            A list of collectors associated with the database.

            
            

            - *(dict) --* 

              Briefly describes a Fleet Advisor collector.

              
              

              - **CollectorReferencedId** *(string) --* 

                The reference ID of the Fleet Advisor collector.

                
              

              - **CollectorName** *(string) --* 

                The name of the Fleet Advisor collector.

                
          
        
      
    
      

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

        If ``NextToken`` is returned, there are more results available. The value of ``NextToken`` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

        
  
  **Exceptions**
  
  *   :py:class:`DatabaseMigrationService.Client.exceptions.InvalidResourceStateFault`

  