Class: Aws::S3::Types::ListObjectVersionsRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-s3/types.rb

Overview

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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

The bucket name that contains the objects.

Returns:

  • (String)

8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
# File 'lib/aws-sdk-s3/types.rb', line 8285

class ListObjectVersionsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_keys,
  :prefix,
  :version_id_marker,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#delimiterString

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.

Returns:

  • (String)

8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
# File 'lib/aws-sdk-s3/types.rb', line 8285

class ListObjectVersionsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_keys,
  :prefix,
  :version_id_marker,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#encoding_typeString

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.

Returns:

  • (String)

8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
# File 'lib/aws-sdk-s3/types.rb', line 8285

class ListObjectVersionsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_keys,
  :prefix,
  :version_id_marker,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#expected_bucket_ownerString

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.

Returns:

  • (String)

8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
# File 'lib/aws-sdk-s3/types.rb', line 8285

class ListObjectVersionsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_keys,
  :prefix,
  :version_id_marker,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#key_markerString

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

Returns:

  • (String)

8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
# File 'lib/aws-sdk-s3/types.rb', line 8285

class ListObjectVersionsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_keys,
  :prefix,
  :version_id_marker,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#max_keysInteger

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 &lt;isTruncated&gt;true&lt;/isTruncated&gt;. To return the additional keys, see key-marker and version-id-marker.

Returns:

  • (Integer)

8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
# File 'lib/aws-sdk-s3/types.rb', line 8285

class ListObjectVersionsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_keys,
  :prefix,
  :version_id_marker,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#prefixString

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.

Returns:

  • (String)

8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
# File 'lib/aws-sdk-s3/types.rb', line 8285

class ListObjectVersionsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_keys,
  :prefix,
  :version_id_marker,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#version_id_markerString

Specifies the object version you want to start listing from.

Returns:

  • (String)

8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
# File 'lib/aws-sdk-s3/types.rb', line 8285

class ListObjectVersionsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_keys,
  :prefix,
  :version_id_marker,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end