Skip to content

Returns information about snapshots for a specified elastic cluster

Description

Returns information about snapshots for a specified elastic cluster.

Usage

docdbelastic_list_cluster_snapshots(clusterArn, maxResults, nextToken,
  snapshotType)

Arguments

  • clusterArn

    The ARN identifier of the elastic cluster.

  • 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.

  • snapshotType

    The type of cluster snapshots to be returned. You can specify one of the following values:

    • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
    • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

Value

A list with the following syntax:

list(
  nextToken = "string",
  snapshots = list(
    list(
      clusterArn = "string",
      snapshotArn = "string",
      snapshotCreationTime = "string",
      snapshotName = "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"
    )
  )
)

Request syntax

svc$list_cluster_snapshots(
  clusterArn = "string",
  maxResults = 123,
  nextToken = "string",
  snapshotType = "string"
)