/AWS1/CL_S3_LISTOBJVRSSOUTPUT

ListObjectVersionsOutput

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_istruncated TYPE /AWS1/S3_ISTRUNCATED /AWS1/S3_ISTRUNCATED

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request by using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.

iv_keymarker TYPE /AWS1/S3_KEYMARKER /AWS1/S3_KEYMARKER

Marks the last key returned in a truncated response.

iv_versionidmarker TYPE /AWS1/S3_VERSIONIDMARKER /AWS1/S3_VERSIONIDMARKER

Marks the last version of the key returned in a truncated response.

iv_nextkeymarker TYPE /AWS1/S3_NEXTKEYMARKER /AWS1/S3_NEXTKEYMARKER

When the number of responses exceeds the value of MaxKeys, NextKeyMarker specifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.

iv_nextversionidmarker TYPE /AWS1/S3_NEXTVERSIONIDMARKER /AWS1/S3_NEXTVERSIONIDMARKER

When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request.

it_versions TYPE /AWS1/CL_S3_OBJECTVERSION=>TT_OBJECTVERSIONLIST TT_OBJECTVERSIONLIST

Container for version information.

it_deletemarkers TYPE /AWS1/CL_S3_DELETEMARKERENTRY=>TT_DELETEMARKERS TT_DELETEMARKERS

Container for an object that is a delete marker. To learn more about delete markers, see Working with delete markers.

iv_name TYPE /AWS1/S3_BUCKETNAME /AWS1/S3_BUCKETNAME

The bucket name.

iv_prefix TYPE /AWS1/S3_PREFIX /AWS1/S3_PREFIX

Selects objects that start with the value supplied by this parameter.

iv_delimiter TYPE /AWS1/S3_DELIMITER /AWS1/S3_DELIMITER

The delimiter grouping the included keys. A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

iv_maxkeys TYPE /AWS1/S3_MAXKEYS /AWS1/S3_MAXKEYS

Specifies the maximum number of objects to return.

it_commonprefixes TYPE /AWS1/CL_S3_COMMONPREFIX=>TT_COMMONPREFIXLIST TT_COMMONPREFIXLIST

All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

iv_encodingtype TYPE /AWS1/S3_ENCODINGTYPE /AWS1/S3_ENCODINGTYPE

Encoding type used by Amazon S3 to encode object key names in the XML 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:

KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

iv_requestcharged TYPE /AWS1/S3_REQUESTCHARGED /AWS1/S3_REQUESTCHARGED

If present, indicates that the requester was successfully charged for the request. For more information, see Using Requester Pays buckets for storage transfers and usage in the Amazon Simple Storage Service user guide.

This functionality is not supported for directory buckets.

---

Queryable Attributes

IsTruncated

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request by using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.

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

KeyMarker

Marks the last key returned in a truncated response.

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

VersionIdMarker

Marks the last version of the key returned in a truncated response.

Accessible with the following methods

Method	Description
GET_VERSIONIDMARKER()	Getter for VERSIONIDMARKER, with configurable default
ASK_VERSIONIDMARKER()	Getter for VERSIONIDMARKER w/ exceptions if field has no val
HAS_VERSIONIDMARKER()	Determine if VERSIONIDMARKER has a value

NextKeyMarker

When the number of responses exceeds the value of MaxKeys, NextKeyMarker specifies the first key not returned that satisfies the search criteria. Use this value 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

NextVersionIdMarker

When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request.

Accessible with the following methods

Method	Description
GET_NEXTVERSIONIDMARKER()	Getter for NEXTVERSIONIDMARKER, with configurable default
ASK_NEXTVERSIONIDMARKER()	Getter for NEXTVERSIONIDMARKER w/ exceptions if field has no
HAS_NEXTVERSIONIDMARKER()	Determine if NEXTVERSIONIDMARKER has a value

Versions

Container for version information.

Accessible with the following methods

Method	Description
GET_VERSIONS()	Getter for VERSIONS, with configurable default
ASK_VERSIONS()	Getter for VERSIONS w/ exceptions if field has no value
HAS_VERSIONS()	Determine if VERSIONS has a value

DeleteMarkers

Container for an object that is a delete marker. To learn more about delete markers, see Working with delete markers.

Accessible with the following methods

Method	Description
GET_DELETEMARKERS()	Getter for DELETEMARKERS, with configurable default
ASK_DELETEMARKERS()	Getter for DELETEMARKERS w/ exceptions if field has no value
HAS_DELETEMARKERS()	Determine if DELETEMARKERS has a value

Name

The bucket name.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

Prefix

Selects objects that start with the value supplied by this parameter.

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

The delimiter grouping the included keys. A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

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

MaxKeys

Specifies the maximum number of objects to return.

Accessible with the following methods

Method	Description
GET_MAXKEYS()	Getter for MAXKEYS, with configurable default
ASK_MAXKEYS()	Getter for MAXKEYS w/ exceptions if field has no value
HAS_MAXKEYS()	Determine if MAXKEYS has a value

CommonPrefixes

All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

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 key names in the XML 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:

KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

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

If present, indicates that the requester was successfully charged for the request. For more information, see Using Requester Pays buckets for storage transfers and usage in the Amazon Simple Storage Service user guide.

This functionality is not supported for directory buckets.

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