WorkSpacesThinClient / Client / create_environment

create_environment#

WorkSpacesThinClient.Client.create_environment(**kwargs)#

Creates an environment for your thin client devices.

Request Syntax

response = 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'
    }
)

Parameters:

name (string) – The name for the environment.
desktopArn (string) –
[REQUIRED]

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).
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.
kmsKeyArn (string) – The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.
clientToken (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.

This field is autopopulated if not provided.
tags (dict) –
A map of the key-value pairs of the tag or tags to assign to the resource.
- (string) –
  - (string) –
deviceCreationTags (dict) –
A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
- (string) –
  - (string) –

Return type:

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.

create_environment#

Request Syntax

Response Syntax

Response Structure

Exceptions