AWS CLI Command Reference

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-workspaces-pool

Description

Creates a pool of WorkSpaces.

See also: AWS API Documentation

Synopsis

  create-workspaces-pool
--pool-name <value>
--description <value>
--bundle-id <value>
--directory-id <value>
--capacity <value>
[--tags <value>]
[--application-settings <value>]
[--timeout-settings <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--pool-name (string)

The name of the pool.

--description (string)

The pool description.

--bundle-id (string)

The identifier of the bundle for the pool.

--directory-id (string)

The identifier of the directory for the pool.

--capacity (structure)

The user capacity of the pool.

DesiredUserSessions -> (integer)

The desired number of user sessions for the WorkSpaces in the pool.

Shorthand Syntax:

DesiredUserSessions=integer

JSON Syntax:

{
  "DesiredUserSessions": integer
}

--tags (list)

The tags for the pool.

(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"
  }
  ...
]

--application-settings (structure)

Indicates the application settings of the pool.

Status -> (string)

Enables or disables persistent application settings for users during their pool sessions.

SettingsGroup -> (string)

The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple pools by specifying the same settings group for each pool.

Shorthand Syntax:

Status=string,SettingsGroup=string

JSON Syntax:

{
  "Status": "DISABLED"|"ENABLED",
  "SettingsGroup": "string"
}

--timeout-settings (structure)

Indicates the timeout settings of the pool.

DisconnectTimeoutInSeconds -> (integer)

Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

IdleDisconnectTimeoutInSeconds -> (integer)

The amount of time in seconds a connection will stay active while idle.

MaxUserDurationInSeconds -> (integer)

Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

Shorthand Syntax:

DisconnectTimeoutInSeconds=integer,IdleDisconnectTimeoutInSeconds=integer,MaxUserDurationInSeconds=integer

JSON Syntax:

{
  "DisconnectTimeoutInSeconds": integer,
  "IdleDisconnectTimeoutInSeconds": integer,
  "MaxUserDurationInSeconds": integer
}

--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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

WorkspacesPool -> (structure)

Indicates the pool to create.

PoolId -> (string)

The identifier of a pool.

PoolArn -> (string)

The Amazon Resource Name (ARN) for the pool.

CapacityStatus -> (structure)

The capacity status for the pool

AvailableUserSessions -> (integer)

The number of user sessions currently available for streaming from your pool.

AvailableUserSessions = ActualUserSessions - ActiveUserSessions

DesiredUserSessions -> (integer)

The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your pool can support in a steady state.

ActualUserSessions -> (integer)

The total number of user sessions that are available for streaming or are currently streaming in your pool.

ActualUserSessions = AvailableUserSessions + ActiveUserSessions

ActiveUserSessions -> (integer)

The number of user sessions currently being used for your pool.

PoolName -> (string)

The name of the pool,

Description -> (string)

The description of the pool.

State -> (string)

The current state of the pool.

CreatedAt -> (timestamp)

The time the pool was created.

BundleId -> (string)

The identifier of the bundle used by the pool.

DirectoryId -> (string)

The identifier of the directory used by the pool.

Errors -> (list)

The pool errors.

(structure)

Describes a pool error.

ErrorCode -> (string)

The error code.

ErrorMessage -> (string)

The error message.

ApplicationSettings -> (structure)

The persistent application settings for users of the pool.

Status -> (string)

Specifies whether persistent application settings are enabled for users during their pool sessions.

SettingsGroup -> (string)

The path prefix for the S3 bucket where users’ persistent application settings are stored.

S3BucketName -> (string)

The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an Amazon Web Services Region, an S3 bucket is created. The bucket is unique to the Amazon Web Services account and the Region.

TimeoutSettings -> (structure)

The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.

DisconnectTimeoutInSeconds -> (integer)

Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

IdleDisconnectTimeoutInSeconds -> (integer)

The amount of time in seconds a connection will stay active while idle.

MaxUserDurationInSeconds -> (integer)

Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.