Skip to content

describe_db_snapshot_tenant_databases

Operation

describe_db_snapshot_tenant_databases

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.

Parameters:

Name Type Description Default
request DescribeDBSnapshotTenantDatabasesInput | DescribeDBSnapshotTenantDatabasesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeDBSnapshotTenantDatabasesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeDBSnapshotTenantDatabasesOutput

An instance of DescribeDBSnapshotTenantDatabasesOutput.

describe_db_snapshot_tenant_databases async

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.

Parameters:

Name Type Description Default
request DescribeDBSnapshotTenantDatabasesInput | DescribeDBSnapshotTenantDatabasesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeDBSnapshotTenantDatabasesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeDBSnapshotTenantDatabasesOutput

An instance of DescribeDBSnapshotTenantDatabasesOutput.

Input

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

DescribeDBSnapshotTenantDatabasesInputDict

Bases: TypedDict

Dictionary form of DescribeDBSnapshotTenantDatabasesInput.

Attributes

db_instance_identifier instance-attribute
db_instance_identifier: str | None

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.
db_snapshot_identifier instance-attribute
db_snapshot_identifier: str | None

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.

dbi_resource_id instance-attribute
dbi_resource_id: str | None

A specific DB resource identifier to describe.

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

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.

marker instance-attribute
marker: str | None

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.

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.

snapshot_type instance-attribute
snapshot_type: str | None

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.

DescribeDBSnapshotTenantDatabasesInput dataclass

Bases: _SerdeShape

Dataclass for DescribeDBSnapshotTenantDatabasesInput structure.

Attributes

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

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.
db_snapshot_identifier class-attribute instance-attribute
db_snapshot_identifier: str | None = ...

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.

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

A specific DB resource identifier to describe.

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

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.

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

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.

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.

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

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.

Output

DescribeDBSnapshotTenantDatabasesOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeDBSnapshotTenantDatabasesOutput structure.

Attributes

db_snapshot_tenant_databases class-attribute instance-attribute
db_snapshot_tenant_databases: list[DBSnapshotTenantDatabase] | None = ...

A list of DB snapshot tenant databases.

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

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.

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.