DescribeWorkspaceSnapshots - Amazon WorkSpaces Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DescribeWorkspaceSnapshots

Describes the snapshots for the specified WorkSpace.

Request Syntax

{ "WorkspaceId": "string" }

Request Parameters

The request accepts the following data in JSON format.

WorkspaceId

The identifier of the WorkSpace.

Type: String

Pattern: ^ws-[0-9a-z]{8,63}$

Required: Yes

Response Syntax

{ "RebuildSnapshots": [ { "SnapshotTime": number } ], "RestoreSnapshots": [ { "SnapshotTime": 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.

RebuildSnapshots

Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include the user volume.

Type: Array of Snapshot objects

RestoreSnapshots

Information about the snapshots that can be used to restore a WorkSpace. These snapshots include both the root volume and the user volume.

Type: Array of Snapshot objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: