Class GetBucketLocationCommandProtected

Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint request parameter in a CreateBucket request. For more information, see CreateBucket.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

We recommend that you use HeadBucket to return the Region that a bucket resides in. For backward compatibility, Amazon S3 continues to support GetBucketLocation.

The following operations are related to GetBucketLocation:

• GetObject

• CreateBucket

Example

Use a bare-bones client and the command you need to make an API call.

import { S3Client, GetBucketLocationCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, GetBucketLocationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const input = { // GetBucketLocationRequest
  Bucket: "STRING_VALUE", // required
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new GetBucketLocationCommand(input);
const response = await client.send(command);
// { // GetBucketLocationOutput
//   LocationConstraint: "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" || "ap-south-2" || "eu-south-2",
// };

Param

GetBucketLocationCommandInput

Returns

GetBucketLocationCommandOutput

See

• GetBucketLocationCommandInput for command's input shape.
• GetBucketLocationCommandOutput for command's response shape.
• config for S3Client's config shape.

Throws

S3ServiceException

Base exception class for all service exceptions from S3 service.

Example

To get bucket location

// The following example returns bucket location.
const input = {
  "Bucket": "examplebucket"
};
const command = new GetBucketLocationCommand(input);
const response = await client.send(command);
/* response ==
{
  "LocationConstraint": "us-west-2"
}
*/
// example id: to-get-bucket-location-1481594573609