Amazon Simple Storage Service
API Reference (API Version 2006-03-01)

GetBucketAccelerateConfiguration

This implementation of the GET operation 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 Simple Storage Service Developer 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 on transfer acceleration, see Transfer Acceleration in the Amazon Simple Storage Service Developer Guide.

Request Syntax

GET /?accelerate HTTP/1.1 Host: Bucket.s3.amazonaws.com

URI Request Parameters

The request requires the following URI parameters.

Bucket

Name of the bucket for which the accelerate configuration is retrieved.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 <?xml version="1.0" encoding="UTF-8"?> <GetBucketAccelerateConfigurationOutput> <Status>string</Status> </GetBucketAccelerateConfigurationOutput>

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in XML format by the service.

GetBucketAccelerateConfigurationOutput

Root level tag for the GetBucketAccelerateConfigurationOutput parameters.

Required: Yes

Status

The accelerate configuration of the bucket.

Type: String

Valid Values: Enabled | Suspended

Examples

This implementation of the GET operation returns the following responses:

If the transfer acceleration state is set to Enabled on a bucket, the response is:

<AccelerateConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Status>Enabled</Status> </AccelerateConfiguration>

If the transfer acceleration state is set to Suspended on a bucket, the response is:

<AccelerateConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Status>Suspended</Status> </AccelerateConfiguration>

If the transfer acceleration state on a bucket has never been set to Enabled or Suspended, the response is:

<AccelerateConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/" />

Retrieve the transfer acceleration configuration for a bucket

The following example shows a GET /?accelerate request to retrieve the transfer acceleration state of the bucket named examplebucket.

<AccelerateConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Status>Enabled</Status> </AccelerateConfiguration>

The following is a sample of the response body (only) that shows bucket transfer acceleration is enabled.

GET /?accelerate HTTP/1.1 Host: examplebucket.s3.amazonaws.com Date: Mon, 11 Apr 2016 12:00:00 GMT Authorization: authorization string Content-Type: text/plain

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: