Struct aws_sdk_s3::operation::list_multipart_uploads::builders::ListMultipartUploadsFluentBuilder
source · pub struct ListMultipartUploadsFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to ListMultipartUploads
.
This operation lists in-progress multipart uploads in a bucket. An in-progress multipart upload is a multipart upload that has been initiated by the CreateMultipartUpload
request, but has not yet been completed or aborted.
Directory buckets - If multipart uploads in a directory bucket are in progress, you can't delete the bucket until all the in-progress multipart uploads are aborted or completed.
The ListMultipartUploads
operation returns a maximum of 1,000 multipart uploads in the response. The limit of 1,000 multipart uploads is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads
request parameter. If there are more than 1,000 multipart uploads that satisfy your ListMultipartUploads
request, the response returns an IsTruncated
element with the value of true
, a NextKeyMarker
element, and a NextUploadIdMarker
element. To list the remaining multipart uploads, you need to make subsequent ListMultipartUploads
requests. In these requests, include two query parameters: key-marker
and upload-id-marker
. Set the value of key-marker
to the NextKeyMarker
value from the previous response. Similarly, set the value of upload-id-marker
to the NextUploadIdMarker
value from the previous response.
Directory buckets - The upload-id-marker
element and the NextUploadIdMarker
element aren't supported by directory buckets. To list the additional multipart uploads, you only need to set the value of key-marker
to the NextKeyMarker
value from the previous response.
For more information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.
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://bucket_name.s3express-az_id.region.amazonaws.com/key-name
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
- Permissions
-
-
General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.
-
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the
CreateSession
API operation for session-based authorization. Specifically, you grant thes3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make theCreateSession
API 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 anotherCreateSession
API 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 of multipart uploads in response
-
-
General purpose bucket - In the
ListMultipartUploads
response, the multipart uploads are sorted based on two criteria:-
Key-based sorting - Multipart uploads are initially sorted in ascending order based on their object keys.
-
Time-based sorting - For uploads that share the same object key, they are further sorted in ascending order based on the upload initiation time. Among uploads with the same key, the one that was initiated first will appear before the ones that were initiated later.
-
-
Directory bucket - In the
ListMultipartUploads
response, the multipart uploads aren't sorted lexicographically based on the object keys.
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to ListMultipartUploads
:
Implementations§
source§impl ListMultipartUploadsFluentBuilder
impl ListMultipartUploadsFluentBuilder
sourcepub fn as_input(&self) -> &ListMultipartUploadsInputBuilder
pub fn as_input(&self) -> &ListMultipartUploadsInputBuilder
Access the ListMultipartUploads as a reference.
sourcepub async fn send(
self,
) -> Result<ListMultipartUploadsOutput, SdkError<ListMultipartUploadsError, HttpResponse>>
pub async fn send( self, ) -> Result<ListMultipartUploadsOutput, SdkError<ListMultipartUploadsError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self,
) -> CustomizableOperation<ListMultipartUploadsOutput, ListMultipartUploadsError, Self>
pub fn customize( self, ) -> CustomizableOperation<ListMultipartUploadsOutput, ListMultipartUploadsError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn bucket(self, input: impl Into<String>) -> Self
pub fn bucket(self, input: impl Into<String>) -> Self
The name of the bucket to which the multipart upload was initiated.
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
The name of the bucket to which the multipart upload was initiated.
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>
The name of the bucket to which the multipart upload was initiated.
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
Character you use to group keys.
All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes
. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes
result element are not returned elsewhere in the response.
Directory buckets - For directory buckets, /
is the only supported delimiter.
sourcepub fn set_delimiter(self, input: Option<String>) -> Self
pub fn set_delimiter(self, input: Option<String>) -> Self
Character you use to group keys.
All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes
. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes
result element are not returned elsewhere in the response.
Directory buckets - For directory buckets, /
is the only supported delimiter.
sourcepub fn get_delimiter(&self) -> &Option<String>
pub fn get_delimiter(&self) -> &Option<String>
Character you use to group keys.
All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes
. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes
result element are not returned elsewhere in the response.
Directory buckets - For directory buckets, /
is the only supported delimiter.
sourcepub fn encoding_type(self, input: EncodingType) -> Self
pub fn encoding_type(self, input: EncodingType) -> Self
Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key can contain any Unicode character; however, the XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
sourcepub fn set_encoding_type(self, input: Option<EncodingType>) -> Self
pub fn set_encoding_type(self, input: Option<EncodingType>) -> Self
Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key can contain any Unicode character; however, the XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
sourcepub fn get_encoding_type(&self) -> &Option<EncodingType>
pub fn get_encoding_type(&self) -> &Option<EncodingType>
Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key can contain any Unicode character; however, the XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
sourcepub fn key_marker(self, input: impl Into<String>) -> Self
pub fn key_marker(self, input: impl Into<String>) -> Self
Specifies the multipart upload after which listing should begin.
-
General purpose buckets - For general purpose buckets,
key-marker
is an object key. Together withupload-id-marker
, this parameter specifies the multipart upload after which listing should begin.If
upload-id-marker
is not specified, only the keys lexicographically greater than the specifiedkey-marker
will be included in the list.If
upload-id-marker
is specified, any multipart uploads for a key equal to thekey-marker
might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specifiedupload-id-marker
. -
Directory buckets - For directory buckets,
key-marker
is obfuscated and isn't a real object key. Theupload-id-marker
parameter isn't supported by directory buckets. To list the additional multipart uploads, you only need to set the value ofkey-marker
to theNextKeyMarker
value from the previous response.In the
ListMultipartUploads
response, the multipart uploads aren't sorted lexicographically based on the object keys.
sourcepub fn set_key_marker(self, input: Option<String>) -> Self
pub fn set_key_marker(self, input: Option<String>) -> Self
Specifies the multipart upload after which listing should begin.
-
General purpose buckets - For general purpose buckets,
key-marker
is an object key. Together withupload-id-marker
, this parameter specifies the multipart upload after which listing should begin.If
upload-id-marker
is not specified, only the keys lexicographically greater than the specifiedkey-marker
will be included in the list.If
upload-id-marker
is specified, any multipart uploads for a key equal to thekey-marker
might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specifiedupload-id-marker
. -
Directory buckets - For directory buckets,
key-marker
is obfuscated and isn't a real object key. Theupload-id-marker
parameter isn't supported by directory buckets. To list the additional multipart uploads, you only need to set the value ofkey-marker
to theNextKeyMarker
value from the previous response.In the
ListMultipartUploads
response, the multipart uploads aren't sorted lexicographically based on the object keys.
sourcepub fn get_key_marker(&self) -> &Option<String>
pub fn get_key_marker(&self) -> &Option<String>
Specifies the multipart upload after which listing should begin.
-
General purpose buckets - For general purpose buckets,
key-marker
is an object key. Together withupload-id-marker
, this parameter specifies the multipart upload after which listing should begin.If
upload-id-marker
is not specified, only the keys lexicographically greater than the specifiedkey-marker
will be included in the list.If
upload-id-marker
is specified, any multipart uploads for a key equal to thekey-marker
might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specifiedupload-id-marker
. -
Directory buckets - For directory buckets,
key-marker
is obfuscated and isn't a real object key. Theupload-id-marker
parameter isn't supported by directory buckets. To list the additional multipart uploads, you only need to set the value ofkey-marker
to theNextKeyMarker
value from the previous response.In the
ListMultipartUploads
response, the multipart uploads aren't sorted lexicographically based on the object keys.
sourcepub fn max_uploads(self, input: i32) -> Self
pub fn max_uploads(self, input: i32) -> Self
Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.
sourcepub fn set_max_uploads(self, input: Option<i32>) -> Self
pub fn set_max_uploads(self, input: Option<i32>) -> Self
Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.
sourcepub fn get_max_uploads(&self) -> &Option<i32>
pub fn get_max_uploads(&self) -> &Option<i32>
Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.
sourcepub fn prefix(self, input: impl Into<String>) -> Self
pub fn prefix(self, input: impl Into<String>) -> Self
Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix
to make groups in the same way that you'd use a folder in a file system.)
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
Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix
to make groups in the same way that you'd use a folder in a file system.)
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>
Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix
to make groups in the same way that you'd use a folder in a file system.)
Directory buckets - For directory buckets, only prefixes that end in a delimiter (/
) are supported.
sourcepub fn upload_id_marker(self, input: impl Into<String>) -> Self
pub fn upload_id_marker(self, input: impl Into<String>) -> Self
Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker
.
This functionality is not supported for directory buckets.
sourcepub fn set_upload_id_marker(self, input: Option<String>) -> Self
pub fn set_upload_id_marker(self, input: Option<String>) -> Self
Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker
.
This functionality is not supported for directory buckets.
sourcepub fn get_upload_id_marker(&self) -> &Option<String>
pub fn get_upload_id_marker(&self) -> &Option<String>
Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker
.
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 request_payer(self, input: RequestPayer) -> Self
pub fn request_payer(self, input: RequestPayer) -> Self
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
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 they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
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 they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
Trait Implementations§
source§impl Clone for ListMultipartUploadsFluentBuilder
impl Clone for ListMultipartUploadsFluentBuilder
source§fn clone(&self) -> ListMultipartUploadsFluentBuilder
fn clone(&self) -> ListMultipartUploadsFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for ListMultipartUploadsFluentBuilder
impl !RefUnwindSafe for ListMultipartUploadsFluentBuilder
impl Send for ListMultipartUploadsFluentBuilder
impl Sync for ListMultipartUploadsFluentBuilder
impl Unpin for ListMultipartUploadsFluentBuilder
impl !UnwindSafe for ListMultipartUploadsFluentBuilder
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
)