Skip to content

/AWS1/IF_SHB=>LISTFREETRIALSTATUSESV2()

About ListFreeTrialStatusesV2

Lists the free trial status of Security Hub features. A delegated Security Hub administrator can list the status for accounts in its organization. Any other account can list the status only for itself. Free trial status remains available after a feature is disabled.

Method Signature

METHODS /AWS1/IF_SHB~LISTFREETRIALSTATUSESV2
  IMPORTING
    !IT_ACCOUNTIDS TYPE /AWS1/CL_SHBFRETRIALACCIDLST_W=>TT_FREETRIALACCOUNTIDLIST OPTIONAL
    !IT_STATUSES TYPE /AWS1/CL_SHBFRETRIALSTATVALL00=>TT_FREETRIALSTATUSVALUELIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SHBMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SHBNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_shblstfretrialstsv201
  RAISING
    /AWS1/CX_SHBACCESSDENIEDEX
    /AWS1/CX_SHBINTERNALSERVEREX
    /AWS1/CX_SHBRESOURCENOTFOUNDEX
    /AWS1/CX_SHBTHROTTLINGEX
    /AWS1/CX_SHBVALIDATIONEX
    /AWS1/CX_SHBCLIENTEXC
    /AWS1/CX_SHBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

it_accountids TYPE /AWS1/CL_SHBFRETRIALACCIDLST_W=>TT_FREETRIALACCOUNTIDLIST TT_FREETRIALACCOUNTIDLIST

The Amazon Web Services account identifiers to list free trial status for. You can specify accounts other than your own only if you are a delegated Security Hub administrator.

it_statuses TYPE /AWS1/CL_SHBFRETRIALSTATVALL00=>TT_FREETRIALSTATUSVALUELIST TT_FREETRIALSTATUSVALUELIST

The free trial statuses to filter the results by. Valid values:

  • ACTIVE returns only features with an ongoing free trial period.

  • INACTIVE returns only features whose free trial period has ended, or that never started.

iv_maxresults TYPE /AWS1/SHBMAXRESULTS /AWS1/SHBMAXRESULTS

The maximum number of results to return. If you don't specify a value, Security Hub returns up to 100 results.

iv_nexttoken TYPE /AWS1/SHBNEXTTOKEN /AWS1/SHBNEXTTOKEN

The pagination token to request the next page of results.

RETURNING

oo_output TYPE REF TO /aws1/cl_shblstfretrialstsv201 /AWS1/CL_SHBLSTFRETRIALSTSV201

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->listfreetrialstatusesv2(
  it_accountids = VALUE /aws1/cl_shbfretrialaccidlst_w=>tt_freetrialaccountidlist(
    ( new /aws1/cl_shbfretrialaccidlst_w( |string| ) )
  )
  it_statuses = VALUE /aws1/cl_shbfretrialstatvall00=>tt_freetrialstatusvaluelist(
    ( new /aws1/cl_shbfretrialstatvall00( |string| ) )
  )
  iv_maxresults = 123
  iv_nexttoken = |string|
).

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_accountfreetrialstatuses( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_freetrialaccountid = lo_row_1->get_accountid( ).
      lv_timestamp = lo_row_1->get_evaluatedat( ).
      LOOP AT lo_row_1->get_freetrialstatuses( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_freetrialtype = lo_row_3->get_featuretype( ).
          lv_freetrialstatusvalue = lo_row_3->get_status( ).
          lv_timestamp = lo_row_3->get_startedat( ).
          lv_timestamp = lo_row_3->get_expiresat( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.