Get Bucket Accelerate Configuration
| s3_get_bucket_accelerate_configuration | R Documentation |
This operation is not supported for directory buckets¶
Description¶
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
put_bucket_accelerate_configuration 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
get_bucket_accelerate_configuration:
put_bucket_accelerate_configuration
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.
Usage¶
s3_get_bucket_accelerate_configuration(Bucket, ExpectedBucketOwner,
RequestPayer)
Arguments¶
Bucket |
[required] The name of the bucket for which the accelerate configuration is retrieved. |
ExpectedBucketOwner |
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 |
RequestPayer |
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for the corresponding charges. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide. This functionality is not supported for directory buckets. |
Value¶
A list with the following syntax:
list(
Status = "Enabled"|"Suspended",
RequestCharged = "requester"
)
Request syntax¶
svc$get_bucket_accelerate_configuration(
Bucket = "string",
ExpectedBucketOwner = "string",
RequestPayer = "requester"
)