ListObjectsRequest

public struct ListObjectsRequest : AWSShape
extension S3.ListObjectsRequest: AWSPaginateStringToken

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The name of the bucket containing the objects.

    Declaration

    Swift

    public let bucket: String

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

    Declaration

    Swift

    public let delimiter: String?

  • Undocumented

    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?

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

    Declaration

    Swift

    public let marker: String?

  • 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. Bucket owners need not specify this parameter in their requests.

    Declaration

    Swift

    public let requestPayer: RequestPayer?

  • Undocumented

    Declaration

    Swift

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

Paginators

  • Undocumented

    Declaration

    Swift

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