Returns information about provisioned instances, and supports pagination.
neptune_describe_db_instances(DBInstanceIdentifier, Filters, MaxRecords,
Marker)
The user-supplied instance identifier. 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 DBInstance.
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 will only include
information about the DB instances associated with the DB clusters
identified by these ARNs.
engine
- Accepts an engine name (such as neptune
), and restricts
the results list to DB instances created by that engine.
For example, to invoke this API from the AWS CLI and filter so that only Neptune DB instances are returned, you could use the following command:
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 the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
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
.
svc$describe_db_instances( DBInstanceIdentifier = "string", Filters = list( list( Name = "string", Values = list( "string" ) ) ), MaxRecords = 123, Marker = "string" )
This operation can also return information for Amazon RDS instances and Amazon DocDB instances.