Skip to content

/AWS1/IF_ESS=>LISTVPCENDPOINTACCESS()

About ListVpcEndpointAccess

Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Method Signature

METHODS /AWS1/IF_ESS~LISTVPCENDPOINTACCESS
  IMPORTING
    !IV_DOMAINNAME TYPE /AWS1/ESSDOMAINNAME OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/ESSNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_esslistvpcendptaccrsp
  RAISING
    /AWS1/CX_ESSBASEEXCEPTION
    /AWS1/CX_ESSDISABLEDOPEX
    /AWS1/CX_ESSINTERNALEXCEPTION
    /AWS1/CX_ESSRESOURCENOTFOUNDEX
    /AWS1/CX_ESSCLIENTEXC
    /AWS1/CX_ESSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_domainname TYPE /AWS1/ESSDOMAINNAME /AWS1/ESSDOMAINNAME

The name of the OpenSearch Service domain to retrieve access information for.

Optional arguments:

iv_nexttoken TYPE /AWS1/ESSNEXTTOKEN /AWS1/ESSNEXTTOKEN

Provides an identifier to allow retrieval of paginated results.

RETURNING

oo_output TYPE REF TO /aws1/cl_esslistvpcendptaccrsp /AWS1/CL_ESSLISTVPCENDPTACCRSP

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->listvpcendpointaccess(
  iv_domainname = |string|
  iv_nexttoken = |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_authorizedprincipallist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_principaltype = lo_row_1->get_principaltype( ).
      lv_string = lo_row_1->get_principal( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.