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

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 ListObjectsV2Request data as a 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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

Bucket name to list.

When using this action 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

When using this action 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 action using S3 on Outposts through the Amazon Web Services 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 S3 User Guide.

Returns:

  • (String)


8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8704

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

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


8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8704

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#delimiterString

A delimiter is a character you use to group keys.

Returns:

  • (String)


8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8704

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#encoding_typeString

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

Returns:

  • (String)


8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8704

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#expected_bucket_ownerString

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)


8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8704

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

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


8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8704

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#max_keysInteger

Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Returns:

  • (Integer)


8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8704

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#prefixString

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

Returns:

  • (String)


8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8704

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String)


8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8704

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

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


8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8704

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end