Updates an environment.
Request Syntax
PATCH /environments/id HTTP/1.1
Content-type: application/json
{
"desiredSoftwareSetId": "string",
"desktopArn": "string",
"desktopEndpoint": "string",
"deviceCreationTags": {
"string" : "string"
},
"maintenanceWindow": {
"applyTimeOf": "string",
"daysOfTheWeek": [ "string" ],
"endTimeHour": number,
"endTimeMinute": number,
"startTimeHour": number,
"startTimeMinute": number,
"type": "string"
},
"name": "string",
"softwareSetUpdateMode": "string",
"softwareSetUpdateSchedule": "string"
}URI Request Parameters
The request uses the following URI parameters.
- id
-
The ID of the environment to update.
Pattern:
[a-z0-9]{9}Required: Yes
Request Body
The request accepts the following data in JSON format.
- desiredSoftwareSetId
-
The ID of the software set to apply.
Type: String
Pattern:
[0-9]{0,9}Required: No
- desktopArn
-
The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[0-9]{0,12}:[a-zA-Z0-9\-\/\._]+Required: No
- desktopEndpoint
-
The URL for the identity provider login (only for environments that use AppStream 2.0).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
(https:\/\/)[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,32}(:[0-9]{1,5})?(\/.*)?Required: No
- deviceCreationTags
-
A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
(?!aws:)[A-Za-z0-9 _=@:.+-/]+Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
[A-Za-z0-9 _=@:.+-/]+Required: No
- maintenanceWindow
-
A specification for a time window to apply software updates.
Type: MaintenanceWindow object
Required: No
- name
-
The name of the environment to update.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern:
$|^[0-9\p{IsAlphabetic}+:,.@'" -][0-9\p{IsAlphabetic}+=:,.@'" -]*Required: No
- softwareSetUpdateMode
-
An option to define which software updates to apply.
Type: String
Valid Values:
USE_LATEST | USE_DESIREDRequired: No
- softwareSetUpdateSchedule
-
An option to define if software updates should be applied within a maintenance window.
Type: String
Valid Values:
USE_MAINTENANCE_WINDOW | APPLY_IMMEDIATELYRequired: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"environment": {
"activationCode": "string",
"arn": "string",
"createdAt": number,
"desiredSoftwareSetId": "string",
"desktopArn": "string",
"desktopEndpoint": "string",
"desktopType": "string",
"id": "string",
"maintenanceWindow": {
"applyTimeOf": "string",
"daysOfTheWeek": [ "string" ],
"endTimeHour": number,
"endTimeMinute": number,
"startTimeHour": number,
"startTimeMinute": number,
"type": "string"
},
"name": "string",
"pendingSoftwareSetId": "string",
"softwareSetUpdateMode": "string",
"softwareSetUpdateSchedule": "string",
"updatedAt": number
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- environment
-
Describes an environment.
Type: EnvironmentSummary object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
The server encountered an internal error and is unable to complete the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource specified in the request was not found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the specified constraints.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
