DESCRIBEPRODUCTS()`¶

About DescribeProducts¶

Returns information about product integrations in Security Hub.

You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration.

If you don't provide an integration ARN, then the results include all of the available product integrations.

Method Signature¶

METHODS /AWS1/IF_SHB~DESCRIBEPRODUCTS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/SHBNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SHBMAXRESULTS OPTIONAL
    !IV_PRODUCTARN TYPE /AWS1/SHBNONEMPTYSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_shbdescrproductsrsp
  RAISING
    /AWS1/CX_SHBINTERNALEXCEPTION
    /AWS1/CX_SHBINVALIDACCESSEX
    /AWS1/CX_SHBINVALIDINPUTEX
    /AWS1/CX_SHBLIMITEXCEEDEDEX
    /AWS1/CX_SHBCLIENTEXC
    /AWS1/CX_SHBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/SHBNEXTTOKEN` `/AWS1/SHBNEXTTOKEN`¶

The token that is required for pagination. On your first call to the DescribeProducts operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

`iv_maxresults` `TYPE /AWS1/SHBMAXRESULTS` `/AWS1/SHBMAXRESULTS`¶

The maximum number of results to return.

`iv_productarn` `TYPE /AWS1/SHBNONEMPTYSTRING` `/AWS1/SHBNONEMPTYSTRING`¶

The ARN of the integration to return.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_shbdescrproductsrsp` `/AWS1/CL_SHBDESCRPRODUCTSRSP`¶

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->describeproducts(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_productarn = |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_products( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_nonemptystring = lo_row_1->get_productarn( ).
      lv_nonemptystring = lo_row_1->get_productname( ).
      lv_nonemptystring = lo_row_1->get_companyname( ).
      lv_nonemptystring = lo_row_1->get_description( ).
      LOOP AT lo_row_1->get_categories( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_nonemptystring = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_integrationtypes( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_integrationtype = lo_row_5->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_nonemptystring = lo_row_1->get_marketplaceurl( ).
      lv_nonemptystring = lo_row_1->get_activationurl( ).
      lv_nonemptystring = lo_row_1->get_productsubscriptionres00( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

To get information about Security Hub integrations¶

The following example returns details about AWS services and third-party products that Security Hub integrates with.

DATA(lo_result) = lo_client->describeproducts(
  iv_maxresults = 1
  iv_nexttoken = |NULL|
  iv_productarn = |arn:aws:securityhub:us-east-1:517716713836:product/crowdstrike/crowdstrike-falcon|
).

/AWS1/IF_SHB=>DESCRIBEPRODUCTS()¶