Struct aws_sdk_s3::output::ListObjectsV2Output [−][src]
#[non_exhaustive]pub struct ListObjectsV2Output {
pub is_truncated: bool,
pub contents: Option<Vec<Object>>,
pub name: Option<String>,
pub prefix: Option<String>,
pub delimiter: Option<String>,
pub max_keys: i32,
pub common_prefixes: Option<Vec<CommonPrefix>>,
pub encoding_type: Option<EncodingType>,
pub key_count: i32,
pub continuation_token: Option<String>,
pub next_continuation_token: Option<String>,
pub start_after: Option<String>,
}
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.is_truncated: bool
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.
contents: Option<Vec<Object>>
Metadata about each object returned.
name: Option<String>
The bucket name.
When using this action with an access point, 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.
When using 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 using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.
prefix: Option<String>
Keys that begin with the indicated prefix.
delimiter: Option<String>
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.
max_keys: i32
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.
common_prefixes: Option<Vec<CommonPrefix>>
All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the number of returns.
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.
encoding_type: Option<EncodingType>
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
.
key_count: i32
KeyCount is the number of keys returned with this request. KeyCount will always be less than or equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys
continuation_token: Option<String>
If ContinuationToken was sent with the request, it is included in the response.
next_continuation_token: Option<String>
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
start_after: Option<String>
If StartAfter was sent with the request, it is included in the response.
Implementations
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.
The bucket name.
When using this action with an access point, 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.
When using 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 using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.
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.
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.
All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the number of returns.
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.
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
.
KeyCount is the number of keys returned with this request. KeyCount will always be less than or equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys
If ContinuationToken was sent with the request, it is included in the response.
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
If StartAfter was sent with the request, it is included in the response.
Creates a new builder-style object to manufacture ListObjectsV2Output
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for ListObjectsV2Output
impl Send for ListObjectsV2Output
impl Sync for ListObjectsV2Output
impl Unpin for ListObjectsV2Output
impl UnwindSafe for ListObjectsV2Output
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more