AWSS3ListObjectVersionsRequest

Objective-C

@interface AWSS3ListObjectVersionsRequest

Swift

class AWSS3ListObjectVersionsRequest

  • The bucket name that contains the objects.

    Declaration

    Objective-C

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

    Swift

    var bucket: String? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var delimiter: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSS3EncodingType encodingType;

    Swift

    var encodingType: AWSS3EncodingType { get set }

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

    Declaration

    Objective-C

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

    Swift

    var expectedBucketOwner: String? { get set }

  • Specifies the key to start with when listing objects in a bucket.

    Declaration

    Objective-C

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

    Swift

    var keyMarker: String? { get set }

  • Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.

    Declaration

    Objective-C

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

    Swift

    var maxKeys: NSNumber? { get set }

  • Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you’d use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

    Declaration

    Objective-C

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

    Swift

    var prefix: String? { get set }

  • Specifies the object version you want to start listing from.

    Declaration

    Objective-C

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

    Swift

    var versionIdMarker: String? { get set }