Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListSnapshots

Lists the enhanced snapshots in your account. Snapshots are not scoped to an application. To list the snapshots that were created from a specific application, use the SourceApplicationName parameter.

You can specify only one of the following filters in a request: SourceApplicationName, SnapshotInitiator, SnapshotInitiatorOperation, or SnapshotStatus. If you specify more than one filter, InvalidArgumentException is returned.

The results are sorted in descending order of snapshot creation timestamp. To get detailed information about a specific snapshot, use DescribeSnapshot.

Request Syntax


{
   "Limit": number,
   "NextToken": "string",
   "SnapshotInitiator": "string",
   "SnapshotInitiatorOperation": "string",
   "SnapshotStatus": "string",
   "SourceApplicationName": "string"
}

Request Parameters

The request accepts the following data in JSON format.

Limit

The maximum number of snapshots to list.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

NextToken

A pagination token that can be used in a subsequent request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No

SnapshotInitiator

Use this parameter to list only the snapshots with the specified initiator.

Type: String

Valid Values: USER | SYSTEM

Required: No

SnapshotInitiatorOperation

Use this parameter to list only the snapshots that were created by the specified operation.

Type: String

Valid Values: CreateSnapshot | ImportSnapshot | SystemCreateSnapshot

Required: No

SnapshotStatus

Use this parameter to list only the snapshots with the specified status.

Type: String

Valid Values: CREATING | READY | DELETING | FAILED

Required: No

SourceApplicationName

The name of the application.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9_.-]+

Required: No

Response Syntax


{
   "NextToken": "string",
   "SnapshotInfoList": [ 
      { 
         "SnapshotArn": "string",
         "SnapshotCreationTimestamp": number,
         "SnapshotFormat": "string",
         "SnapshotInitiator": "string",
         "SnapshotInitiatorOperation": "string",
         "SnapshotName": "string",
         "SnapshotStatus": "string",
         "SourceApplicationName": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

A pagination token that can be used in a subsequent request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

SnapshotInfoList

A list of SnapshotInfo objects.

Type: Array of SnapshotInfo objects

Errors

InvalidArgumentException

The specified input parameter value is not valid.

HTTP Status Code: 400

UnsupportedOperationException

The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

HTTP Status Code: 400