AWS API Changes

2024/06/25 - Amazon WorkSpaces Thin Client - 3 updated api methods

Changes This release adds the deviceCreationTags field to CreateEnvironment API input, UpdateEnvironment API input and GetEnvironment API output.

CreateEnvironment (updated)

Link ¶
Changes (request)

{'deviceCreationTags': {'string': 'string'}}

Creates an environment for your thin client devices.

See also: AWS API Documentation

Request Syntax

client.create_environment(
    name='string',
    desktopArn='string',
    desktopEndpoint='string',
    softwareSetUpdateSchedule='USE_MAINTENANCE_WINDOW'|'APPLY_IMMEDIATELY',
    maintenanceWindow={
        'type': 'SYSTEM'|'CUSTOM',
        'startTimeHour': 123,
        'startTimeMinute': 123,
        'endTimeHour': 123,
        'endTimeMinute': 123,
        'daysOfTheWeek': [
            'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
        ],
        'applyTimeOf': 'UTC'|'DEVICE'
    },
    softwareSetUpdateMode='USE_LATEST'|'USE_DESIRED',
    desiredSoftwareSetId='string',
    kmsKeyArn='string',
    clientToken='string',
    tags={
        'string': 'string'
    },
    deviceCreationTags={
        'string': 'string'
    }
)

type name:

string

param name:

The name for the environment.

type desktopArn:

string

param desktopArn:

[REQUIRED]

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

type desktopEndpoint:

string

param desktopEndpoint:

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

type softwareSetUpdateSchedule:

string

param softwareSetUpdateSchedule:

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

type maintenanceWindow:

dict

param maintenanceWindow:

A specification for a time window to apply software updates.

type (string) --

An option to select the default or custom maintenance window.
startTimeHour (integer) --

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

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

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

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

The days of the week during which the maintenance window is open.
- (string) --
applyTimeOf (string) --

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

type softwareSetUpdateMode:

string

param softwareSetUpdateMode:

An option to define which software updates to apply.

type desiredSoftwareSetId:

string

param desiredSoftwareSetId:

The ID of the software set to apply.

type kmsKeyArn:

string

param kmsKeyArn:

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

type clientToken:

string

param 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.

This field is autopopulated if not provided.

type tags:

dict

param tags:

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

(string) --
- (string) --

type deviceCreationTags:

dict

param deviceCreationTags:

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

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'environment': {
        'id': 'string',
        'name': 'string',
        'desktopArn': 'string',
        'desktopEndpoint': 'string',
        'desktopType': 'workspaces'|'appstream'|'workspaces-web',
        'activationCode': 'string',
        'softwareSetUpdateSchedule': 'USE_MAINTENANCE_WINDOW'|'APPLY_IMMEDIATELY',
        'maintenanceWindow': {
            'type': 'SYSTEM'|'CUSTOM',
            'startTimeHour': 123,
            'startTimeMinute': 123,
            'endTimeHour': 123,
            'endTimeMinute': 123,
            'daysOfTheWeek': [
                'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
            ],
            'applyTimeOf': 'UTC'|'DEVICE'
        },
        'softwareSetUpdateMode': 'USE_LATEST'|'USE_DESIRED',
        'desiredSoftwareSetId': 'string',
        'pendingSoftwareSetId': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'arn': 'string'
    }
}

Response Structure

(dict) --
- environment (dict) --
  
  Describes an environment.
  - id (string) --
    
    The ID of the environment.
  - name (string) --
    
    The name of the environment.
  - desktopArn (string) --
    
    The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
  - desktopEndpoint (string) --
    
    The URL for the identity provider login (only for environments that use AppStream 2.0).
  - desktopType (string) --
    
    The type of streaming desktop for the environment.
  - activationCode (string) --
    
    The activation code to register a device to the environment.
  - softwareSetUpdateSchedule (string) --
    
    An option to define if software updates should be applied within a maintenance window.
  - maintenanceWindow (dict) --
    
    A specification for a time window to apply software updates.
    - type (string) --
      
      An option to select the default or custom maintenance window.
    - startTimeHour (integer) --
      
      The hour for the maintenance window start ( 00- 23).
    - startTimeMinute (integer) --
      
      The minutes past the hour for the maintenance window start ( 00- 59).
    - endTimeHour (integer) --
      
      The hour for the maintenance window end ( 00- 23).
    - endTimeMinute (integer) --
      
      The minutes for the maintenance window end ( 00- 59).
    - daysOfTheWeek (list) --
      
      The days of the week during which the maintenance window is open.
      - (string) --
    - applyTimeOf (string) --
      
      The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).
  - softwareSetUpdateMode (string) --
    
    An option to define which software updates to apply.
  - desiredSoftwareSetId (string) --
    
    The ID of the software set to apply.
  - pendingSoftwareSetId (string) --
    
    The ID of the software set that is pending to be installed.
  - createdAt (datetime) --
    
    The timestamp of when the environment was created.
  - updatedAt (datetime) --
    
    The timestamp of when the device was updated.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the environment.

GetEnvironment (updated)

Link ¶
Changes (response)

{'environment': {'deviceCreationTags': {'string': 'string'}}}

Returns information for an environment.

See also: AWS API Documentation

Request Syntax

client.get_environment(
    id='string'
)

type id:

string

param id:

[REQUIRED]

The ID of the environment for which to return information.

rtype:

dict

returns:

Response Syntax

{
    'environment': {
        'id': 'string',
        'name': 'string',
        'desktopArn': 'string',
        'desktopEndpoint': 'string',
        'desktopType': 'workspaces'|'appstream'|'workspaces-web',
        'activationCode': 'string',
        'registeredDevicesCount': 123,
        'softwareSetUpdateSchedule': 'USE_MAINTENANCE_WINDOW'|'APPLY_IMMEDIATELY',
        'maintenanceWindow': {
            'type': 'SYSTEM'|'CUSTOM',
            'startTimeHour': 123,
            'startTimeMinute': 123,
            'endTimeHour': 123,
            'endTimeMinute': 123,
            'daysOfTheWeek': [
                'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
            ],
            'applyTimeOf': 'UTC'|'DEVICE'
        },
        'softwareSetUpdateMode': 'USE_LATEST'|'USE_DESIRED',
        'desiredSoftwareSetId': 'string',
        'pendingSoftwareSetId': 'string',
        'pendingSoftwareSetVersion': 'string',
        'softwareSetComplianceStatus': 'NO_REGISTERED_DEVICES'|'COMPLIANT'|'NOT_COMPLIANT',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'arn': 'string',
        'kmsKeyArn': 'string',
        'tags': {
            'string': 'string'
        },
        'deviceCreationTags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- environment (dict) --
  
  Describes an environment.
  - id (string) --
    
    The ID of the environment.
  - name (string) --
    
    The name of the environment.
  - desktopArn (string) --
    
    The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
  - desktopEndpoint (string) --
    
    The URL for the identity provider login (only for environments that use AppStream 2.0).
  - desktopType (string) --
    
    The type of streaming desktop for the environment.
  - activationCode (string) --
    
    The activation code to register a device to the environment.
  - registeredDevicesCount (integer) --
    
    The number of devices registered to the environment.
  - softwareSetUpdateSchedule (string) --
    
    An option to define if software updates should be applied within a maintenance window.
  - maintenanceWindow (dict) --
    
    A specification for a time window to apply software updates.
    - type (string) --
      
      An option to select the default or custom maintenance window.
    - startTimeHour (integer) --
      
      The hour for the maintenance window start ( 00- 23).
    - startTimeMinute (integer) --
      
      The minutes past the hour for the maintenance window start ( 00- 59).
    - endTimeHour (integer) --
      
      The hour for the maintenance window end ( 00- 23).
    - endTimeMinute (integer) --
      
      The minutes for the maintenance window end ( 00- 59).
    - daysOfTheWeek (list) --
      
      The days of the week during which the maintenance window is open.
      - (string) --
    - applyTimeOf (string) --
      
      The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).
  - softwareSetUpdateMode (string) --
    
    An option to define which software updates to apply.
  - desiredSoftwareSetId (string) --
    
    The ID of the software set to apply.
  - pendingSoftwareSetId (string) --
    
    The ID of the software set that is pending to be installed.
  - pendingSoftwareSetVersion (string) --
    
    The version of the software set that is pending to be installed.
  - softwareSetComplianceStatus (string) --
    
    Describes if the software currently installed on all devices in the environment is a supported version.
  - createdAt (datetime) --
    
    The timestamp of when the environment was created.
  - updatedAt (datetime) --
    
    The timestamp of when the device was updated.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the environment.
  - kmsKeyArn (string) --
    
    The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the environment.
  - tags (dict) --
    
    The tag keys and optional values for the resource.
    - (string) --
      - (string) --
  - deviceCreationTags (dict) --
    
    "The tag keys and optional values for the newly created devices for this environment."
    - (string) --
      - (string) --

UpdateEnvironment (updated)

Link ¶
Changes (request)

{'deviceCreationTags': {'string': 'string'}}

Updates an environment.

See also: AWS API Documentation

Request Syntax

client.update_environment(
    id='string',
    name='string',
    desktopArn='string',
    desktopEndpoint='string',
    softwareSetUpdateSchedule='USE_MAINTENANCE_WINDOW'|'APPLY_IMMEDIATELY',
    maintenanceWindow={
        'type': 'SYSTEM'|'CUSTOM',
        'startTimeHour': 123,
        'startTimeMinute': 123,
        'endTimeHour': 123,
        'endTimeMinute': 123,
        'daysOfTheWeek': [
            'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
        ],
        'applyTimeOf': 'UTC'|'DEVICE'
    },
    softwareSetUpdateMode='USE_LATEST'|'USE_DESIRED',
    desiredSoftwareSetId='string',
    deviceCreationTags={
        'string': 'string'
    }
)

type id:

string

param id:

[REQUIRED]

The ID of the environment to update.

type name:

string

param name:

The name of the environment to update.

type desktopArn:

string

param desktopArn:

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

type desktopEndpoint:

string

param desktopEndpoint:

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

type softwareSetUpdateSchedule:

string

param softwareSetUpdateSchedule:

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

type maintenanceWindow:

dict

param maintenanceWindow:

A specification for a time window to apply software updates.

type (string) --

An option to select the default or custom maintenance window.
startTimeHour (integer) --

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

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

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

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

The days of the week during which the maintenance window is open.
- (string) --
applyTimeOf (string) --

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

type softwareSetUpdateMode:

string

param softwareSetUpdateMode:

An option to define which software updates to apply.

type desiredSoftwareSetId:

string

param desiredSoftwareSetId:

The ID of the software set to apply.

type deviceCreationTags:

dict

param deviceCreationTags:

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

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'environment': {
        'id': 'string',
        'name': 'string',
        'desktopArn': 'string',
        'desktopEndpoint': 'string',
        'desktopType': 'workspaces'|'appstream'|'workspaces-web',
        'activationCode': 'string',
        'softwareSetUpdateSchedule': 'USE_MAINTENANCE_WINDOW'|'APPLY_IMMEDIATELY',
        'maintenanceWindow': {
            'type': 'SYSTEM'|'CUSTOM',
            'startTimeHour': 123,
            'startTimeMinute': 123,
            'endTimeHour': 123,
            'endTimeMinute': 123,
            'daysOfTheWeek': [
                'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
            ],
            'applyTimeOf': 'UTC'|'DEVICE'
        },
        'softwareSetUpdateMode': 'USE_LATEST'|'USE_DESIRED',
        'desiredSoftwareSetId': 'string',
        'pendingSoftwareSetId': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'arn': 'string'
    }
}

Response Structure

(dict) --
- environment (dict) --
  
  Describes an environment.
  - id (string) --
    
    The ID of the environment.
  - name (string) --
    
    The name of the environment.
  - desktopArn (string) --
    
    The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
  - desktopEndpoint (string) --
    
    The URL for the identity provider login (only for environments that use AppStream 2.0).
  - desktopType (string) --
    
    The type of streaming desktop for the environment.
  - activationCode (string) --
    
    The activation code to register a device to the environment.
  - softwareSetUpdateSchedule (string) --
    
    An option to define if software updates should be applied within a maintenance window.
  - maintenanceWindow (dict) --
    
    A specification for a time window to apply software updates.
    - type (string) --
      
      An option to select the default or custom maintenance window.
    - startTimeHour (integer) --
      
      The hour for the maintenance window start ( 00- 23).
    - startTimeMinute (integer) --
      
      The minutes past the hour for the maintenance window start ( 00- 59).
    - endTimeHour (integer) --
      
      The hour for the maintenance window end ( 00- 23).
    - endTimeMinute (integer) --
      
      The minutes for the maintenance window end ( 00- 59).
    - daysOfTheWeek (list) --
      
      The days of the week during which the maintenance window is open.
      - (string) --
    - applyTimeOf (string) --
      
      The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).
  - softwareSetUpdateMode (string) --
    
    An option to define which software updates to apply.
  - desiredSoftwareSetId (string) --
    
    The ID of the software set to apply.
  - pendingSoftwareSetId (string) --
    
    The ID of the software set that is pending to be installed.
  - createdAt (datetime) --
    
    The timestamp of when the environment was created.
  - updatedAt (datetime) --
    
    The timestamp of when the device was updated.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the environment.