GETBUCKETACL()`¶

About GetBucketAcl¶

This operation is not supported for directory buckets.

This implementation of the GET action uses the acl subresource to return the access control list (ACL) of a bucket. To use GET to return the ACL of the bucket, you must have the READ_ACP access to the bucket. If READ_ACP permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the bucket-owner-full-control ACL with the owner being the account that created the bucket. For more information, see Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.

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.

The following operations are related to GetBucketAcl:

ListObjects

Method Signature¶

METHODS /AWS1/IF_S3~GETBUCKETACL
  IMPORTING
    !IV_BUCKET TYPE /AWS1/S3_BUCKETNAME OPTIONAL
    !IV_EXPECTEDBUCKETOWNER TYPE /AWS1/S3_ACCOUNTID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_s3_getbucketacloutput
  RAISING
    /AWS1/CX_S3_CLIENTEXC
    /AWS1/CX_S3_SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_bucket` `TYPE /AWS1/S3_BUCKETNAME` `/AWS1/S3_BUCKETNAME`¶

Specifies the S3 bucket whose ACL is being requested.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

Optional arguments:¶

`iv_expectedbucketowner` `TYPE /AWS1/S3_ACCOUNTID` `/AWS1/S3_ACCOUNTID`¶

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_s3_getbucketacloutput` `/AWS1/CL_S3_GETBUCKETACLOUTPUT`¶

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->getbucketacl(
  iv_bucket = |string|
  iv_expectedbucketowner = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_owner = lo_result->get_owner( ).
  IF lo_owner IS NOT INITIAL.
    lv_displayname = lo_owner->get_displayname( ).
    lv_id = lo_owner->get_id( ).
  ENDIF.
  LOOP AT lo_result->get_grants( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lo_grantee = lo_row_1->get_grantee( ).
      IF lo_grantee IS NOT INITIAL.
        lv_displayname = lo_grantee->get_displayname( ).
        lv_emailaddress = lo_grantee->get_emailaddress( ).
        lv_id = lo_grantee->get_id( ).
        lv_uri = lo_grantee->get_uri( ).
        lv_type = lo_grantee->get_type( ).
      ENDIF.
      lv_permission = lo_row_1->get_permission( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_S3=>GETBUCKETACL()¶