You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

Returns:

  • (String)


4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4462

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

#delimiterString

A delimiter is a character you use to group keys.

Returns:

  • (String)


4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4462

class ListObjectVersionsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_keys,
  :prefix,
  :version_id_marker)
  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)


4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4462

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

#key_markerString

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

Returns:

  • (String)


4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4462

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

#max_keysInteger

Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.

Returns:

  • (Integer)


4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4462

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

#prefixString

Limits the response to keys that begin with the specified prefix.

Returns:

  • (String)


4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4462

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

#version_id_markerString

Specifies the object version you want to start listing from.

Returns:

  • (String)


4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4462

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