AWS SDK for PHP 3.x

Client: Aws\WorkSpacesThinClient\WorkSpacesThinClientClient

Service ID: workspaces-thin-client

Version: 2023-08-22

This page describes the parameters and results for the operations of the Amazon WorkSpaces Thin Client (2023-08-22), and shows how to use the Aws\WorkSpacesThinClient\WorkSpacesThinClientClient object to call the described operations. This documentation is specific to the 2023-08-22 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateEnvironment ( array $params = [] ): Creates an environment for your thin client devices.
DeleteDevice ( array $params = [] ): Deletes a thin client device.
DeleteEnvironment ( array $params = [] ): Deletes an environment.
DeregisterDevice ( array $params = [] ): Deregisters a thin client device.
GetDevice ( array $params = [] ): Returns information for a thin client device.
GetEnvironment ( array $params = [] ): Returns information for an environment.
GetSoftwareSet ( array $params = [] ): Returns information for a software set.
ListDevices ( array $params = [] ): Returns a list of thin client devices.
ListEnvironments ( array $params = [] ): Returns a list of environments.
ListSoftwareSets ( array $params = [] ): Returns a list of software sets.
ListTagsForResource ( array $params = [] ): Returns a list of tags for a resource.
TagResource ( array $params = [] ): Assigns one or more tags (key-value pairs) to the specified resource.
UntagResource ( array $params = [] ): Removes a tag or tags from a resource.
UpdateDevice ( array $params = [] ): Updates a thin client device.
UpdateEnvironment ( array $params = [] ): Updates an environment.
UpdateSoftwareSet ( array $params = [] ): Updates a software set.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListDevices
ListEnvironments
ListSoftwareSets

Operations

CreateEnvironment

$result = $client->createEnvironment([/* ... */]);
$promise = $client->createEnvironmentAsync([/* ... */]);

Creates an environment for your thin client devices.

Parameter Syntax

$result = $client->createEnvironment([
    'clientToken' => '<string>',
    'desiredSoftwareSetId' => '<string>',
    'desktopArn' => '<string>', // REQUIRED
    'desktopEndpoint' => '<string>',
    'deviceCreationTags' => ['<string>', ...],
    'kmsKeyArn' => '<string>',
    'maintenanceWindow' => [
        'applyTimeOf' => 'UTC|DEVICE',
        'daysOfTheWeek' => ['<string>', ...],
        'endTimeHour' => <integer>,
        'endTimeMinute' => <integer>,
        'startTimeHour' => <integer>,
        'startTimeMinute' => <integer>,
        'type' => 'SYSTEM|CUSTOM',
    ],
    'name' => '<string>',
    'softwareSetUpdateMode' => 'USE_LATEST|USE_DESIRED',
    'softwareSetUpdateSchedule' => 'USE_MAINTENANCE_WINDOW|APPLY_IMMEDIATELY',
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

clientToken

: Type: string

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.

desiredSoftwareSetId

: Type: string

The ID of the software set to apply.

desktopArn

: Required: Yes
: Type: string

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

desktopEndpoint

: Type: string

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

deviceCreationTags

: Type: Associative array of custom strings keys (DeviceCreationTagKey) to strings

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

kmsKeyArn

: Type: string

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

maintenanceWindow

: Type: MaintenanceWindow structure

A specification for a time window to apply software updates.

name

: Type: string

The name for the environment.

softwareSetUpdateMode

: Type: string

An option to define which software updates to apply.

softwareSetUpdateSchedule

: Type: string

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

tags

: Type: Associative array of custom strings keys (String) to strings

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

Result Syntax

[
    'environment' => [
        'activationCode' => '<string>',
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'desiredSoftwareSetId' => '<string>',
        'desktopArn' => '<string>',
        'desktopEndpoint' => '<string>',
        'desktopType' => 'workspaces|appstream|workspaces-web',
        'id' => '<string>',
        'maintenanceWindow' => [
            'applyTimeOf' => 'UTC|DEVICE',
            'daysOfTheWeek' => ['<string>', ...],
            'endTimeHour' => <integer>,
            'endTimeMinute' => <integer>,
            'startTimeHour' => <integer>,
            'startTimeMinute' => <integer>,
            'type' => 'SYSTEM|CUSTOM',
        ],
        'name' => '<string>',
        'pendingSoftwareSetId' => '<string>',
        'softwareSetUpdateMode' => 'USE_LATEST|USE_DESIRED',
        'softwareSetUpdateSchedule' => 'USE_MAINTENANCE_WINDOW|APPLY_IMMEDIATELY',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members

environment

: Type: EnvironmentSummary structure

Describes an environment.

Errors

ServiceQuotaExceededException:: Your request exceeds a service quota.
ValidationException:: The input fails to satisfy the specified constraints.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource specified in the request was not found.
ThrottlingException:: The request was denied due to request throttling.
ConflictException:: 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.
InternalServerException:: The server encountered an internal error and is unable to complete the request.

DeleteDevice

$result = $client->deleteDevice([/* ... */]);
$promise = $client->deleteDeviceAsync([/* ... */]);

Deletes a thin client device.

Parameter Syntax

$result = $client->deleteDevice([
    'clientToken' => '<string>',
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members

clientToken

: Type: string

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.

id

: Required: Yes
: Type: string

The ID of the device to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:: The input fails to satisfy the specified constraints.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource specified in the request was not found.
ThrottlingException:: The request was denied due to request throttling.
ConflictException:: 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.
InternalServerException:: The server encountered an internal error and is unable to complete the request.

DeleteEnvironment

$result = $client->deleteEnvironment([/* ... */]);
$promise = $client->deleteEnvironmentAsync([/* ... */]);

Deletes an environment.

Parameter Syntax

$result = $client->deleteEnvironment([
    'clientToken' => '<string>',
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members

clientToken

: Type: string

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.

id

: Required: Yes
: Type: string

The ID of the environment to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:: The input fails to satisfy the specified constraints.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource specified in the request was not found.
ThrottlingException:: The request was denied due to request throttling.
ConflictException:: 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.
InternalServerException:: The server encountered an internal error and is unable to complete the request.

DeregisterDevice

$result = $client->deregisterDevice([/* ... */]);
$promise = $client->deregisterDeviceAsync([/* ... */]);

Deregisters a thin client device.

Parameter Syntax

$result = $client->deregisterDevice([
    'clientToken' => '<string>',
    'id' => '<string>', // REQUIRED
    'targetDeviceStatus' => 'DEREGISTERED|ARCHIVED',
]);

Parameter Details

Members

clientToken

: Type: string

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.

id

: Required: Yes
: Type: string

The ID of the device to deregister.

targetDeviceStatus

: Type: string

The desired new status for the device.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:: The input fails to satisfy the specified constraints.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource specified in the request was not found.
ThrottlingException:: The request was denied due to request throttling.
ConflictException:: 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.
InternalServerException:: The server encountered an internal error and is unable to complete the request.

GetDevice

$result = $client->getDevice([/* ... */]);
$promise = $client->getDeviceAsync([/* ... */]);

Returns information for a thin client device.

Parameter Syntax

$result = $client->getDevice([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members

id

: Required: Yes
: Type: string

The ID of the device for which to return information.

Result Syntax

[
    'device' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'currentSoftwareSetId' => '<string>',
        'currentSoftwareSetVersion' => '<string>',
        'desiredSoftwareSetId' => '<string>',
        'environmentId' => '<string>',
        'id' => '<string>',
        'kmsKeyArn' => '<string>',
        'lastConnectedAt' => <DateTime>,
        'lastPostureAt' => <DateTime>,
        'model' => '<string>',
        'name' => '<string>',
        'pendingSoftwareSetId' => '<string>',
        'pendingSoftwareSetVersion' => '<string>',
        'serialNumber' => '<string>',
        'softwareSetComplianceStatus' => 'NONE|COMPLIANT|NOT_COMPLIANT',
        'softwareSetUpdateSchedule' => 'USE_MAINTENANCE_WINDOW|APPLY_IMMEDIATELY',
        'softwareSetUpdateStatus' => 'AVAILABLE|IN_PROGRESS|UP_TO_DATE',
        'status' => 'REGISTERED|DEREGISTERING|DEREGISTERED|ARCHIVED',
        'tags' => ['<string>', ...],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members

device

: Type: Device structure

Describes an device.

Errors

ValidationException:: The input fails to satisfy the specified constraints.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource specified in the request was not found.
ThrottlingException:: The request was denied due to request throttling.
InternalServerException:: The server encountered an internal error and is unable to complete the request.

GetEnvironment

$result = $client->getEnvironment([/* ... */]);
$promise = $client->getEnvironmentAsync([/* ... */]);

Returns information for an environment.

Parameter Syntax

$result = $client->getEnvironment([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members

id

: Required: Yes
: Type: string

The ID of the environment for which to return information.

Result Syntax

[
    'environment' => [
        'activationCode' => '<string>',
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'desiredSoftwareSetId' => '<string>',
        'desktopArn' => '<string>',
        'desktopEndpoint' => '<string>',
        'desktopType' => 'workspaces|appstream|workspaces-web',
        'deviceCreationTags' => ['<string>', ...],
        'id' => '<string>',
        'kmsKeyArn' => '<string>',
        'maintenanceWindow' => [
            'applyTimeOf' => 'UTC|DEVICE',
            'daysOfTheWeek' => ['<string>', ...],
            'endTimeHour' => <integer>,
            'endTimeMinute' => <integer>,
            'startTimeHour' => <integer>,
            'startTimeMinute' => <integer>,
            'type' => 'SYSTEM|CUSTOM',
        ],
        'name' => '<string>',
        'pendingSoftwareSetId' => '<string>',
        'pendingSoftwareSetVersion' => '<string>',
        'registeredDevicesCount' => <integer>,
        'softwareSetComplianceStatus' => 'NO_REGISTERED_DEVICES|COMPLIANT|NOT_COMPLIANT',
        'softwareSetUpdateMode' => 'USE_LATEST|USE_DESIRED',
        'softwareSetUpdateSchedule' => 'USE_MAINTENANCE_WINDOW|APPLY_IMMEDIATELY',
        'tags' => ['<string>', ...],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members

environment

: Type: Environment structure

Describes an environment.

Errors

ValidationException:: The input fails to satisfy the specified constraints.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource specified in the request was not found.
ThrottlingException:: The request was denied due to request throttling.
InternalServerException:: The server encountered an internal error and is unable to complete the request.

GetSoftwareSet

$result = $client->getSoftwareSet([/* ... */]);
$promise = $client->getSoftwareSetAsync([/* ... */]);

Returns information for a software set.

Parameter Syntax

$result = $client->getSoftwareSet([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members

id

: Required: Yes
: Type: string

The ID of the software set for which to return information.

Result Syntax

[
    'softwareSet' => [
        'arn' => '<string>',
        'id' => '<string>',
        'releasedAt' => <DateTime>,
        'software' => [
            [
                'name' => '<string>',
                'version' => '<string>',
            ],
            // ...
        ],
        'supportedUntil' => <DateTime>,
        'tags' => ['<string>', ...],
        'validationStatus' => 'VALIDATED|NOT_VALIDATED',
        'version' => '<string>',
    ],
]

Result Details

Members

softwareSet

: Type: SoftwareSet structure

Describes a software set.

Errors

ValidationException:: The input fails to satisfy the specified constraints.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource specified in the request was not found.
ThrottlingException:: The request was denied due to request throttling.
InternalServerException:: The server encountered an internal error and is unable to complete the request.

ListDevices

$result = $client->listDevices([/* ... */]);
$promise = $client->listDevicesAsync([/* ... */]);

Returns a list of thin client devices.

Parameter Syntax

$result = $client->listDevices([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

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.

nextToken

: Type: string

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.

Result Syntax

[
    'devices' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'currentSoftwareSetId' => '<string>',
            'desiredSoftwareSetId' => '<string>',
            'environmentId' => '<string>',
            'id' => '<string>',
            'lastConnectedAt' => <DateTime>,
            'lastPostureAt' => <DateTime>,
            'model' => '<string>',
            'name' => '<string>',
            'pendingSoftwareSetId' => '<string>',
            'serialNumber' => '<string>',
            'softwareSetUpdateSchedule' => 'USE_MAINTENANCE_WINDOW|APPLY_IMMEDIATELY',
            'status' => 'REGISTERED|DEREGISTERING|DEREGISTERED|ARCHIVED',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

devices

: Type: Array of DeviceSummary structures

Describes devices.

nextToken

: Type: string

Errors

ValidationException:: The input fails to satisfy the specified constraints.
AccessDeniedException:: You do not have sufficient access to perform this action.
ThrottlingException:: The request was denied due to request throttling.
InternalServerException:: The server encountered an internal error and is unable to complete the request.

ListEnvironments

$result = $client->listEnvironments([/* ... */]);
$promise = $client->listEnvironmentsAsync([/* ... */]);

Returns a list of environments.

Parameter Syntax

$result = $client->listEnvironments([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

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.

nextToken

: Type: string

Result Syntax

[
    'environments' => [
        [
            'activationCode' => '<string>',
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'desiredSoftwareSetId' => '<string>',
            'desktopArn' => '<string>',
            'desktopEndpoint' => '<string>',
            'desktopType' => 'workspaces|appstream|workspaces-web',
            'id' => '<string>',
            'maintenanceWindow' => [
                'applyTimeOf' => 'UTC|DEVICE',
                'daysOfTheWeek' => ['<string>', ...],
                'endTimeHour' => <integer>,
                'endTimeMinute' => <integer>,
                'startTimeHour' => <integer>,
                'startTimeMinute' => <integer>,
                'type' => 'SYSTEM|CUSTOM',
            ],
            'name' => '<string>',
            'pendingSoftwareSetId' => '<string>',
            'softwareSetUpdateMode' => 'USE_LATEST|USE_DESIRED',
            'softwareSetUpdateSchedule' => 'USE_MAINTENANCE_WINDOW|APPLY_IMMEDIATELY',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

environments

: Type: Array of EnvironmentSummary structures

Describes environments.

nextToken

: Type: string

Errors

ValidationException:: The input fails to satisfy the specified constraints.
AccessDeniedException:: You do not have sufficient access to perform this action.
ThrottlingException:: The request was denied due to request throttling.
InternalServerException:: The server encountered an internal error and is unable to complete the request.

ListSoftwareSets

$result = $client->listSoftwareSets([/* ... */]);
$promise = $client->listSoftwareSetsAsync([/* ... */]);

Returns a list of software sets.

Parameter Syntax

$result = $client->listSoftwareSets([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

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.

nextToken

: Type: string

Result Syntax

[
    'nextToken' => '<string>',
    'softwareSets' => [
        [
            'arn' => '<string>',
            'id' => '<string>',
            'releasedAt' => <DateTime>,
            'supportedUntil' => <DateTime>,
            'validationStatus' => 'VALIDATED|NOT_VALIDATED',
            'version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

softwareSets

: Type: Array of SoftwareSetSummary structures

Describes software sets.

Errors

ValidationException:: The input fails to satisfy the specified constraints.
AccessDeniedException:: You do not have sufficient access to perform this action.
ThrottlingException:: The request was denied due to request throttling.
InternalServerException:: The server encountered an internal error and is unable to complete the request.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns a list of tags for a resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members

tags

: Type: Associative array of custom strings keys (String) to strings

A map of the key-value pairs for the tag or tags assigned to the specified resource.

Errors

ValidationException:: The input fails to satisfy the specified constraints.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource specified in the request was not found.
ThrottlingException:: The request was denied due to request throttling.
InternalServerException:: The server encountered an internal error and is unable to complete the request.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Assigns one or more tags (key-value pairs) to the specified resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource that you want to tag.

tags

: Required: Yes
: Type: Associative array of custom strings keys (String) to strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:: The input fails to satisfy the specified constraints.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource specified in the request was not found.
ThrottlingException:: The request was denied due to request throttling.
ConflictException:: 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.
InternalServerException:: The server encountered an internal error and is unable to complete the request.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a tag or tags from a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource that you want to untag.

tagKeys

: Required: Yes
: Type: Array of strings

The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:: The input fails to satisfy the specified constraints.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource specified in the request was not found.
ThrottlingException:: The request was denied due to request throttling.
ConflictException:: 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.
InternalServerException:: The server encountered an internal error and is unable to complete the request.

UpdateDevice

$result = $client->updateDevice([/* ... */]);
$promise = $client->updateDeviceAsync([/* ... */]);

Updates a thin client device.

Parameter Syntax

$result = $client->updateDevice([
    'desiredSoftwareSetId' => '<string>',
    'id' => '<string>', // REQUIRED
    'name' => '<string>',
    'softwareSetUpdateSchedule' => 'USE_MAINTENANCE_WINDOW|APPLY_IMMEDIATELY',
]);

Parameter Details

Members

desiredSoftwareSetId

: Type: string

The ID of the software set to apply.

id

: Required: Yes
: Type: string

The ID of the device to update.

name

: Type: string

The name of the device to update.

softwareSetUpdateSchedule

: Type: string

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

Result Syntax

[
    'device' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'currentSoftwareSetId' => '<string>',
        'desiredSoftwareSetId' => '<string>',
        'environmentId' => '<string>',
        'id' => '<string>',
        'lastConnectedAt' => <DateTime>,
        'lastPostureAt' => <DateTime>,
        'model' => '<string>',
        'name' => '<string>',
        'pendingSoftwareSetId' => '<string>',
        'serialNumber' => '<string>',
        'softwareSetUpdateSchedule' => 'USE_MAINTENANCE_WINDOW|APPLY_IMMEDIATELY',
        'status' => 'REGISTERED|DEREGISTERING|DEREGISTERED|ARCHIVED',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members

device

: Type: DeviceSummary structure

Describes a device.

Errors

ValidationException:: The input fails to satisfy the specified constraints.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource specified in the request was not found.
ThrottlingException:: The request was denied due to request throttling.
InternalServerException:: The server encountered an internal error and is unable to complete the request.

UpdateEnvironment

$result = $client->updateEnvironment([/* ... */]);
$promise = $client->updateEnvironmentAsync([/* ... */]);

Updates an environment.

Parameter Syntax

$result = $client->updateEnvironment([
    'desiredSoftwareSetId' => '<string>',
    'desktopArn' => '<string>',
    'desktopEndpoint' => '<string>',
    'deviceCreationTags' => ['<string>', ...],
    'id' => '<string>', // REQUIRED
    'maintenanceWindow' => [
        'applyTimeOf' => 'UTC|DEVICE',
        'daysOfTheWeek' => ['<string>', ...],
        'endTimeHour' => <integer>,
        'endTimeMinute' => <integer>,
        'startTimeHour' => <integer>,
        'startTimeMinute' => <integer>,
        'type' => 'SYSTEM|CUSTOM',
    ],
    'name' => '<string>',
    'softwareSetUpdateMode' => 'USE_LATEST|USE_DESIRED',
    'softwareSetUpdateSchedule' => 'USE_MAINTENANCE_WINDOW|APPLY_IMMEDIATELY',
]);

Parameter Details

Members

desiredSoftwareSetId

: Type: string

The ID of the software set to apply.

desktopArn

: Type: string

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

desktopEndpoint

: Type: string

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

deviceCreationTags

: Type: Associative array of custom strings keys (DeviceCreationTagKey) to strings

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

id

: Required: Yes
: Type: string

The ID of the environment to update.

maintenanceWindow

: Type: MaintenanceWindow structure

A specification for a time window to apply software updates.

name

: Type: string

The name of the environment to update.

softwareSetUpdateMode

: Type: string

An option to define which software updates to apply.

softwareSetUpdateSchedule

: Type: string

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

Result Syntax

[
    'environment' => [
        'activationCode' => '<string>',
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'desiredSoftwareSetId' => '<string>',
        'desktopArn' => '<string>',
        'desktopEndpoint' => '<string>',
        'desktopType' => 'workspaces|appstream|workspaces-web',
        'id' => '<string>',
        'maintenanceWindow' => [
            'applyTimeOf' => 'UTC|DEVICE',
            'daysOfTheWeek' => ['<string>', ...],
            'endTimeHour' => <integer>,
            'endTimeMinute' => <integer>,
            'startTimeHour' => <integer>,
            'startTimeMinute' => <integer>,
            'type' => 'SYSTEM|CUSTOM',
        ],
        'name' => '<string>',
        'pendingSoftwareSetId' => '<string>',
        'softwareSetUpdateMode' => 'USE_LATEST|USE_DESIRED',
        'softwareSetUpdateSchedule' => 'USE_MAINTENANCE_WINDOW|APPLY_IMMEDIATELY',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members

environment

: Type: EnvironmentSummary structure

Describes an environment.

Errors

ValidationException:: The input fails to satisfy the specified constraints.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource specified in the request was not found.
ThrottlingException:: The request was denied due to request throttling.
InternalServerException:: The server encountered an internal error and is unable to complete the request.

UpdateSoftwareSet

$result = $client->updateSoftwareSet([/* ... */]);
$promise = $client->updateSoftwareSetAsync([/* ... */]);

Updates a software set.

Parameter Syntax

$result = $client->updateSoftwareSet([
    'id' => '<string>', // REQUIRED
    'validationStatus' => 'VALIDATED|NOT_VALIDATED', // REQUIRED
]);

Parameter Details

Members

id

: Required: Yes
: Type: string

The ID of the software set to update.

validationStatus

: Required: Yes
: Type: string

An option to define if the software set has been validated.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:: The input fails to satisfy the specified constraints.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The resource specified in the request was not found.
ThrottlingException:: The request was denied due to request throttling.
InternalServerException:: The server encountered an internal error and is unable to complete the request.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members

message

: Type: string

ConflictException

Description

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.

Members

message

: Type: string

resourceId

: Type: string

The ID of the resource associated with the request.

resourceType

: Type: string

The type of the resource associated with the request.

Device

Description

Describes a thin client device.

Members

arn

: Type: string

The Amazon Resource Name (ARN) of the device.

createdAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the device was created.

currentSoftwareSetId

: Type: string

The ID of the software set currently installed on the device.

currentSoftwareSetVersion

: Type: string

The version of the software set currently installed on the device.

desiredSoftwareSetId

: Type: string

The ID of the software set which the device has been set to.

environmentId

: Type: string

The ID of the environment the device is associated with.

id

: Type: string

The ID of the device.

kmsKeyArn

: Type: string

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

lastConnectedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the most recent session on the device.

lastPostureAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the most recent check-in of the device.

model

: Type: string

The model number of the device.

name

: Type: string

The name of the device.

pendingSoftwareSetId

: Type: string

The ID of the software set that is pending to be installed on the device.

pendingSoftwareSetVersion

: Type: string

The version of the software set that is pending to be installed on the device.

serialNumber

: Type: string

The hardware serial number of the device.

softwareSetComplianceStatus

: Type: string

Describes if the software currently installed on the device is a supported version.

softwareSetUpdateSchedule

: Type: string

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

softwareSetUpdateStatus

: Type: string

Describes if the device has a supported version of software installed.

status

: Type: string

The status of the device.

tags

: Type: Associative array of custom strings keys (String) to strings

The tag keys and optional values for the resource.

updatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the device was updated.

DeviceSummary

Description

Describes a thin client device.

Members

arn

: Type: string

The Amazon Resource Name (ARN) of the device.

createdAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the device was created.

currentSoftwareSetId

: Type: string

The ID of the software set currently installed on the device.

desiredSoftwareSetId

: Type: string

The ID of the software set which the device has been set to.

environmentId

: Type: string

The ID of the environment the device is associated with.

id

: Type: string

The ID of the device.

lastConnectedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the most recent session on the device.

lastPostureAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the most recent check-in of the device.

model

: Type: string

The model number of the device.

name

: Type: string

The name of the device.

pendingSoftwareSetId

: Type: string

The ID of the software set that is pending to be installed on the device.

serialNumber

: Type: string

The hardware serial number of the device.

softwareSetUpdateSchedule

: Type: string

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

status

: Type: string

The status of the device.

updatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the device was updated.

Environment

Description

Describes an environment.

Members

activationCode

: Type: string

The activation code to register a device to the environment.

arn

: Type: string

The Amazon Resource Name (ARN) of the environment.

createdAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the environment was created.

desiredSoftwareSetId

: Type: string

The ID of the software set to apply.

desktopArn

: Type: string

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

desktopEndpoint

: Type: string

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

desktopType

: Type: string

The type of streaming desktop for the environment.

deviceCreationTags

: Type: Associative array of custom strings keys (DeviceCreationTagKey) to strings

The tag keys and optional values for the newly created devices for this environment.

id

: Type: string

The ID of the environment.

kmsKeyArn

: Type: string

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

maintenanceWindow

: Type: MaintenanceWindow structure

A specification for a time window to apply software updates.

name

: Type: string

The name of the environment.

pendingSoftwareSetId

: Type: string

The ID of the software set that is pending to be installed.

pendingSoftwareSetVersion

: Type: string

The version of the software set that is pending to be installed.

registeredDevicesCount

: Type: int

The number of devices registered to the environment.

softwareSetComplianceStatus

: Type: string

Describes if the software currently installed on all devices in the environment is a supported version.

softwareSetUpdateMode

: Type: string

An option to define which software updates to apply.

softwareSetUpdateSchedule

: Type: string

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

tags

: Type: Associative array of custom strings keys (String) to strings

The tag keys and optional values for the resource.

updatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the device was updated.

EnvironmentSummary

Description

Describes an environment.

Members

activationCode

: Type: string

The activation code to register a device to the environment.

arn

: Type: string

The Amazon Resource Name (ARN) of the environment.

createdAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the environment was created.

desiredSoftwareSetId

: Type: string

The ID of the software set to apply.

desktopArn

: Type: string

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

desktopEndpoint

: Type: string

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

desktopType

: Type: string

The type of streaming desktop for the environment.

id

: Type: string

The ID of the environment.

maintenanceWindow

: Type: MaintenanceWindow structure

A specification for a time window to apply software updates.

name

: Type: string

The name of the environment.

pendingSoftwareSetId

: Type: string

The ID of the software set that is pending to be installed.

softwareSetUpdateMode

: Type: string

An option to define which software updates to apply.

softwareSetUpdateSchedule

: Type: string

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

updatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the device was updated.

InternalServerException

Description

The server encountered an internal error and is unable to complete the request.

Members

message

: Type: string

retryAfterSeconds

: Type: int

The number of seconds to wait before retrying the next request.

MaintenanceWindow

Description

Describes the maintenance window for a thin client device.

Members

applyTimeOf

: Type: string

The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).

daysOfTheWeek

: Type: Array of strings

The days of the week during which the maintenance window is open.

endTimeHour

: Type: int

The hour for the maintenance window end (00-23).

endTimeMinute

: Type: int

The minutes for the maintenance window end (00-59).

startTimeHour

: Type: int

The hour for the maintenance window start (00-23).

startTimeMinute

: Type: int

The minutes past the hour for the maintenance window start (00-59).

type

: Type: string

An option to select the default or custom maintenance window.

ResourceNotFoundException

Description

The resource specified in the request was not found.

Members

message

: Type: string

resourceId

: Type: string

The ID of the resource associated with the request.

resourceType

: Type: string

The type of the resource associated with the request.

ServiceQuotaExceededException

Description

Your request exceeds a service quota.

Members

message

: Type: string

quotaCode

: Type: string

The code for the quota in Service Quotas.

resourceId

: Type: string

The ID of the resource that exceeds the service quota.

resourceType

: Type: string

The type of the resource that exceeds the service quota.

serviceCode

: Type: string

The code for the service in Service Quotas.

Software

Description

Describes software.

Members

name

: Type: string

The name of the software component.

version

: Type: string

The version of the software component.

SoftwareSet

Description

Describes a software set.

Members

arn

: Type: string

The Amazon Resource Name (ARN) of the software set.

id

: Type: string

The ID of the software set.

releasedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the software set was released.

software

: Type: Array of Software structures

A list of the software components in the software set.

supportedUntil

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the end of support for the software set.

tags

: Type: Associative array of custom strings keys (String) to strings

The tag keys and optional values for the resource.

validationStatus

: Type: string

An option to define if the software set has been validated.

version

: Type: string

The version of the software set.

SoftwareSetSummary

Description

Describes a software set.

Members

arn

: Type: string

The Amazon Resource Name (ARN) of the software set.

id

: Type: string

The ID of the software set.

releasedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the software set was released.

supportedUntil

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the end of support for the software set.

validationStatus

: Type: string

An option to define if the software set has been validated.

version

: Type: string

The version of the software set.

ThrottlingException

Description

The request was denied due to request throttling.

Members

message

: Type: string

quotaCode

: Type: string

The code for the quota in Service Quotas.

retryAfterSeconds

: Type: int

The number of seconds to wait before retrying the next request.

serviceCode

: Type: string

The code for the service in Service Quotas.

ValidationException

Description

The input fails to satisfy the specified constraints.

Members

fieldList

: Type: Array of ValidationExceptionField structures

A list of fields that didn't validate.

message

: Type: string

reason

: Type: string

The reason for the exception.

ValidationExceptionField

Description

Describes a validation exception.

Members

message

: Required: Yes
: Type: string

A message that describes the reason for the exception.

name

: Required: Yes
: Type: string

The name of the exception.

Amazon WorkSpaces Thin Client 2023-08-22

Operation Summary

Paginators

Operations

CreateEnvironment

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteDevice

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteEnvironment

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeregisterDevice

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

GetDevice

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetEnvironment

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetSoftwareSet

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListDevices

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListEnvironments

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListSoftwareSets

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members