---
title: "GET /cluster-snapshots"
method: GET
path: "/cluster-snapshots"
---

# GET /cluster-snapshots

`GET /cluster-snapshots`

Returns information about snapshots for a specified elastic cluster.

## Query parameters

- `clusterArn` string
- `maxResults` integer
- `nextToken` string — <pre><code>Token or cursor used in paginated operations. When this value is provided as operation input, the service returns results from where the previous response left off. When this value is present in operation output, it indicates that there are more results to retrieve. This should be opaque to not expose implementation details and potentially versioned to allow evolution of pagination strategy. </code></pre>
- `snapshotType` string

## Response `200`

Success

- ListClusterSnapshotsOutput
  - `nextToken` string — <p>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 <code>max-results</code>.</p> <p>If there is no more data in the responce, the <code>nextToken</code> will not be returned.</p>
  - `snapshots` ClusterSnapshotInList[] — A list of snapshots for a specified elastic cluster.
    - `clusterArn` string, required — The ARN identifier of the elastic cluster.
    - `snapshotArn` string, required — The ARN identifier of the elastic cluster snapshot.
    - `snapshotCreationTime` string, required — The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
    - `snapshotName` string, required — The name of the elastic cluster snapshot.
    - `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', required — The status of the elastic cluster snapshot.

## Other responses

- `480` — ThrottlingException
- `481` — ValidationException
- `482` — InternalServerException
- `483` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/docdb-elastic.md) · [All operations](https://skmtc.net/aws/apis/docdb-elastic/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/docdb-elastic/versions/71417e1f0c94/schema)