class Aws::S3::Types::ListObjectVersionsRequest
@note When making an API call, you may pass ListObjectVersionsRequest
data as a hash: { bucket: "BucketName", # required delimiter: "Delimiter", encoding_type: "url", # accepts url key_marker: "KeyMarker", max_keys: 1, prefix: "Prefix", version_id_marker: "VersionIdMarker", expected_bucket_owner: "AccountId", }
@!attribute [rw] bucket
The bucket name that contains the objects. @return [String]
@!attribute [rw] delimiter
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. @return [String]
@!attribute [rw] encoding_type
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. @return [String]
@!attribute [rw] key_marker
Specifies the key to start with when listing objects in a bucket. @return [String]
@!attribute [rw] max_keys
Sets the maximum number of keys returned in the response. By default the action 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. @return [Integer]
@!attribute [rw] prefix
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. @return [String]
@!attribute [rw] version_id_marker
Specifies the object version you want to start listing from. @return [String]
@!attribute [rw] expected_bucket_owner
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. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersionsRequest AWS API Documentation
Constants
- SENSITIVE