Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . workspaces ]

create-workspace-bundle

Description

Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-workspace-bundle
--bundle-name <value>
--bundle-description <value>
--image-id <value>
--compute-type <value>
--user-storage <value>
[--root-storage <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--bundle-name (string)

The name of the bundle.

--bundle-description (string)

The description of the bundle.

--image-id (string)

The identifier of the image that is used to create the bundle.

--compute-type (structure)

Describes the compute type of the bundle.

Name -> (string)

The compute type.

Shorthand Syntax:

Name=string

JSON Syntax:

{
  "Name": "VALUE"|"STANDARD"|"PERFORMANCE"|"POWER"|"GRAPHICS"|"POWERPRO"|"GRAPHICSPRO"
}

--user-storage (structure)

Describes the user volume for a WorkSpace bundle.

Capacity -> (string)

The size of the user volume.

Shorthand Syntax:

Capacity=string

JSON Syntax:

{
  "Capacity": "string"
}

--root-storage (structure)

Describes the root volume for a WorkSpace bundle.

Capacity -> (string)

The size of the root volume.

Shorthand Syntax:

Capacity=string

JSON Syntax:

{
  "Capacity": "string"
}

--tags (list)

The tags associated with the bundle.

Note

To add tags at the same time when you're creating the bundle, you must create an IAM policy that grants your IAM user permissions 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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

WorkspaceBundle -> (structure)

Describes a WorkSpace bundle.

BundleId -> (string)

The identifier of the bundle.

Name -> (string)

The name of the bundle.

Owner -> (string)

The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by AWS.

Description -> (string)

The description of the bundle.

ImageId -> (string)

The identifier of the image that was used to create the bundle.

RootStorage -> (structure)

The size of the root volume.

Capacity -> (string)

The size of the root volume.

UserStorage -> (structure)

The size of the user volume.

Capacity -> (string)

The size of the user volume.

ComputeType -> (structure)

The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles .

Name -> (string)

The compute type.

LastUpdatedTime -> (timestamp)

The last time that the bundle was updated.

CreationTime -> (timestamp)

The time when the bundle was created.