#[non_exhaustive]pub struct ListObjectsV2InputBuilder { /* private fields */ }
Expand description
A builder for ListObjectsV2Input
.
Implementations§
source§impl ListObjectsV2InputBuilder
impl ListObjectsV2InputBuilder
sourcepub fn bucket(self, input: impl Into<String>) -> Self
pub fn bucket(self, input: impl Into<String>) -> Self
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.
Access points and Object Lambda access points are not supported by directory buckets.
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.
sourcepub fn set_bucket(self, input: Option<String>) -> Self
pub fn set_bucket(self, input: Option<String>) -> Self
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.
Access points and Object Lambda access points are not supported by directory buckets.
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.
sourcepub fn get_bucket(&self) -> &Option<String>
pub fn get_bucket(&self) -> &Option<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.
Access points and Object Lambda access points are not supported by directory buckets.
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.
sourcepub fn delimiter(self, input: impl Into<String>) -> Self
pub fn delimiter(self, input: impl Into<String>) -> Self
A delimiter is a character that you use to group keys.
-
Directory buckets - For directory buckets,
/
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.
sourcepub fn set_delimiter(self, input: Option<String>) -> Self
pub fn set_delimiter(self, input: Option<String>) -> Self
A delimiter is a character that you use to group keys.
-
Directory buckets - For directory buckets,
/
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.
sourcepub fn get_delimiter(&self) -> &Option<String>
pub fn get_delimiter(&self) -> &Option<String>
A delimiter is a character that you use to group keys.
-
Directory buckets - For directory buckets,
/
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.
sourcepub fn encoding_type(self, input: EncodingType) -> Self
pub fn encoding_type(self, input: EncodingType) -> Self
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.
sourcepub fn set_encoding_type(self, input: Option<EncodingType>) -> Self
pub fn set_encoding_type(self, input: Option<EncodingType>) -> Self
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.
sourcepub fn get_encoding_type(&self) -> &Option<EncodingType>
pub fn get_encoding_type(&self) -> &Option<EncodingType>
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.
sourcepub fn max_keys(self, input: i32) -> Self
pub fn max_keys(self, input: i32) -> Self
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.
sourcepub fn set_max_keys(self, input: Option<i32>) -> Self
pub fn set_max_keys(self, input: Option<i32>) -> Self
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.
sourcepub fn get_max_keys(&self) -> &Option<i32>
pub fn get_max_keys(&self) -> &Option<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.
sourcepub fn prefix(self, input: impl Into<String>) -> Self
pub fn prefix(self, input: impl Into<String>) -> Self
Limits the response to keys that begin with the specified prefix.
Directory buckets - For directory buckets, only prefixes that end in a delimiter (/
) are supported.
sourcepub fn set_prefix(self, input: Option<String>) -> Self
pub fn set_prefix(self, input: Option<String>) -> Self
Limits the response to keys that begin with the specified prefix.
Directory buckets - For directory buckets, only prefixes that end in a delimiter (/
) are supported.
sourcepub fn get_prefix(&self) -> &Option<String>
pub fn get_prefix(&self) -> &Option<String>
Limits the response to keys that begin with the specified prefix.
Directory buckets - For directory buckets, only prefixes that end in a delimiter (/
) are supported.
sourcepub fn continuation_token(self, input: impl Into<String>) -> Self
pub fn continuation_token(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_continuation_token(self, input: Option<String>) -> Self
pub fn set_continuation_token(self, input: Option<String>) -> Self
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.
sourcepub fn get_continuation_token(&self) -> &Option<String>
pub fn get_continuation_token(&self) -> &Option<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.
sourcepub fn fetch_owner(self, input: bool) -> Self
pub fn fetch_owner(self, input: bool) -> Self
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
.
Directory buckets - For directory buckets, the bucket owner is returned as the object owner for all objects.
sourcepub fn set_fetch_owner(self, input: Option<bool>) -> Self
pub fn set_fetch_owner(self, input: Option<bool>) -> Self
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
.
Directory buckets - For directory buckets, the bucket owner is returned as the object owner for all objects.
sourcepub fn get_fetch_owner(&self) -> &Option<bool>
pub fn get_fetch_owner(&self) -> &Option<bool>
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
.
Directory buckets - For directory buckets, the bucket owner is returned as the object owner for all objects.
sourcepub fn start_after(self, input: impl Into<String>) -> Self
pub fn start_after(self, input: impl Into<String>) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn set_start_after(self, input: Option<String>) -> Self
pub fn set_start_after(self, input: Option<String>) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn get_start_after(&self) -> &Option<String>
pub fn get_start_after(&self) -> &Option<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.
This functionality is not supported for directory buckets.
sourcepub fn request_payer(self, input: RequestPayer) -> Self
pub fn request_payer(self, input: RequestPayer) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn set_request_payer(self, input: Option<RequestPayer>) -> Self
pub fn set_request_payer(self, input: Option<RequestPayer>) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn get_request_payer(&self) -> &Option<RequestPayer>
pub fn get_request_payer(&self) -> &Option<RequestPayer>
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.
This functionality is not supported for directory buckets.
sourcepub fn expected_bucket_owner(self, input: impl Into<String>) -> Self
pub fn expected_bucket_owner(self, input: impl Into<String>) -> Self
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).
sourcepub fn set_expected_bucket_owner(self, input: Option<String>) -> Self
pub fn set_expected_bucket_owner(self, input: Option<String>) -> Self
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).
sourcepub fn get_expected_bucket_owner(&self) -> &Option<String>
pub fn get_expected_bucket_owner(&self) -> &Option<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).
sourcepub fn optional_object_attributes(self, input: OptionalObjectAttributes) -> Self
pub fn optional_object_attributes(self, input: OptionalObjectAttributes) -> Self
Appends an item to optional_object_attributes
.
To override the contents of this collection use set_optional_object_attributes
.
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
This functionality is not supported for directory buckets.
sourcepub fn set_optional_object_attributes(
self,
input: Option<Vec<OptionalObjectAttributes>>,
) -> Self
pub fn set_optional_object_attributes( self, input: Option<Vec<OptionalObjectAttributes>>, ) -> Self
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
This functionality is not supported for directory buckets.
sourcepub fn get_optional_object_attributes(
&self,
) -> &Option<Vec<OptionalObjectAttributes>>
pub fn get_optional_object_attributes( &self, ) -> &Option<Vec<OptionalObjectAttributes>>
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
This functionality is not supported for directory buckets.
sourcepub fn build(self) -> Result<ListObjectsV2Input, BuildError>
pub fn build(self) -> Result<ListObjectsV2Input, BuildError>
Consumes the builder and constructs a ListObjectsV2Input
.
source§impl ListObjectsV2InputBuilder
impl ListObjectsV2InputBuilder
sourcepub async fn send_with(
self,
client: &Client,
) -> Result<ListObjectsV2Output, SdkError<ListObjectsV2Error, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<ListObjectsV2Output, SdkError<ListObjectsV2Error, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for ListObjectsV2InputBuilder
impl Clone for ListObjectsV2InputBuilder
source§fn clone(&self) -> ListObjectsV2InputBuilder
fn clone(&self) -> ListObjectsV2InputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ListObjectsV2InputBuilder
impl Debug for ListObjectsV2InputBuilder
source§impl Default for ListObjectsV2InputBuilder
impl Default for ListObjectsV2InputBuilder
source§fn default() -> ListObjectsV2InputBuilder
fn default() -> ListObjectsV2InputBuilder
impl StructuralPartialEq for ListObjectsV2InputBuilder
Auto Trait Implementations§
impl Freeze for ListObjectsV2InputBuilder
impl RefUnwindSafe for ListObjectsV2InputBuilder
impl Send for ListObjectsV2InputBuilder
impl Sync for ListObjectsV2InputBuilder
impl Unpin for ListObjectsV2InputBuilder
impl UnwindSafe for ListObjectsV2InputBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)