Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14169872.1 KB

Creates an environment for your thin client devices.

post/environments

Request body

namestring password

The name for the environment.

desktopArnstring required

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

desktopEndpointstring password

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

softwareSetUpdateSchedule'USE_MAINTENANCE_WINDOW' | 'APPLY_IMMEDIATELY'

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

softwareSetUpdateMode'USE_LATEST' | 'USE_DESIRED'

An option to define which software updates to apply.

desiredSoftwareSetIdstring

The ID of the software set to apply.

kmsKeyArnstring

The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.

clientTokenstring
<p>Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value</a>.</p> <p>If you don't provide this value, then Amazon Web Services generates a random one for you.</p> <p>If you retry the operation with the same <code>ClientToken</code>, but with different parameters, the retry fails with an <code>IdempotentParameterMismatch</code> error.</p>
tagsobject

A map of the key-value pairs of the tag or tags to assign to the resource.

deviceCreationTagsobject

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

Response

Success