CREATESPENDINGLIMIT()`¶

About CreateSpendingLimit¶

Creates a spending limit for a specified quantum device. Spending limits help you control costs by setting maximum amounts that can be spent on quantum computing tasks within a specified time period. Simulators do not support spending limits.

Method Signature¶

METHODS /AWS1/IF_BRK~CREATESPENDINGLIMIT
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/BRKSTRING64 OPTIONAL
    !IV_DEVICEARN TYPE /AWS1/BRKDEVICEARN OPTIONAL
    !IV_SPENDINGLIMIT TYPE /AWS1/BRKSTRING OPTIONAL
    !IO_TIMEPERIOD TYPE REF TO /AWS1/CL_BRKTIMEPERIOD OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_BRKTAGSMAP_W=>TT_TAGSMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_brkcrespendinglmtrsp
  RAISING
    /AWS1/CX_BRKACCESSDENIEDEX
    /AWS1/CX_BRKDEVICERETIREDEX
    /AWS1/CX_BRKINTERNALSERVICEEX
    /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`¶

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Braket ignores the request, but does not return an error.

`iv_devicearn` `TYPE /AWS1/BRKDEVICEARN` `/AWS1/BRKDEVICEARN`¶

The Amazon Resource Name (ARN) of the quantum device to apply the spending limit to.

`iv_spendinglimit` `TYPE /AWS1/BRKSTRING` `/AWS1/BRKSTRING`¶

The maximum amount that can be spent on the specified device, in USD.

Optional arguments:¶

`io_timeperiod` `TYPE REF TO /AWS1/CL_BRKTIMEPERIOD` `/AWS1/CL_BRKTIMEPERIOD`¶

The time period during which the spending limit is active, including start and end dates.

`it_tags` `TYPE /AWS1/CL_BRKTAGSMAP_W=>TT_TAGSMAP` `TT_TAGSMAP`¶

The tags to apply to the spending limit. Each tag consists of a key and an optional value.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_brkcrespendinglmtrsp` `/AWS1/CL_BRKCRESPENDINGLMTRSP`¶

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->createspendinglimit(
  io_timeperiod = new /aws1/cl_brktimeperiod(
    iv_endat = '20150101000000.0000000'
    iv_startat = '20150101000000.0000000'
  )
  it_tags = VALUE /aws1/cl_brktagsmap_w=>tt_tagsmap(
    (
      VALUE /aws1/cl_brktagsmap_w=>ts_tagsmap_maprow(
        value = new /aws1/cl_brktagsmap_w( |string| )
        key = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_devicearn = |string|
  iv_spendinglimit = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_spendinglimitarn = lo_result->get_spendinglimitarn( ).
ENDIF.

/AWS1/IF_BRK=>CREATESPENDINGLIMIT()¶