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

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::ListObjectVersionsRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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

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

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

• #optional_object_attributes ⇒ Array<String>

  Specifies the optional fields that you want returned in the response.

• #prefix ⇒ String

  Use this parameter to select only those keys that begin with the specified prefix.

• #request_payer ⇒ String

  Confirms that the requester knows that they will be charged for the request.

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

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 10469

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

#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.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 10469

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

#encoding_type ⇒ String

Encoding type used by Amazon S3 to encode the [object keys] in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can’t parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren’t supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see [Object key naming guidelines].

<note markdown=“1”> When using the URL encoding type, non-ASCII characters that are used in an object’s key name will be percent-encoded according to UTF-8 code values. For example, the object ‘test_file(3).png` will appear as `test_file%283%29.png`.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 10469

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

#expected_bucket_owner ⇒ String

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 10469

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

#key_marker ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 10469

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

#max_keys ⇒ Integer

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`.

Returns:

• (Integer)

# File 'lib/aws-sdk-s3/types.rb', line 10469

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

#optional_object_attributes ⇒ Array<String>

Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-s3/types.rb', line 10469

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

#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 that 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)

# File 'lib/aws-sdk-s3/types.rb', line 10469

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

#request_payer ⇒ String

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 10469

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

#version_id_marker ⇒ String

Specifies the object version you want to start listing from.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 10469

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