LISTACCESSGRANTSLOCATIONS()`¶

About ListAccessGrantsLocations¶

Returns a list of the locations registered in your S3 Access Grants instance.

Permissions: You must have the s3:ListAccessGrantsLocations permission to use this operation.

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

Method Signature¶

METHODS /AWS1/IF_S3C~LISTACCESSGRANTSLOCATIONS
  IMPORTING
    !IV_ACCOUNTID TYPE /AWS1/S3CACCOUNTID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/S3CCONTINUATIONTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/S3CMAXRESULTS OPTIONAL
    !IV_LOCATIONSCOPE TYPE /AWS1/S3CS3PREFIX OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_s3clstaccgrantslocsrs
  RAISING
    /AWS1/CX_S3CCLIENTEXC
    /AWS1/CX_S3CSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_accountid` `TYPE /AWS1/S3CACCOUNTID` `/AWS1/S3CACCOUNTID`¶

The Amazon Web Services account ID of the S3 Access Grants instance.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/S3CCONTINUATIONTOKEN` `/AWS1/S3CCONTINUATIONTOKEN`¶

A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants Locations request in order to retrieve the next page of results.

`iv_maxresults` `TYPE /AWS1/S3CMAXRESULTS` `/AWS1/S3CMAXRESULTS`¶

The maximum number of access grants that you would like returned in the List Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.

`iv_locationscope` `TYPE /AWS1/S3CS3PREFIX` `/AWS1/S3CS3PREFIX`¶

The S3 path to the location that you are registering. The location scope can be the default S3 location s3://, the S3 path to a bucket s3://, or the S3 path to a bucket and prefix s3:///. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_s3clstaccgrantslocsrs` `/AWS1/CL_S3CLSTACCGRANTSLOCSRS`¶

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->listaccessgrantslocations(
  iv_accountid = |string|
  iv_locationscope = |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.
  lv_continuationtoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_accessgrantslocslist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_creationtimestamp = lo_row_1->get_createdat( ).
      lv_accessgrantslocationid = lo_row_1->get_accessgrantslocationid( ).
      lv_accessgrantslocationarn = lo_row_1->get_accessgrantslocationarn( ).
      lv_s3prefix = lo_row_1->get_locationscope( ).
      lv_iamrolearn = lo_row_1->get_iamrolearn( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_S3C=>LISTACCESSGRANTSLOCATIONS()¶