Amazon WorkSpaces Thin Client

Returns a list of thin client devices.

See also: AWS API Documentation

Request Syntax

client.list_devices(
    nextToken='string',
    maxResults=123
)

type nextToken

string

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

type maxResults

integer

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

rtype

dict

returns

Response Syntax

{
    'devices': [
        {
            'id': 'string',
            'serialNumber': 'string',
            'name': 'string',
            'model': 'string',
            'environmentId': 'string',
            'status': 'REGISTERED'|'DEREGISTERING'|'DEREGISTERED'|'ARCHIVED',
            'currentSoftwareSetId': 'string',
            'desiredSoftwareSetId': 'string',
            'pendingSoftwareSetId': 'string',
            'softwareSetUpdateSchedule': 'USE_MAINTENANCE_WINDOW'|'APPLY_IMMEDIATELY',
            'lastConnectedAt': datetime(2015, 1, 1),
            'lastPostureAt': datetime(2015, 1, 1),
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'arn': 'string',
            'tags': {
                'resourceArn': 'string',
                'internalId': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • devices (list) --

    Describes devices.

    • (dict) --

      Describes a thin client device.

      • id (string) --

        The ID of the device.

      • serialNumber (string) --

        The hardware serial number of the device.

      • name (string) --

        The name of the device.

      • model (string) --

        The model number of the device.

      • environmentId (string) --

        The ID of the environment the device is associated with.

      • status (string) --

        The status of the device.

      • currentSoftwareSetId (string) --

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

      • desiredSoftwareSetId (string) --

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

      • pendingSoftwareSetId (string) --

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

      • softwareSetUpdateSchedule (string) --

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

      • lastConnectedAt (datetime) --

        The timestamp of the most recent session on the device.

      • lastPostureAt (datetime) --

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

      • createdAt (datetime) --

        The timestamp of when the device was created.

      • updatedAt (datetime) --

        The timestamp of when the device was updated.

      • arn (string) --

        The Amazon Resource Name (ARN) of the device.

      • tags (dict) --

        The tag keys and optional values for the resource.

        • resourceArn (string) --

          The Amazon Resource Name (ARN) of a resource to tag.

        • internalId (string) --

          The internal ID of a resource to tag.

  • nextToken (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 .

Deletes a thin client device.

See also: AWS API Documentation

Request Syntax

client.delete_device(
    id='string',
    clientToken='string'
)

type id

string

param id

[REQUIRED]

The ID of the device to delete.

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.

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

Returns information for a thin client device.

See also: AWS API Documentation

Request Syntax

client.get_device(
    id='string'
)

type id

string

param id

[REQUIRED]

The ID of the device for which to return information.

rtype

dict

returns

Response Syntax

{
    'device': {
        'id': 'string',
        'serialNumber': 'string',
        'name': 'string',
        'model': 'string',
        'environmentId': 'string',
        'status': 'REGISTERED'|'DEREGISTERING'|'DEREGISTERED'|'ARCHIVED',
        'currentSoftwareSetId': 'string',
        'currentSoftwareSetVersion': 'string',
        'desiredSoftwareSetId': 'string',
        'pendingSoftwareSetId': 'string',
        'pendingSoftwareSetVersion': 'string',
        'softwareSetUpdateSchedule': 'USE_MAINTENANCE_WINDOW'|'APPLY_IMMEDIATELY',
        'softwareSetComplianceStatus': 'NONE'|'COMPLIANT'|'NOT_COMPLIANT',
        'softwareSetUpdateStatus': 'AVAILABLE'|'IN_PROGRESS'|'UP_TO_DATE',
        'lastConnectedAt': datetime(2015, 1, 1),
        'lastPostureAt': datetime(2015, 1, 1),
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'arn': 'string',
        'kmsKeyArn': 'string',
        'tags': {
            'resourceArn': 'string',
            'internalId': 'string'
        }
    }
}

Response Structure

• (dict) --

  • device (dict) --

    Describes an device.

    • id (string) --

      The ID of the device.

    • serialNumber (string) --

      The hardware serial number of the device.

    • name (string) --

      The name of the device.

    • model (string) --

      The model number of the device.

    • environmentId (string) --

      The ID of the environment the device is associated with.

    • status (string) --

      The status of the device.

    • currentSoftwareSetId (string) --

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

    • currentSoftwareSetVersion (string) --

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

    • desiredSoftwareSetId (string) --

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

    • pendingSoftwareSetId (string) --

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

    • pendingSoftwareSetVersion (string) --

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

    • softwareSetUpdateSchedule (string) --

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

    • softwareSetComplianceStatus (string) --

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

    • softwareSetUpdateStatus (string) --

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

    • lastConnectedAt (datetime) --

      The timestamp of the most recent session on the device.

    • lastPostureAt (datetime) --

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

    • createdAt (datetime) --

      The timestamp of when the device was created.

    • updatedAt (datetime) --

      The timestamp of when the device was updated.

    • arn (string) --

      The Amazon Resource Name (ARN) of the device.

    • kmsKeyArn (string) --

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

    • tags (dict) --

      The tag keys and optional values for the resource.

      • resourceArn (string) --

        The Amazon Resource Name (ARN) of a resource to tag.

      • internalId (string) --

        The internal ID of a resource to tag.

Deregisters a thin client device.

See also: AWS API Documentation

Request Syntax

client.deregister_device(
    id='string',
    targetDeviceStatus='DEREGISTERED'|'ARCHIVED',
    clientToken='string'
)

type id

string

param id

[REQUIRED]

The ID of the device to deregister.

type targetDeviceStatus

string

param targetDeviceStatus

The desired new status for the device.

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.

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

Returns information for a software set.

See also: AWS API Documentation

Request Syntax

client.get_software_set(
    id='string'
)

type id

string

param id

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'softwareSet': {
        'id': 'string',
        'version': 'string',
        'releasedAt': datetime(2015, 1, 1),
        'supportedUntil': datetime(2015, 1, 1),
        'validationStatus': 'VALIDATED'|'NOT_VALIDATED',
        'software': [
            {
                'name': 'string',
                'version': 'string'
            },
        ],
        'arn': 'string'
    }
}

Response Structure

• (dict) --

  • softwareSet (dict) --

    Describes a software set.

    • id (string) --

      The ID of the software set.

    • version (string) --

      The version of the software set.

    • releasedAt (datetime) --

      The timestamp of when the software set was released.

    • supportedUntil (datetime) --

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

    • validationStatus (string) --

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

    • software (list) --

      A list of the software components in the software set.

      • (dict) --

        Describes software.

        • name (string) --

          The name of the software component.

        • version (string) --

          The version of the software component.

    • arn (string) --

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

Deletes an environment.

See also: AWS API Documentation

Request Syntax

client.delete_environment(
    id='string',
    clientToken='string'
)

type id

string

param id

[REQUIRED]

The ID of the environment to delete.

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.

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

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

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)

type resourceArn

string

param resourceArn

[REQUIRED]

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

type tags

dict

param tags

[REQUIRED]

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

• (string) --

  • (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

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'
)

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.

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',
        'tags': {
            'resourceArn': 'string',
            'internalId': '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.

    • tags (dict) --

      The tag keys and optional values for the resource.

      • resourceArn (string) --

        The Amazon Resource Name (ARN) of a resource to tag.

      • internalId (string) --

        The internal ID of a resource to tag.

Returns a list of software sets.

See also: AWS API Documentation

Request Syntax

client.list_software_sets(
    nextToken='string',
    maxResults=123
)

type nextToken

string

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

type maxResults

integer

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

rtype

dict

returns

Response Syntax

{
    'softwareSets': [
        {
            'id': 'string',
            'version': 'string',
            'releasedAt': datetime(2015, 1, 1),
            'supportedUntil': datetime(2015, 1, 1),
            'validationStatus': 'VALIDATED'|'NOT_VALIDATED',
            'arn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • softwareSets (list) --

    Describes software sets.

    • (dict) --

      Describes a software set.

      • id (string) --

        The ID of the software set.

      • version (string) --

        The version of the software set.

      • releasedAt (datetime) --

        The timestamp of when the software set was released.

      • supportedUntil (datetime) --

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

      • validationStatus (string) --

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

      • arn (string) --

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

  • nextToken (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 .

Removes a tag or tags from a resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)

type resourceArn

string

param resourceArn

[REQUIRED]

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

type tagKeys

list

param tagKeys

[REQUIRED]

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

• (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

Updates a software set.

See also: AWS API Documentation

Request Syntax

client.update_software_set(
    id='string',
    validationStatus='VALIDATED'|'NOT_VALIDATED'
)

type id

string

param id

[REQUIRED]

The ID of the software set to update.

type validationStatus

string

param validationStatus

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

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

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) --

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',
        'tags': {
            'resourceArn': 'string',
            'internalId': '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.

    • tags (dict) --

      The tag keys and optional values for the resource.

      • resourceArn (string) --

        The Amazon Resource Name (ARN) of a resource to tag.

      • internalId (string) --

        The internal ID of a resource to tag.

Returns a list of environments.

See also: AWS API Documentation

Request Syntax

client.list_environments(
    nextToken='string',
    maxResults=123
)

type nextToken

string

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

type maxResults

integer

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

rtype

dict

returns

Response Syntax

{
    'environments': [
        {
            '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',
            'tags': {
                'resourceArn': 'string',
                'internalId': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • environments (list) --

    Describes environments.

    • (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.

      • tags (dict) --

        The tag keys and optional values for the resource.

        • resourceArn (string) --

          The Amazon Resource Name (ARN) of a resource to tag.

        • internalId (string) --

          The internal ID of a resource to tag.

  • nextToken (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 .

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': {
            'resourceArn': 'string',
            'internalId': '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.

      • resourceArn (string) --

        The Amazon Resource Name (ARN) of a resource to tag.

      • internalId (string) --

        The internal ID of a resource to tag.

Returns a list of tags for a resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)

type resourceArn

string

param resourceArn

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --

  • tags (dict) --

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

    • (string) --

      • (string) --

Updates a thin client device.

See also: AWS API Documentation

Request Syntax

client.update_device(
    id='string',
    name='string',
    desiredSoftwareSetId='string',
    softwareSetUpdateSchedule='USE_MAINTENANCE_WINDOW'|'APPLY_IMMEDIATELY',
    kmsKeyArn='string'
)

type id

string

param id

[REQUIRED]

The ID of the device to update.

type name

string

param name

The name of the device to update.

type desiredSoftwareSetId

string

param desiredSoftwareSetId

The ID of the software set to apply.

type softwareSetUpdateSchedule

string

param softwareSetUpdateSchedule

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

type kmsKeyArn

string

param kmsKeyArn

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

rtype

dict

returns

Response Syntax

{
    'device': {
        'id': 'string',
        'serialNumber': 'string',
        'name': 'string',
        'model': 'string',
        'environmentId': 'string',
        'status': 'REGISTERED'|'DEREGISTERING'|'DEREGISTERED'|'ARCHIVED',
        'currentSoftwareSetId': 'string',
        'desiredSoftwareSetId': 'string',
        'pendingSoftwareSetId': 'string',
        'softwareSetUpdateSchedule': 'USE_MAINTENANCE_WINDOW'|'APPLY_IMMEDIATELY',
        'lastConnectedAt': datetime(2015, 1, 1),
        'lastPostureAt': datetime(2015, 1, 1),
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'arn': 'string',
        'tags': {
            'resourceArn': 'string',
            'internalId': 'string'
        }
    }
}

Response Structure

• (dict) --

  • device (dict) --

    Describes a device.

    • id (string) --

      The ID of the device.

    • serialNumber (string) --

      The hardware serial number of the device.

    • name (string) --

      The name of the device.

    • model (string) --

      The model number of the device.

    • environmentId (string) --

      The ID of the environment the device is associated with.

    • status (string) --

      The status of the device.

    • currentSoftwareSetId (string) --

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

    • desiredSoftwareSetId (string) --

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

    • pendingSoftwareSetId (string) --

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

    • softwareSetUpdateSchedule (string) --

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

    • lastConnectedAt (datetime) --

      The timestamp of the most recent session on the device.

    • lastPostureAt (datetime) --

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

    • createdAt (datetime) --

      The timestamp of when the device was created.

    • updatedAt (datetime) --

      The timestamp of when the device was updated.

    • arn (string) --

      The Amazon Resource Name (ARN) of the device.

    • tags (dict) --

      The tag keys and optional values for the resource.

      • resourceArn (string) --

        The Amazon Resource Name (ARN) of a resource to tag.

      • internalId (string) --

        The internal ID of a resource to tag.