GETBUCKETACCELERATECONF()`¶

About GetBucketAccelerateConfiguration¶

This operation is not supported for directory buckets.

This implementation of the GET action uses the accelerate subresource to return the Transfer Acceleration state of a bucket, which is either Enabled or Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3.

To use this operation, you must have permission to perform the s3:GetAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.

You set the Transfer Acceleration state of an existing bucket to Enabled or Suspended by using the PutBucketAccelerateConfiguration operation.

A GET accelerate request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket.

For more information about transfer acceleration, see Transfer Acceleration in the Amazon S3 User Guide.

The following operations are related to GetBucketAccelerateConfiguration:

PutBucketAccelerateConfiguration

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~GETBUCKETACCELERATECONF
  IMPORTING
    !IV_BUCKET TYPE /AWS1/S3_BUCKETNAME OPTIONAL
    !IV_EXPECTEDBUCKETOWNER TYPE /AWS1/S3_ACCOUNTID OPTIONAL
    !IV_REQUESTPAYER TYPE /AWS1/S3_REQUESTPAYER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_s3_getbktaccconfout
  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 bucket for which the accelerate configuration is retrieved.

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).

`iv_requestpayer` `TYPE /AWS1/S3_REQUESTPAYER` `/AWS1/S3_REQUESTPAYER`¶

RequestPayer

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_s3_getbktaccconfout` `/AWS1/CL_S3_GETBKTACCCONFOUT`¶

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

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_bucketacceleratestatus = lo_result->get_status( ).
  lv_requestcharged = lo_result->get_requestcharged( ).
ENDIF.

/AWS1/IF_S3=>GETBUCKETACCELERATECONF()¶