:doc:`SsmSap <../../ssm-sap>` / Client / list_databases

**************
list_databases
**************



.. py:method:: SsmSap.Client.list_databases(**kwargs)

  

  Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ssm-sap-2018-05-10/ListDatabases>`_  


  **Request Syntax**
  ::

    response = client.list_databases(
        ApplicationId='string',
        ComponentId='string',
        NextToken='string',
        MaxResults=123
    )
    
  :type ApplicationId: string
  :param ApplicationId: 

    The ID of the application.

    

  
  :type ComponentId: string
  :param ComponentId: 

    The ID of the component.

    

  
  :type NextToken: string
  :param NextToken: 

    The token for the next page of results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default.

    

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

    
    ::

      {
          'Databases': [
              {
                  'ApplicationId': 'string',
                  'ComponentId': 'string',
                  'DatabaseId': 'string',
                  'DatabaseType': 'SYSTEM'|'TENANT',
                  'Arn': 'string',
                  'Tags': {
                      'string': 'string'
                  }
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The SAP HANA databases of an application.

        
        

        - *(dict) --* 

          The summary of the database.

          
          

          - **ApplicationId** *(string) --* 

            The ID of the application.

            
          

          - **ComponentId** *(string) --* 

            The ID of the component.

            
          

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

            The ID of the database.

            
          

          - **DatabaseType** *(string) --* 

            The type of the database.

            
          

          - **Arn** *(string) --* 

            The Amazon Resource Name (ARN) of the database.

            
          

          - **Tags** *(dict) --* 

            The tags of the database.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
      
    
      

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

        The token to use to retrieve the next page of results. This value is null when there are no more results to return.

        
  
  **Exceptions**
  
  *   :py:class:`SsmSap.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`SsmSap.Client.exceptions.ValidationException`

  
  *   :py:class:`SsmSap.Client.exceptions.InternalServerException`

  