Skip to content

RDS  >  Operations  >  describe_db_instances

describe_db_instances

Operation

describe_db_instances async

describe_db_instances(request: DescribeDBInstancesInput | DescribeDBInstancesInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeDBInstancesOutput
describe_db_instances(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBInstancesInputDict]) -> DescribeDBInstancesOutput

Describes provisioned RDS instances. This API supports pagination.

Note

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

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
DescribeDBInstancesOutput

An instance of DescribeDBInstancesOutput.

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

DescribeDBInstancesInput dataclass

Bases: _SerdeShape

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

The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

Constraints:

  • If supplied, must match the identifier of an existing DB instance.
filters class-attribute instance-attribute
filters: list[Filter] | None = ...

A filter that specifies one or more DB instances to describe.

Supported Filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.

  • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.

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

  • domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.

  • engine - Accepts engine names. The results list only includes information about the DB instances for these engines.

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

An optional pagination token provided by a previous DescribeDBInstances 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.

Default: 100

Constraints: Minimum 20, maximum 100.

Dictionaries

DescribeDBInstancesInputDict

Bases: TypedDict

Dictionary form of DescribeDBInstancesInput.

Attributes
db_instance_identifier instance-attribute
db_instance_identifier: str | None

The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

Constraints:

  • If supplied, must match the identifier of an existing DB instance.
filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

A filter that specifies one or more DB instances to describe.

Supported Filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.

  • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.

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

  • domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.

  • engine - Accepts engine names. The results list only includes information about the DB instances for these engines.

marker instance-attribute
marker: str | None

An optional pagination token provided by a previous DescribeDBInstances 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.

Default: 100

Constraints: Minimum 20, maximum 100.

Output

DescribeDBInstancesOutput dataclass

Bases: _SerdeShape

Contains the result of a successful invocation of the DescribeDBInstances action.

Attributes

db_instances class-attribute instance-attribute
db_instances: list[DBInstance] | None = ...

A list of DBInstance instances.

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.