RDS / Client / describe_tenant_databases

describe_tenant_databases#

RDS.Client.describe_tenant_databases(**kwargs)#

Describes the tenant databases in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle CDB instances are supported.

See also: AWS API Documentation

Request Syntax

response = client.describe_tenant_databases(
    DBInstanceIdentifier='string',
    TenantDBName='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    Marker='string',
    MaxRecords=123
)
Parameters:

  • DBInstanceIdentifier (string) – The user-supplied DB instance identifier, which must match the identifier of an existing instance owned by the Amazon Web Services account. This parameter isn’t case-sensitive.

  • TenantDBName (string) – The user-supplied tenant database name, which must match the name of an existing tenant database on the specified DB instance owned by your Amazon Web Services account. This parameter isn’t case-sensitive.

  • Filters (list) –

    A filter that specifies one or more database tenants 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.

    • dbi-resource-id - DB instance resource identifiers. The results list only includes information about the tenants contained within the DB instances identified by these resource identifiers.

    • (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) –

  • Marker (string) – An optional pagination token provided by a previous DescribeTenantDatabases request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • MaxRecords (integer) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'TenantDatabases': [
        {
            'TenantDatabaseCreateTime': datetime(2015, 1, 1),
            'DBInstanceIdentifier': 'string',
            'TenantDBName': 'string',
            'Status': 'string',
            'MasterUsername': 'string',
            'DbiResourceId': 'string',
            'TenantDatabaseResourceId': 'string',
            'TenantDatabaseARN': 'string',
            'CharacterSetName': 'string',
            'NcharCharacterSetName': 'string',
            'DeletionProtection': True|False,
            'PendingModifiedValues': {
                'MasterUserPassword': 'string',
                'TenantDBName': 'string'
            },
            'TagList': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • Marker (string) –

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

    • TenantDatabases (list) –

      An array of the tenant databases requested by the DescribeTenantDatabases operation.

      • (dict) –

        A tenant database in the DB instance. This data type is an element in the response to the DescribeTenantDatabases action.

        • TenantDatabaseCreateTime (datetime) –

          The creation time of the tenant database.

        • DBInstanceIdentifier (string) –

          The ID of the DB instance that contains the tenant database.

        • TenantDBName (string) –

          The database name of the tenant database.

        • Status (string) –

          The status of the tenant database.

        • MasterUsername (string) –

          The master username of the tenant database.

        • DbiResourceId (string) –

          The Amazon Web Services Region-unique, immutable identifier for the DB instance.

        • TenantDatabaseResourceId (string) –

          The Amazon Web Services Region-unique, immutable identifier for the tenant database.

        • TenantDatabaseARN (string) –

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

        • CharacterSetName (string) –

          The character set of the tenant database.

        • NcharCharacterSetName (string) –

          The NCHAR character set name of the tenant database.

        • DeletionProtection (boolean) –

          Specifies whether deletion protection is enabled for the DB instance.

        • PendingModifiedValues (dict) –

          Information about pending changes for a tenant database.

          • MasterUserPassword (string) –

            The master password for the tenant database.

          • TenantDBName (string) –

            The name of the tenant database.

        • TagList (list) –

          A list of tags.

          For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources 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 in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources 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