Table of Contents

Class ListPartsRequest

Namespace
Amazon.S3.Model
Assembly
AWSSDK.S3.dll

Container for the parameters to the ListParts operation. Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the 

max-parts
request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an 
IsTruncated
field with the value of true, and a 
NextPartNumberMarker
element. In subsequent 
ListParts
requests you can include the part-number-marker query string

parameter and set its value to the 

NextPartNumberMarker
field value from the previous response.

If the upload was created using a checksum algorithm, you will need to have permission to the 

kms:Decrypt
action for the request to succeed.

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 

ListParts
: 
public class ListPartsRequest : AmazonWebServiceRequest
Inheritance
ListPartsRequest

Constructors

ListPartsRequest() 

public ListPartsRequest()

Properties

BucketName

Gets and sets the property BucketName.

The name of the bucket to which the parts are being uploaded.

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

string

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

EncodingType

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

string

Key

The object key for which the multipart upload was initiated.

public string Key { get; set; }

Property Value

string

Remarks

This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." is interpreted as use parent directory. For further information view the documentation for the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri

MaxParts

Gets and sets the property MaxParts.

Sets the maximum number of parts to return. 

public int MaxParts { get; set; }

Property Value

int

PartNumberMarker

Gets and sets the property PartNumberMarker.

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed. 

public string PartNumberMarker { get; set; }

Property Value

string

RequestPayer

Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests.

public RequestPayer RequestPayer { get; set; }

Property Value

RequestPayer

SSECustomerAlgorithm

Gets and sets the property SSECustomerAlgorithm.

The SSE algorithm used to encrypt the object. This is only needed when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide. 

public string SSECustomerAlgorithm { get; set; }

Property Value

string

SSECustomerKey

Gets and sets the property SSECustomerKey.

The SSE customer key. This is only needed when the object was cureated using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide. 

public string SSECustomerKey { get; set; }

Property Value

string

SSECustomerKeyMD5

Gets and sets the property SSECustomerKeyMD5.

The MD5 SSE customer key. This is only needed when the object was cureated using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide. 

public string SSECustomerKeyMD5 { get; set; }

Property Value

string

UploadId

Gets and sets the property UploadId.

Upload ID identifying the multipart upload whose parts are being listed. 

public string UploadId { get; set; }

Property Value

string