ListObjectsV2Request

public struct ListObjectsV2Request : AWSShape
extension S3.ListObjectsV2Request: AWSPaginateStringToken

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let bucket: String

  • 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

    Swift

    public let continuationToken: String?

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

    Declaration

    Swift

    public let delimiter: String?

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

    Declaration

    Swift

    public let encodingType: EncodingType?

  • 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

    Swift

    public let expectedBucketOwner: String?

  • 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

    Swift

    public let fetchOwner: Bool?

  • 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

    Swift

    public let maxKeys: Int?

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

    Declaration

    Swift

    public let prefix: String?

  • 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

    Swift

    public let requestPayer: RequestPayer?

  • 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

    Swift

    public let startAfter: String?

  • Undocumented

    Declaration

    Swift

    public init(bucket: String, continuationToken: String? = nil, delimiter: String? = nil, encodingType: EncodingType? = nil, expectedBucketOwner: String? = nil, fetchOwner: Bool? = nil, maxKeys: Int? = nil, prefix: String? = nil, requestPayer: RequestPayer? = nil, startAfter: String? = nil)

Paginators

  • Undocumented

    Declaration

    Swift

    public func usingPaginationToken(_ token: String) -> S3.ListObjectsV2Request