Skip to content

/AWS1/CL_S3_LISTOBJSV2OUTPUT

ListObjectsV2Output

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_istruncated TYPE /AWS1/S3_ISTRUNCATED /AWS1/S3_ISTRUNCATED

Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.

it_contents TYPE /AWS1/CL_S3_OBJECT=>TT_OBJECTLIST TT_OBJECTLIST

Metadata about each object returned.

iv_name TYPE /AWS1/S3_BUCKETNAME /AWS1/S3_BUCKETNAME

The bucket name.

iv_prefix TYPE /AWS1/S3_PREFIX /AWS1/S3_PREFIX

Keys that begin with the indicated prefix.

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

iv_delimiter TYPE /AWS1/S3_DELIMITER /AWS1/S3_DELIMITER

Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.

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

iv_maxkeys TYPE /AWS1/S3_MAXKEYS /AWS1/S3_MAXKEYS

Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

it_commonprefixes TYPE /AWS1/CL_S3_COMMONPREFIX=>TT_COMMONPREFIXLIST TT_COMMONPREFIXLIST

All of the keys (up to 1,000) that share the same prefix are grouped together. When counting the total numbers of returns by this API operation, this group of keys is considered as one item.

A response can contain CommonPrefixes only if you specify a delimiter.

CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter.

CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

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

  • Directory buckets - When you query ListObjectsV2 with a delimiter during in-progress multipart uploads, the CommonPrefixes response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.

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:

Delimiter, Prefix, Key, and StartAfter.

iv_keycount TYPE /AWS1/S3_KEYCOUNT /AWS1/S3_KEYCOUNT

KeyCount is the number of keys returned with this request. KeyCount will always be less than or equal to the MaxKeys field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.

iv_continuationtoken TYPE /AWS1/S3_TOKEN /AWS1/S3_TOKEN

If ContinuationToken was sent with the request, it is included in the response. You can use the returned ContinuationToken for pagination of the list response.

iv_nextcontinuationtoken TYPE /AWS1/S3_NEXTTOKEN /AWS1/S3_NEXTTOKEN

NextContinuationToken is sent when isTruncated is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key

iv_startafter TYPE /AWS1/S3_STARTAFTER /AWS1/S3_STARTAFTER

If StartAfter was sent with the request, it is included in the response.

This functionality is not supported for directory buckets.

iv_requestcharged TYPE /AWS1/S3_REQUESTCHARGED /AWS1/S3_REQUESTCHARGED

RequestCharged

Queryable Attributes

IsTruncated

Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.

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

Contents

Metadata about each object returned.

Accessible with the following methods

Method Description
GET_CONTENTS() Getter for CONTENTS, with configurable default
ASK_CONTENTS() Getter for CONTENTS w/ exceptions if field has no value
HAS_CONTENTS() Determine if CONTENTS 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

Keys that begin with the indicated 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

Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.

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

MaxKeys

Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

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 (up to 1,000) that share the same prefix are grouped together. When counting the total numbers of returns by this API operation, this group of keys is considered as one item.

A response can contain CommonPrefixes only if you specify a delimiter.

CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter.

CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

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

  • Directory buckets - When you query ListObjectsV2 with a delimiter during in-progress multipart uploads, the CommonPrefixes response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.

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:

Delimiter, Prefix, Key, and StartAfter.

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

KeyCount

KeyCount is the number of keys returned with this request. KeyCount will always be less than or equal to the MaxKeys field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.

Accessible with the following methods

Method Description
GET_KEYCOUNT() Getter for KEYCOUNT, with configurable default
ASK_KEYCOUNT() Getter for KEYCOUNT w/ exceptions if field has no value
HAS_KEYCOUNT() Determine if KEYCOUNT has a value

ContinuationToken

If ContinuationToken was sent with the request, it is included in the response. You can use the returned ContinuationToken for pagination of the list response.

Accessible with the following methods

Method Description
GET_CONTINUATIONTOKEN() Getter for CONTINUATIONTOKEN, with configurable default
ASK_CONTINUATIONTOKEN() Getter for CONTINUATIONTOKEN w/ exceptions if field has no v
HAS_CONTINUATIONTOKEN() Determine if CONTINUATIONTOKEN has a value

NextContinuationToken

NextContinuationToken is sent when isTruncated is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key

Accessible with the following methods

Method Description
GET_NEXTCONTINUATIONTOKEN() Getter for NEXTCONTINUATIONTOKEN, with configurable default
ASK_NEXTCONTINUATIONTOKEN() Getter for NEXTCONTINUATIONTOKEN w/ exceptions if field has
HAS_NEXTCONTINUATIONTOKEN() Determine if NEXTCONTINUATIONTOKEN has a value

StartAfter

If StartAfter was sent with the request, it is included in the response.

This functionality is not supported for directory buckets.

Accessible with the following methods

Method Description
GET_STARTAFTER() Getter for STARTAFTER, with configurable default
ASK_STARTAFTER() Getter for STARTAFTER w/ exceptions if field has no value
HAS_STARTAFTER() Determine if STARTAFTER 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