jobs

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

Overview

Name	jobs
Type	Resource
Id	aws.braket.jobs

Fields

The following fields are returned by SELECT queries:

get_job

Name	Datatype	Description
algorithm_specification	object	Defines the Amazon Braket hybrid job to be created. Specifies the container image the job uses and the paths to the Python scripts used for entry and training.
associations	array	The list of Amazon Braket resources associated with the hybrid job.
billable_duration	integer	The billable time for which the Amazon Braket hybrid job used to complete.
checkpoint_config	object	Contains information about the output locations for hybrid job checkpoint data.
created_at	string (date-time)	The time at which the Amazon Braket hybrid job was created.
device_config	object	Configures the primary device used to create and run an Amazon Braket hybrid job.
ended_at	string (date-time)	The time at which the Amazon Braket hybrid job ended.
events	array	Details about the time and type of events occurred related to the Amazon Braket hybrid job.
failure_reason	string	A description of the reason why an Amazon Braket hybrid job failed, if it failed.
hyper_parameters	object	Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the traiing job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.
input_data_config	array	A list of parameters that specify the name and type of input data and where it is located.
instance_config	object	Configures the resource instances to use while running the Amazon Braket hybrid job on Amazon Braket.
job_arn	string	The ARN of the Amazon Braket hybrid job. (pattern: <code>arn:aws[a-z-]:braket:[a-z0-9-]+:[0-9]{12}:job/.</code>)
job_name	string	The name of the Amazon Braket hybrid job. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,50}</code>)
output_data_config	object	Specifies the path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them.
queue_info	object	Queue information for the requested hybrid job. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetJob API request.
role_arn	string	The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output results and other hybrid job details to the s3 buckets of a user. (pattern: <code>arn:aws[a-z-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@-_/]+</code>)
started_at	string (date-time)	The time at which the Amazon Braket hybrid job was started.
status	string	The status of the Amazon Braket hybrid job. (QUEUED, RUNNING, COMPLETED, FAILED, CANCELLING, CANCELLED)
stopping_condition	object	Specifies limits for how long an Amazon Braket hybrid job can run.
tags	object	The tags associated with this hybrid job.

search_jobs

Name	Datatype	Description
created_at	string (date-time)	The time at which the Amazon Braket hybrid job was created.
device	string	The primary device used by an Amazon Braket hybrid job.
ended_at	string (date-time)	The time at which the Amazon Braket hybrid job ended.
job_arn	string	The ARN of the Amazon Braket hybrid job. (pattern: <code>arn:aws[a-z-]:braket:[a-z0-9-]+:[0-9]{12}:job/.</code>)
job_name	string	The name of the Amazon Braket hybrid job.
started_at	string (date-time)	The time at which the Amazon Braket hybrid job was started.
status	string	The status of the Amazon Braket hybrid job. (QUEUED, RUNNING, COMPLETED, FAILED, CANCELLING, CANCELLED)
tags	object	Displays the key, value pairs of tags associated with this hybrid job.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_job	select	job_arn, region	additionalAttributeNames	Retrieves the specified Amazon Braket hybrid job.
search_jobs	select	region		Searches for Amazon Braket hybrid jobs that match the specified filter values.
create_job	insert	region, clientToken, algorithmSpecification, outputDataConfig, jobName, roleArn, instanceConfig, deviceConfig		Creates an Amazon Braket hybrid job.
cancel_job	exec	job_arn, region		Cancels an Amazon Braket hybrid job.

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
job_arn	string	The ARN of the Amazon Braket hybrid job to cancel.
region	string	AWS region (default: us-east-1)
additionalAttributeNames	array	A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported.

SELECT examples

get_job

Retrieves the specified Amazon Braket hybrid job.

SELECT
algorithm_specification,
associations,
billable_duration,
checkpoint_config,
created_at,
device_config,
ended_at,
events,
failure_reason,
hyper_parameters,
input_data_config,
instance_config,
job_arn,
job_name,
output_data_config,
queue_info,
role_arn,
started_at,
status,
stopping_condition,
tags
FROM aws.braket.jobs
WHERE job_arn = '{{ job_arn }}' -- required
AND region = '{{ region }}' -- required
AND additionalAttributeNames = '{{ additionalAttributeNames }}'
;

search_jobs

Searches for Amazon Braket hybrid jobs that match the specified filter values.

SELECT
created_at,
device,
ended_at,
job_arn,
job_name,
started_at,
status,
tags
FROM aws.braket.jobs
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_job

Creates an Amazon Braket hybrid job.

INSERT INTO aws.braket.jobs (
clientToken,
algorithmSpecification,
inputDataConfig,
outputDataConfig,
checkpointConfig,
jobName,
roleArn,
stoppingCondition,
instanceConfig,
hyperParameters,
deviceConfig,
tags,
associations,
region
)
SELECT 
'{{ clientToken }}' /* required */,
'{{ algorithmSpecification }}' /* required */,
'{{ inputDataConfig }}',
'{{ outputDataConfig }}' /* required */,
'{{ checkpointConfig }}',
'{{ jobName }}' /* required */,
'{{ roleArn }}' /* required */,
'{{ stoppingCondition }}',
'{{ instanceConfig }}' /* required */,
'{{ hyperParameters }}',
'{{ deviceConfig }}' /* required */,
'{{ tags }}',
'{{ associations }}',
'{{ region }}'
RETURNING
job_arn
;

Manifest

# Description fields are for documentation purposes
- name: jobs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the jobs resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: algorithmSpecification
    description: |
      Defines the Amazon Braket hybrid job to be created. Specifies the container image the job uses and the paths to the Python scripts used for entry and training.
    value:
      scriptModeConfig:
        entryPoint: "{{ entryPoint }}"
        s3Uri: "{{ s3Uri }}"
        compressionType: "{{ compressionType }}"
      containerImage:
        uri: "{{ uri }}"
  - name: inputDataConfig
    value:
      - channelName: "{{ channelName }}"
        contentType: "{{ contentType }}"
        dataSource:
          s3DataSource:
            s3Uri: "{{ s3Uri }}"
  - name: outputDataConfig
    description: |
      Specifies the path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them.
    value:
      kmsKeyId: "{{ kmsKeyId }}"
      s3Path: "{{ s3Path }}"
  - name: checkpointConfig
    description: |
      Contains information about the output locations for hybrid job checkpoint data.
    value:
      localPath: "{{ localPath }}"
      s3Uri: "{{ s3Uri }}"
  - name: jobName
    value: "{{ jobName }}"
  - name: roleArn
    value: "{{ roleArn }}"
  - name: stoppingCondition
    description: |
      Specifies limits for how long an Amazon Braket hybrid job can run.
    value:
      maxRuntimeInSeconds: {{ maxRuntimeInSeconds }}
  - name: instanceConfig
    description: |
      Configures the resource instances to use while running the Amazon Braket hybrid job on Amazon Braket.
    value:
      instanceType: "{{ instanceType }}"
      volumeSizeInGb: {{ volumeSizeInGb }}
      instanceCount: {{ instanceCount }}
  - name: hyperParameters
    value: "{{ hyperParameters }}"
  - name: deviceConfig
    description: |
      Configures the primary device used to create and run an Amazon Braket hybrid job.
    value:
      device: "{{ device }}"
  - name: tags
    value: "{{ tags }}"
  - name: associations
    value:
      - arn: "{{ arn }}"
        type_: "{{ type_ }}"

Lifecycle Methods

cancel_job

Cancels an Amazon Braket hybrid job.

EXEC aws.braket.jobs.cancel_job 
@job_arn='{{ job_arn }}' --required, 
@region='{{ region }}' --required
;