GETSINK()`¶

About GetSink¶

Returns complete information about one monitoring account sink.

To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_identifier` `TYPE /AWS1/OAMRESOURCEIDENTIFIER` `/AWS1/OAMRESOURCEIDENTIFIER`¶

The ARN of the sink to retrieve information for.

Optional arguments:¶

`iv_includetags` `TYPE /AWS1/OAMINCLUDETAGS` `/AWS1/OAMINCLUDETAGS`¶

Specifies whether to include the tags associated with the sink in the response. When IncludeTags is set to true and the caller has the required permission, oam:ListTagsForResource, the API will return the tags for the specified resource. If the caller doesn't have the required permission, oam:ListTagsForResource, the API will raise an exception.

The default value is false.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_oamgetsinkoutput` `/AWS1/CL_OAMGETSINKOUTPUT`¶

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->/aws1/if_oam~getsink(
  iv_identifier = |string|
  iv_includetags = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_arn( ).
  lv_string = lo_result->get_id( ).
  lv_string = lo_result->get_name( ).
  LOOP AT lo_result->get_tags( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      lv_string = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/CL_OAM=>GETSINK()¶