List Clusters

docdbelastic_list_clusters

R Documentation

Returns information about provisioned Amazon DocumentDB elastic clusters¶

Description¶

Returns information about provisioned Amazon DocumentDB elastic clusters.

Usage¶

docdbelastic_list_clusters(maxResults, nextToken)

Arguments¶

maxResults

The maximum number of elastic cluster snapshot results to receive in the response.

nextToken

A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.

If there is no more data in the responce, the nextToken will not be returned.

Value¶

A list with the following syntax:

list(
  clusters = list(
    list(
      clusterArn = "string",
      clusterName = "string",
      status = "CREATING"|"ACTIVE"|"DELETING"|"UPDATING"|"VPC_ENDPOINT_LIMIT_EXCEEDED"|"IP_ADDRESS_LIMIT_EXCEEDED"|"INVALID_SECURITY_GROUP_ID"|"INVALID_SUBNET_ID"|"INACCESSIBLE_ENCRYPTION_CREDS"|"INACCESSIBLE_SECRET_ARN"|"INACCESSIBLE_VPC_ENDPOINT"|"INCOMPATIBLE_NETWORK"|"MERGING"|"MODIFYING"|"SPLITTING"|"COPYING"|"STARTING"|"STOPPING"|"STOPPED"|"MAINTENANCE"|"INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_clusters(
  maxResults = 123,
  nextToken = "string"
)