LISTVPCENDPOINTS()`¶

About ListVpcEndpoints¶

Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

Method Signature¶

METHODS /AWS1/IF_OSS~LISTVPCENDPOINTS
  IMPORTING
    !IO_VPCENDPOINTFILTERS TYPE REF TO /AWS1/CL_OSSVPCENDPOINTFILTERS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/OSSSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/OSSINTEGER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_osslistvpcendptsrsp
  RAISING
    /AWS1/CX_OSSINTERNALSERVEREX
    /AWS1/CX_OSSVALIDATIONEX
    /AWS1/CX_OSSCLIENTEXC
    /AWS1/CX_OSSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`io_vpcendpointfilters` `TYPE REF TO /AWS1/CL_OSSVPCENDPOINTFILTERS` `/AWS1/CL_OSSVPCENDPOINTFILTERS`¶

Filter the results according to the current status of the VPC endpoint. Possible statuses are CREATING, DELETING, UPDATING, ACTIVE, and FAILED.

`iv_nexttoken` `TYPE /AWS1/OSSSTRING` `/AWS1/OSSSTRING`¶

If your initial ListVpcEndpoints operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.

`iv_maxresults` `TYPE /AWS1/OSSINTEGER` `/AWS1/OSSINTEGER`¶

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_osslistvpcendptsrsp` `/AWS1/CL_OSSLISTVPCENDPTSRSP`¶

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->listvpcendpoints(
  io_vpcendpointfilters = new /aws1/cl_ossvpcendpointfilters( |string| )
  iv_maxresults = 123
  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_vpcendpointsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_vpcendpointid = lo_row_1->get_id( ).
      lv_vpcendpointname = lo_row_1->get_name( ).
      lv_vpcendpointstatus = lo_row_1->get_status( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_OSS=>LISTVPCENDPOINTS()¶