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 implementation of the operation, you must be the bucket owner.

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

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 command = new GetBucketLocationCommand(input);
const response = await client.send(command);

See

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

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