v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14169872.1 KB

Updates an environment.

patch/environments/{id}

Path parameters

idstring required

The ID of the environment to update.

Request body

namestring password

The name of the environment to update.

desktopArnstring

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.

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