aws_sdk_s3/operation/list_objects_v2/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_objects_v2::_list_objects_v2_output::ListObjectsV2OutputBuilder;
3
4pub use crate::operation::list_objects_v2::_list_objects_v2_input::ListObjectsV2InputBuilder;
5
6impl crate::operation::list_objects_v2::builders::ListObjectsV2InputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::list_objects_v2::ListObjectsV2Output,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::list_objects_v2::ListObjectsV2Error,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.list_objects_v2();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `ListObjectsV2`.
24///
25/// <important>
26/// <p>End of support notice: Beginning November 21, 2025, Amazon S3 will stop returning <code>DisplayName</code>. Update your applications to use canonical IDs (unique identifier for Amazon Web Services accounts), Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full resource naming) as a direct replacement of <code>DisplayName</code>.</p>
27/// <p>This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.</p>
28/// </important>
29/// <p>Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A <code>200 OK</code> response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. For more information about listing objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html">Listing object keys programmatically</a> in the <i>Amazon S3 User Guide</i>. To get a list of your buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a>.</p><note>
30/// <ul>
31/// <li>
32/// <p><b>General purpose bucket</b> - For general purpose buckets, <code>ListObjectsV2</code> doesn't return prefixes that are related only to in-progress multipart uploads.</p></li>
33/// <li>
34/// <p><b>Directory buckets</b> - For directory buckets, <code>ListObjectsV2</code> response includes the prefixes that are related only to in-progress multipart uploads.</p></li>
35/// <li>
36/// <p><b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p></li>
37/// </ul>
38/// </note>
39/// <dl>
40/// <dt>
41/// Permissions
42/// </dt>
43/// <dd>
44/// <ul>
45/// <li>
46/// <p><b>General purpose bucket permissions</b> - To use this operation, you must have READ access to the bucket. You must have permission to perform the <code>s3:ListBucket</code> action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>.</p></li>
47/// <li>
48/// <p><b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html"> <code>CreateSession</code> </a>.</p></li>
49/// </ul>
50/// </dd>
51/// <dt>
52/// Sorting order of returned objects
53/// </dt>
54/// <dd>
55/// <ul>
56/// <li>
57/// <p><b>General purpose bucket</b> - For general purpose buckets, <code>ListObjectsV2</code> returns objects in lexicographical order based on their key names.</p></li>
58/// <li>
59/// <p><b>Directory bucket</b> - For directory buckets, <code>ListObjectsV2</code> does not return objects in lexicographical order.</p></li>
60/// </ul>
61/// </dd>
62/// <dt>
63/// HTTP Host header syntax
64/// </dt>
65/// <dd>
66/// <p><b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p>
67/// </dd>
68/// </dl><important>
69/// <p>This section describes the latest revision of this action. We recommend that you use this revised API operation for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API operation, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a>.</p>
70/// </important>
71/// <p>The following operations are related to <code>ListObjectsV2</code>:</p>
72/// <ul>
73/// <li>
74/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a></p></li>
75/// <li>
76/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a></p></li>
77/// <li>
78/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a></p></li>
79/// </ul><important>
80/// <p>You must URL encode any signed header values that contain spaces. For example, if your header value is <code>my file.txt</code>, containing two spaces after <code>my</code>, you must URL encode this value to <code>my%20%20file.txt</code>.</p>
81/// </important>
82#[derive(::std::clone::Clone, ::std::fmt::Debug)]
83pub struct ListObjectsV2FluentBuilder {
84 handle: ::std::sync::Arc<crate::client::Handle>,
85 inner: crate::operation::list_objects_v2::builders::ListObjectsV2InputBuilder,
86 config_override: ::std::option::Option<crate::config::Builder>,
87}
88impl
89 crate::client::customize::internal::CustomizableSend<
90 crate::operation::list_objects_v2::ListObjectsV2Output,
91 crate::operation::list_objects_v2::ListObjectsV2Error,
92 > for ListObjectsV2FluentBuilder
93{
94 fn send(
95 self,
96 config_override: crate::config::Builder,
97 ) -> crate::client::customize::internal::BoxFuture<
98 crate::client::customize::internal::SendResult<
99 crate::operation::list_objects_v2::ListObjectsV2Output,
100 crate::operation::list_objects_v2::ListObjectsV2Error,
101 >,
102 > {
103 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
104 }
105}
106impl ListObjectsV2FluentBuilder {
107 /// Creates a new `ListObjectsV2FluentBuilder`.
108 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
109 Self {
110 handle,
111 inner: ::std::default::Default::default(),
112 config_override: ::std::option::Option::None,
113 }
114 }
115 /// Access the ListObjectsV2 as a reference.
116 pub fn as_input(&self) -> &crate::operation::list_objects_v2::builders::ListObjectsV2InputBuilder {
117 &self.inner
118 }
119 /// Sends the request and returns the response.
120 ///
121 /// If an error occurs, an `SdkError` will be returned with additional details that
122 /// can be matched against.
123 ///
124 /// By default, any retryable failures will be retried twice. Retry behavior
125 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
126 /// set when configuring the client.
127 pub async fn send(
128 self,
129 ) -> ::std::result::Result<
130 crate::operation::list_objects_v2::ListObjectsV2Output,
131 ::aws_smithy_runtime_api::client::result::SdkError<
132 crate::operation::list_objects_v2::ListObjectsV2Error,
133 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
134 >,
135 > {
136 let input = self
137 .inner
138 .build()
139 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
140 let runtime_plugins = crate::operation::list_objects_v2::ListObjectsV2::operation_runtime_plugins(
141 self.handle.runtime_plugins.clone(),
142 &self.handle.conf,
143 self.config_override,
144 );
145 crate::operation::list_objects_v2::ListObjectsV2::orchestrate(&runtime_plugins, input).await
146 }
147
148 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
149 pub fn customize(
150 self,
151 ) -> crate::client::customize::CustomizableOperation<
152 crate::operation::list_objects_v2::ListObjectsV2Output,
153 crate::operation::list_objects_v2::ListObjectsV2Error,
154 Self,
155 > {
156 crate::client::customize::CustomizableOperation::new(self)
157 }
158 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
159 self.set_config_override(::std::option::Option::Some(config_override.into()));
160 self
161 }
162
163 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
164 self.config_override = config_override;
165 self
166 }
167 /// Create a paginator for this request
168 ///
169 /// Paginators are used by calling [`send().await`](crate::operation::list_objects_v2::paginator::ListObjectsV2Paginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
170 pub fn into_paginator(self) -> crate::operation::list_objects_v2::paginator::ListObjectsV2Paginator {
171 crate::operation::list_objects_v2::paginator::ListObjectsV2Paginator::new(self.handle, self.inner)
172 }
173 /// <p><b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p>
174 /// <p><b>Access points</b> - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p><note>
175 /// <p>Object Lambda access points are not supported by directory buckets.</p>
176 /// </note>
177 /// <p><b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
178 pub fn bucket(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
179 self.inner = self.inner.bucket(input.into());
180 self
181 }
182 /// <p><b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p>
183 /// <p><b>Access points</b> - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p><note>
184 /// <p>Object Lambda access points are not supported by directory buckets.</p>
185 /// </note>
186 /// <p><b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
187 pub fn set_bucket(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
188 self.inner = self.inner.set_bucket(input);
189 self
190 }
191 /// <p><b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p>
192 /// <p><b>Access points</b> - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p><note>
193 /// <p>Object Lambda access points are not supported by directory buckets.</p>
194 /// </note>
195 /// <p><b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
196 pub fn get_bucket(&self) -> &::std::option::Option<::std::string::String> {
197 self.inner.get_bucket()
198 }
199 /// <p>A delimiter is a character that you use to group keys.</p>
200 /// <p><code>CommonPrefixes</code> is filtered out from results if it is not lexicographically greater than the <code>StartAfter</code> value.</p><note>
201 /// <ul>
202 /// <li>
203 /// <p><b>Directory buckets</b> - For directory buckets, <code>/</code> is the only supported delimiter.</p></li>
204 /// <li>
205 /// <p><b>Directory buckets </b> - When you query <code>ListObjectsV2</code> with a delimiter during in-progress multipart uploads, the <code>CommonPrefixes</code> response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart Upload Overview</a> in the <i>Amazon S3 User Guide</i>.</p></li>
206 /// </ul>
207 /// </note>
208 pub fn delimiter(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
209 self.inner = self.inner.delimiter(input.into());
210 self
211 }
212 /// <p>A delimiter is a character that you use to group keys.</p>
213 /// <p><code>CommonPrefixes</code> is filtered out from results if it is not lexicographically greater than the <code>StartAfter</code> value.</p><note>
214 /// <ul>
215 /// <li>
216 /// <p><b>Directory buckets</b> - For directory buckets, <code>/</code> is the only supported delimiter.</p></li>
217 /// <li>
218 /// <p><b>Directory buckets </b> - When you query <code>ListObjectsV2</code> with a delimiter during in-progress multipart uploads, the <code>CommonPrefixes</code> response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart Upload Overview</a> in the <i>Amazon S3 User Guide</i>.</p></li>
219 /// </ul>
220 /// </note>
221 pub fn set_delimiter(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
222 self.inner = self.inner.set_delimiter(input);
223 self
224 }
225 /// <p>A delimiter is a character that you use to group keys.</p>
226 /// <p><code>CommonPrefixes</code> is filtered out from results if it is not lexicographically greater than the <code>StartAfter</code> value.</p><note>
227 /// <ul>
228 /// <li>
229 /// <p><b>Directory buckets</b> - For directory buckets, <code>/</code> is the only supported delimiter.</p></li>
230 /// <li>
231 /// <p><b>Directory buckets </b> - When you query <code>ListObjectsV2</code> with a delimiter during in-progress multipart uploads, the <code>CommonPrefixes</code> response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart Upload Overview</a> in the <i>Amazon S3 User Guide</i>.</p></li>
232 /// </ul>
233 /// </note>
234 pub fn get_delimiter(&self) -> &::std::option::Option<::std::string::String> {
235 self.inner.get_delimiter()
236 }
237 /// <p>Encoding type used by Amazon S3 to encode the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html">object keys</a> in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines">Object key naming guidelines</a>.</p><note>
238 /// <p>When using the URL encoding type, non-ASCII characters that are used in an object's key name will be percent-encoded according to UTF-8 code values. For example, the object <code>test_file(3).png</code> will appear as <code>test_file%283%29.png</code>.</p>
239 /// </note>
240 pub fn encoding_type(mut self, input: crate::types::EncodingType) -> Self {
241 self.inner = self.inner.encoding_type(input);
242 self
243 }
244 /// <p>Encoding type used by Amazon S3 to encode the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html">object keys</a> in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines">Object key naming guidelines</a>.</p><note>
245 /// <p>When using the URL encoding type, non-ASCII characters that are used in an object's key name will be percent-encoded according to UTF-8 code values. For example, the object <code>test_file(3).png</code> will appear as <code>test_file%283%29.png</code>.</p>
246 /// </note>
247 pub fn set_encoding_type(mut self, input: ::std::option::Option<crate::types::EncodingType>) -> Self {
248 self.inner = self.inner.set_encoding_type(input);
249 self
250 }
251 /// <p>Encoding type used by Amazon S3 to encode the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html">object keys</a> in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines">Object key naming guidelines</a>.</p><note>
252 /// <p>When using the URL encoding type, non-ASCII characters that are used in an object's key name will be percent-encoded according to UTF-8 code values. For example, the object <code>test_file(3).png</code> will appear as <code>test_file%283%29.png</code>.</p>
253 /// </note>
254 pub fn get_encoding_type(&self) -> &::std::option::Option<crate::types::EncodingType> {
255 self.inner.get_encoding_type()
256 }
257 /// <p>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.</p>
258 pub fn max_keys(mut self, input: i32) -> Self {
259 self.inner = self.inner.max_keys(input);
260 self
261 }
262 /// <p>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.</p>
263 pub fn set_max_keys(mut self, input: ::std::option::Option<i32>) -> Self {
264 self.inner = self.inner.set_max_keys(input);
265 self
266 }
267 /// <p>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.</p>
268 pub fn get_max_keys(&self) -> &::std::option::Option<i32> {
269 self.inner.get_max_keys()
270 }
271 /// <p>Limits the response to keys that begin with the specified prefix.</p><note>
272 /// <p><b>Directory buckets</b> - For directory buckets, only prefixes that end in a delimiter (<code>/</code>) are supported.</p>
273 /// </note>
274 pub fn prefix(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
275 self.inner = self.inner.prefix(input.into());
276 self
277 }
278 /// <p>Limits the response to keys that begin with the specified prefix.</p><note>
279 /// <p><b>Directory buckets</b> - For directory buckets, only prefixes that end in a delimiter (<code>/</code>) are supported.</p>
280 /// </note>
281 pub fn set_prefix(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
282 self.inner = self.inner.set_prefix(input);
283 self
284 }
285 /// <p>Limits the response to keys that begin with the specified prefix.</p><note>
286 /// <p><b>Directory buckets</b> - For directory buckets, only prefixes that end in a delimiter (<code>/</code>) are supported.</p>
287 /// </note>
288 pub fn get_prefix(&self) -> &::std::option::Option<::std::string::String> {
289 self.inner.get_prefix()
290 }
291 /// <p><code>ContinuationToken</code> indicates to Amazon S3 that the list is being continued on this bucket with a token. <code>ContinuationToken</code> is obfuscated and is not a real key. You can use this <code>ContinuationToken</code> for pagination of the list results.</p>
292 pub fn continuation_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
293 self.inner = self.inner.continuation_token(input.into());
294 self
295 }
296 /// <p><code>ContinuationToken</code> indicates to Amazon S3 that the list is being continued on this bucket with a token. <code>ContinuationToken</code> is obfuscated and is not a real key. You can use this <code>ContinuationToken</code> for pagination of the list results.</p>
297 pub fn set_continuation_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
298 self.inner = self.inner.set_continuation_token(input);
299 self
300 }
301 /// <p><code>ContinuationToken</code> indicates to Amazon S3 that the list is being continued on this bucket with a token. <code>ContinuationToken</code> is obfuscated and is not a real key. You can use this <code>ContinuationToken</code> for pagination of the list results.</p>
302 pub fn get_continuation_token(&self) -> &::std::option::Option<::std::string::String> {
303 self.inner.get_continuation_token()
304 }
305 /// <p>The owner field is not present in <code>ListObjectsV2</code> by default. If you want to return the owner field with each key in the result, then set the <code>FetchOwner</code> field to <code>true</code>.</p><note>
306 /// <p><b>Directory buckets</b> - For directory buckets, the bucket owner is returned as the object owner for all objects.</p>
307 /// </note>
308 pub fn fetch_owner(mut self, input: bool) -> Self {
309 self.inner = self.inner.fetch_owner(input);
310 self
311 }
312 /// <p>The owner field is not present in <code>ListObjectsV2</code> by default. If you want to return the owner field with each key in the result, then set the <code>FetchOwner</code> field to <code>true</code>.</p><note>
313 /// <p><b>Directory buckets</b> - For directory buckets, the bucket owner is returned as the object owner for all objects.</p>
314 /// </note>
315 pub fn set_fetch_owner(mut self, input: ::std::option::Option<bool>) -> Self {
316 self.inner = self.inner.set_fetch_owner(input);
317 self
318 }
319 /// <p>The owner field is not present in <code>ListObjectsV2</code> by default. If you want to return the owner field with each key in the result, then set the <code>FetchOwner</code> field to <code>true</code>.</p><note>
320 /// <p><b>Directory buckets</b> - For directory buckets, the bucket owner is returned as the object owner for all objects.</p>
321 /// </note>
322 pub fn get_fetch_owner(&self) -> &::std::option::Option<bool> {
323 self.inner.get_fetch_owner()
324 }
325 /// <p>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.</p><note>
326 /// <p>This functionality is not supported for directory buckets.</p>
327 /// </note>
328 pub fn start_after(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
329 self.inner = self.inner.start_after(input.into());
330 self
331 }
332 /// <p>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.</p><note>
333 /// <p>This functionality is not supported for directory buckets.</p>
334 /// </note>
335 pub fn set_start_after(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
336 self.inner = self.inner.set_start_after(input);
337 self
338 }
339 /// <p>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.</p><note>
340 /// <p>This functionality is not supported for directory buckets.</p>
341 /// </note>
342 pub fn get_start_after(&self) -> &::std::option::Option<::std::string::String> {
343 self.inner.get_start_after()
344 }
345 /// <p>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.</p><note>
346 /// <p>This functionality is not supported for directory buckets.</p>
347 /// </note>
348 pub fn request_payer(mut self, input: crate::types::RequestPayer) -> Self {
349 self.inner = self.inner.request_payer(input);
350 self
351 }
352 /// <p>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.</p><note>
353 /// <p>This functionality is not supported for directory buckets.</p>
354 /// </note>
355 pub fn set_request_payer(mut self, input: ::std::option::Option<crate::types::RequestPayer>) -> Self {
356 self.inner = self.inner.set_request_payer(input);
357 self
358 }
359 /// <p>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.</p><note>
360 /// <p>This functionality is not supported for directory buckets.</p>
361 /// </note>
362 pub fn get_request_payer(&self) -> &::std::option::Option<crate::types::RequestPayer> {
363 self.inner.get_request_payer()
364 }
365 /// <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
366 pub fn expected_bucket_owner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
367 self.inner = self.inner.expected_bucket_owner(input.into());
368 self
369 }
370 /// <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
371 pub fn set_expected_bucket_owner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
372 self.inner = self.inner.set_expected_bucket_owner(input);
373 self
374 }
375 /// <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
376 pub fn get_expected_bucket_owner(&self) -> &::std::option::Option<::std::string::String> {
377 self.inner.get_expected_bucket_owner()
378 }
379 ///
380 /// Appends an item to `OptionalObjectAttributes`.
381 ///
382 /// To override the contents of this collection use [`set_optional_object_attributes`](Self::set_optional_object_attributes).
383 ///
384 /// <p>Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.</p><note>
385 /// <p>This functionality is not supported for directory buckets.</p>
386 /// </note>
387 pub fn optional_object_attributes(mut self, input: crate::types::OptionalObjectAttributes) -> Self {
388 self.inner = self.inner.optional_object_attributes(input);
389 self
390 }
391 /// <p>Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.</p><note>
392 /// <p>This functionality is not supported for directory buckets.</p>
393 /// </note>
394 pub fn set_optional_object_attributes(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::OptionalObjectAttributes>>) -> Self {
395 self.inner = self.inner.set_optional_object_attributes(input);
396 self
397 }
398 /// <p>Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.</p><note>
399 /// <p>This functionality is not supported for directory buckets.</p>
400 /// </note>
401 pub fn get_optional_object_attributes(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::OptionalObjectAttributes>> {
402 self.inner.get_optional_object_attributes()
403 }
404}