GetBucketLocation
Returns the Region the bucket resides in
You set the bucket's Region using the LocationConstraint request parameter in a CreateBucket request.
To use this API operation against an access point, provide the alias of the access point in place of the bucket name.
Request Syntax
URI Request Parameters
The request uses the following URI parameters.
Bucket
The name of the bucket for which to get the location.
Required: Yes
x-amz-expected-bucket-owner
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
Request Body
The request does not have a request body.
Response Syntax
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.
LocationConstraint
Root level tag for the LocationConstraint parameters.
Required: Yes
LocationConstraint
Specifies the Region where the bucket resides.
Buckets in Region us-east-1 have a LocationConstraint of null.
Type: String
Valid Values: af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ca-central-1 | cn-north-1 | cn-northwest-1 | EU | eu-central-1 | eu-north-1 | eu-south-1 | eu-west-1 | eu-west-2 | eu-west-3 | me-south-1 | sa-east-1 | us-east-2 | us-gov-east-1 | us-gov-west-1 | us-west-1 | us-west-2
Examples
Sample Request
The following request returns the Region of the specified bucket.
Sample Response
This example illustrates one usage of GetBucketLocation.
Last updated