Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GetBucketLocationCommand

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:

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.

see

GetBucketLocationCommandOutput for command's response shape.

see

config for S3Client's config shape.

Hierarchy

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly input

input: GetBucketLocationCommandInput

Readonly middlewareStack