You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::S3::Types::ListObjectVersionsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::ListObjectVersionsRequest
- Defined in:
- (unknown)
Overview
When passing ListObjectVersionsRequest as input to an Aws::Client method, you can use a vanilla 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",
use_accelerate_endpoint: false,
}
Instance Attribute Summary collapse
-
#bucket ⇒ String
The bucket name that contains the objects.
-
#delimiter ⇒ String
A delimiter is a character that you specify to group keys.
-
#encoding_type ⇒ String
Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use.
-
#expected_bucket_owner ⇒ String
The account id of the expected bucket owner.
-
#key_marker ⇒ String
Specifies the key to start with when listing objects in a bucket.
-
#max_keys ⇒ Integer
Sets the maximum number of keys returned in the response.
-
#prefix ⇒ String
Use this parameter to select only those keys that begin with the specified prefix.
-
#use_accelerate_endpoint ⇒ Boolean
When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.
-
#version_id_marker ⇒ String
Specifies the object version you want to start listing from.
Instance Attribute Details
#bucket ⇒ String
The bucket name that contains the objects.
#delimiter ⇒ String
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.
#encoding_type ⇒ String
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.
Possible values:
- url
#expected_bucket_owner ⇒ String
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.
#key_marker ⇒ String
Specifies the key to start with when listing objects in a bucket.
#max_keys ⇒ Integer
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.
#prefix ⇒ String
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.
#use_accelerate_endpoint ⇒ Boolean
When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.
#version_id_marker ⇒ String
Specifies the object version you want to start listing from.