Request Parameters Response Elements Errors Examples See Also

DescribeDBInstances

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.
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

Errors

For information about the errors that are common to all actions, see Common Errors.

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>
        <SecondaryAvailabilityZone>us-east-1a</SecondaryAvailabilityZone>
        <DBSecurityGroups/>
        <Iops>1000</Iops>
        <EnhancedMonitoringResourceArn>arn:aws:logs:us-east-1:1234567890:log-group:RDSOSMetrics:log-stream:db-IXRXA2XS7KFFA6JWYYWFZEBJDE</EnhancedMonitoringResourceArn>
        <EngineVersion>5.6.39</EngineVersion>
        <MasterUsername>mysqldbadmin</MasterUsername>
        <InstanceCreateTime>2018-03-28T19:54:07.871Z</InstanceCreateTime>
        <DBInstanceClass>db.m4.xlarge</DBInstanceClass>
        <ReadReplicaDBInstanceIdentifiers/>
        <MonitoringInterval>60</MonitoringInterval>
        <DBInstanceStatus>available</DBInstanceStatus>
        <BackupRetentionPeriod>7</BackupRetentionPeriod>
        <KmsKeyId>arn:aws:kms:us-east-1:1234567890:key/######################</KmsKeyId>
        <OptionGroupMemberships>
          <OptionGroupMembership>
            <OptionGroupName>default:mysql-5-6</OptionGroupName>
            <Status>in-sync</Status>
          </OptionGroupMembership>
        </OptionGroupMemberships>
        <LatestRestorableTime>2018-03-28T20:10:00Z</LatestRestorableTime>
        <CACertificateIdentifier>rds-ca-2015</CACertificateIdentifier>
        <DbInstancePort>0</DbInstancePort>
        <DbiResourceId>db-IXRXA2XS7KFFA6JWYYWFZEBJDE</DbiResourceId>
        <PreferredBackupWindow>05:27-05:57</PreferredBackupWindow>
        <DBInstanceIdentifier>mysqldb</DBInstanceIdentifier>
        <DBInstanceArn>arn:aws:rds:us-east-1:1234567890:db:mysqldb</DBInstanceArn>
        <Endpoint>
          <HostedZoneId>Z2R2ITUGPM61AM</HostedZoneId>
          <Address>mysqldb.########.us-east-1.rds.amazonaws.com</Address>
          <Port>3306</Port>
        </Endpoint>
        <Engine>mysql</Engine>
        <PubliclyAccessible>true</PubliclyAccessible>
        <IAMDatabaseAuthenticationEnabled>false</IAMDatabaseAuthenticationEnabled>
        <PerformanceInsightsEnabled>false</PerformanceInsightsEnabled>
        <MultiAZ>true</MultiAZ>
        <MonitoringRoleArn>arn:aws:iam::1234567890:role/rds-monitoring-role</MonitoringRoleArn>
        <DomainMemberships/>
        <StorageEncrypted>true</StorageEncrypted>
        <DBSubnetGroup>
          <VpcId>vpc-########</VpcId>
          <Subnets>
            <Subnet>
              <SubnetIdentifier>subnet-########</SubnetIdentifier>
              <SubnetStatus>Active</SubnetStatus>
              <SubnetAvailabilityZone>
                <Name>us-east-1e</Name>
              </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>
        </VpcSecurityGroups>
        <LicenseModel>general-public-license</LicenseModel>
        <PendingModifiedValues/>
        <PreferredMaintenanceWindow>fri:05:57-fri:06:27</PreferredMaintenanceWindow>
        <StorageType>io1</StorageType>
        <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
        <CopyTagsToSnapshot>false</CopyTagsToSnapshot>
      </DBInstance>
      <DBInstance>
        <AllocatedStorage>100</AllocatedStorage>
        <DBParameterGroups>
          <DBParameterGroup>
            <DBParameterGroupName>default.oracle-ee-12.1</DBParameterGroupName>
            <ParameterApplyStatus>in-sync</ParameterApplyStatus>
          </DBParameterGroup>
        </DBParameterGroups>
        <AvailabilityZone>us-east-1c</AvailabilityZone>
        <SecondaryAvailabilityZone>us-east-1f</SecondaryAvailabilityZone>
        <DBSecurityGroups/>
        <Iops>1000</Iops>
        <EnhancedMonitoringResourceArn>arn:aws:logs:us-east-1:1234567890:log-group:RDSOSMetrics:log-stream:db-YVS5NRBNHPGJZ3IT3WADXYSWYU</EnhancedMonitoringResourceArn>
        <EngineVersion>12.1.0.2.v11</EngineVersion>
        <MasterUsername>oracledbadmin</MasterUsername>
        <InstanceCreateTime>2018-03-28T20:00:48.832Z</InstanceCreateTime>
        <DBInstanceClass>db.m4.xlarge</DBInstanceClass>
        <ReadReplicaDBInstanceIdentifiers/>
        <MonitoringInterval>60</MonitoringInterval>
        <DBInstanceStatus>available</DBInstanceStatus>
        <BackupRetentionPeriod>7</BackupRetentionPeriod>
        <KmsKeyId>arn:aws:kms:us-east-1:1234567890:key/###################</KmsKeyId>
        <OptionGroupMemberships>
          <OptionGroupMembership>
            <OptionGroupName>default:oracle-ee-12-1</OptionGroupName>
            <Status>in-sync</Status>
          </OptionGroupMembership>
        </OptionGroupMemberships>
        <LatestRestorableTime>2018-03-28T20:14:30.818Z</LatestRestorableTime>
        <CACertificateIdentifier>rds-ca-2015</CACertificateIdentifier>
        <DbInstancePort>0</DbInstancePort>
        <DbiResourceId>db-YVS5NRBNHPGJZ3IT3WADXYSWYU</DbiResourceId>
        <PreferredBackupWindow>07:39-08:09</PreferredBackupWindow>
        <DBInstanceIdentifier>oracledb</DBInstanceIdentifier>
        <DBInstanceArn>arn:aws:rds:us-east-1:1234567890:db:oracledb</DBInstanceArn>
        <Endpoint>
          <HostedZoneId>Z2R2ITUGPM61AM</HostedZoneId>
          <Address>oracledb.########.us-east-1.rds.amazonaws.com</Address>
          <Port>1521</Port>
        </Endpoint>
        <Engine>oracle-ee</Engine>
        <PubliclyAccessible>true</PubliclyAccessible>
        <IAMDatabaseAuthenticationEnabled>false</IAMDatabaseAuthenticationEnabled>
        <PerformanceInsightsEnabled>false</PerformanceInsightsEnabled>
        <DBName>ORCL</DBName>
        <MultiAZ>true</MultiAZ>
        <CharacterSetName>AL32UTF8</CharacterSetName>
        <MonitoringRoleArn>arn:aws:iam::1234567890:role/rds-monitoring-role</MonitoringRoleArn>
        <DomainMemberships/>
        <StorageEncrypted>true</StorageEncrypted>
        <DBSubnetGroup>
          <VpcId>vpc-########</VpcId>
          <Subnets>
            <Subnet>
              <SubnetIdentifier>subnet-########</SubnetIdentifier>
              <SubnetStatus>Active</SubnetStatus>
              <SubnetAvailabilityZone>
                <Name>us-east-1e</Name>
              </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>
        </VpcSecurityGroups>
        <LicenseModel>bring-your-own-license</LicenseModel>
        <PendingModifiedValues/>
        <PreferredMaintenanceWindow>tue:08:39-tue:09:09</PreferredMaintenanceWindow>
        <StorageType>io1</StorageType>
        <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
        <CopyTagsToSnapshot>false</CopyTagsToSnapshot>
      </DBInstance>
    </DBInstances>
  </DescribeDBInstancesResult>
  <ResponseMetadata>
    <RequestId>298f362b-e14a-4ee0-9840-4546c276014a</RequestId>
  </ResponseMetadata>
</DescribeDBInstancesResponse>