The parameters to request the region that contains a bucket.
Declaration Syntax
C# |
public class GetBucketLocationRequest : S3Request
Members
All Members | Constructors | Methods | Properties | ||
Icon | Member | Description |
---|---|---|
GetBucketLocationRequest()()()() | Initializes a new instance of the GetBucketLocationRequest class | |
AddHeader(String, String) |
Adds the header to the collection of headers for the request.
(Inherited from S3Request.) | |
AddHeaders(NameValueCollection) |
Adds all of the specified key/value pairs into the request headers collection.
(Inherited from S3Request.) | |
BucketName |
The name of the bucket to query.
| |
Equals(Object) | (Inherited from Object.) | |
GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType()()()() | Gets the type of the current instance. (Inherited from Object.) | |
InputStream |
Input stream for the request; content for the request will be read from the stream.
(Inherited from S3Request.) | |
ReadWriteTimeout |
Overrides the default HttpWebRequest ReadWriteTimeout value.
(Inherited from S3Request.) | |
Timeout |
Overrides the default HttpWebRequest timeout value.
(Inherited from S3Request.) | |
ToString()()()() | (Inherited from S3Request.) | |
WithBucketName(String) | Obsolete.
Sets the name of the bucket to query.
| |
WithInputStream(Stream) | Obsolete.
Sets an input stream for the request; content for the request will be read from the stream.
(Inherited from S3Request.) | |
WithReadWriteTimeout(Int32) | Obsolete.
Overrides the default HttpWebRequest ReadWriteTimeout value.
(Inherited from S3Request.) | |
WithTimeout(Int32) | Obsolete.
Overrides the default HttpWebRequest timeout value.
(Inherited from S3Request.) |
Remarks
A bucket's region can be set using the LocationConstraint parameter on bucket creation.
Examples
This example shows how to retrieve the location of a bucket.
CopyGetBucketLocation 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);