Struct aws_sdk_s3::client::fluent_builders::ListMultipartUploads [−][src]
pub struct ListMultipartUploads<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to ListMultipartUploads
.
This action lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.
This action returns at most 1,000 multipart uploads in the response. 1,000 multipart
uploads is the maximum number of uploads a response can include, which is also the default
value. You can further limit the number of uploads in a response by specifying the
max-uploads
parameter in the response. If additional multipart uploads
satisfy the list criteria, the response will contain an IsTruncated
element
with the value true. To list the additional multipart uploads, use the
key-marker
and upload-id-marker
request parameters.
In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.
For more information on multipart uploads, see Uploading Objects Using Multipart Upload.
For information on permissions required to use the multipart upload API, see Multipart Upload and Permissions.
The following operations are related to ListMultipartUploads
:
Implementations
impl<C, M, R> ListMultipartUploads<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> ListMultipartUploads<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<ListMultipartUploadsOutput, SdkError<ListMultipartUploadsError>> where
R::Policy: SmithyRetryPolicy<ListMultipartUploadsInputOperationOutputAlias, ListMultipartUploadsOutput, ListMultipartUploadsError, ListMultipartUploadsInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<ListMultipartUploadsOutput, SdkError<ListMultipartUploadsError>> where
R::Policy: SmithyRetryPolicy<ListMultipartUploadsInputOperationOutputAlias, ListMultipartUploadsOutput, ListMultipartUploadsError, ListMultipartUploadsInputOperationRetryAlias>,
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.
The name of the bucket to which the multipart upload was initiated.
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.
The name of the bucket to which the multipart upload was initiated.
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.
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.
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.
Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, 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.
Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, 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.
Together with upload-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 specified key-marker
will be included in the list.
If upload-id-marker
is specified, any multipart uploads for a key equal to
the key-marker
might also be included, provided those multipart uploads have
upload IDs lexicographically greater than the specified
upload-id-marker
.
Together with upload-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 specified key-marker
will be included in the list.
If upload-id-marker
is specified, any multipart uploads for a key equal to
the key-marker
might also be included, provided those multipart uploads have
upload IDs lexicographically greater than the specified
upload-id-marker
.
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.
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.
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 you'd use a folder in a file system.)
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 you'd use a folder in a file system.)
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
.
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
.
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !RefUnwindSafe for ListMultipartUploads<C, M, R>
impl<C, M, R> Send for ListMultipartUploads<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for ListMultipartUploads<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for ListMultipartUploads<C, M, R>
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !UnwindSafe for ListMultipartUploads<C, M, R>
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