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

Class: Aws::S3::Types::ListObjectsV2Request

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListObjectsV2Request as input to an Aws::Client method, you can use a vanilla Hash:

{
  bucket: "BucketName", # required
  delimiter: "Delimiter",
  encoding_type: "url", # accepts url
  max_keys: 1,
  prefix: "Prefix",
  continuation_token: "Token",
  fetch_owner: false,
  start_after: "StartAfter",
  request_payer: "requester", # accepts requester
  use_accelerate_endpoint: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

Name of the bucket to list.

Returns:

  • (String)

    Name of the bucket to list.

#continuation_tokenString

ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key

Returns:

  • (String)

    ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token.

#delimiterString

A delimiter is a character you use to group keys.

Returns:

  • (String)

    A delimiter is a character you use to group keys.

#encoding_typeString

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

Possible values:

  • url

Returns:

  • (String)

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

#fetch_ownerBoolean

The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true

Returns:

  • (Boolean)

    The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true.

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

    Sets the maximum number of keys returned in the response.

#prefixString

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

Returns:

  • (String)

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

#request_payerString

Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

Possible values:

  • requester

Returns:

  • (String)

    Confirms that the requester knows that she or he will be charged for the list objects request in V2 style.

#start_afterString

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket

Returns:

  • (String)

    StartAfter is where you want Amazon S3 to start listing from.

#use_accelerate_endpointBoolean

When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.

Returns: