Container for the parameters to the GetBucketLocation operation.
Using the GetBucketLocation operation is no longer a best practice. To return
the Region that a bucket resides in, we recommend that you use the HeadBucket
operation instead. For backward compatibility, Amazon S3 continues to support the
GetBucketLocation operation.
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.
In a bucket's home Region, calls to the GetBucketLocation operation are governed
by the bucket's policy. In other Regions, the bucket policy doesn't apply, which means
that cross-account access won't be authorized. However, calls to the HeadBucket
operation always return the bucket’s location through an HTTP response header, whether
access to the bucket is authorized or not. Therefore, we recommend using the HeadBucket
operation for bucket Region discovery and to avoid using the GetBucketLocation
operation.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation with 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.
This operation is not supported for directory buckets.
The following operations are related to GetBucketLocation:
You must URL encode any signed header values that contain spaces. For example, if
your header value is my file.txt, containing two spaces after my, you
must URL encode this value to my%20%20file.txt.
Inheritance Hierarchy
Namespace: Amazon.S3.Model
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z
Syntax
public class GetBucketLocationRequest : AmazonWebServiceRequest IAmazonWebServiceRequest
The GetBucketLocationRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
GetBucketLocationRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
BucketName | System.String |
Gets and sets the property BucketName. The name of the bucket for which to get the location. When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation with 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 |
|
|
ExpectedBucketOwner | System.String |
Gets and sets the property ExpectedBucketOwner.
The account ID of the expected bucket owner. If the account ID that you provide does
not match the actual owner of the bucket, the request fails with the HTTP status code
|
Examples
This example shows how to retrieve the location of a bucket.
GetBucketLocation sample
// Create a client
AmazonS3Client client = new AmazonS3Client();
// Construct request
GetBucketLocationRequest request = new GetBucketLocationRequest
{
BucketName = "amzn-s3-demo-bucket"
};
// Issue call
GetBucketLocationResponse response = await client.GetBucketLocationAsync(request);
// View response data
Console.WriteLine("Bucket location - {0}", response.Location);
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer