Class ListMultipartUploadsRequest
Container for the parameters to the ListMultipartUploads operation. 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
:
public class ListMultipartUploadsRequest : AmazonWebServiceRequest
- Inheritance
-
ListMultipartUploadsRequest
Constructors
ListMultipartUploadsRequest()
public ListMultipartUploadsRequest()
Properties
BucketName
Gets and sets the property BucketName.
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 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.
public string BucketName { get; set; }
Property Value
Delimiter
Gets and sets the property Delimiter.
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.
public string Delimiter { get; set; }
Property Value
Encoding
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.
public EncodingType Encoding { get; set; }
Property Value
ExpectedBucketOwner
Gets and sets the property ExpectedBucketOwner.
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.
public string ExpectedBucketOwner { get; set; }
Property Value
KeyMarker
Gets and sets the property KeyMarker.
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
.
public string KeyMarker { get; set; }
Property Value
MaxUploads
Gets and sets the property MaxUploads.
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.
public int MaxUploads { get; set; }
Property Value
Prefix
Gets and sets the property Prefix.
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.)
public string Prefix { get; set; }
Property Value
UploadIdMarker
Gets and sets the property UploadIdMarker.
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
.
public string UploadIdMarker { get; set; }