CANCELSPOTFLEETREQUESTS()`¶

About CancelSpotFleetRequests¶

Cancels the specified Spot Fleet requests.

After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.

You must also specify whether a canceled Spot Fleet request should terminate its instances. If you choose to terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.

Terminating an instance is permanent and irreversible.

After you terminate an instance, you can no longer connect to it, and it can't be recovered. All attached Amazon EBS volumes that are configured to be deleted on termination are also permanently deleted and can't be recovered. All data stored on instance store volumes is permanently lost. For more information, see How instance termination works.

Before you terminate an instance, ensure that you have backed up all data that you need to retain after the termination to persistent storage.

Restrictions

You can delete up to 100 fleets in a single request. If you exceed the specified number, no fleets are deleted.

Method Signature¶

METHODS /AWS1/IF_EC2~CANCELSPOTFLEETREQUESTS
  IMPORTING
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IT_SPOTFLEETREQUESTIDS TYPE /AWS1/CL_EC2SPOTFLEETREQIDLS00=>TT_SPOTFLEETREQUESTIDLIST OPTIONAL
    !IV_TERMINATEINSTANCES TYPE /AWS1/EC2BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2cancspotfleetreq01
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`it_spotfleetrequestids` `TYPE /AWS1/CL_EC2SPOTFLEETREQIDLS00=>TT_SPOTFLEETREQUESTIDLIST` `TT_SPOTFLEETREQUESTIDLIST`¶

The IDs of the Spot Fleet requests.

Constraint: You can specify up to 100 IDs in a single request.

`iv_terminateinstances` `TYPE /AWS1/EC2BOOLEAN` `/AWS1/EC2BOOLEAN`¶

Indicates whether to terminate the associated instances when the Spot Fleet request is canceled. The default is to terminate the instances.

To let the instances continue to run after the Spot Fleet request is canceled, specify no-terminate-instances.

Optional arguments:¶

`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_ec2cancspotfleetreq01` `/AWS1/CL_EC2CANCSPOTFLEETREQ01`¶

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->cancelspotfleetrequests(
  it_spotfleetrequestids = VALUE /aws1/cl_ec2spotfleetreqidls00=>tt_spotfleetrequestidlist(
    ( new /aws1/cl_ec2spotfleetreqidls00( |string| ) )
  )
  iv_dryrun = ABAP_TRUE
  iv_terminateinstances = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_successfulfleetrequests( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_batchstate = lo_row_1->get_currentspotfleetreqstate( ).
      lv_batchstate = lo_row_1->get_previousspotfleetreqst00( ).
      lv_string = lo_row_1->get_spotfleetrequestid( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_unsuccfulfleetrequests( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lo_cancelspotfleetrequests = lo_row_3->get_error( ).
      IF lo_cancelspotfleetrequests IS NOT INITIAL.
        lv_cancelbatcherrorcode = lo_cancelspotfleetrequests->get_code( ).
        lv_string = lo_cancelspotfleetrequests->get_message( ).
      ENDIF.
      lv_string = lo_row_3->get_spotfleetrequestid( ).
    ENDIF.
  ENDLOOP.
ENDIF.

To cancel a Spot fleet request¶

This example cancels the specified Spot fleet request and terminates its associated Spot Instances.

DATA(lo_result) = lo_client->cancelspotfleetrequests(
  it_spotfleetrequestids = VALUE /aws1/cl_ec2spotfleetreqidls00=>tt_spotfleetrequestidlist(
    ( new /aws1/cl_ec2spotfleetreqidls00( |sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE| ) )
  )
  iv_terminateinstances = ABAP_TRUE
).

To cancel a Spot fleet request without terminating its Spot Instances¶

This example cancels the specified Spot fleet request without terminating its associated Spot Instances.

DATA(lo_result) = lo_client->cancelspotfleetrequests(
  it_spotfleetrequestids = VALUE /aws1/cl_ec2spotfleetreqidls00=>tt_spotfleetrequestidlist(
    ( new /aws1/cl_ec2spotfleetreqidls00( |sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE| ) )
  )
  iv_terminateinstances = ABAP_FALSE
).

/AWS1/IF_EC2=>CANCELSPOTFLEETREQUESTS()¶