Container for the parameters to the GetBucketLocation operation.
This operation is not supported by directory buckets.
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.
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.
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:
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 = "SampleBucket"
};
// Issue call
GetBucketLocationResponse response = client.GetBucketLocation(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.5 and newer, 3.5