Directory buckets - The HTTP Host header syntax isBucket-name.s3express-zone-id.region-code.amazonaws.com.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the formatBucket-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 formatbucket-base-name--zone-id--x-s3 (for example,amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, seeDirectory bucket naming rules in theAmazon 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 formAccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, seeUsing access points in theAmazon S3 User Guide.

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 formAccessPointName-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, seeWhat is S3 on Outposts? in theAmazon S3 User Guide.

Required: Yes

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 thisContinuationToken for pagination of the list results.

A delimiter is a character that you use to group keys.

CommonPrefixes is filtered out from results if it is not lexicographically greater than theStartAfter value.

Encoding type used by Amazon S3 to encode theobject 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, seeObject key naming guidelines.

Valid Values:url

The owner field is not present inListObjectsV2 by default. If you want to return the owner field with each key in the result, then set theFetchOwner field totrue.

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.

Limits the response to keys that begin with the specified prefix.

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.

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 code403 Forbidden (access denied).

Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

Valid Values:RestoreStatus

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.

Valid Values:requester

If present, indicates that the requester was successfully charged for the request. For more information, seeUsing Requester Pays buckets for storage transfers and usage in theAmazon Simple Storage Service user guide.

Valid Values:requester

Root level tag for the ListBucketResult parameters.

Required: Yes

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 containCommonPrefixes only if you specify a delimiter.

CommonPrefixes contains all (if there are any) keys betweenPrefix and the next occurrence of the string specified by a delimiter.

CommonPrefixes lists keys that act like subdirectories in the directory specified byPrefix.

For example, if the prefix isnotes/ and the delimiter is a slash (/) as innotes/summer/july, the common prefix isnotes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

Type: Array ofCommonPrefix data types

Metadata about each object returned.

Type: Array ofObject data types

IfContinuationToken was sent with the request, it is included in the response. You can use the returnedContinuationToken for pagination of the list response.

Type: String

Causes keys that contain the same string between theprefix and the first occurrence of the delimiter to be rolled up into a single result element in theCommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against theMaxKeys value.

Type: String

Encoding type used by Amazon S3 to encode object key names in the XML response.

If you specify theencoding-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, andStartAfter.

Type: String

Valid Values:url

Set tofalse if all of the results were returned. Set totrue if more keys are available to return. If the number of results exceeds that specified byMaxKeys, all of the results might not be returned.

Type: Boolean

KeyCount is the number of keys returned with this request.KeyCount will always be less than or equal to theMaxKeys field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.

Type: 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.

Type: Integer

The bucket name.

Type: String

NextContinuationToken is sent whenisTruncated 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 thisNextContinuationToken.NextContinuationToken is obfuscated and is not a real key

Type: String

Keys that begin with the indicated prefix.

Type: String

If StartAfter was sent with the request, it is included in the response.

Type: String

The specified bucket does not exist.

HTTP Status Code: 404