describe_workspace_snapshots

WorkSpaces.Client.describe_workspace_snapshots(**kwargs)

Describes the snapshots for the specified WorkSpace.

See also: AWS API Documentation

Request Syntax

response = client.describe_workspace_snapshots(
    WorkspaceId='string'
)

Parameters

WorkspaceId (string) --

[REQUIRED]

The identifier of the WorkSpace.

Return type

dict

Returns

Response Syntax

{
    'RebuildSnapshots': [
        {
            'SnapshotTime': datetime(2015, 1, 1)
        },
    ],
    'RestoreSnapshots': [
        {
            'SnapshotTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) --
  • RebuildSnapshots (list) --

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

    • (dict) --

      Describes a snapshot.

      • SnapshotTime (datetime) --

        The time when the snapshot was created.

  • RestoreSnapshots (list) --

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

    • (dict) --

      Describes a snapshot.

      • SnapshotTime (datetime) --

        The time when the snapshot was created.

Exceptions

• WorkSpaces.Client.exceptions.InvalidParameterValuesException
• WorkSpaces.Client.exceptions.ResourceNotFoundException
• WorkSpaces.Client.exceptions.AccessDeniedException