Class: Aws::S3::Types::ListObjectsV2Request
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::ListObjectsV2Request
- Defined in:
- gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#bucket ⇒ String
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com
. -
#continuation_token ⇒ String
ContinuationToken
indicates to Amazon S3 that the list is being continued on this bucket with a token. -
#delimiter ⇒ String
A delimiter is a character that you use to group keys.
-
#encoding_type ⇒ String
Encoding type used by Amazon S3 to encode object keys in the response.
-
#expected_bucket_owner ⇒ String
The account ID of the expected bucket owner.
-
#fetch_owner ⇒ Boolean
The owner field is not present in
ListObjectsV2
by default. -
#max_keys ⇒ Integer
Sets the maximum number of keys returned in the response.
-
#optional_object_attributes ⇒ Array<String>
Specifies the optional fields that you want returned in the response.
-
#prefix ⇒ String
Limits the response to keys that begin with the specified prefix.
-
#request_payer ⇒ String
Confirms that the requester knows that she or he will be charged for the list objects request in V2 style.
-
#start_after ⇒ String
StartAfter is where you want Amazon S3 to start listing from.
Instance Attribute Details
#bucket ⇒ String
Directory buckets - When you use this operation with a directory
bucket, you must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style
requests are not supported. Directory bucket names must be unique in
the chosen Availability Zone. Bucket names must follow the format
bucket_base_name--az-id--x-s3
(for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket
naming restrictions, see Directory bucket naming rules in the
Amazon S3 User Guide.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
S3 on Outposts - When you use this action with Amazon S3 on
Outposts, you must direct requests to the S3 on Outposts hostname.
The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
.
When you use this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts access point ARN in place of
the bucket name. For more information about S3 on Outposts ARNs, see
What is S3 on Outposts? in the Amazon S3 User Guide.
10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10555 class ListObjectsV2Request < Struct.new( :bucket, :delimiter, :encoding_type, :max_keys, :prefix, :continuation_token, :fetch_owner, :start_after, :request_payer, :expected_bucket_owner, :optional_object_attributes) 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.
10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10555 class ListObjectsV2Request < Struct.new( :bucket, :delimiter, :encoding_type, :max_keys, :prefix, :continuation_token, :fetch_owner, :start_after, :request_payer, :expected_bucket_owner, :optional_object_attributes) SENSITIVE = [] include Aws::Structure end |
#delimiter ⇒ String
A delimiter is a character that you use to group keys.
/
is the only
supported delimiter.
- Directory buckets - When you query
ListObjectsV2
with a delimiter during in-progress multipart uploads, theCommonPrefixes
response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.
10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10555 class ListObjectsV2Request < Struct.new( :bucket, :delimiter, :encoding_type, :max_keys, :prefix, :continuation_token, :fetch_owner, :start_after, :request_payer, :expected_bucket_owner, :optional_object_attributes) SENSITIVE = [] include Aws::Structure end |
#encoding_type ⇒ String
Encoding type used by Amazon S3 to encode object keys in the
response. If using url
, non-ASCII characters used in an object's
key name will be URL encoded. For example, the object
test_file(3).png will appear as test_file%283%29.png.
10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10555 class ListObjectsV2Request < Struct.new( :bucket, :delimiter, :encoding_type, :max_keys, :prefix, :continuation_token, :fetch_owner, :start_after, :request_payer, :expected_bucket_owner, :optional_object_attributes) 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).
10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10555 class ListObjectsV2Request < Struct.new( :bucket, :delimiter, :encoding_type, :max_keys, :prefix, :continuation_token, :fetch_owner, :start_after, :request_payer, :expected_bucket_owner, :optional_object_attributes) SENSITIVE = [] include Aws::Structure end |
#fetch_owner ⇒ Boolean
The owner field is not present in ListObjectsV2
by default. If you
want to return the owner field with each key in the result, then set
the FetchOwner
field to true
.
10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10555 class ListObjectsV2Request < Struct.new( :bucket, :delimiter, :encoding_type, :max_keys, :prefix, :continuation_token, :fetch_owner, :start_after, :request_payer, :expected_bucket_owner, :optional_object_attributes) SENSITIVE = [] include Aws::Structure end |
#max_keys ⇒ Integer
Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10555 class ListObjectsV2Request < Struct.new( :bucket, :delimiter, :encoding_type, :max_keys, :prefix, :continuation_token, :fetch_owner, :start_after, :request_payer, :expected_bucket_owner, :optional_object_attributes) SENSITIVE = [] include Aws::Structure end |
#optional_object_attributes ⇒ Array<String>
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10555 class ListObjectsV2Request < Struct.new( :bucket, :delimiter, :encoding_type, :max_keys, :prefix, :continuation_token, :fetch_owner, :start_after, :request_payer, :expected_bucket_owner, :optional_object_attributes) SENSITIVE = [] include Aws::Structure end |
#prefix ⇒ String
Limits the response to keys that begin with the specified prefix.
/
) are supported.
10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10555 class ListObjectsV2Request < Struct.new( :bucket, :delimiter, :encoding_type, :max_keys, :prefix, :continuation_token, :fetch_owner, :start_after, :request_payer, :expected_bucket_owner, :optional_object_attributes) SENSITIVE = [] include Aws::Structure end |
#request_payer ⇒ String
Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.
10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10555 class ListObjectsV2Request < Struct.new( :bucket, :delimiter, :encoding_type, :max_keys, :prefix, :continuation_token, :fetch_owner, :start_after, :request_payer, :expected_bucket_owner, :optional_object_attributes) SENSITIVE = [] include Aws::Structure end |
#start_after ⇒ String
StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.
10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10555 class ListObjectsV2Request < Struct.new( :bucket, :delimiter, :encoding_type, :max_keys, :prefix, :continuation_token, :fetch_owner, :start_after, :request_payer, :expected_bucket_owner, :optional_object_attributes) SENSITIVE = [] include Aws::Structure end |