Class: Aws::S3::Types::GetBucketLocationRequest

Inherits:

Struct

Object
Struct
Aws::S3::Types::GetBucketLocationRequest

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-s3/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#bucket ⇒ String

The name of the bucket for which to get the location.
#expected_bucket_owner ⇒ String

The account ID of the expected bucket owner.

Instance Attribute Details

#bucket ⇒ `String`

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 ‘InvalidAccessPointAliasError` is returned. For more information about `InvalidAccessPointAliasError`, see [List of Error Codes].

[1]: docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 6423

class GetBucketLocationRequest < Struct.new(
  :bucket,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#expected_bucket_owner ⇒ `String`

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 ‘403 Forbidden` (access denied).