Skip to content

RDS  >  Operations  >  describe_tenant_databases

describe_tenant_databases

Operation

describe_tenant_databases async

describe_tenant_databases(request: DescribeTenantDatabasesInput | DescribeTenantDatabasesInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeTenantDatabasesOutput
describe_tenant_databases(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTenantDatabasesInputDict]) -> DescribeTenantDatabasesOutput

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

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeTenantDatabasesOutput

An instance of DescribeTenantDatabasesOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeTenantDatabasesInput dataclass

Bases: _SerdeShape

Dataclass for DescribeTenantDatabasesInput structure.

Attributes
db_instance_identifier class-attribute instance-attribute
db_instance_identifier: str | None = ...

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.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

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.

marker class-attribute instance-attribute
marker: str | None = ...

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.

max_records class-attribute instance-attribute
max_records: int | None = ...

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.

tenant_db_name class-attribute instance-attribute
tenant_db_name: str | None = ...

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.

Dictionaries

DescribeTenantDatabasesInputDict

Bases: TypedDict

Dictionary form of DescribeTenantDatabasesInput.

Attributes
db_instance_identifier instance-attribute
db_instance_identifier: str | None

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.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

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.

marker instance-attribute
marker: str | None

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.

max_records instance-attribute
max_records: int | None

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.

tenant_db_name instance-attribute
tenant_db_name: str | None

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.

Output

DescribeTenantDatabasesOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeTenantDatabasesOutput structure.

Attributes

marker class-attribute instance-attribute
marker: str | None = ...

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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

tenant_databases class-attribute instance-attribute
tenant_databases: list[TenantDatabase] | None = ...

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