Skip to content

/AWS1/IF_EC2=>CREATECAPACITYRESVCANCLQUOTE()

About CreateCapacityReservationCancellationQuote

Generates a cancellation quote for a future-dated Capacity Reservation that is within its commitment duration. The quote includes the cancellation terms and a quote ID that you can pass to the CancelCapacityReservation action. Cancellation quotes are valid for 24 hours.

Method Signature

METHODS /AWS1/IF_EC2~CREATECAPACITYRESVCANCLQUOTE
  IMPORTING
    !IV_CAPACITYRESERVATIONID TYPE /AWS1/EC2CAPACITYRESERVATIONID OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
    !IT_TAGSPECIFICATIONS TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2crecaprsvcancqters
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_capacityreservationid TYPE /AWS1/EC2CAPACITYRESERVATIONID /AWS1/EC2CAPACITYRESERVATIONID

The ID of the Capacity Reservation.

Optional arguments:

iv_clienttoken TYPE /AWS1/EC2STRING /AWS1/EC2STRING

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

it_tagspecifications TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST TT_TAGSPECIFICATIONLIST

The tags to apply to the cancellation quote.

iv_dryrun TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2crecaprsvcancqters /AWS1/CL_EC2CRECAPRSVCANCQTERS

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->createcapacityresvcanclquote(
  it_tagspecifications = VALUE /aws1/cl_ec2tagspecification=>tt_tagspecificationlist(
    (
      new /aws1/cl_ec2tagspecification(
        it_tags = VALUE /aws1/cl_ec2tag=>tt_taglist(
          (
            new /aws1/cl_ec2tag(
              iv_key = |string|
              iv_value = |string|
            )
          )
        )
        iv_resourcetype = |string|
      )
    )
  )
  iv_capacityreservationid = |string|
  iv_clienttoken = |string|
  iv_dryrun = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_capacityreservationcanc = lo_result->get_capacityresvcanclquote( ).
  IF lo_capacityreservationcanc IS NOT INITIAL.
    lv_capacityreservationcanc_1 = lo_capacityreservationcanc->get_capacityresvcanclquoteid( ).
    lv_capacityreservationid = lo_capacityreservationcanc->get_capacityreservationid( ).
    lv_milliseconddatetime = lo_capacityreservationcanc->get_createtime( ).
    lv_milliseconddatetime = lo_capacityreservationcanc->get_expirationtime( ).
    lv_capacityreservationcanc_2 = lo_capacityreservationcanc->get_quotestate( ).
    lo_capacityreservationconf = lo_capacityreservationcanc->get_currentconfiguration( ).
    IF lo_capacityreservationconf IS NOT INITIAL.
      lv_integer = lo_capacityreservationconf->get_instancecount( ).
      lv_string = lo_capacityreservationconf->get_reservationstate( ).
    ENDIF.
    LOOP AT lo_capacityreservationcanc->get_cancellationterms( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_applycancellationcharge = lo_row_1->get_cancellationtype( ).
        lv_string = lo_row_1->get_reservationstate( ).
        lv_boxedinteger = lo_row_1->get_committedinstancecount( ).
        lv_boxedlong = lo_row_1->get_chargecommitmentdurhours( ).
        lv_milliseconddatetime = lo_row_1->get_chargeenddate( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_capacityreservationcanc->get_tags( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_string = lo_row_3->get_key( ).
        lv_string = lo_row_3->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.