Class: Aws::S3Control::Types::GetBucketRequest

Inherits:

Struct

Object
Struct
Aws::S3Control::Types::GetBucketRequest

show all

Includes:: Aws::Structure

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

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#account_id ⇒ String

The Amazon Web Services account ID of the Outposts bucket.
#bucket ⇒ String

Specifies the bucket.

Instance Attribute Details

#account_id ⇒ `String`

The Amazon Web Services account ID of the Outposts bucket.

Returns:

(String)

# File 'lib/aws-sdk-s3control/types.rb', line 2978

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

#bucket ⇒ `String`

Specifies the bucket.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>`. For example, to access the bucket `reports` through Outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports`. The value must be URL encoded.