class Aws::S3::Types::ListObjectsV2Request

@see docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2Request AWS API Documentation
@return [Array<String>]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
response. Fields that you do not specify are not returned.
Specifies the optional fields that you want returned in the
@!attribute [rw] optional_object_attributes
@return [String]
denied).
request fails with the HTTP status code ‘403 Forbidden` (access
you provide does not match the actual owner of the bucket, the
The account ID of the expected bucket owner. If the account ID that
@!attribute [rw] expected_bucket_owner
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
this parameter in their requests.
the list objects request in V2 style. Bucket owners need not specify
Confirms that the requester knows that she or he will be charged for
@!attribute [rw] request_payer
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
key in the bucket.
S3 starts listing after this specified key. StartAfter can be any
StartAfter is where you want Amazon S3 to start listing from. Amazon
@!attribute [rw] start_after
@return [Boolean]
</note>
returned as the object owner for all objects.
<note markdown=“1”> **Directory buckets** - For directory buckets, the bucket owner is
the `FetchOwner` field to `true`.
want to return the owner field with each key in the result, then set
The owner field is not present in `ListObjectsV2` by default. If you
@!attribute [rw] fetch_owner
@return [String]
`ContinuationToken` for pagination of the list results.
obfuscated and is not a real key. You can use this
continued on this bucket with a token. `ContinuationToken` is
`ContinuationToken` indicates to Amazon S3 that the list is being
@!attribute [rw] continuation_token
@return [String]
</note>
end in a delimiter (`/`) are supported.
<note markdown=“1”> **Directory buckets** - For directory buckets, only prefixes that
Limits the response to keys that begin with the specified prefix.
@!attribute [rw] prefix
@return [Integer]
might contain fewer keys but will never contain more.
default, the action returns up to 1,000 key names. The response
Sets the maximum number of keys returned in the response. By
@!attribute [rw] max_keys
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html </note>
as `test_file%283%29.png`.
code values. For example, the object `test_file(3).png` will appear
in an object’s key name will be percent-encoded according to UTF-8
<note markdown=“1”> When using the URL encoding type, non-ASCII characters that are used
object key names, see [Object key naming guidelines].
the response. For more information about characters to avoid in
can add this parameter to request that Amazon S3 encode the keys in
from 0 to 10. For characters that aren’t supported in XML 1.0, you
parse certain characters, such as characters with an ASCII value
contain any Unicode character. However, the XML 1.0 parser can’t
the response. Responses are encoded only in UTF-8. An object key can
Encoding type used by Amazon S3 to encode the [object keys] in
@!attribute [rw] encoding_type
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html </note> Overview][1] in the *Amazon S3 User Guide*.
information about multipart uploads, see [Multipart Upload
associated with the in-progress multipart uploads. For more
`CommonPrefixes` response parameter contains the prefixes that are
delimiter during in-progress multipart uploads, the
* Directory buckets - When you query ‘ListObjectsV2` with a
supported delimiter.
<note markdown=“1”> * **Directory buckets** - For directory buckets, `/` is the only
A delimiter is a character that you use to group keys.
@!attribute [rw] delimiter
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html Outposts?][3] in the *Amazon S3 User Guide*.
more information about S3 on Outposts, see [What is S3 on
must be the Outposts access point ARN or the access point alias. For
When you use this action with S3 on Outposts, the destination bucket
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
Outposts hostname takes the form `
you must direct requests to the S3 on Outposts hostname. The S3 on
**S3 on Outposts** - When you use this action with S3 on Outposts,
</note>
directory buckets.
<note markdown=“1”> Access points and Object Lambda access points are not supported by
[Using access points] in the *Amazon S3 User Guide*.
bucket name. For more information about access point ARNs, see
Services SDKs, you provide the access point ARN in place of the
When using this action with an access point through the Amazon Web
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
The access point hostname takes the form
point ARN, you must direct requests to the access point hostname.
bucket name or specify the access point ARN. When using the access
you must provide the alias of the access point in place of the
**Access points** - When you use this action with an access point,
*Amazon S3 User Guide*.
naming restrictions, see [Directory bucket naming rules] in the
amzn-s3-demo-bucket–usw2-az1–x-s3`). For information about bucket
follow the format ` bucket-base-name–zone-id–x-s3` (for example, `
the chosen Zone (Availability Zone or Local Zone). Bucket names must
requests are not supported. Directory bucket names must be unique in
Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style
bucket, you must use virtual-hosted-style requests in the format `
**Directory buckets** - When you use this operation with a directory
@!attribute [rw] bucket

class Aws::S3::Types::ListObjectsV2Request

Namespace

Included Modules

Defined in