cluster_jobs

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

Overview

Name	cluster_jobs
Type	Resource
Id	aws.snowball.cluster_jobs

Fields

The following fields are returned by SELECT queries:

list_cluster_jobs

Name	Datatype	Description
creation_date	string (date-time)	The creation date for this job.
description	string	The optional description of this specific job, for example Important Photos 2016-08-11. (pattern: <code>.*</code>)
is_master	boolean	A value that indicates that this job is a main job. A main job represents a successful request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each main job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular main job are listed, because they are created after the main job is created.
job_id	string	The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. (pattern: <code>.*</code>)
job_state	string	The current state of this job. (New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWSSortingFacility, WithAWS, InProgress, Complete, Cancelled, Listing, Pending)
job_type	string	The type of job. (IMPORT, EXPORT, LOCAL_USE)
snowball_type	string	The type of device used with this job. (STANDARD, EDGE, EDGE_C, EDGE_CG, EDGE_S, SNC1_HDD, SNC1_SSD, V3_5C, V3_5S, RACK_5U_C)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_cluster_jobs	select	region		Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.

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

list_cluster_jobs

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.

SELECT
creation_date,
description,
is_master,
job_id,
job_state,
job_type,
snowball_type
FROM aws.snowball.cluster_jobs
WHERE region = '{{ region }}' -- required
;