list_objects_v2¶
Operation¶
async
¶
list_objects_v2(input: ListObjectsV2Input, plugins: list[Plugin] | None = None) -> ListObjectsV2Output
Returns some or all (up to 1,000) of the objects in a bucket with each
request. You can use the request parameters as selection criteria to
return a subset of the objects in a bucket. A 200 OK response can
contain valid or invalid XML. Make sure to design your application to
parse the contents of the response and handle it appropriately. For more
information about listing objects, see Listing object keys
programmatically
in the Amazon S3 User Guide. To get a list of your buckets, see
ListBuckets.
Note
-
General purpose bucket - For general purpose buckets,
ListObjectsV2doesn't return prefixes that are related only to in-progress multipart uploads. -
Directory buckets - For directory buckets,
ListObjectsV2response includes the prefixes that are related only to in-progress multipart uploads. -
Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format
https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name. Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
- Permissions
-
- General purpose bucket permissions - To use this operation, you
must have READ access to the bucket. You must have permission to
perform the
s3:ListBucketaction. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.
- General purpose bucket permissions - To use this operation, you
must have READ access to the bucket. You must have permission to
perform the
- Directory bucket permissions - To grant access to this API
operation on a directory bucket, we recommend that you use the
CreateSessionAPI operation for session-based authorization. Specifically, you grant thes3express:CreateSessionpermission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make theCreateSessionAPI call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make anotherCreateSessionAPI call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, seeCreateSession.
- Sorting order of returned objects
-
- General purpose bucket - For general purpose buckets,
ListObjectsV2returns objects in lexicographical order based on their key names.
- General purpose bucket - For general purpose buckets,
- Directory bucket - For directory buckets,
ListObjectsV2does not return objects in lexicographical order.
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
Bucket-name.s3express-zone-id.region-code.amazonaws.com.
Warning
This section describes the latest revision of this action. We recommend that you use this revised API operation for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API operation, ListObjects.
The following operations are related to ListObjectsV2:
Warning
You must URL encode any signed header values that contain spaces. For
example, if your header value is my file.txt, containing two spaces
after my, you must URL encode this value to my%20%20file.txt.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListObjectsV2Input
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ListObjectsV2Output
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ListObjectsV2Input structure.
Attributes¶
class-attribute
instance-attribute
¶
bucket: str | None = ...
Directory buckets - When you use this operation with a directory
bucket, you must use virtual-hosted-style requests in the format
Bucket-name.s3express-zone-id.region-code.amazonaws.com.
Path-style requests are not supported. Directory bucket names must be
unique in the chosen Zone (Availability Zone or Local Zone). Bucket
names must follow the format
bucket-base-name--zone-id--x-s3 (for example,
amzn-s3-demo-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 for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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.
Note
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket
must be the Outposts access point ARN or the access point alias. For
more information about S3 on Outposts, see What is S3 on
Outposts?
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
continuation_token: str | None = ...
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.
class-attribute
instance-attribute
¶
delimiter: str | None = ...
A delimiter is a character that you use to group keys.
CommonPrefixes is filtered out from results if it is not
lexicographically greater than the StartAfter value.
Note
-
Directory buckets - For directory buckets,
/is the only supported delimiter. -
Directory buckets - When you query
ListObjectsV2with a delimiter during in-progress multipart uploads, theCommonPrefixesresponse 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.
class-attribute
instance-attribute
¶
encoding_type: str | None = ...
Encoding type used by Amazon S3 to encode the object keys in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see Object key naming guidelines.
Note
When using the URL encoding type, non-ASCII characters that are used in
an object's key name will be percent-encoded according to UTF-8 code
values. For example, the object test_file(3).png will appear as
test_file%283%29.png.
class-attribute
instance-attribute
¶
expected_bucket_owner: str | None = ...
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).
class-attribute
instance-attribute
¶
fetch_owner: bool | None = ...
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.
Note
Directory buckets - For directory buckets, the bucket owner is returned as the object owner for all objects.
class-attribute
instance-attribute
¶
max_keys: int | None = ...
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.
class-attribute
instance-attribute
¶
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
Note
This functionality is not supported for directory buckets.
class-attribute
instance-attribute
¶
prefix: str | None = ...
Limits the response to keys that begin with the specified prefix.
Note
Directory buckets - For directory buckets, only prefixes that end in
a delimiter (/) are supported.
class-attribute
instance-attribute
¶
request_payer: str | None = ...
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.
Note
This functionality is not supported for directory buckets.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ListObjectsV2Output structure.
Attributes¶
class-attribute
instance-attribute
¶
common_prefixes: list[CommonPrefix] | None = ...
All of the keys (up to 1,000) that share the same prefix are grouped together. When counting the total numbers of returns by this API operation, this group of keys is considered as one item.
A response can contain CommonPrefixes only if you specify a delimiter.
CommonPrefixes contains all (if there are any) keys between Prefix
and the next occurrence of the string specified by a delimiter.
CommonPrefixes lists keys that act like subdirectories in the
directory specified by Prefix.
For example, if the prefix is notes/ and the delimiter is a slash
(/) as in notes/summer/july, the common prefix is notes/summer/.
All of the keys that roll up into a common prefix count as a single
return when calculating the number of returns.
Note
-
Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/) are supported. -
Directory buckets - When you query
ListObjectsV2with a delimiter during in-progress multipart uploads, theCommonPrefixesresponse 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.
class-attribute
instance-attribute
¶
Metadata about each object returned.
class-attribute
instance-attribute
¶
continuation_token: str | None = ...
If ContinuationToken was sent with the request, it is included in the
response. You can use the returned ContinuationToken for pagination of
the list response.
class-attribute
instance-attribute
¶
delimiter: str | None = ...
Causes keys that contain the same string between the prefix and the
first occurrence of the delimiter to be rolled up into a single result
element in the CommonPrefixes collection. These rolled-up keys are not
returned elsewhere in the response. Each rolled-up result counts as only
one return against the MaxKeys value.
Note
Directory buckets - For directory buckets, / is the only supported
delimiter.
class-attribute
instance-attribute
¶
encoding_type: str | None = ...
Encoding type used by Amazon S3 to encode object key names in the XML response.
If you specify the encoding-type request parameter, Amazon S3 includes
this element in the response, and returns encoded key name values in the
following response elements:
Delimiter, Prefix, Key, and StartAfter.
class-attribute
instance-attribute
¶
is_truncated: bool | None = ...
Set to false if all of the results were returned. Set to true if
more keys are available to return. If the number of results exceeds that
specified by MaxKeys, all of the results might not be returned.
class-attribute
instance-attribute
¶
key_count: int | None = ...
KeyCount is the number of keys returned with this request. KeyCount
will always be less than or equal to the MaxKeys field. For example,
if you ask for 50 keys, your result will include 50 keys or fewer.
class-attribute
instance-attribute
¶
max_keys: int | None = ...
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.
class-attribute
instance-attribute
¶
next_continuation_token: str | None = ...
NextContinuationToken is sent when isTruncated is true, which means
there are more keys in the bucket that can be listed. The next list
requests to Amazon S3 can be continued with this
NextContinuationToken. NextContinuationToken is obfuscated and is
not a real key
class-attribute
instance-attribute
¶
prefix: str | None = ...
Keys that begin with the indicated prefix.
Note
Directory buckets - For directory buckets, only prefixes that end in
a delimiter (/) are supported.
class-attribute
instance-attribute
¶
request_charged: str | None = ...
If present, indicates that the requester was successfully charged for the request. For more information, see Using Requester Pays buckets for storage transfers and usage in the Amazon Simple Storage Service user guide.
Note
This functionality is not supported for directory buckets.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.