ListSnapshots
Returns a list of snapshots.
Request Syntax
{
"endTime": number
,
"maxResults": number
,
"namespaceArn": "string
",
"namespaceName": "string
",
"nextToken": "string
",
"ownerAccount": "string
",
"startTime": number
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- endTime
-
The timestamp showing when the snapshot creation finished.
Type: Timestamp
Required: No
- maxResults
-
An optional parameter that specifies the maximum number of results to return. You can use
nextToken
to display the next page of results.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- namespaceArn
-
The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.
Type: String
Required: No
- namespaceName
-
The namespace from which to list all snapshots.
Type: String
Required: No
- nextToken
-
If
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.Type: String
Required: No
- ownerAccount
-
The owner AWS account of the snapshot.
Type: String
Required: No
- startTime
-
The time when the creation of the snapshot was initiated.
Type: Timestamp
Required: No
Response Syntax
{
"nextToken": "string",
"snapshots": [
{
"accountsWithProvisionedRestoreAccess": [ "string" ],
"accountsWithRestoreAccess": [ "string" ],
"actualIncrementalBackupSizeInMegaBytes": number,
"adminPasswordSecretArn": "string",
"adminPasswordSecretKmsKeyId": "string",
"adminUsername": "string",
"backupProgressInMegaBytes": number,
"currentBackupRateInMegaBytesPerSecond": number,
"elapsedTimeInSeconds": number,
"estimatedSecondsToCompletion": number,
"kmsKeyId": "string",
"namespaceArn": "string",
"namespaceName": "string",
"ownerAccount": "string",
"snapshotArn": "string",
"snapshotCreateTime": "string",
"snapshotName": "string",
"snapshotRemainingDays": number,
"snapshotRetentionPeriod": number,
"snapshotRetentionStartTime": "string",
"status": "string",
"totalBackupSizeInMegaBytes": number
}
]
}
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
-
If
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.Type: String
- snapshots
-
All of the returned snapshot objects.
Type: Array of Snapshot objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource could not be found.
HTTP Status Code: 400
- ValidationException
-
The input failed to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: