GETINVESTIGATION()`¶

About GetInvestigation¶

This API is currently available as a preview. This feature is available in the following Amazon Web Services Regions: US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Paris), Europe (Stockholm), and Asia Pacific (Tokyo).

Retrieves the results and status of a specific GuardDuty investigation.

An administrator account can retrieve any investigation within the organization. Member accounts can only retrieve investigations that belong to them.

Method Signature¶

METHODS /AWS1/IF_GDY~GETINVESTIGATION
  IMPORTING
    !IV_DETECTORID TYPE /AWS1/GDYDETECTORID OPTIONAL
    !IV_INVESTIGATIONID TYPE /AWS1/GDYINVESTIGATIONID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gdygetinvestgtnrsp
  RAISING
    /AWS1/CX_GDYACCESSDENIEDEX
    /AWS1/CX_GDYBADREQUESTEX
    /AWS1/CX_GDYINTERNALSERVERER00
    /AWS1/CX_GDYRESOURCENOTFOUNDEX
    /AWS1/CX_GDYCLIENTEXC
    /AWS1/CX_GDYSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_detectorid` `TYPE /AWS1/GDYDETECTORID` `/AWS1/GDYDETECTORID`¶

The unique ID of the GuardDuty detector associated with the investigation.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

`iv_investigationid` `TYPE /AWS1/GDYINVESTIGATIONID` `/AWS1/GDYINVESTIGATIONID`¶

The unique identifier of the investigation to retrieve.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_gdygetinvestgtnrsp` `/AWS1/CL_GDYGETINVESTGTNRSP`¶

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->getinvestigation(
  iv_detectorid = |string|
  iv_investigationid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_investigation = lo_result->get_investigation( ).
  IF lo_investigation IS NOT INITIAL.
    lv_investigationid = lo_investigation->get_investigationid( ).
    lv_investigationstatus = lo_investigation->get_status( ).
    lv_triggerprompt = lo_investigation->get_triggerprompt( ).
    lv_triggeredby = lo_investigation->get_triggeredby( ).
    lo_investigationmetadata = lo_investigation->get_metadata( ).
    IF lo_investigationmetadata IS NOT INITIAL.
      lv_string = lo_investigationmetadata->get_version( ).
      lo_product = lo_investigationmetadata->get_product( ).
      IF lo_product IS NOT INITIAL.
        lv_string = lo_product->get_name( ).
        lv_string = lo_product->get_feature( ).
      ENDIF.
    ENDIF.
    lo_clouddetails = lo_investigation->get_cloud( ).
    IF lo_clouddetails IS NOT INITIAL.
      lv_cloudprovider = lo_clouddetails->get_provider( ).
      lv_string = lo_clouddetails->get_region( ).
      lv_string = lo_clouddetails->get_account( ).
    ENDIF.
    lv_risklevel = lo_investigation->get_risklevel( ).
    lv_riskdetails = lo_investigation->get_risk( ).
    lv_confidence = lo_investigation->get_confidence( ).
    lv_string = lo_investigation->get_summary( ).
    lv_timestamp = lo_investigation->get_starttime( ).
    lv_timestamp = lo_investigation->get_endtime( ).
    lv_investigationerrordetai = lo_investigation->get_error( ).
  ENDIF.
ENDIF.

/AWS1/IF_GDY=>GETINVESTIGATION()¶