workloads

Creates, updates, deletes, gets or lists a workloads resource.

Overview

Name	workloads
Type	Resource
Id	aws.launch_wizard.workloads

Fields

The following fields are returned by SELECT queries:

get_workload

Name	Datatype	Description
description	string	The description of a workload.
display_name	string	The display name of a workload.
documentation_url	string	The URL of a workload document.
icon_url	string	The URL of a workload icon.
status	string	The status of a workload. You can list deployments in the DISABLED status. (ACTIVE, INACTIVE, DISABLED, DELETED)
status_message	string	The message about a workload's status.
workload_name	string	The name of the workload. (pattern: <code>[A-Za-z][a-zA-Z0-9-_]*</code>)

list_workloads

Name	Datatype	Description
display_name	string	The display name of the workload data.
status	string	The status of the workload. (ACTIVE, INACTIVE, DISABLED, DELETED)
workload_name	string	The name of the workload. (pattern: <code>[A-Za-z][a-zA-Z0-9-_]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_workload	select	region		Returns information about a workload.
list_workloads	select	region		Lists the available workload names. You can use the ListWorkloadDeploymentPatterns operation to discover the available deployment patterns for a given workload.

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

get_workload

Returns information about a workload.

SELECT
description,
display_name,
documentation_url,
icon_url,
status,
status_message,
workload_name
FROM aws.launch_wizard.workloads
WHERE region = '{{ region }}' -- required
;

list_workloads

Lists the available workload names. You can use the ListWorkloadDeploymentPatterns operation to discover the available deployment patterns for a given workload.

SELECT
display_name,
status,
workload_name
FROM aws.launch_wizard.workloads
WHERE region = '{{ region }}' -- required
;