AWSS3ListObjectsV2Request

Objective-C

@interface AWSS3ListObjectsV2Request

Swift

class AWSS3ListObjectsV2Request

  • Bucket name to list.

    When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

    When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

    Declaration

    Objective-C

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

    Swift

    var bucket: String? { get set }

  • ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.

    Declaration

    Objective-C

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

    Swift

    var continuationToken: String? { get set }

  • A delimiter is a character you use to group keys.

    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 }

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

  • The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true.

    Declaration

    Objective-C

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

    Swift

    var fetchOwner: NSNumber? { 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.

    Declaration

    Objective-C

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

    Swift

    var maxKeys: NSNumber? { get set }

  • Limits the response to keys that begin with the specified prefix.

    Declaration

    Objective-C

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

    Swift

    var prefix: String? { get set }

  • Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

    Declaration

    Objective-C

    @property (nonatomic) AWSS3RequestPayer requestPayer;

    Swift

    var requestPayer: AWSS3RequestPayer { get set }

  • StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.

    Declaration

    Objective-C

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

    Swift

    var startAfter: String? { get set }