LISTCALLERACCESSGRANTS()`¶

About ListCallerAccessGrants¶

Use this API to list the access grants that grant the caller access to Amazon S3 data through S3 Access Grants. The caller (grantee) can be an Identity and Access Management (IAM) identity or Amazon Web Services Identity Center corporate directory identity. You must pass the Amazon Web Services account of the S3 data owner (grantor) in the request. You can, optionally, narrow the results by GrantScope, using a fragment of the data's S3 path, and S3 Access Grants will return only the grants with a path that contains the path fragment. You can also pass the AllowedByApplication filter in the request, which returns only the grants authorized for applications, whether the application is the caller's Identity Center application or any other application (ALL). For more information, see List the caller's access grants in the Amazon S3 User Guide.

Permissions: You must have the s3:ListCallerAccessGrants 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~LISTCALLERACCESSGRANTS
  IMPORTING
    !IV_ACCOUNTID TYPE /AWS1/S3CACCOUNTID OPTIONAL
    !IV_GRANTSCOPE TYPE /AWS1/S3CS3PREFIX OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/S3CCONTINUATIONTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/S3CMAXRESULTS OPTIONAL
    !IV_ALLOWEDBYAPPLICATION TYPE /AWS1/S3CBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_s3clstcalleraccgran01
  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_grantscope` `TYPE /AWS1/S3CS3PREFIX` `/AWS1/S3CS3PREFIX`¶

The S3 path of the data that you would like to access. Must start with s3://. You can optionally pass only the beginning characters of a path, and S3 Access Grants will search for all applicable grants for the path fragment.

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

A pagination token to request the next page of results. Pass this value into a subsequent List Caller Access Grants 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 Caller 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_allowedbyapplication` `TYPE /AWS1/S3CBOOLEAN` `/AWS1/S3CBOOLEAN`¶

If this optional parameter is passed in the request, a filter is applied to the results. The results will include only the access grants for the caller's Identity Center application or for any other applications (ALL).

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_s3clstcalleraccgran01` `/AWS1/CL_S3CLSTCALLERACCGRAN01`¶

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->listcalleraccessgrants(
  iv_accountid = |string|
  iv_allowedbyapplication = ABAP_TRUE
  iv_grantscope = |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_calleraccessgrantslist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_permission = lo_row_1->get_permission( ).
      lv_s3prefix = lo_row_1->get_grantscope( ).
      lv_identitycenterapplicati = lo_row_1->get_applicationarn( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_S3C=>LISTCALLERACCESSGRANTS()¶