DescribeSnapshots

GET /?Action=DescribeSnapshots
Description

Describes one or more snapshots that are available to you.
You can filter the described snapshots using the SnapshotId.N, the Owner.N and the RestorableBy.N parameters.
You can also use the Filter.N parameter to filter the snapshots on the following properties:

  • description: The description of the snapshot.

  • owner-alias: The account alias of the owner of the snapshot.

  • owner-id: The account ID of the owner of the snapshot.

  • progress: The progress of the snapshot, as a percentage.

  • snapshot-id: The ID of the snapshot.

  • start-time: The time at which the snapshot was initiated.

  • status: The state of the snapshot (in-queue | completed | error).

  • volume-id: The ID of the volume used to create the snapshot.

  • volume-size: The size of the volume used to create the snapshot, in gibibytes (GiB).

  • tag-key: The key of a tag associated with the resource.

  • tag-value: The value of a tag associated with the resource.

  • tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.

Note

If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.
Body parameter

Required: false
Name: DescribeSnapshotsRequest

Name Description Required Schema Default Example

DryRun

If set to true, checks whether you have the required permissions to perform the action.

false

boolean

Filter.N

One or more filters. Example:
osc-cli fcu DescribeSnapshots \
  --Filter.1.Name "tag:KEYOFTHETAG" \
  --Filter.1.Value.1 "VALUEOFTHETAG"

false

Filter

MaxResults

The maximum number of results that can be returned in a single page. You can use NextToken to request the next results pages. This value is between 5 and 1000. If you provide a value larger than 1000, only 1000 results are returned.

false

integer

NextToken

The token to request the next results page.

false

string

Owner.N

One or more owners of the snapshots.

false

string

RestorableBy.N

One or more accounts IDs that have the permissions to create volumes from the snapshot.

false

string

SnapshotId.N

One or more snapshot IDs.

false

string
Responses
HTTP Code 200
HTTP Code Description Schema

200

DescribeSnapshotsResult

Response 200

Response 200

Name Description Required Schema Default Example

nextToken

The token to request the next results page. If the value is null, there is no results left to be returned.

false

string

requestId

The ID of the request.

false

string

snapshotSet.N

Information about one or more snapshots.

false

Snapshot