Skip to content

/AWS1/IF_RSH=>DESCRIBEENDPOINTACCESS()

About DescribeEndpointAccess

Describes a Redshift-managed VPC endpoint.

Method Signature

METHODS /AWS1/IF_RSH~DESCRIBEENDPOINTACCESS
  IMPORTING
    !IV_CLUSTERIDENTIFIER TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_RESOURCEOWNER TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_ENDPOINTNAME TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_VPCID TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/RSHINTEGEROPTIONAL OPTIONAL
    !IV_MARKER TYPE /AWS1/RSHSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rshendpointaccesslist
  RAISING
    /AWS1/CX_RSHCLUSTNOTFOUNDFAULT
    /AWS1/CX_RSHENDPTNOTFOUNDFAULT
    /AWS1/CX_RSHINVCLUSTSTATEFAULT
    /AWS1/CX_RSHCLIENTEXC
    /AWS1/CX_RSHSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_clusteridentifier TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

The cluster identifier associated with the described endpoint.

iv_resourceowner TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

The Amazon Web Services account ID of the owner of the cluster.

iv_endpointname TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

The name of the endpoint to be described.

iv_vpcid TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

The virtual private cloud (VPC) identifier with access to the cluster.

iv_maxrecords TYPE /AWS1/RSHINTEGEROPTIONAL /AWS1/RSHINTEGEROPTIONAL

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a Marker is included in the response so that the remaining results can be retrieved.

iv_marker TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

An optional pagination token provided by a previous DescribeEndpointAccess request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

RETURNING

oo_output TYPE REF TO /aws1/cl_rshendpointaccesslist /AWS1/CL_RSHENDPOINTACCESSLIST

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->describeendpointaccess(
  iv_clusteridentifier = |string|
  iv_endpointname = |string|
  iv_marker = |string|
  iv_maxrecords = 123
  iv_resourceowner = |string|
  iv_vpcid = |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_endpointaccesslist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_clusteridentifier( ).
      lv_string = lo_row_1->get_resourceowner( ).
      lv_string = lo_row_1->get_subnetgroupname( ).
      lv_string = lo_row_1->get_endpointstatus( ).
      lv_string = lo_row_1->get_endpointname( ).
      lv_tstamp = lo_row_1->get_endpointcreatetime( ).
      lv_integer = lo_row_1->get_port( ).
      lv_string = lo_row_1->get_address( ).
      LOOP AT lo_row_1->get_vpcsecuritygroups( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_vpcsecuritygroupid( ).
          lv_string = lo_row_3->get_status( ).
        ENDIF.
      ENDLOOP.
      lo_vpcendpoint = lo_row_1->get_vpcendpoint( ).
      IF lo_vpcendpoint IS NOT INITIAL.
        lv_string = lo_vpcendpoint->get_vpcendpointid( ).
        lv_string = lo_vpcendpoint->get_vpcid( ).
        LOOP AT lo_vpcendpoint->get_networkinterfaces( ) into lo_row_4.
          lo_row_5 = lo_row_4.
          IF lo_row_5 IS NOT INITIAL.
            lv_string = lo_row_5->get_networkinterfaceid( ).
            lv_string = lo_row_5->get_subnetid( ).
            lv_string = lo_row_5->get_privateipaddress( ).
            lv_string = lo_row_5->get_availabilityzone( ).
            lv_string = lo_row_5->get_ipv6address( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_marker( ).
ENDIF.