[ aws . workspaces ]

rebuild-workspaces

Description

Rebuilds the specified WorkSpace.

You cannot rebuild a WorkSpace unless its state is AVAILABLE , ERROR , UNHEALTHY , STOPPED , or REBOOTING .

Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace .

This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  rebuild-workspaces
--rebuild-workspace-requests <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--rebuild-workspace-requests (list)

The WorkSpace to rebuild. You can specify a single WorkSpace.

(structure)

Describes the information used to rebuild a WorkSpace.

WorkspaceId -> (string)

The identifier of the WorkSpace.

Shorthand Syntax:

--rebuild-workspace-requests WorkspaceId1

JSON Syntax:

[
  {
    "WorkspaceId": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

FailedRequests -> (list)

Information about the WorkSpace that could not be rebuilt.

(structure)

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.