Skip to content

/AWS1/IF_BRK=>CREATEJOB()

About CreateJob

Creates an Amazon Braket hybrid job.

Method Signature

METHODS /AWS1/IF_BRK~CREATEJOB
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/BRKSTRING64 OPTIONAL
    !IO_ALGORITHMSPECIFICATION TYPE REF TO /AWS1/CL_BRKALGORITHMSPEC OPTIONAL
    !IT_INPUTDATACONFIG TYPE /AWS1/CL_BRKINPUTFILECONFIG=>TT_INPUTCONFIGLIST OPTIONAL
    !IO_OUTPUTDATACONFIG TYPE REF TO /AWS1/CL_BRKJOBOUTPUTDATACFG OPTIONAL
    !IO_CHECKPOINTCONFIG TYPE REF TO /AWS1/CL_BRKJOBCHECKPOINTCFG OPTIONAL
    !IV_JOBNAME TYPE /AWS1/BRKSTRING OPTIONAL
    !IV_ROLEARN TYPE /AWS1/BRKROLEARN OPTIONAL
    !IO_STOPPINGCONDITION TYPE REF TO /AWS1/CL_BRKJOBSTOPPINGCOND OPTIONAL
    !IO_INSTANCECONFIG TYPE REF TO /AWS1/CL_BRKINSTANCECONFIG OPTIONAL
    !IT_HYPERPARAMETERS TYPE /AWS1/CL_BRKHYPERPARAMETERS_W=>TT_HYPERPARAMETERS OPTIONAL
    !IO_DEVICECONFIG TYPE REF TO /AWS1/CL_BRKDEVICECONFIG OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_BRKTAGSMAP_W=>TT_TAGSMAP OPTIONAL
    !IT_ASSOCIATIONS TYPE /AWS1/CL_BRKASSOCIATION=>TT_ASSOCIATIONS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_brkcreatejobresponse
  RAISING
    /AWS1/CX_BRKACCESSDENIEDEX
    /AWS1/CX_BRKCONFLICTEXCEPTION
    /AWS1/CX_BRKDEVICEOFFLINEEX
    /AWS1/CX_BRKDEVICERETIREDEX
    /AWS1/CX_BRKINTERNALSERVICEEX
    /AWS1/CX_BRKSERVICEQUOTAEXCDEX
    /AWS1/CX_BRKTHROTTLINGEX
    /AWS1/CX_BRKVALIDATIONEX
    /AWS1/CX_BRKCLIENTEXC
    /AWS1/CX_BRKSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_clienttoken TYPE /AWS1/BRKSTRING64 /AWS1/BRKSTRING64

The client token associated with this request that guarantees that the request 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 hybrid job artifacts and the encryption key used to store them.

iv_jobname TYPE /AWS1/BRKSTRING /AWS1/BRKSTRING

The name of the Amazon Braket hybrid 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 results and hybrid job details 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 hybrid 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 hybrid job checkpoint data.

io_stoppingcondition TYPE REF TO /AWS1/CL_BRKJOBSTOPPINGCOND /AWS1/CL_BRKJOBSTOPPINGCOND

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

it_hyperparameters TYPE /AWS1/CL_BRKHYPERPARAMETERS_W=>TT_HYPERPARAMETERS TT_HYPERPARAMETERS

Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the training 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 the hyperparameter.

Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.

it_tags TYPE /AWS1/CL_BRKTAGSMAP_W=>TT_TAGSMAP TT_TAGSMAP

Tags to be added to the hybrid job you're creating.

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

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createjob(
  io_algorithmspecification = new /aws1/cl_brkalgorithmspec(
    io_containerimage = new /aws1/cl_brkcontainerimage( |string| )
    io_scriptmodeconfig = new /aws1/cl_brkscriptmodeconfig(
      iv_compressiontype = |string|
      iv_entrypoint = |string|
      iv_s3uri = |string|
    )
  )
  io_checkpointconfig = new /aws1/cl_brkjobcheckpointcfg(
    iv_localpath = |string|
    iv_s3uri = |string|
  )
  io_deviceconfig = new /aws1/cl_brkdeviceconfig( |string| )
  io_instanceconfig = new /aws1/cl_brkinstanceconfig(
    iv_instancecount = 123
    iv_instancetype = |string|
    iv_volumesizeingb = 123
  )
  io_outputdataconfig = new /aws1/cl_brkjoboutputdatacfg(
    iv_kmskeyid = |string|
    iv_s3path = |string|
  )
  io_stoppingcondition = new /aws1/cl_brkjobstoppingcond( 123 )
  it_associations = VALUE /aws1/cl_brkassociation=>tt_associations(
    (
      new /aws1/cl_brkassociation(
        iv_arn = |string|
        iv_type = |string|
      )
    )
  )
  it_hyperparameters = VALUE /aws1/cl_brkhyperparameters_w=>tt_hyperparameters(
    (
      VALUE /aws1/cl_brkhyperparameters_w=>ts_hyperparameters_maprow(
        key = |string|
        value = new /aws1/cl_brkhyperparameters_w( |string| )
      )
    )
  )
  it_inputdataconfig = VALUE /aws1/cl_brkinputfileconfig=>tt_inputconfiglist(
    (
      new /aws1/cl_brkinputfileconfig(
        io_datasource = new /aws1/cl_brkdatasource( new /aws1/cl_brks3datasource( |string| ) )
        iv_channelname = |string|
        iv_contenttype = |string|
      )
    )
  )
  it_tags = VALUE /aws1/cl_brktagsmap_w=>tt_tagsmap(
    (
      VALUE /aws1/cl_brktagsmap_w=>ts_tagsmap_maprow(
        key = |string|
        value = new /aws1/cl_brktagsmap_w( |string| )
      )
    )
  )
  iv_clienttoken = |string|
  iv_jobname = |string|
  iv_rolearn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_jobarn = lo_result->get_jobarn( ).
ENDIF.