The Wayback Machine - https://web.archive.org/web/20190716202101/https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETaccelerate.html
Sign In to the Console
Amazon Simple Storage Service
API Reference (API Version 2006-03-01)

AWS Documentation » Amazon Simple Storage Service (S3) » API Reference » Operations on Buckets » GET Bucket accelerate

GET Bucket accelerate

Description

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 PUT Bucket accelerate 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.

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/"/>

For more information on transfer acceleration, see Transfer Acceleration in the Amazon Simple Storage Service Developer Guide.

Requests

Syntax

GET /?accelerate HTTP/1.1
Host: bucketname.s3.amazonaws.com
Content-Length: length
Date: date
Authorization: authorization string (see Authenticating Requests (AWS Signature Version
		4))

Request Parameters

This implementation of the operation does not use request parameters.

Request Headers

This implementation of the operation uses only request headers that are common to all operations. For more information, see Common Request Headers.

Request Elements

This implementation of the operation does not use request elements.

Responses

Response Headers

This implementation of the operation uses only response headers that are common to most responses. For more information, see Common Response Headers.

Response Elements

This implementation of GET returns the following response elements.

Name Description
AccelerateConfiguration

Container for the Status response element.

Type: Container

Ancestor: None
Status

The transfer acceleration state of the bucket.

Type: Enum

Valid Values: Suspended | Enabled

Ancestor: AccelerateConfiguration

Special Errors

This implementation of the operation does not return special errors. For general information about Amazon S3 errors and a list of error codes, see Error Responses.

Examples

Example 1: 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. 

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

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

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