Skip to content

/AWS1/CL_STG=>DESCRIBENFSFILESHARES()

About DescribeNFSFileShares

Gets a description for one or more Network File System (NFS) file shares from an S3 File Gateway. This operation is only supported for S3 File Gateways.

Method Signature

IMPORTING

Required arguments:

it_filesharearnlist TYPE /AWS1/CL_STGFILESHAREARNLIST_W=>TT_FILESHAREARNLIST TT_FILESHAREARNLIST

An array containing the Amazon Resource Name (ARN) of each file share to be described.

RETURNING

oo_output TYPE REF TO /aws1/cl_stgdscnfsfileshares01 /AWS1/CL_STGDSCNFSFILESHARES01

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_stg~describenfsfileshares(
  it_filesharearnlist = VALUE /aws1/cl_stgfilesharearnlist_w=>tt_filesharearnlist(
    ( new /aws1/cl_stgfilesharearnlist_w( |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_nfsfileshareinfolist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lo_nfsfilesharedefaults = lo_row_1->get_nfsfilesharedefaults( ).
      IF lo_nfsfilesharedefaults IS NOT INITIAL.
        lv_permissionmode = lo_nfsfilesharedefaults->get_filemode( ).
        lv_permissionmode = lo_nfsfilesharedefaults->get_directorymode( ).
        lv_permissionid = lo_nfsfilesharedefaults->get_groupid( ).
        lv_permissionid = lo_nfsfilesharedefaults->get_ownerid( ).
      ENDIF.
      lv_filesharearn = lo_row_1->get_filesharearn( ).
      lv_fileshareid = lo_row_1->get_fileshareid( ).
      lv_filesharestatus = lo_row_1->get_filesharestatus( ).
      lv_gatewayarn = lo_row_1->get_gatewayarn( ).
      lv_encryptiontype = lo_row_1->get_encryptiontype( ).
      lv_boolean2 = lo_row_1->get_kmsencrypted( ).
      lv_kmskey = lo_row_1->get_kmskey( ).
      lv_path = lo_row_1->get_path( ).
      lv_role = lo_row_1->get_role( ).
      lv_locationarn = lo_row_1->get_locationarn( ).
      lv_storageclass = lo_row_1->get_defaultstorageclass( ).
      lv_objectacl = lo_row_1->get_objectacl( ).
      LOOP AT lo_row_1->get_clientlist( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_ipv4addresscidr = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_squash = lo_row_1->get_squash( ).
      lv_boolean = lo_row_1->get_readonly( ).
      lv_boolean = lo_row_1->get_guessmimetypeenabled( ).
      lv_boolean = lo_row_1->get_requesterpays( ).
      LOOP AT lo_row_1->get_tags( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_tagkey = lo_row_5->get_key( ).
          lv_tagvalue = lo_row_5->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_filesharename = lo_row_1->get_filesharename( ).
      lo_cacheattributes = lo_row_1->get_cacheattributes( ).
      IF lo_cacheattributes IS NOT INITIAL.
        lv_cachestaletimeoutinseco = lo_cacheattributes->get_cachestaletmoutinseconds( ).
      ENDIF.
      lv_notificationpolicy = lo_row_1->get_notificationpolicy( ).
      lv_dnshostname = lo_row_1->get_vpcendpointdnsname( ).
      lv_regionid = lo_row_1->get_bucketregion( ).
      lv_auditdestinationarn = lo_row_1->get_auditdestinationarn( ).
    ENDIF.
  ENDLOOP.
ENDIF.