You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::S3::Types::ListObjectsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::ListObjectsRequest
- Defined in:
- (unknown)
Overview
When passing ListObjectsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
bucket: "BucketName", # required
delimiter: "Delimiter",
encoding_type: "url", # accepts url
marker: "Marker",
max_keys: 1,
prefix: "Prefix",
request_payer: "requester", # accepts requester
expected_bucket_owner: "AccountId",
use_accelerate_endpoint: false,
}
Instance Attribute Summary collapse
-
#bucket ⇒ String
The name of the bucket containing the objects.
-
#delimiter ⇒ String
A delimiter is a character you use to group keys.
-
#encoding_type ⇒ String
Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use.
-
#expected_bucket_owner ⇒ String
The account id of the expected bucket owner.
-
#marker ⇒ String
Specifies the key to start with when listing objects in a bucket.
-
#max_keys ⇒ Integer
Sets the maximum number of keys returned in the response.
-
#prefix ⇒ 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.
-
#use_accelerate_endpoint ⇒ Boolean
When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.
Instance Attribute Details
#bucket ⇒ String
The name of the bucket containing 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 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.
#delimiter ⇒ String
A delimiter is a character you use to group keys.
#encoding_type ⇒ String
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.
Possible values:
- url
#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.
#marker ⇒ String
Specifies the key to start with when listing objects in a bucket.
#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.
#prefix ⇒ 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. Bucket owners need not specify this parameter in their requests.
Possible values:
- requester
#use_accelerate_endpoint ⇒ Boolean
When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.