/AWS1/IF_S3=>GETPUBLICACCESSBLOCK()

About GetPublicAccessBlock

This operation is not supported for directory buckets.

Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. This operation returns the bucket-level configuration only. To understand the effective public access behavior, you must also consider account-level settings (which may inherit from organization-level policies). To use this operation, you must have the s3:GetBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. Account-level settings automatically inherit from organization-level policies when present. If the PublicAccessBlock settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public".

The following operations are related to GetPublicAccessBlock:

• Using Amazon S3 Block Public Access

• PutPublicAccessBlock

• GetPublicAccessBlock

• DeletePublicAccessBlock

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_S3~GETPUBLICACCESSBLOCK
  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_getpubaccblockout
  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

The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to retrieve.

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_getpubaccblockout /AWS1/CL_S3_GETPUBACCBLOCKOUT

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->getpublicaccessblock(
  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_publicaccessblockconfig = lo_result->get_publicaccessblockconf( ).
  IF lo_publicaccessblockconfig IS NOT INITIAL.
    lv_setting = lo_publicaccessblockconfig->get_blockpublicacls( ).
    lv_setting = lo_publicaccessblockconfig->get_ignorepublicacls( ).
    lv_setting = lo_publicaccessblockconfig->get_blockpublicpolicy( ).
    lv_setting = lo_publicaccessblockconfig->get_restrictpublicbuckets( ).
  ENDIF.
ENDIF.