:doc:`RDS <../../rds>` / Client / describe_db_snapshot_tenant_databases

*************************************
describe_db_snapshot_tenant_databases
*************************************



.. py:method:: RDS.Client.describe_db_snapshot_tenant_databases(**kwargs)

  

  Describes the tenant databases that exist in a DB snapshot. This command only applies to RDS for Oracle DB instances in the multi-tenant configuration.

   

  You can use this command to inspect the tenant databases within a snapshot before restoring it. You can't directly interact with the tenant databases in a DB snapshot. If you restore a snapshot that was taken from DB instance using the multi-tenant configuration, you restore all its tenant databases.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBSnapshotTenantDatabases>`_  


  **Request Syntax**
  ::

    response = client.describe_db_snapshot_tenant_databases(
        DBInstanceIdentifier='string',
        DBSnapshotIdentifier='string',
        SnapshotType='string',
        Filters=[
            {
                'Name': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        MaxRecords=123,
        Marker='string',
        DbiResourceId='string'
    )
    
  :type DBInstanceIdentifier: string
  :param DBInstanceIdentifier: 

    The ID of the DB instance used to create the DB snapshots. This parameter isn't case-sensitive.

     

    Constraints:

     

    
    * If supplied, must match the identifier of an existing ``DBInstance``.
    

    

  
  :type DBSnapshotIdentifier: string
  :param DBSnapshotIdentifier: 

    The ID of a DB snapshot that contains the tenant databases to describe. This value is stored as a lowercase string.

     

    Constraints:

     

    
    * If you specify this parameter, the value must match the ID of an existing DB snapshot.
     
    * If you specify an automatic snapshot, you must also specify ``SnapshotType``.
    

    

  
  :type SnapshotType: string
  :param SnapshotType: 

    The type of DB snapshots to be returned. You can specify one of the following values:

     

    
    * ``automated`` – All DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
     
    * ``manual`` – All DB snapshots that have been taken by my Amazon Web Services account.
     
    * ``shared`` – All manual DB snapshots that have been shared to my Amazon Web Services account.
     
    * ``public`` – All DB snapshots that have been marked as public.
     
    * ``awsbackup`` – All DB snapshots managed by the Amazon Web Services Backup service.
    

    

  
  :type Filters: list
  :param Filters: 

    A filter that specifies one or more tenant databases to describe.

     

    Supported filters:

     

    
    * ``tenant-db-name`` - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.
     
    * ``tenant-database-resource-id`` - Tenant database resource identifiers. The results list only includes information about the tenant databases contained within the DB snapshots.
     
    * ``dbi-resource-id`` - DB instance resource identifiers. The results list only includes information about snapshots containing tenant databases contained within the DB instances identified by these resource identifiers.
     
    * ``db-instance-id`` - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
     
    * ``db-snapshot-id`` - Accepts DB snapshot identifiers.
     
    * ``snapshot-type`` - Accepts types of DB snapshots.
    

    

  
    - *(dict) --* 

      A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

       

      .. note::

        

        Currently, wildcards are not supported in filters.

        

       

      The following actions can be filtered:

       

      
      * ``DescribeDBClusterBacktracks``
       
      * ``DescribeDBClusterEndpoints``
       
      * ``DescribeDBClusters``
       
      * ``DescribeDBInstances``
       
      * ``DescribeDBRecommendations``
       
      * ``DescribeDBShardGroups``
       
      * ``DescribePendingMaintenanceActions``
      

      

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

        The name of the filter. Filter names are case-sensitive.

        

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

        One or more filter values. Filter values are case-sensitive.

        

      
        - *(string) --* 

        
    
    

  :type MaxRecords: integer
  :param MaxRecords: 

    The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

    

  
  :type Marker: string
  :param Marker: 

    An optional pagination token provided by a previous ``DescribeDBSnapshotTenantDatabases`` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ``MaxRecords``.

    

  
  :type DbiResourceId: string
  :param DbiResourceId: 

    A specific DB resource identifier to describe.

    

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

    
    ::

      {
          'Marker': 'string',
          'DBSnapshotTenantDatabases': [
              {
                  'DBSnapshotIdentifier': 'string',
                  'DBInstanceIdentifier': 'string',
                  'DbiResourceId': 'string',
                  'EngineName': 'string',
                  'SnapshotType': 'string',
                  'TenantDatabaseCreateTime': datetime(2015, 1, 1),
                  'TenantDBName': 'string',
                  'MasterUsername': 'string',
                  'TenantDatabaseResourceId': 'string',
                  'CharacterSetName': 'string',
                  'DBSnapshotTenantDatabaseARN': 'string',
                  'NcharCharacterSetName': 'string',
                  'TagList': [
                      {
                          'Key': 'string',
                          'Value': 'string'
                      },
                  ]
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Marker** *(string) --* 

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ``MaxRecords``.

        
      

      - **DBSnapshotTenantDatabases** *(list) --* 

        A list of DB snapshot tenant databases.

        
        

        - *(dict) --* 

          Contains the details of a tenant database in a snapshot of a DB instance.

          
          

          - **DBSnapshotIdentifier** *(string) --* 

            The identifier for the snapshot of the DB instance.

            
          

          - **DBInstanceIdentifier** *(string) --* 

            The ID for the DB instance that contains the tenant databases.

            
          

          - **DbiResourceId** *(string) --* 

            The resource identifier of the source CDB instance. This identifier can't be changed and is unique to an Amazon Web Services Region.

            
          

          - **EngineName** *(string) --* 

            The name of the database engine.

            
          

          - **SnapshotType** *(string) --* 

            The type of DB snapshot.

            
          

          - **TenantDatabaseCreateTime** *(datetime) --* 

            The time the DB snapshot was taken, specified in Coordinated Universal Time (UTC). If you copy the snapshot, the creation time changes.

            
          

          - **TenantDBName** *(string) --* 

            The name of the tenant database.

            
          

          - **MasterUsername** *(string) --* 

            The master username of the tenant database.

            
          

          - **TenantDatabaseResourceId** *(string) --* 

            The resource ID of the tenant database.

            
          

          - **CharacterSetName** *(string) --* 

            The name of the character set of a tenant database.

            
          

          - **DBSnapshotTenantDatabaseARN** *(string) --* 

            The Amazon Resource Name (ARN) for the snapshot tenant database.

            
          

          - **NcharCharacterSetName** *(string) --* 

            The ``NCHAR`` character set name of the tenant database.

            
          

          - **TagList** *(list) --* 

            A list of tags.

             

            For more information, see `Tagging Amazon RDS resources <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html>`__ in the *Amazon RDS User Guide* or `Tagging Amazon Aurora and Amazon RDS resources <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html>`__ in the *Amazon Aurora User Guide*.

            
            

            - *(dict) --* 

              Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

               

              For more information, see `Tagging Amazon RDS resources <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html>`__ in the *Amazon RDS User Guide* or `Tagging Amazon Aurora and Amazon RDS resources <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html>`__ in the *Amazon Aurora User Guide*.

              
              

              - **Key** *(string) --* 

                A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").

                
              

              - **Value** *(string) --* 

                A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").

                
          
        
      
    
  
  **Exceptions**
  
  *   :py:class:`RDS.Client.exceptions.DBSnapshotNotFoundFault`

  