/AWS1/CL_RDS=>DESCRIBEDBCLUSTERS()

About DescribeDBClusters

Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

Method Signature

IMPORTING

Optional arguments:

IV_DBCLUSTERIDENTIFIER TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

• If supplied, must match an existing DB cluster identifier.

IT_FILTERS TYPE /AWS1/CL_RDSFILTER=>TT_FILTERLIST TT_FILTERLIST

A filter that specifies one or more DB clusters to describe.

Supported Filters:

• clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.

• db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.

• domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.

• engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.

IV_MAXRECORDS TYPE /AWS1/RDSINTEGEROPTIONAL /AWS1/RDSINTEGEROPTIONAL

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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100

IV_MARKER TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

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.

IV_INCLUDESHARED TYPE /AWS1/RDSBOOLEAN /AWS1/RDSBOOLEAN

Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_RDSDBCLUSTERMESSAGE /AWS1/CL_RDSDBCLUSTERMESSAGE