Creates an environment for your thin client devices.
", "endpoint":{"hostPrefix":"api."} }, "DeleteDevice":{ "name":"DeleteDevice", "http":{ "method":"DELETE", "requestUri":"/devices/{id}", "responseCode":204 }, "input":{"shape":"DeleteDeviceRequest"}, "output":{"shape":"DeleteDeviceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Deletes a thin client device.
", "endpoint":{"hostPrefix":"api."}, "idempotent":true }, "DeleteEnvironment":{ "name":"DeleteEnvironment", "http":{ "method":"DELETE", "requestUri":"/environments/{id}", "responseCode":204 }, "input":{"shape":"DeleteEnvironmentRequest"}, "output":{"shape":"DeleteEnvironmentResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Deletes an environment.
", "endpoint":{"hostPrefix":"api."}, "idempotent":true }, "DeregisterDevice":{ "name":"DeregisterDevice", "http":{ "method":"POST", "requestUri":"/deregister-device/{id}", "responseCode":202 }, "input":{"shape":"DeregisterDeviceRequest"}, "output":{"shape":"DeregisterDeviceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Deregisters a thin client device.
", "endpoint":{"hostPrefix":"api."}, "idempotent":true }, "GetDevice":{ "name":"GetDevice", "http":{ "method":"GET", "requestUri":"/devices/{id}", "responseCode":200 }, "input":{"shape":"GetDeviceRequest"}, "output":{"shape":"GetDeviceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Returns information for a thin client device.
", "endpoint":{"hostPrefix":"api."} }, "GetEnvironment":{ "name":"GetEnvironment", "http":{ "method":"GET", "requestUri":"/environments/{id}", "responseCode":200 }, "input":{"shape":"GetEnvironmentRequest"}, "output":{"shape":"GetEnvironmentResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Returns information for an environment.
", "endpoint":{"hostPrefix":"api."} }, "GetSoftwareSet":{ "name":"GetSoftwareSet", "http":{ "method":"GET", "requestUri":"/softwaresets/{id}", "responseCode":200 }, "input":{"shape":"GetSoftwareSetRequest"}, "output":{"shape":"GetSoftwareSetResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Returns information for a software set.
", "endpoint":{"hostPrefix":"api."} }, "ListDevices":{ "name":"ListDevices", "http":{ "method":"GET", "requestUri":"/devices", "responseCode":200 }, "input":{"shape":"ListDevicesRequest"}, "output":{"shape":"ListDevicesResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Returns a list of thin client devices.
", "endpoint":{"hostPrefix":"api."} }, "ListEnvironments":{ "name":"ListEnvironments", "http":{ "method":"GET", "requestUri":"/environments", "responseCode":200 }, "input":{"shape":"ListEnvironmentsRequest"}, "output":{"shape":"ListEnvironmentsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Returns a list of environments.
", "endpoint":{"hostPrefix":"api."} }, "ListSoftwareSets":{ "name":"ListSoftwareSets", "http":{ "method":"GET", "requestUri":"/softwaresets", "responseCode":200 }, "input":{"shape":"ListSoftwareSetsRequest"}, "output":{"shape":"ListSoftwareSetsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Returns a list of software sets.
", "endpoint":{"hostPrefix":"api."} }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Returns a list of tags for a resource.
", "endpoint":{"hostPrefix":"api."} }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Assigns one or more tags (key-value pairs) to the specified resource.
", "endpoint":{"hostPrefix":"api."} }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Removes a tag or tags from a resource.
", "endpoint":{"hostPrefix":"api."}, "idempotent":true }, "UpdateDevice":{ "name":"UpdateDevice", "http":{ "method":"PATCH", "requestUri":"/devices/{id}", "responseCode":200 }, "input":{"shape":"UpdateDeviceRequest"}, "output":{"shape":"UpdateDeviceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Updates a thin client device.
", "endpoint":{"hostPrefix":"api."}, "idempotent":true }, "UpdateEnvironment":{ "name":"UpdateEnvironment", "http":{ "method":"PATCH", "requestUri":"/environments/{id}", "responseCode":200 }, "input":{"shape":"UpdateEnvironmentRequest"}, "output":{"shape":"UpdateEnvironmentResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Updates an environment.
", "endpoint":{"hostPrefix":"api."}, "idempotent":true }, "UpdateSoftwareSet":{ "name":"UpdateSoftwareSet", "http":{ "method":"PATCH", "requestUri":"/softwaresets/{id}", "responseCode":204 }, "input":{"shape":"UpdateSoftwareSetRequest"}, "output":{"shape":"UpdateSoftwareSetResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Updates a software set.
", "endpoint":{"hostPrefix":"api."}, "idempotent":true } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"} }, "documentation":"You do not have sufficient access to perform this action.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "ActivationCode":{ "type":"string", "pattern":"[a-z]{2}[a-z0-9]{6}", "sensitive":true }, "ApplyTimeOf":{ "type":"string", "enum":[ "UTC", "DEVICE" ] }, "Arn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[0-9]{0,12}:[a-zA-Z0-9\\-\\/\\._]+" }, "ClientToken":{ "type":"string", "max":512, "min":1 }, "ConflictException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"}, "resourceId":{ "shape":"ResourceId", "documentation":"The ID of the resource associated with the request.
" }, "resourceType":{ "shape":"ResourceType", "documentation":"The type of the resource associated with the request.
" } }, "documentation":"The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "CreateEnvironmentRequest":{ "type":"structure", "required":["desktopArn"], "members":{ "name":{ "shape":"EnvironmentName", "documentation":"The name for the environment.
" }, "desktopArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.
" }, "desktopEndpoint":{ "shape":"DesktopEndpoint", "documentation":"The URL for the identity provider login (only for environments that use AppStream 2.0).
" }, "softwareSetUpdateSchedule":{ "shape":"SoftwareSetUpdateSchedule", "documentation":"An option to define if software updates should be applied within a maintenance window.
" }, "maintenanceWindow":{ "shape":"MaintenanceWindow", "documentation":"A specification for a time window to apply software updates.
" }, "softwareSetUpdateMode":{ "shape":"SoftwareSetUpdateMode", "documentation":"An option to define which software updates to apply.
" }, "desiredSoftwareSetId":{ "shape":"SoftwareSetId", "documentation":"The ID of the software set to apply.
" }, "kmsKeyArn":{ "shape":"KmsKeyArn", "documentation":"The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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 UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
A map of the key-value pairs of the tag or tags to assign to the resource.
" }, "deviceCreationTags":{ "shape":"DeviceCreationTagsMap", "documentation":"A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
" } } }, "CreateEnvironmentResponse":{ "type":"structure", "members":{ "environment":{ "shape":"EnvironmentSummary", "documentation":"Describes an environment.
" } } }, "DayOfWeek":{ "type":"string", "enum":[ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "DayOfWeekList":{ "type":"list", "member":{"shape":"DayOfWeek"}, "max":7, "min":1 }, "DeleteDeviceRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"DeviceId", "documentation":"The ID of the device to delete.
", "location":"uri", "locationName":"id" }, "clientToken":{ "shape":"ClientToken", "documentation":"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 UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
The ID of the environment to delete.
", "location":"uri", "locationName":"id" }, "clientToken":{ "shape":"ClientToken", "documentation":"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 UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
The ID of the device to deregister.
", "location":"uri", "locationName":"id" }, "targetDeviceStatus":{ "shape":"TargetDeviceStatus", "documentation":"The desired new status for the device.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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 UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
The ID of the device.
" }, "serialNumber":{ "shape":"String", "documentation":"The hardware serial number of the device.
" }, "name":{ "shape":"DeviceName", "documentation":"The name of the device.
" }, "model":{ "shape":"String", "documentation":"The model number of the device.
" }, "environmentId":{ "shape":"EnvironmentId", "documentation":"The ID of the environment the device is associated with.
" }, "status":{ "shape":"DeviceStatus", "documentation":"The status of the device.
" }, "currentSoftwareSetId":{ "shape":"SoftwareSetId", "documentation":"The ID of the software set currently installed on the device.
" }, "currentSoftwareSetVersion":{ "shape":"String", "documentation":"The version of the software set currently installed on the device.
" }, "desiredSoftwareSetId":{ "shape":"SoftwareSetId", "documentation":"The ID of the software set which the device has been set to.
" }, "pendingSoftwareSetId":{ "shape":"SoftwareSetId", "documentation":"The ID of the software set that is pending to be installed on the device.
" }, "pendingSoftwareSetVersion":{ "shape":"String", "documentation":"The version of the software set that is pending to be installed on the device.
" }, "softwareSetUpdateSchedule":{ "shape":"SoftwareSetUpdateSchedule", "documentation":"An option to define if software updates should be applied within a maintenance window.
" }, "softwareSetComplianceStatus":{ "shape":"DeviceSoftwareSetComplianceStatus", "documentation":"Describes if the software currently installed on the device is a supported version.
" }, "softwareSetUpdateStatus":{ "shape":"SoftwareSetUpdateStatus", "documentation":"Describes if the device has a supported version of software installed.
" }, "lastConnectedAt":{ "shape":"Timestamp", "documentation":"The timestamp of the most recent session on the device.
" }, "lastPostureAt":{ "shape":"Timestamp", "documentation":"The timestamp of the most recent check-in of the device.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the device was created.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the device was updated.
" }, "arn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the device.
" }, "kmsKeyArn":{ "shape":"KmsKeyArn", "documentation":"The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the device.
" }, "lastUserId":{ "shape":"UserId", "documentation":"The user ID of the most recent session on the device.
" } }, "documentation":"Describes a thin client device.
" }, "DeviceCreationTagKey":{ "type":"string", "max":128, "min":1, "pattern":"(?!aws:)[A-Za-z0-9 _=@:.+-/]+" }, "DeviceCreationTagValue":{ "type":"string", "max":256, "min":0, "pattern":"[A-Za-z0-9 _=@:.+-/]+" }, "DeviceCreationTagsMap":{ "type":"map", "key":{"shape":"DeviceCreationTagKey"}, "value":{"shape":"DeviceCreationTagValue"}, "max":50, "min":0, "sensitive":true }, "DeviceId":{ "type":"string", "pattern":"[a-zA-Z0-9]{24}" }, "DeviceList":{ "type":"list", "member":{"shape":"DeviceSummary"} }, "DeviceName":{ "type":"string", "max":64, "min":0, "pattern":"$|^[0-9\\p{IsAlphabetic}+:,.@'\" -]*", "sensitive":true }, "DeviceSoftwareSetComplianceStatus":{ "type":"string", "enum":[ "NONE", "COMPLIANT", "NOT_COMPLIANT" ] }, "DeviceStatus":{ "type":"string", "enum":[ "REGISTERED", "DEREGISTERING", "DEREGISTERED", "ARCHIVED" ] }, "DeviceSummary":{ "type":"structure", "members":{ "id":{ "shape":"DeviceId", "documentation":"The ID of the device.
" }, "serialNumber":{ "shape":"String", "documentation":"The hardware serial number of the device.
" }, "name":{ "shape":"DeviceName", "documentation":"The name of the device.
" }, "model":{ "shape":"String", "documentation":"The model number of the device.
" }, "environmentId":{ "shape":"EnvironmentId", "documentation":"The ID of the environment the device is associated with.
" }, "status":{ "shape":"DeviceStatus", "documentation":"The status of the device.
" }, "currentSoftwareSetId":{ "shape":"SoftwareSetId", "documentation":"The ID of the software set currently installed on the device.
" }, "desiredSoftwareSetId":{ "shape":"SoftwareSetId", "documentation":"The ID of the software set which the device has been set to.
" }, "pendingSoftwareSetId":{ "shape":"SoftwareSetId", "documentation":"The ID of the software set that is pending to be installed on the device.
" }, "softwareSetUpdateSchedule":{ "shape":"SoftwareSetUpdateSchedule", "documentation":"An option to define if software updates should be applied within a maintenance window.
" }, "lastConnectedAt":{ "shape":"Timestamp", "documentation":"The timestamp of the most recent session on the device.
" }, "lastPostureAt":{ "shape":"Timestamp", "documentation":"The timestamp of the most recent check-in of the device.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the device was created.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the device was updated.
" }, "arn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the device.
" }, "lastUserId":{ "shape":"UserId", "documentation":"The user ID of the most recent session on the device.
" } }, "documentation":"Describes a thin client device.
" }, "Environment":{ "type":"structure", "members":{ "id":{ "shape":"EnvironmentId", "documentation":"The ID of the environment.
" }, "name":{ "shape":"EnvironmentName", "documentation":"The name of the environment.
" }, "desktopArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.
" }, "desktopEndpoint":{ "shape":"DesktopEndpoint", "documentation":"The URL for the identity provider login (only for environments that use AppStream 2.0).
" }, "desktopType":{ "shape":"DesktopType", "documentation":"The type of streaming desktop for the environment.
" }, "activationCode":{ "shape":"ActivationCode", "documentation":"The activation code to register a device to the environment.
" }, "registeredDevicesCount":{ "shape":"Integer", "documentation":"The number of devices registered to the environment.
" }, "softwareSetUpdateSchedule":{ "shape":"SoftwareSetUpdateSchedule", "documentation":"An option to define if software updates should be applied within a maintenance window.
" }, "maintenanceWindow":{ "shape":"MaintenanceWindow", "documentation":"A specification for a time window to apply software updates.
" }, "softwareSetUpdateMode":{ "shape":"SoftwareSetUpdateMode", "documentation":"An option to define which software updates to apply.
" }, "desiredSoftwareSetId":{ "shape":"SoftwareSetId", "documentation":"The ID of the software set to apply.
" }, "pendingSoftwareSetId":{ "shape":"SoftwareSetId", "documentation":"The ID of the software set that is pending to be installed.
" }, "pendingSoftwareSetVersion":{ "shape":"String", "documentation":"The version of the software set that is pending to be installed.
" }, "softwareSetComplianceStatus":{ "shape":"EnvironmentSoftwareSetComplianceStatus", "documentation":"Describes if the software currently installed on all devices in the environment is a supported version.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the environment was created.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the device was updated.
" }, "arn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the environment.
" }, "kmsKeyArn":{ "shape":"KmsKeyArn", "documentation":"The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the environment.
" }, "deviceCreationTags":{ "shape":"DeviceCreationTagsMap", "documentation":"The tag keys and optional values for the newly created devices for this environment.
" } }, "documentation":"Describes an environment.
" }, "EnvironmentId":{ "type":"string", "pattern":"[a-z0-9]{9}" }, "EnvironmentList":{ "type":"list", "member":{"shape":"EnvironmentSummary"} }, "EnvironmentName":{ "type":"string", "max":64, "min":0, "pattern":"$|^[0-9\\p{IsAlphabetic}+:,.@'\" -][0-9\\p{IsAlphabetic}+=:,.@'\" -]*", "sensitive":true }, "EnvironmentSoftwareSetComplianceStatus":{ "type":"string", "enum":[ "NO_REGISTERED_DEVICES", "COMPLIANT", "NOT_COMPLIANT" ] }, "EnvironmentSummary":{ "type":"structure", "members":{ "id":{ "shape":"EnvironmentId", "documentation":"The ID of the environment.
" }, "name":{ "shape":"EnvironmentName", "documentation":"The name of the environment.
" }, "desktopArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.
" }, "desktopEndpoint":{ "shape":"DesktopEndpoint", "documentation":"The URL for the identity provider login (only for environments that use AppStream 2.0).
" }, "desktopType":{ "shape":"DesktopType", "documentation":"The type of streaming desktop for the environment.
" }, "activationCode":{ "shape":"ActivationCode", "documentation":"The activation code to register a device to the environment.
" }, "softwareSetUpdateSchedule":{ "shape":"SoftwareSetUpdateSchedule", "documentation":"An option to define if software updates should be applied within a maintenance window.
" }, "maintenanceWindow":{ "shape":"MaintenanceWindow", "documentation":"A specification for a time window to apply software updates.
" }, "softwareSetUpdateMode":{ "shape":"SoftwareSetUpdateMode", "documentation":"An option to define which software updates to apply.
" }, "desiredSoftwareSetId":{ "shape":"SoftwareSetId", "documentation":"The ID of the software set to apply.
" }, "pendingSoftwareSetId":{ "shape":"SoftwareSetId", "documentation":"The ID of the software set that is pending to be installed.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the environment was created.
" }, "updatedAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the device was updated.
" }, "arn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the environment.
" } }, "documentation":"Describes an environment.
" }, "ExceptionMessage":{"type":"string"}, "FieldName":{"type":"string"}, "GetDeviceRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"DeviceId", "documentation":"The ID of the device for which to return information.
", "location":"uri", "locationName":"id" } } }, "GetDeviceResponse":{ "type":"structure", "members":{ "device":{ "shape":"Device", "documentation":"Describes an device.
" } } }, "GetEnvironmentRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"EnvironmentId", "documentation":"The ID of the environment for which to return information.
", "location":"uri", "locationName":"id" } } }, "GetEnvironmentResponse":{ "type":"structure", "members":{ "environment":{ "shape":"Environment", "documentation":"Describes an environment.
" } } }, "GetSoftwareSetRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"SoftwareSetId", "documentation":"The ID of the software set for which to return information.
", "location":"uri", "locationName":"id" } } }, "GetSoftwareSetResponse":{ "type":"structure", "members":{ "softwareSet":{ "shape":"SoftwareSet", "documentation":"Describes a software set.
" } } }, "Hour":{ "type":"integer", "box":true, "max":23, "min":0 }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"}, "retryAfterSeconds":{ "shape":"RetryAfterSeconds", "documentation":"The number of seconds to wait before retrying the next request.
", "location":"header", "locationName":"Retry-After" } }, "documentation":"The server encountered an internal error and is unable to complete the request.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "KmsKeyArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:[\\w+=\\/,.@-]+:kms:[a-zA-Z0-9\\-]*:[0-9]{0,12}:key\\/[a-zA-Z0-9-]+" }, "ListDevicesRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
", "location":"querystring", "locationName":"maxResults" } } }, "ListDevicesResponse":{ "type":"structure", "members":{ "devices":{ "shape":"DeviceList", "documentation":"Describes devices.
" }, "nextToken":{ "shape":"PaginationToken", "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
", "location":"querystring", "locationName":"maxResults" } } }, "ListEnvironmentsResponse":{ "type":"structure", "members":{ "environments":{ "shape":"EnvironmentList", "documentation":"Describes environments.
" }, "nextToken":{ "shape":"PaginationToken", "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
", "location":"querystring", "locationName":"maxResults" } } }, "ListSoftwareSetsResponse":{ "type":"structure", "members":{ "softwareSets":{ "shape":"SoftwareSetList", "documentation":"Describes software sets.
" }, "nextToken":{ "shape":"PaginationToken", "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.
", "location":"uri", "locationName":"resourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"TagsMap", "documentation":"A map of the key-value pairs for the tag or tags assigned to the specified resource.
" } } }, "MaintenanceWindow":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"MaintenanceWindowType", "documentation":"An option to select the default or custom maintenance window.
" }, "startTimeHour":{ "shape":"Hour", "documentation":"The hour for the maintenance window start (00-23).
The minutes past the hour for the maintenance window start (00-59).
The hour for the maintenance window end (00-23).
The minutes for the maintenance window end (00-59).
The days of the week during which the maintenance window is open.
" }, "applyTimeOf":{ "shape":"ApplyTimeOf", "documentation":"The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).
" } }, "documentation":"Describes the maintenance window for a thin client device.
" }, "MaintenanceWindowType":{ "type":"string", "enum":[ "SYSTEM", "CUSTOM" ] }, "MaxResults":{ "type":"integer", "box":true, "max":50, "min":1 }, "Minute":{ "type":"integer", "box":true, "max":59, "min":0 }, "PaginationToken":{ "type":"string", "max":2048, "min":0, "pattern":"\\S*" }, "QuotaCode":{"type":"string"}, "ResourceId":{"type":"string"}, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"}, "resourceId":{ "shape":"ResourceId", "documentation":"The ID of the resource associated with the request.
" }, "resourceType":{ "shape":"ResourceType", "documentation":"The type of the resource associated with the request.
" } }, "documentation":"The resource specified in the request was not found.
", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ResourceType":{"type":"string"}, "RetryAfterSeconds":{ "type":"integer", "box":true }, "ServiceCode":{"type":"string"}, "ServiceQuotaExceededException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"}, "resourceId":{ "shape":"ResourceId", "documentation":"The ID of the resource that exceeds the service quota.
" }, "resourceType":{ "shape":"ResourceType", "documentation":"The type of the resource that exceeds the service quota.
" }, "serviceCode":{ "shape":"ServiceCode", "documentation":"The code for the service in Service Quotas.
" }, "quotaCode":{ "shape":"QuotaCode", "documentation":"The code for the quota in Service Quotas.
" } }, "documentation":"Your request exceeds a service quota.
", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "Software":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"The name of the software component.
" }, "version":{ "shape":"String", "documentation":"The version of the software component.
" } }, "documentation":"Describes software.
" }, "SoftwareList":{ "type":"list", "member":{"shape":"Software"} }, "SoftwareSet":{ "type":"structure", "members":{ "id":{ "shape":"SoftwareSetId", "documentation":"The ID of the software set.
" }, "version":{ "shape":"String", "documentation":"The version of the software set.
" }, "releasedAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the software set was released.
" }, "supportedUntil":{ "shape":"Timestamp", "documentation":"The timestamp of the end of support for the software set.
" }, "validationStatus":{ "shape":"SoftwareSetValidationStatus", "documentation":"An option to define if the software set has been validated.
" }, "software":{ "shape":"SoftwareList", "documentation":"A list of the software components in the software set.
" }, "arn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the software set.
" } }, "documentation":"Describes a software set.
" }, "SoftwareSetId":{ "type":"string", "pattern":"[0-9]{1,9}" }, "SoftwareSetIdOrEmptyString":{ "type":"string", "pattern":"[0-9]{0,9}" }, "SoftwareSetList":{ "type":"list", "member":{"shape":"SoftwareSetSummary"} }, "SoftwareSetSummary":{ "type":"structure", "members":{ "id":{ "shape":"SoftwareSetId", "documentation":"The ID of the software set.
" }, "version":{ "shape":"String", "documentation":"The version of the software set.
" }, "releasedAt":{ "shape":"Timestamp", "documentation":"The timestamp of when the software set was released.
" }, "supportedUntil":{ "shape":"Timestamp", "documentation":"The timestamp of the end of support for the software set.
" }, "validationStatus":{ "shape":"SoftwareSetValidationStatus", "documentation":"An option to define if the software set has been validated.
" }, "arn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the software set.
" } }, "documentation":"Describes a software set.
" }, "SoftwareSetUpdateMode":{ "type":"string", "enum":[ "USE_LATEST", "USE_DESIRED" ] }, "SoftwareSetUpdateSchedule":{ "type":"string", "enum":[ "USE_MAINTENANCE_WINDOW", "APPLY_IMMEDIATELY" ] }, "SoftwareSetUpdateStatus":{ "type":"string", "enum":[ "AVAILABLE", "IN_PROGRESS", "UP_TO_DATE" ] }, "SoftwareSetValidationStatus":{ "type":"string", "enum":[ "VALIDATED", "NOT_VALIDATED" ] }, "String":{"type":"string"}, "TagKeys":{ "type":"list", "member":{"shape":"String"}, "sensitive":true }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of the resource that you want to tag.
", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagsMap", "documentation":"A map of the key-value pairs of the tag or tags to assign to the resource.
" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagsMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"}, "sensitive":true }, "TargetDeviceStatus":{ "type":"string", "enum":[ "DEREGISTERED", "ARCHIVED" ] }, "ThrottlingException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"}, "serviceCode":{ "shape":"ServiceCode", "documentation":"The code for the service in Service Quotas.
" }, "quotaCode":{ "shape":"QuotaCode", "documentation":"The code for the quota in Service Quotas.
" }, "retryAfterSeconds":{ "shape":"RetryAfterSeconds", "documentation":"The number of seconds to wait before retrying the next request.
", "location":"header", "locationName":"Retry-After" } }, "documentation":"The request was denied due to request throttling.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true }, "Timestamp":{"type":"timestamp"}, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of the resource that you want to untag.
", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeys", "documentation":"The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.
", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateDeviceRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"DeviceId", "documentation":"The ID of the device to update.
", "location":"uri", "locationName":"id" }, "name":{ "shape":"DeviceName", "documentation":"The name of the device to update.
" }, "desiredSoftwareSetId":{ "shape":"SoftwareSetId", "documentation":"The ID of the software set to apply.
" }, "softwareSetUpdateSchedule":{ "shape":"SoftwareSetUpdateSchedule", "documentation":"An option to define if software updates should be applied within a maintenance window.
" } } }, "UpdateDeviceResponse":{ "type":"structure", "members":{ "device":{ "shape":"DeviceSummary", "documentation":"Describes a device.
" } } }, "UpdateEnvironmentRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"EnvironmentId", "documentation":"The ID of the environment to update.
", "location":"uri", "locationName":"id" }, "name":{ "shape":"EnvironmentName", "documentation":"The name of the environment to update.
" }, "desktopArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.
" }, "desktopEndpoint":{ "shape":"DesktopEndpoint", "documentation":"The URL for the identity provider login (only for environments that use AppStream 2.0).
" }, "softwareSetUpdateSchedule":{ "shape":"SoftwareSetUpdateSchedule", "documentation":"An option to define if software updates should be applied within a maintenance window.
" }, "maintenanceWindow":{ "shape":"MaintenanceWindow", "documentation":"A specification for a time window to apply software updates.
" }, "softwareSetUpdateMode":{ "shape":"SoftwareSetUpdateMode", "documentation":"An option to define which software updates to apply.
" }, "desiredSoftwareSetId":{ "shape":"SoftwareSetIdOrEmptyString", "documentation":"The ID of the software set to apply.
" }, "deviceCreationTags":{ "shape":"DeviceCreationTagsMap", "documentation":"A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
" } } }, "UpdateEnvironmentResponse":{ "type":"structure", "members":{ "environment":{ "shape":"EnvironmentSummary", "documentation":"Describes an environment.
" } } }, "UpdateSoftwareSetRequest":{ "type":"structure", "required":[ "id", "validationStatus" ], "members":{ "id":{ "shape":"SoftwareSetId", "documentation":"The ID of the software set to update.
", "location":"uri", "locationName":"id" }, "validationStatus":{ "shape":"SoftwareSetValidationStatus", "documentation":"An option to define if the software set has been validated.
" } } }, "UpdateSoftwareSetResponse":{ "type":"structure", "members":{ } }, "UserId":{ "type":"string", "sensitive":true }, "ValidationException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"}, "reason":{ "shape":"ValidationExceptionReason", "documentation":"The reason for the exception.
" }, "fieldList":{ "shape":"ValidationExceptionFieldList", "documentation":"A list of fields that didn't validate.
" } }, "documentation":"The input fails to satisfy the specified constraints.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "name", "message" ], "members":{ "name":{ "shape":"FieldName", "documentation":"The name of the exception.
" }, "message":{ "shape":"ExceptionMessage", "documentation":"A message that describes the reason for the exception.
" } }, "documentation":"Describes a validation exception.
" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "ValidationExceptionReason":{ "type":"string", "enum":[ "unknownOperation", "cannotParse", "fieldValidationFailed", "other" ] } }, "documentation":"Amazon WorkSpaces Thin Client is an affordable device built to work with Amazon Web Services End User Computing (EUC) virtual desktops to provide users with a complete cloud desktop solution. WorkSpaces Thin Client is a compact device designed to connect up to two monitors and USB devices like a keyboard, mouse, headset, and webcam. To maximize endpoint security, WorkSpaces Thin Client devices do not allow local data storage or installation of unapproved applications. The WorkSpaces Thin Client device ships preloaded with device management software.
You can use these APIs to complete WorkSpaces Thin Client tasks, such as creating environments or viewing devices. For more information about WorkSpaces Thin Client, including the required permissions to use the service, see the Amazon WorkSpaces Thin Client Administrator Guide. For more information about using the Command Line Interface (CLI) to manage your WorkSpaces Thin Client resources, see the WorkSpaces Thin Client section of the CLI Reference.
" }