/AWS1/CL_NEP=>DESCRIBEDBCLUSTERS()
¶
About DescribeDBClusters¶
Returns information about provisioned DB clusters, and supports pagination.
This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.
Method Signature¶
IMPORTING¶
Optional arguments:¶
IV_DBCLUSTERIDENTIFIER
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
If supplied, must match an existing DBClusterIdentifier.
IT_FILTERS
TYPE /AWS1/CL_NEPFILTER=>TT_FILTERLIST
TT_FILTERLIST
¶
A filter that specifies one or more DB clusters 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 clusters identified by these ARNs.
engine
- Accepts an engine name (such asneptune
), and restricts the results list to DB clusters created by that engine.For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB clusters are returned, you could use the following command:
IV_MAXRECORDS
TYPE /AWS1/NEPINTEGEROPTIONAL
/AWS1/NEPINTEGEROPTIONAL
¶
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.
IV_MARKER
TYPE /AWS1/NEPSTRING
/AWS1/NEPSTRING
¶
An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.