/AWS1/CL_S3_LISTMPUPLOADSOUT

ListMultipartUploadsOutput

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_bucket TYPE /AWS1/S3_BUCKETNAME /AWS1/S3_BUCKETNAME

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

iv_keymarker TYPE /AWS1/S3_KEYMARKER /AWS1/S3_KEYMARKER

The key at or after which the listing began.

iv_uploadidmarker TYPE /AWS1/S3_UPLOADIDMARKER /AWS1/S3_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.

This functionality is not supported for directory buckets.

iv_nextkeymarker TYPE /AWS1/S3_NEXTKEYMARKER /AWS1/S3_NEXTKEYMARKER

When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.

iv_prefix TYPE /AWS1/S3_PREFIX /AWS1/S3_PREFIX

When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

iv_delimiter TYPE /AWS1/S3_DELIMITER /AWS1/S3_DELIMITER

Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.

Directory buckets - For directory buckets, / is the only supported delimiter.

iv_nextuploadidmarker TYPE /AWS1/S3_NEXTUPLOADIDMARKER /AWS1/S3_NEXTUPLOADIDMARKER

When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.

This functionality is not supported for directory buckets.

iv_maxuploads TYPE /AWS1/S3_MAXUPLOADS /AWS1/S3_MAXUPLOADS

Maximum number of multipart uploads that could have been included in the response.

iv_istruncated TYPE /AWS1/S3_ISTRUNCATED /AWS1/S3_ISTRUNCATED

Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.

it_uploads TYPE /AWS1/CL_S3_MULTIPARTUPLOAD=>TT_MULTIPARTUPLOADLIST TT_MULTIPARTUPLOADLIST

Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.

it_commonprefixes TYPE /AWS1/CL_S3_COMMONPREFIX=>TT_COMMONPREFIXLIST TT_COMMONPREFIXLIST

If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

iv_encodingtype TYPE /AWS1/S3_ENCODINGTYPE /AWS1/S3_ENCODINGTYPE

Encoding type used by Amazon S3 to encode object keys in the response.

If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.

iv_requestcharged TYPE /AWS1/S3_REQUESTCHARGED /AWS1/S3_REQUESTCHARGED

RequestCharged

---

Queryable Attributes

Bucket

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

Accessible with the following methods

Method	Description
GET_BUCKET()	Getter for BUCKET, with configurable default
ASK_BUCKET()	Getter for BUCKET w/ exceptions if field has no value
HAS_BUCKET()	Determine if BUCKET has a value

KeyMarker

The key at or after which the listing began.

Accessible with the following methods

Method	Description
GET_KEYMARKER()	Getter for KEYMARKER, with configurable default
ASK_KEYMARKER()	Getter for KEYMARKER w/ exceptions if field has no value
HAS_KEYMARKER()	Determine if KEYMARKER has a value

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.

This functionality is not supported for directory buckets.

Accessible with the following methods

Method	Description
GET_UPLOADIDMARKER()	Getter for UPLOADIDMARKER, with configurable default
ASK_UPLOADIDMARKER()	Getter for UPLOADIDMARKER w/ exceptions if field has no valu
HAS_UPLOADIDMARKER()	Determine if UPLOADIDMARKER has a value

NextKeyMarker

When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.

Accessible with the following methods

Method	Description
GET_NEXTKEYMARKER()	Getter for NEXTKEYMARKER, with configurable default
ASK_NEXTKEYMARKER()	Getter for NEXTKEYMARKER w/ exceptions if field has no value
HAS_NEXTKEYMARKER()	Determine if NEXTKEYMARKER has a value

Prefix

When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

Accessible with the following methods

Method	Description
GET_PREFIX()	Getter for PREFIX, with configurable default
ASK_PREFIX()	Getter for PREFIX w/ exceptions if field has no value
HAS_PREFIX()	Determine if PREFIX has a value

Delimiter

Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.

Directory buckets - For directory buckets, / is the only supported delimiter.

Accessible with the following methods

Method	Description
GET_DELIMITER()	Getter for DELIMITER, with configurable default
ASK_DELIMITER()	Getter for DELIMITER w/ exceptions if field has no value
HAS_DELIMITER()	Determine if DELIMITER has a value

NextUploadIdMarker

When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.

This functionality is not supported for directory buckets.

Accessible with the following methods

Method	Description
GET_NEXTUPLOADIDMARKER()	Getter for NEXTUPLOADIDMARKER, with configurable default
ASK_NEXTUPLOADIDMARKER()	Getter for NEXTUPLOADIDMARKER w/ exceptions if field has no
HAS_NEXTUPLOADIDMARKER()	Determine if NEXTUPLOADIDMARKER has a value

MaxUploads

Maximum number of multipart uploads that could have been included in the response.

Accessible with the following methods

Method	Description
GET_MAXUPLOADS()	Getter for MAXUPLOADS, with configurable default
ASK_MAXUPLOADS()	Getter for MAXUPLOADS w/ exceptions if field has no value
HAS_MAXUPLOADS()	Determine if MAXUPLOADS has a value

IsTruncated

Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.

Accessible with the following methods

Method	Description
GET_ISTRUNCATED()	Getter for ISTRUNCATED, with configurable default
ASK_ISTRUNCATED()	Getter for ISTRUNCATED w/ exceptions if field has no value
HAS_ISTRUNCATED()	Determine if ISTRUNCATED has a value

Uploads

Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.

Accessible with the following methods

Method	Description
GET_UPLOADS()	Getter for UPLOADS, with configurable default
ASK_UPLOADS()	Getter for UPLOADS w/ exceptions if field has no value
HAS_UPLOADS()	Determine if UPLOADS has a value

CommonPrefixes

If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

Accessible with the following methods

Method	Description
GET_COMMONPREFIXES()	Getter for COMMONPREFIXES, with configurable default
ASK_COMMONPREFIXES()	Getter for COMMONPREFIXES w/ exceptions if field has no valu
HAS_COMMONPREFIXES()	Determine if COMMONPREFIXES has a value

EncodingType

Encoding type used by Amazon S3 to encode object keys in the response.

If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.

Accessible with the following methods

Method	Description
GET_ENCODINGTYPE()	Getter for ENCODINGTYPE, with configurable default
ASK_ENCODINGTYPE()	Getter for ENCODINGTYPE w/ exceptions if field has no value
HAS_ENCODINGTYPE()	Determine if ENCODINGTYPE has a value

RequestCharged

RequestCharged

Accessible with the following methods

Method	Description
GET_REQUESTCHARGED()	Getter for REQUESTCHARGED, with configurable default
ASK_REQUESTCHARGED()	Getter for REQUESTCHARGED w/ exceptions if field has no valu
HAS_REQUESTCHARGED()	Determine if REQUESTCHARGED has a value