DESCRIBEINSIGHTDETAILS()`¶

About DescribeInsightDetails¶

Describes the details of an existing insight for an Amazon OpenSearch Service domain. Returns detailed fields associated with the specified insight, such as text descriptions and metric data.

Method Signature¶

METHODS /AWS1/IF_OSR~DESCRIBEINSIGHTDETAILS
  IMPORTING
    !IO_ENTITY TYPE REF TO /AWS1/CL_OSRINSIGHTENTITY OPTIONAL
    !IV_INSIGHTID TYPE /AWS1/OSRGUID OPTIONAL
    !IV_SHOWHTMLCONTENT TYPE /AWS1/OSRBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_osrdscinsightdetsrsp
  RAISING
    /AWS1/CX_OSRBASEEXCEPTION
    /AWS1/CX_OSRDISABLEDOPEX
    /AWS1/CX_OSRINTERNALEXCEPTION
    /AWS1/CX_OSRLIMITEXCEEDEDEX
    /AWS1/CX_OSRRESOURCENOTFOUNDEX
    /AWS1/CX_OSRVALIDATIONEX
    /AWS1/CX_OSRCLIENTEXC
    /AWS1/CX_OSRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`io_entity` `TYPE REF TO /AWS1/CL_OSRINSIGHTENTITY` `/AWS1/CL_OSRINSIGHTENTITY`¶

The entity for which to retrieve insight details. Specifies the type and value of the entity, such as a domain name or Amazon Web Services account ID.

`iv_insightid` `TYPE /AWS1/OSRGUID` `/AWS1/OSRGUID`¶

The unique identifier of the insight to describe.

Optional arguments:¶

`iv_showhtmlcontent` `TYPE /AWS1/OSRBOOLEAN` `/AWS1/OSRBOOLEAN`¶

Specifies whether to show response with HTML content in response or not.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_osrdscinsightdetsrsp` `/AWS1/CL_OSRDSCINSIGHTDETSRSP`¶

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->describeinsightdetails(
  io_entity = new /aws1/cl_osrinsightentity(
    iv_type = |string|
    iv_value = |string|
  )
  iv_insightid = |string|
  iv_showhtmlcontent = 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_fields( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_name( ).
      lv_insightfieldtype = lo_row_1->get_type( ).
      lv_string = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_OSR=>DESCRIBEINSIGHTDETAILS()¶