Skip to main content

jobs_by_consumable_resources

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

Overview

Namejobs_by_consumable_resources
TypeResource
Idaws.batch.jobs_by_consumable_resources

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
consumable_resource_propertiesobjectContains a list of consumable resources required by the job.
created_atinteger (int64)The Unix timestamp (in milliseconds) for when the consumable resource was created.
job_arnstringThe Amazon Resource Name (ARN) of the job.
job_definition_arnstringThe Amazon Resource Name (ARN) of the job definition.
job_namestringThe name of the job.
job_queue_arnstringThe Amazon Resource Name (ARN) of the job queue.
job_statusstringThe status of the job. Can be one of: SUBMITTED PENDING RUNNABLE STARTING RUNNING SUCCEEDED FAILED
quantityinteger (int64)The total amount of the consumable resource that is available.
share_identifierstringThe fair-share scheduling identifier for the job.
started_atinteger (int64)The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.
status_reasonstringA short, human-readable string to provide more details for the current status of the job.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_jobs_by_consumable_resourceselectregionReturns a list of Batch jobs that require a specific consumable resource.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

Returns a list of Batch jobs that require a specific consumable resource.

SELECT
consumable_resource_properties,
created_at,
job_arn,
job_definition_arn,
job_name,
job_queue_arn,
job_status,
quantity,
share_identifier,
started_at,
status_reason
FROM aws.batch.jobs_by_consumable_resources
WHERE region = '{{ region }}' -- required
;