reboot_workspaces

WorkSpaces.Client.reboot_workspaces(**kwargs)

Reboots the specified WorkSpaces.

You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY .

This operation is asynchronous and returns before the WorkSpaces have rebooted.

See also: AWS API Documentation

Request Syntax

response = client.reboot_workspaces(
    RebootWorkspaceRequests=[
        {
            'WorkspaceId': 'string'
        },
    ]
)

Parameters

RebootWorkspaceRequests (list) --

[REQUIRED]

The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.

• (dict) --

  Describes the information used to reboot a WorkSpace.

  • WorkspaceId (string) -- [REQUIRED]

    The identifier of the WorkSpace.

Return type

dict

Returns

Response Syntax

{
    'FailedRequests': [
        {
            'WorkspaceId': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

• (dict) --
  • FailedRequests (list) --

    Information about the WorkSpaces that could not be rebooted.

    • (dict) --

      Describes a WorkSpace that could not be rebooted. ( RebootWorkspaces ), rebuilt ( RebuildWorkspaces ), restored ( RestoreWorkspace ), terminated ( TerminateWorkspaces ), started ( StartWorkspaces ), or stopped ( StopWorkspaces ).

      • WorkspaceId (string) --

        The identifier of the WorkSpace.

      • ErrorCode (string) --

        The error code that is returned if the WorkSpace cannot be rebooted.

      • ErrorMessage (string) --

        The text of the error message that is returned if the WorkSpace cannot be rebooted.

Exceptions

• WorkSpaces.Client.exceptions.OperationNotSupportedException