Class: Aws::S3::Types::ListObjectVersionsOutput

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#common_prefixesArray<Types::CommonPrefix>

All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

Returns:


8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-s3/types.rb', line 8196

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  SENSITIVE = []
  include Aws::Structure
end

#delete_markersArray<Types::DeleteMarkerEntry>

Container for an object that is a delete marker.

Returns:


8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-s3/types.rb', line 8196

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  SENSITIVE = []
  include Aws::Structure
end

#delimiterString

The delimiter grouping the included keys. 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)

8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-s3/types.rb', line 8196

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  SENSITIVE = []
  include Aws::Structure
end

#encoding_typeString

Encoding type used by Amazon S3 to encode object key names in the XML response.

If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

`KeyMarker, NextKeyMarker, Prefix, Key`, and `Delimiter`.

Returns:

  • (String)

8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-s3/types.rb', line 8196

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  SENSITIVE = []
  include Aws::Structure
end

#is_truncatedBoolean

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.

Returns:

  • (Boolean)

8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-s3/types.rb', line 8196

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  SENSITIVE = []
  include Aws::Structure
end

#key_markerString

Marks the last key returned in a truncated response.

Returns:

  • (String)

8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-s3/types.rb', line 8196

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  SENSITIVE = []
  include Aws::Structure
end

#max_keysInteger

Specifies the maximum number of objects to return.

Returns:

  • (Integer)

8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-s3/types.rb', line 8196

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The bucket name.

Returns:

  • (String)

8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-s3/types.rb', line 8196

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  SENSITIVE = []
  include Aws::Structure
end

#next_key_markerString

When the number of responses exceeds the value of `MaxKeys`, `NextKeyMarker` specifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.

Returns:

  • (String)

8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-s3/types.rb', line 8196

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  SENSITIVE = []
  include Aws::Structure
end

#next_version_id_markerString

When the number of responses exceeds the value of `MaxKeys`, `NextVersionIdMarker` specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request.

Returns:

  • (String)

8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-s3/types.rb', line 8196

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  SENSITIVE = []
  include Aws::Structure
end

#prefixString

Selects objects that start with the value supplied by this parameter.

Returns:

  • (String)

8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-s3/types.rb', line 8196

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  SENSITIVE = []
  include Aws::Structure
end

#version_id_markerString

Marks the last version of the key returned in a truncated response.

Returns:

  • (String)

8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-s3/types.rb', line 8196

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  SENSITIVE = []
  include Aws::Structure
end

#versionsArray<Types::ObjectVersion>

Container for version information.

Returns:


8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
# File 'lib/aws-sdk-s3/types.rb', line 8196

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  SENSITIVE = []
  include Aws::Structure
end

Instance Method Details

#versions_delete_markersObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

TODO : Remove this customization once the resource code

generator correct handles the JMESPath || expression.
Only used by the Bucket#object_versions collection.

9
10
11
# File 'lib/aws-sdk-s3/customizations/types/list_object_versions_output.rb', line 9

def versions_delete_markers
  versions + delete_markers
end