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
  expected_bucket_owner: "AccountId",
  use_accelerate_endpoint: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

Bucket name to list.

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

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

Returns:

  • (String) —

    Bucket name to list.

#continuation_token ⇒ String

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.

#delimiter ⇒ String

A delimiter is a character you use to group keys.

Returns:

  • (String) —

    A delimiter is a character you use to group keys.

#encoding_type ⇒ String

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.

#expected_bucket_owner ⇒ String

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

  • (String) —

    The account id of the expected bucket owner.

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

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_keys ⇒ Integer

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.

Returns:

  • (Integer) —

    Sets the maximum number of keys returned in the response.

#prefix ⇒ String

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_payer ⇒ String

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_after ⇒ String

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_endpoint ⇒ Boolean

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

Returns: