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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

The bucket name that contains the objects.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Returns:

  • (String)


7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7017

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


7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7017

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


7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7017

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

#key_markerString

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

Returns:

  • (String)


7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7017

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

#max_keysInteger

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.

Returns:

  • (Integer)


7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7017

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


7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7017

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

#version_id_markerString

Specifies the object version you want to start listing from.

Returns:

  • (String)


7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7017

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