Skip to content

/AWS1/IF_CPD=>DESCRIBEENDPOINT()

About DescribeEndpoint

Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints.

Method Signature

IMPORTING

Required arguments:

iv_endpointarn TYPE /AWS1/CPDCOMPREHENDENDPOINTARN /AWS1/CPDCOMPREHENDENDPOINTARN

The Amazon Resource Number (ARN) of the endpoint being described.

RETURNING

oo_output TYPE REF TO /aws1/cl_cpddescrendptresponse /AWS1/CL_CPDDESCRENDPTRESPONSE

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_cpd~describeendpoint( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_endpointproperties = lo_result->get_endpointproperties( ).
  IF lo_endpointproperties IS NOT INITIAL.
    lv_comprehendendpointarn = lo_endpointproperties->get_endpointarn( ).
    lv_endpointstatus = lo_endpointproperties->get_status( ).
    lv_anylengthstring = lo_endpointproperties->get_message( ).
    lv_comprehendmodelarn = lo_endpointproperties->get_modelarn( ).
    lv_comprehendmodelarn = lo_endpointproperties->get_desiredmodelarn( ).
    lv_inferenceunitsinteger = lo_endpointproperties->get_desiredinferenceunits( ).
    lv_inferenceunitsinteger = lo_endpointproperties->get_currentinferenceunits( ).
    lv_timestamp = lo_endpointproperties->get_creationtime( ).
    lv_timestamp = lo_endpointproperties->get_lastmodifiedtime( ).
    lv_iamrolearn = lo_endpointproperties->get_dataaccessrolearn( ).
    lv_iamrolearn = lo_endpointproperties->get_desireddataaccessrolearn( ).
    lv_comprehendflywheelarn = lo_endpointproperties->get_flywheelarn( ).
  ENDIF.
ENDIF.