Class: Aws::S3::Types::ListBucketsRequest

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::ListBucketsRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket_region ⇒ String

  Limits the response to buckets that are located in the specified Amazon Web Services Region.

• #continuation_token ⇒ String

  ‘ContinuationToken` indicates to Amazon S3 that the list is being continued on this bucket with a token.

• #max_buckets ⇒ Integer

  Maximum number of buckets to be returned in response.

• #prefix ⇒ String

  Limits the response to bucket names that begin with the specified bucket name prefix.

Instance Attribute Details

#bucket_region ⇒ String

Limits the response to buckets that are located in the specified Amazon Web Services Region. The Amazon Web Services Region must be expressed according to the Amazon Web Services Region code, such as ‘us-west-2` for the US West (Oregon) Region. For a list of the valid values for all of the Amazon Web Services Regions, see [Regions and Endpoints].

<note markdown=“1”> Requests made to a Regional endpoint that is different from the ‘bucket-region` parameter are not supported. For example, if you want to limit the response to your buckets in Region `us-west-2`, the request must be made to an endpoint in Region `us-west-2`.

</note>

[1]: docs.aws.amazon.com/general/latest/gr/rande.html#s3_region

Returns:

• (String)

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

class ListBucketsRequest < Struct.new(
  :max_buckets,
  :continuation_token,
  :prefix,
  :bucket_region)
  SENSITIVE = []
  include Aws::Structure
end

#continuation_token ⇒ String

‘ContinuationToken` indicates to Amazon S3 that the list is being continued on this bucket with a token. `ContinuationToken` is obfuscated and is not a real key. You can use this `ContinuationToken` for pagination of the list results.

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No.

<note markdown=“1”> If you specify the ‘bucket-region`, `prefix`, or `continuation-token` query parameters without using `max-buckets` to set the maximum number of buckets returned in the response, Amazon S3 applies a default page size of 10,000 and provides a continuation token if there are more buckets.

</note>

Returns:

• (String)

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

class ListBucketsRequest < Struct.new(
  :max_buckets,
  :continuation_token,
  :prefix,
  :bucket_region)
  SENSITIVE = []
  include Aws::Structure
end

#max_buckets ⇒ Integer

Maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an Amazon Web Services account, return all the buckets in response.

Returns:

• (Integer)

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

class ListBucketsRequest < Struct.new(
  :max_buckets,
  :continuation_token,
  :prefix,
  :bucket_region)
  SENSITIVE = []
  include Aws::Structure
end

#prefix ⇒ String

Limits the response to bucket names that begin with the specified bucket name prefix.

Returns:

• (String)

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

class ListBucketsRequest < Struct.new(
  :max_buckets,
  :continuation_token,
  :prefix,
  :bucket_region)
  SENSITIVE = []
  include Aws::Structure
end