DESCRIBEACCESSPOINTS()`¶

About DescribeAccessPoints¶

Returns the description of a specific Amazon EFS access point if the AccessPointId is provided. If you provide an EFS FileSystemId, it returns descriptions of all access points for that file system. You can provide either an AccessPointId or a FileSystemId in the request, but not both.

This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.

Method Signature¶

METHODS /AWS1/IF_EFS~DESCRIBEACCESSPOINTS
  IMPORTING
    !IV_MAXRESULTS TYPE /AWS1/EFSMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EFSTOKEN OPTIONAL
    !IV_ACCESSPOINTID TYPE /AWS1/EFSACCESSPOINTID OPTIONAL
    !IV_FILESYSTEMID TYPE /AWS1/EFSFILESYSTEMID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_efsdescraccpointsrsp
  RAISING
    /AWS1/CX_EFSACCPOINTNOTFOUND
    /AWS1/CX_EFSBADREQUEST
    /AWS1/CX_EFSFILESYSTEMNOTFOUND
    /AWS1/CX_EFSINTERNALSERVERERR
    /AWS1/CX_EFSCLIENTEXC
    /AWS1/CX_EFSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/EFSMAXRESULTS` `/AWS1/EFSMAXRESULTS`¶

(Optional) When retrieving all access points for a file system, you can optionally specify the MaxItems parameter to limit the number of objects returned in a response.
The default value is 100.

`iv_nexttoken` `TYPE /AWS1/EFSTOKEN` `/AWS1/EFSTOKEN`¶

NextToken is present if the response is paginated. You can use NextMarker in the subsequent request to fetch the next page of access point descriptions.

`iv_accesspointid` `TYPE /AWS1/EFSACCESSPOINTID` `/AWS1/EFSACCESSPOINTID`¶

(Optional) Specifies an EFS access point to describe in the response; mutually exclusive with FileSystemId.

`iv_filesystemid` `TYPE /AWS1/EFSFILESYSTEMID` `/AWS1/EFSFILESYSTEMID`¶

(Optional) If you provide a FileSystemId, EFS returns all access points for that file system; mutually exclusive with AccessPointId.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_efsdescraccpointsrsp` `/AWS1/CL_EFSDESCRACCPOINTSRSP`¶

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->describeaccesspoints(
  iv_accesspointid = |string|
  iv_filesystemid = |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_accesspoints( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_clienttoken = lo_row_1->get_clienttoken( ).
      lv_name = lo_row_1->get_name( ).
      LOOP AT lo_row_1->get_tags( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_tagkey = lo_row_3->get_key( ).
          lv_tagvalue = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_accesspointid = lo_row_1->get_accesspointid( ).
      lv_accesspointarn = lo_row_1->get_accesspointarn( ).
      lv_filesystemid = lo_row_1->get_filesystemid( ).
      lo_posixuser = lo_row_1->get_posixuser( ).
      IF lo_posixuser IS NOT INITIAL.
        lv_uid = lo_posixuser->get_uid( ).
        lv_gid = lo_posixuser->get_gid( ).
        LOOP AT lo_posixuser->get_secondarygids( ) into lo_row_4.
          lo_row_5 = lo_row_4.
          IF lo_row_5 IS NOT INITIAL.
            lv_gid = lo_row_5->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      lo_rootdirectory = lo_row_1->get_rootdirectory( ).
      IF lo_rootdirectory IS NOT INITIAL.
        lv_path = lo_rootdirectory->get_path( ).
        lo_creationinfo = lo_rootdirectory->get_creationinfo( ).
        IF lo_creationinfo IS NOT INITIAL.
          lv_owneruid = lo_creationinfo->get_owneruid( ).
          lv_ownergid = lo_creationinfo->get_ownergid( ).
          lv_permissions = lo_creationinfo->get_permissions( ).
        ENDIF.
      ENDIF.
      lv_awsaccountid = lo_row_1->get_ownerid( ).
      lv_lifecyclestate = lo_row_1->get_lifecyclestate( ).
    ENDIF.
  ENDLOOP.
  lv_token = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_EFS=>DESCRIBEACCESSPOINTS()¶