paws.storage (version 0.1.12)

s3_get_bucket_location: Returns the Region the bucket resides in

Description

Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint request parameter in a create_bucket request. For more information, see create_bucket.

To use this implementation of the operation, you must be the bucket owner.

The following operations are related to get_bucket_location:

• get_object

• create_bucket

Usage

s3_get_bucket_location(Bucket, ExpectedBucketOwner)

Value

A list with the following syntax:

list(
  LocationConstraint = "af-south-1"|"ap-east-1"|"ap-northeast-1"|"ap-northeast-2"|"ap-northeast-3"|"ap-south-1"|"ap-southeast-1"|"ap-southeast-2"|"ca-central-1"|"cn-north-1"|"cn-northwest-1"|"EU"|"eu-central-1"|"eu-north-1"|"eu-south-1"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"me-south-1"|"sa-east-1"|"us-east-2"|"us-gov-east-1"|"us-gov-west-1"|"us-west-1"|"us-west-2"
)

Arguments

Bucket

[required] The name of the bucket for which to get the location.

ExpectedBucketOwner

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Request syntax

svc$get_bucket_location(
  Bucket = "string",
  ExpectedBucketOwner = "string"
)

Examples

if (FALSE) {
# The following example returns bucket location.
svc$get_bucket_location(
  Bucket = "examplebucket"
)
}