applications

Creates, updates, deletes, gets or lists an applications resource.

Overview

Name	applications
Type	Resource
Id	aws.workspaces.applications

Fields

The following fields are returned by SELECT queries:

describe_applications

Name	Datatype	Description
applications	array	List of information about the specified applications.
next_token	string	If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_applications	select	region		Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.
associate_workspace_application	update	region, WorkspaceId, ApplicationId		Associates the specified application to the specified WorkSpace.
deploy_workspace_applications	exec	region, WorkspaceId		Deploys associated applications to the specified WorkSpace
disassociate_workspace_application	exec	region, WorkspaceId, ApplicationId		Disassociates the specified application from a WorkSpace.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_applications

Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.

SELECT
applications,
next_token
FROM aws.workspaces.applications
WHERE region = '{{ region }}' -- required
;

UPDATE examples

associate_workspace_application

Associates the specified application to the specified WorkSpace.

UPDATE aws.workspaces.applications
SET 
WorkspaceId = '{{ WorkspaceId }}',
ApplicationId = '{{ ApplicationId }}'
WHERE 
region = '{{ region }}' --required
AND WorkspaceId = '{{ WorkspaceId }}' --required
AND ApplicationId = '{{ ApplicationId }}' --required
RETURNING
association;

Lifecycle Methods

deploy_workspace_applications

Deploys associated applications to the specified WorkSpace

EXEC aws.workspaces.applications.deploy_workspace_applications 
@region='{{ region }}' --required 
@@json=
'{
"WorkspaceId": "{{ WorkspaceId }}", 
"Force": {{ Force }}
}'
;

disassociate_workspace_application

Disassociates the specified application from a WorkSpace.

EXEC aws.workspaces.applications.disassociate_workspace_application 
@region='{{ region }}' --required 
@@json=
'{
"WorkspaceId": "{{ WorkspaceId }}", 
"ApplicationId": "{{ ApplicationId }}"
}'
;