[ aws . workspaces ]

create-workspace-image

Description

Creates a new WorkSpace image from an existing WorkSpace.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-workspace-image
--name <value>
--description <value>
--workspace-id <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the new WorkSpace image.

--description (string)

The description of the new WorkSpace image.

--workspace-id (string)

The identifier of the source WorkSpace

--tags (list)

The tags that you want to add to the new WorkSpace image. To add tags when you’re creating the image, you must create an IAM policy that grants your IAM user permission to use workspaces:CreateTags .

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Value -> (string)

The value of the tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "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

ImageId -> (string)

The identifier of the new WorkSpace image.

Name -> (string)

The name of the image.

Description -> (string)

The description of the image.

OperatingSystem -> (structure)

The operating system that the image is running.

Type -> (string)

The operating system.

State -> (string)

The availability status of the image.

RequiredTenancy -> (string)

Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.

Created -> (timestamp)

The date when the image was created.

OwnerAccountId -> (string)

The identifier of the AWS account that owns the image.