Skip to content

/AWS1/IF_BRK=>CREATEQUANTUMTASK()

About CreateQuantumTask

Creates a quantum task.

Method Signature

METHODS /AWS1/IF_BRK~CREATEQUANTUMTASK
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/BRKSTRING64 OPTIONAL
    !IV_DEVICEARN TYPE /AWS1/BRKDEVICEARN OPTIONAL
    !IV_DEVICEPARAMETERS TYPE /AWS1/BRKJSONVALUE OPTIONAL
    !IV_SHOTS TYPE /AWS1/BRKLONG OPTIONAL
    !IV_OUTPUTS3BUCKET TYPE /AWS1/BRKSTRING OPTIONAL
    !IV_OUTPUTS3KEYPREFIX TYPE /AWS1/BRKSTRING OPTIONAL
    !IV_ACTION TYPE /AWS1/BRKJSONVALUE OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_BRKTAGSMAP_W=>TT_TAGSMAP OPTIONAL
    !IV_JOBTOKEN TYPE /AWS1/BRKJOBTOKEN OPTIONAL
    !IT_ASSOCIATIONS TYPE /AWS1/CL_BRKASSOCIATION=>TT_ASSOCIATIONS OPTIONAL
    !IO_EXPERIMENTALCAPABILITIES TYPE REF TO /AWS1/CL_BRKEXPERIMENTALCAPA00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_brkcrequantumtaskrsp
  RAISING
    /AWS1/CX_BRKACCESSDENIEDEX
    /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 the request.

iv_devicearn TYPE /AWS1/BRKDEVICEARN /AWS1/BRKDEVICEARN

The ARN of the device to run the quantum task on.

iv_shots TYPE /AWS1/BRKLONG /AWS1/BRKLONG

The number of shots to use for the quantum task.

iv_outputs3bucket TYPE /AWS1/BRKSTRING /AWS1/BRKSTRING

The S3 bucket to store quantum task result files in.

iv_outputs3keyprefix TYPE /AWS1/BRKSTRING /AWS1/BRKSTRING

The key prefix for the location in the S3 bucket to store quantum task results in.

iv_action TYPE /AWS1/BRKJSONVALUE /AWS1/BRKJSONVALUE

The action associated with the quantum task.

Optional arguments:

iv_deviceparameters TYPE /AWS1/BRKJSONVALUE /AWS1/BRKJSONVALUE

The parameters for the device to run the quantum task on.

it_tags TYPE /AWS1/CL_BRKTAGSMAP_W=>TT_TAGSMAP TT_TAGSMAP

Tags to be added to the quantum task you're creating.

iv_jobtoken TYPE /AWS1/BRKJOBTOKEN /AWS1/BRKJOBTOKEN

The token for an Amazon Braket hybrid job that associates it with the quantum task.

it_associations TYPE /AWS1/CL_BRKASSOCIATION=>TT_ASSOCIATIONS TT_ASSOCIATIONS

The list of Amazon Braket resources associated with the quantum task.

io_experimentalcapabilities TYPE REF TO /AWS1/CL_BRKEXPERIMENTALCAPA00 /AWS1/CL_BRKEXPERIMENTALCAPA00

Enable experimental capabilities for the quantum task.

RETURNING

oo_output TYPE REF TO /aws1/cl_brkcrequantumtaskrsp /AWS1/CL_BRKCREQUANTUMTASKRSP

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->createquantumtask(
  io_experimentalcapabilities = new /aws1/cl_brkexperimentalcapa00( |string| )
  it_associations = VALUE /aws1/cl_brkassociation=>tt_associations(
    (
      new /aws1/cl_brkassociation(
        iv_arn = |string|
        iv_type = |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_action = |string|
  iv_clienttoken = |string|
  iv_devicearn = |string|
  iv_deviceparameters = |string|
  iv_jobtoken = |string|
  iv_outputs3bucket = |string|
  iv_outputs3keyprefix = |string|
  iv_shots = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_quantumtaskarn = lo_result->get_quantumtaskarn( ).
ENDIF.