DescribeDBInstances
For information about the parameters that are common to all actions, see Common Parameters.
DBInstanceIdentifier
The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn’t case sensitive.
Constraints:
Type: String
Required: No
Filters.Filter.N
A filter that specifies one or more instances to describe.
Supported filters:
db-cluster-id
- Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.- Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.
Type: Array of objects
Required: No
Marker
Type: String
Required: No
MaxRecords
The maximum number of records to include in the response. If more records exist than the specified value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
Type: Integer
Required: No
The following elements are returned by the service.
DBInstances.DBInstance.N
Detailed information about one or more 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
.
For information about the errors that are common to all actions, see .
DBInstanceNotFound
doesn’t refer to an existing instance.
HTTP Status Code: 404
For more information about using this API in one of the language-specific AWS SDKs, see the following: