AWSS3ListObjectsOutput

Objective-C

@interface AWSS3ListObjectsOutput

Swift

class AWSS3ListObjectsOutput

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

    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 the 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSS3CommonPrefix *> *_Nullable commonPrefixes;

    Swift

    var commonPrefixes: [AWSS3CommonPrefix]? { get set }

  • Metadata about each object returned.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSS3Object *> *_Nullable contents;

    Swift

    var contents: [AWSS3Object]? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable delimiter;

    Swift

    var delimiter: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSS3EncodingType encodingType;

    Swift

    var encodingType: AWSS3EncodingType { get set }

  • A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable isTruncated;

    Swift

    var isTruncated: NSNumber? { get set }

  • Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable marker;

    Swift

    var marker: String? { get set }

  • The maximum number of keys returned in the response body.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable maxKeys;

    Swift

    var maxKeys: NSNumber? { get set }

  • The bucket name.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable name;

    Swift

    var name: String? { get set }

  • When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMarker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable nextMarker;

    Swift

    var nextMarker: String? { get set }

  • Keys that begin with the indicated prefix.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable prefix;

    Swift

    var prefix: String? { get set }