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-thin-client ]

update-environment

Description

Updates an environment.

See also: AWS API Documentation

Synopsis

  update-environment
--id <value>
[--name <value>]
[--desktop-arn <value>]
[--desktop-endpoint <value>]
[--software-set-update-schedule <value>]
[--maintenance-window <value>]
[--software-set-update-mode <value>]
[--desired-software-set-id <value>]
[--device-creation-tags <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

--id (string)

The ID of the environment to update.

--name (string)

The name of the environment to update.

--desktop-arn (string)

The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.

--desktop-endpoint (string)

The URL for the identity provider login (only for environments that use AppStream 2.0).

--software-set-update-schedule (string)

An option to define if software updates should be applied within a maintenance window.

Possible values:

  • USE_MAINTENANCE_WINDOW
  • APPLY_IMMEDIATELY

--maintenance-window (structure)

A specification for a time window to apply software updates.

type -> (string)

An option to select the default or custom maintenance window.

startTimeHour -> (integer)

The hour for the maintenance window start (00 -23 ).

startTimeMinute -> (integer)

The minutes past the hour for the maintenance window start (00 -59 ).

endTimeHour -> (integer)

The hour for the maintenance window end (00 -23 ).

endTimeMinute -> (integer)

The minutes for the maintenance window end (00 -59 ).

daysOfTheWeek -> (list)

The days of the week during which the maintenance window is open.

(string)

applyTimeOf -> (string)

The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).

Shorthand Syntax:

type=string,startTimeHour=integer,startTimeMinute=integer,endTimeHour=integer,endTimeMinute=integer,daysOfTheWeek=string,string,applyTimeOf=string

JSON Syntax:

{
  "type": "SYSTEM"|"CUSTOM",
  "startTimeHour": integer,
  "startTimeMinute": integer,
  "endTimeHour": integer,
  "endTimeMinute": integer,
  "daysOfTheWeek": ["MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY", ...],
  "applyTimeOf": "UTC"|"DEVICE"
}

--software-set-update-mode (string)

An option to define which software updates to apply.

Possible values:

  • USE_LATEST
  • USE_DESIRED

--desired-software-set-id (string)

The ID of the software set to apply.

--device-creation-tags (map)

A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "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.

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.

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

environment -> (structure)

Describes an environment.

id -> (string)

The ID of the environment.

name -> (string)

The name of the environment.

desktopArn -> (string)

The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.

desktopEndpoint -> (string)

The URL for the identity provider login (only for environments that use AppStream 2.0).

desktopType -> (string)

The type of streaming desktop for the environment.

activationCode -> (string)

The activation code to register a device to the environment.

softwareSetUpdateSchedule -> (string)

An option to define if software updates should be applied within a maintenance window.

maintenanceWindow -> (structure)

A specification for a time window to apply software updates.

type -> (string)

An option to select the default or custom maintenance window.

startTimeHour -> (integer)

The hour for the maintenance window start (00 -23 ).

startTimeMinute -> (integer)

The minutes past the hour for the maintenance window start (00 -59 ).

endTimeHour -> (integer)

The hour for the maintenance window end (00 -23 ).

endTimeMinute -> (integer)

The minutes for the maintenance window end (00 -59 ).

daysOfTheWeek -> (list)

The days of the week during which the maintenance window is open.

(string)

applyTimeOf -> (string)

The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).

softwareSetUpdateMode -> (string)

An option to define which software updates to apply.

desiredSoftwareSetId -> (string)

The ID of the software set to apply.

pendingSoftwareSetId -> (string)

The ID of the software set that is pending to be installed.

createdAt -> (timestamp)

The timestamp of when the environment was created.

updatedAt -> (timestamp)

The timestamp of when the device was updated.

arn -> (string)

The Amazon Resource Name (ARN) of the environment.