DescribeDBInstances - Amazon Relational Database Service
Archived: 2026-04-05 19:49:08 UTC
Describes provisioned RDS instances. This API supports pagination.
Note
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB
instances.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
DBInstanceIdentifier
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.
Type: String
Required: No
Filters.Filter.N
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.
https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html
Page 1 of 9

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.
Type: Array of Filter objects
Required: No
Marker
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 .
Type: String
Required: No
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.
Default: 100
Constraints: Minimum 20, maximum 100.
Type: Integer
Required: No
Response Elements
The following elements are returned by the service.
DBInstances.DBInstance.N
A list of DBInstance instances.
Type: Array of DBInstance objects
Marker
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 .
Type: String
https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html
Page 2 of 9

Errors
For information about the errors that are common to all actions, see Common Error Types.
DBInstanceNotFound
DBInstanceIdentifier doesn't refer to an existing DB instance.
HTTP Status Code: 404
Examples
Example
This example illustrates one usage of DescribeDBInstances.
Sample Request
https://rds.us-east-1.amazonaws.com/
 ?Action=DescribeDBInstances
 &MaxRecords=100
 &SignatureMethod=HmacSHA256
 &SignatureVersion=4
 &Version=2014-10-31
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=AKIADQKE4SARGYLE/20140420/us-east-1/rds/aws4_request
 &X-Amz-Date=20140420T171917Z
 &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
 &X-Amz-Signature=caa44629fa60576c2c282d9b74d47647f9e9f229f6d0e52db1d3be0d095743b0
Sample Response
<DescribeDBInstancesResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
 <DescribeDBInstancesResult>
 <DBInstances>
 <DBInstance>
 <AllocatedStorage>100</AllocatedStorage>
 <DBParameterGroups>
 <DBParameterGroup>
 <DBParameterGroupName>default.mysql5.6</DBParameterGroupName>
 <ParameterApplyStatus>in-sync</ParameterApplyStatus>
 </DBParameterGroup>
 </DBParameterGroups>
 <AvailabilityZone>us-east-1b</AvailabilityZone>
https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html
Page 3 of 9

us-east-1a1000arn:aws:logs:us-east-1:1234567890:log-group:RDSOSMetrics:log-stream:db-IX 5.6.39mysqldbadmin2018-03-28T19:54:07.871Zdb.m4.xlarge60available7arn:aws:kms:us-east-1:1234567890:key/######################default:mysql-5-6in-sync2018-03-28T20:10:00Zrds-ca-20150db-IXRXA2XS7KFFA6JWYYWFZEBJDE05:27-05:57mysqldbarn:aws:rds:us-east-1:1234567890:db:mysqldbZ2R2ITUGPM61AMmysqldb.########.us-east-1.rds.amazonaws.com3306mysqltruefalsefalsetruearn:aws:iam::1234567890:role/rds-monitoring-roletruevpc-########subnet-########Activeus-east-1e https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html
Page 4 of 9

</SubnetAvailabilityZone>
 </Subnet>
 <Subnet>
 <SubnetIdentifier>subnet-########</SubnetIdentifier>
 <SubnetStatus>Active</SubnetStatus>
 <SubnetAvailabilityZone>
 <Name>us-east-1d</Name>
 </SubnetAvailabilityZone>
 </Subnet>
 <Subnet>
 <SubnetIdentifier>subnet-########</SubnetIdentifier>
 <SubnetStatus>Active</SubnetStatus>
 <SubnetAvailabilityZone>
 <Name>us-east-1c</Name>
 </SubnetAvailabilityZone>
 </Subnet>
 <Subnet>
 <SubnetIdentifier>subnet-########</SubnetIdentifier>
 <SubnetStatus>Active</SubnetStatus>
 <SubnetAvailabilityZone>
 <Name>us-east-1f</Name>
 </SubnetAvailabilityZone>
 </Subnet>
 <Subnet>
 <SubnetIdentifier>subnet-########</SubnetIdentifier>
 <SubnetStatus>Active</SubnetStatus>
 <SubnetAvailabilityZone>
 <Name>us-east-1a</Name>
 </SubnetAvailabilityZone>
 </Subnet>
 <Subnet>
 <SubnetIdentifier>subnet-########</SubnetIdentifier>
 <SubnetStatus>Active</SubnetStatus>
 <SubnetAvailabilityZone>
 <Name>us-east-1b</Name>
 </SubnetAvailabilityZone>
 </Subnet>
 </Subnets>
 <SubnetGroupStatus>Complete</SubnetGroupStatus>
 <DBSubnetGroupDescription>default</DBSubnetGroupDescription>
 <DBSubnetGroupName>default</DBSubnetGroupName>
 </DBSubnetGroup>
 <VpcSecurityGroups>
 <VpcSecurityGroupMembership>
 <VpcSecurityGroupId>sg-########</VpcSecurityGroupId>
 <Status>active</Status>
 </VpcSecurityGroupMembership>
https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html
Page 5 of 9

general-public-licensefri:05:57-fri:06:27io1truefalse100default.oracle-ee-12.1in-syncus-east-1cus-east-1f1000arn:aws:logs:us-east-1:1234567890:log-group:RDSOSMetrics:log-stream:db-YV 12.1.0.2.v11oracledbadmin2018-03-28T20:00:48.832Zdb.m4.xlarge60available7arn:aws:kms:us-east-1:1234567890:key/###################default:oracle-ee-12-1in-sync2018-03-28T20:14:30.818Zrds-ca-20150db-YVS5NRBNHPGJZ3IT3WADXYSWYU07:39-08:09oracledbarn:aws:rds:us-east-1:1234567890:db:oracledbZ2R2ITUGPM61AMoracledb.########.us-east-1.rds.amazonaws.com1521 https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html
Page 6 of 9

oracle-eetruefalsefalseORCLtrueAL32UTF8arn:aws:iam::1234567890:role/rds-monitoring-roletruevpc-########subnet-########Activeus-east-1esubnet-########Activeus-east-1dsubnet-########Activeus-east-1csubnet-########Activeus-east-1fsubnet-########Activeus-east-1a https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html
Page 7 of 9

subnet-########Activeus-east-1bCompletedefaultdefaultsg-########activebring-your-own-licensetue:08:39-tue:09:09io1truefalse298f362b-e14a-4ee0-9840-4546c276014a See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
AWS Command Line Interface V2
AWS SDK for .NET V4
AWS SDK for C++
AWS SDK for Go v2
AWS SDK for Java V2
https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html
Page 8 of 9

AWS SDK for JavaScript V3
AWS SDK for Kotlin
AWS SDK for PHP V3
AWS SDK for Python
AWS SDK for Ruby V3
Source: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html
https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html
Page 9 of 9