String name
The name for the environment.
String desktopArn
The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
String desktopEndpoint
The URL for the identity provider login (only for environments that use AppStream 2.0).
String softwareSetUpdateSchedule
An option to define if software updates should be applied within a maintenance window.
MaintenanceWindow maintenanceWindow
A specification for a time window to apply software updates.
String softwareSetUpdateMode
An option to define which software updates to apply.
String desiredSoftwareSetId
The ID of the software set to apply.
String kmsKeyArn
The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.
String clientToken
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.
Map<K,V> tags
A map of the key-value pairs of the tag or tags to assign to the resource.
Map<K,V> deviceCreationTags
A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
EnvironmentSummary environment
Describes an environment.
String id
The ID of the device to delete.
String clientToken
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.
String id
The ID of the environment to delete.
String clientToken
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.
String id
The ID of the device to deregister.
String targetDeviceStatus
The desired new status for the device.
String clientToken
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.
String id
The ID of the device.
String serialNumber
The hardware serial number of the device.
String name
The name of the device.
String model
The model number of the device.
String environmentId
The ID of the environment the device is associated with.
String status
The status of the device.
String currentSoftwareSetId
The ID of the software set currently installed on the device.
String currentSoftwareSetVersion
The version of the software set currently installed on the device.
String desiredSoftwareSetId
The ID of the software set which the device has been set to.
String pendingSoftwareSetId
The ID of the software set that is pending to be installed on the device.
String pendingSoftwareSetVersion
The version of the software set that is pending to be installed on the device.
String softwareSetUpdateSchedule
An option to define if software updates should be applied within a maintenance window.
String softwareSetComplianceStatus
Describes if the software currently installed on the device is a supported version.
String softwareSetUpdateStatus
Describes if the device has a supported version of software installed.
Date lastConnectedAt
The timestamp of the most recent session on the device.
Date lastPostureAt
The timestamp of the most recent check-in of the device.
Date createdAt
The timestamp of when the device was created.
Date updatedAt
The timestamp of when the device was updated.
String arn
The Amazon Resource Name (ARN) of the device.
String kmsKeyArn
The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the device.
Map<K,V> tags
The tag keys and optional values for the resource.
String id
The ID of the device.
String serialNumber
The hardware serial number of the device.
String name
The name of the device.
String model
The model number of the device.
String environmentId
The ID of the environment the device is associated with.
String status
The status of the device.
String currentSoftwareSetId
The ID of the software set currently installed on the device.
String desiredSoftwareSetId
The ID of the software set which the device has been set to.
String pendingSoftwareSetId
The ID of the software set that is pending to be installed on the device.
String softwareSetUpdateSchedule
An option to define if software updates should be applied within a maintenance window.
Date lastConnectedAt
The timestamp of the most recent session on the device.
Date lastPostureAt
The timestamp of the most recent check-in of the device.
Date createdAt
The timestamp of when the device was created.
Date updatedAt
The timestamp of when the device was updated.
String arn
The Amazon Resource Name (ARN) of the device.
String id
The ID of the environment.
String name
The name of the environment.
String desktopArn
The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
String desktopEndpoint
The URL for the identity provider login (only for environments that use AppStream 2.0).
String desktopType
The type of streaming desktop for the environment.
String activationCode
The activation code to register a device to the environment.
Integer registeredDevicesCount
The number of devices registered to the environment.
String softwareSetUpdateSchedule
An option to define if software updates should be applied within a maintenance window.
MaintenanceWindow maintenanceWindow
A specification for a time window to apply software updates.
String softwareSetUpdateMode
An option to define which software updates to apply.
String desiredSoftwareSetId
The ID of the software set to apply.
String pendingSoftwareSetId
The ID of the software set that is pending to be installed.
String pendingSoftwareSetVersion
The version of the software set that is pending to be installed.
String softwareSetComplianceStatus
Describes if the software currently installed on all devices in the environment is a supported version.
Date createdAt
The timestamp of when the environment was created.
Date updatedAt
The timestamp of when the device was updated.
String arn
The Amazon Resource Name (ARN) of the environment.
String kmsKeyArn
The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the environment.
Map<K,V> tags
The tag keys and optional values for the resource.
Map<K,V> deviceCreationTags
The tag keys and optional values for the newly created devices for this environment.
String id
The ID of the environment.
String name
The name of the environment.
String desktopArn
The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
String desktopEndpoint
The URL for the identity provider login (only for environments that use AppStream 2.0).
String desktopType
The type of streaming desktop for the environment.
String activationCode
The activation code to register a device to the environment.
String softwareSetUpdateSchedule
An option to define if software updates should be applied within a maintenance window.
MaintenanceWindow maintenanceWindow
A specification for a time window to apply software updates.
String softwareSetUpdateMode
An option to define which software updates to apply.
String desiredSoftwareSetId
The ID of the software set to apply.
String pendingSoftwareSetId
The ID of the software set that is pending to be installed.
Date createdAt
The timestamp of when the environment was created.
Date updatedAt
The timestamp of when the device was updated.
String arn
The Amazon Resource Name (ARN) of the environment.
String id
The ID of the device for which to return information.
Device device
Describes an device.
String id
The ID of the environment for which to return information.
Environment environment
Describes an environment.
String id
The ID of the software set for which to return information.
SoftwareSet softwareSet
Describes a software set.
Integer retryAfterSeconds
The number of seconds to wait before retrying the next request.
String nextToken
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.
Integer maxResults
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.
List<E> devices
Describes devices.
String nextToken
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.
String nextToken
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.
Integer maxResults
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.
List<E> environments
Describes environments.
String nextToken
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.
String nextToken
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.
Integer maxResults
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.
List<E> softwareSets
Describes software sets.
String nextToken
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.
String resourceArn
The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.
String type
An option to select the default or custom maintenance window.
Integer startTimeHour
The hour for the maintenance window start (00-23).
Integer startTimeMinute
The minutes past the hour for the maintenance window start (00-59).
Integer endTimeHour
The hour for the maintenance window end (00-23).
Integer endTimeMinute
The minutes for the maintenance window end (00-59).
List<E> daysOfTheWeek
The days of the week during which the maintenance window is open.
String applyTimeOf
The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).
String resourceId
The ID of the resource that exceeds the service quota.
String resourceType
The type of the resource that exceeds the service quota.
String serviceCode
The code for the service in Service Quotas.
String quotaCode
The code for the quota in Service Quotas.
String id
The ID of the software set.
String version
The version of the software set.
Date releasedAt
The timestamp of when the software set was released.
Date supportedUntil
The timestamp of the end of support for the software set.
String validationStatus
An option to define if the software set has been validated.
List<E> software
A list of the software components in the software set.
String arn
The Amazon Resource Name (ARN) of the software set.
Map<K,V> tags
The tag keys and optional values for the resource.
String id
The ID of the software set.
String version
The version of the software set.
Date releasedAt
The timestamp of when the software set was released.
Date supportedUntil
The timestamp of the end of support for the software set.
String validationStatus
An option to define if the software set has been validated.
String arn
The Amazon Resource Name (ARN) of the software set.
String serviceCode
The code for the service in Service Quotas.
String quotaCode
The code for the quota in Service Quotas.
Integer retryAfterSeconds
The number of seconds to wait before retrying the next request.
String id
The ID of the device to update.
String name
The name of the device to update.
String desiredSoftwareSetId
The ID of the software set to apply.
String softwareSetUpdateSchedule
An option to define if software updates should be applied within a maintenance window.
DeviceSummary device
Describes a device.
String id
The ID of the environment to update.
String name
The name of the environment to update.
String desktopArn
The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
String desktopEndpoint
The URL for the identity provider login (only for environments that use AppStream 2.0).
String softwareSetUpdateSchedule
An option to define if software updates should be applied within a maintenance window.
MaintenanceWindow maintenanceWindow
A specification for a time window to apply software updates.
String softwareSetUpdateMode
An option to define which software updates to apply.
String desiredSoftwareSetId
The ID of the software set to apply.
Map<K,V> deviceCreationTags
A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
EnvironmentSummary environment
Describes an environment.
Copyright © 2024. All rights reserved.