Skip to content

/AWS1/CL_BRK=>CREATEJOB()

About CreateJob

Creates an Amazon Braket job.

Method Signature

IMPORTING

Required arguments:

IV_CLIENTTOKEN TYPE /AWS1/BRKSTRING64 /AWS1/BRKSTRING64

A unique token that guarantees that the call to this API is idempotent.

IO_ALGORITHMSPECIFICATION TYPE REF TO /AWS1/CL_BRKALGORITHMSPEC /AWS1/CL_BRKALGORITHMSPEC

Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information about the Python scripts used for entry and training.

IO_OUTPUTDATACONFIG TYPE REF TO /AWS1/CL_BRKJOBOUTPUTDATACFG /AWS1/CL_BRKJOBOUTPUTDATACFG

The path to the S3 location where you want to store job artifacts and the encryption key used to store them.

IV_JOBNAME TYPE /AWS1/BRKSTRING /AWS1/BRKSTRING

The name of the Amazon Braket job.

IV_ROLEARN TYPE /AWS1/BRKROLEARN /AWS1/BRKROLEARN

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 resources to the users' s3 buckets.

IO_INSTANCECONFIG TYPE REF TO /AWS1/CL_BRKINSTANCECONFIG /AWS1/CL_BRKINSTANCECONFIG

Configuration of the resource instances to use while running the hybrid job on Amazon Braket.

IO_DEVICECONFIG TYPE REF TO /AWS1/CL_BRKDEVICECONFIG /AWS1/CL_BRKDEVICECONFIG

The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.

Optional arguments:

IT_INPUTDATACONFIG TYPE /AWS1/CL_BRKINPUTFILECONFIG=>TT_INPUTCONFIGLIST TT_INPUTCONFIGLIST

A list of parameters that specify the name and type of input data and where it is located.

IO_CHECKPOINTCONFIG TYPE REF TO /AWS1/CL_BRKJOBCHECKPOINTCFG /AWS1/CL_BRKJOBCHECKPOINTCFG

Information about the output locations for job checkpoint data.

IO_STOPPINGCONDITION TYPE REF TO /AWS1/CL_BRKJOBSTOPPINGCOND /AWS1/CL_BRKJOBSTOPPINGCOND

The user-defined criteria that specifies when a job stops running.

IT_HYPERPARAMETERS TYPE /AWS1/CL_BRKHYPERPARAMETERS_W=>TT_HYPERPARAMETERS TT_HYPERPARAMETERS

Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.

IT_TAGS TYPE /AWS1/CL_BRKTAGSMAP_W=>TT_TAGSMAP TT_TAGSMAP

A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

IT_ASSOCIATIONS TYPE /AWS1/CL_BRKASSOCIATION=>TT_ASSOCIATIONS TT_ASSOCIATIONS

The list of Amazon Braket resources associated with the hybrid job.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_BRKCREATEJOBRESPONSE /AWS1/CL_BRKCREATEJOBRESPONSE