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/// <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>
26/// <ul>
27/// <li>
28/// <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>
29/// <li>
30/// <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>
31/// <li>
32/// <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>
33/// </ul>
34/// </note>
35/// <dl>
36/// <dt>
37/// Permissions
38/// </dt>
39/// <dd>
40/// <ul>
41/// <li>
42/// <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>
43/// <li>
44/// <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>
45/// </ul>
46/// </dd>
47/// <dt>
48/// Sorting order of returned objects
49/// </dt>
50/// <dd>
51/// <ul>
52/// <li>
53/// <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>
54/// <li>
55/// <p><b>Directory bucket</b> - For directory buckets, <code>ListObjectsV2</code> does not return objects in lexicographical order.</p></li>
56/// </ul>
57/// </dd>
58/// <dt>
59/// HTTP Host header syntax
60/// </dt>
61/// <dd>
62/// <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>
63/// </dd>
64/// </dl><important>
65/// <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>
66/// </important>
67/// <p>The following operations are related to <code>ListObjectsV2</code>:</p>
68/// <ul>
69/// <li>
70/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a></p></li>
71/// <li>
72/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a></p></li>
73/// <li>
74/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a></p></li>
75/// </ul><important>
76/// <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>
77/// </important>
78#[derive(::std::clone::Clone, ::std::fmt::Debug)]
79pub struct ListObjectsV2FluentBuilder {
80 handle: ::std::sync::Arc<crate::client::Handle>,
81 inner: crate::operation::list_objects_v2::builders::ListObjectsV2InputBuilder,
82 config_override: ::std::option::Option<crate::config::Builder>,
83}
84impl
85 crate::client::customize::internal::CustomizableSend<
86 crate::operation::list_objects_v2::ListObjectsV2Output,
87 crate::operation::list_objects_v2::ListObjectsV2Error,
88 > for ListObjectsV2FluentBuilder
89{
90 fn send(
91 self,
92 config_override: crate::config::Builder,
93 ) -> crate::client::customize::internal::BoxFuture<
94 crate::client::customize::internal::SendResult<
95 crate::operation::list_objects_v2::ListObjectsV2Output,
96 crate::operation::list_objects_v2::ListObjectsV2Error,
97 >,
98 > {
99 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
100 }
101}
102impl ListObjectsV2FluentBuilder {
103 /// Creates a new `ListObjectsV2FluentBuilder`.
104 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
105 Self {
106 handle,
107 inner: ::std::default::Default::default(),
108 config_override: ::std::option::Option::None,
109 }
110 }
111 /// Access the ListObjectsV2 as a reference.
112 pub fn as_input(&self) -> &crate::operation::list_objects_v2::builders::ListObjectsV2InputBuilder {
113 &self.inner
114 }
115 /// Sends the request and returns the response.
116 ///
117 /// If an error occurs, an `SdkError` will be returned with additional details that
118 /// can be matched against.
119 ///
120 /// By default, any retryable failures will be retried twice. Retry behavior
121 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
122 /// set when configuring the client.
123 pub async fn send(
124 self,
125 ) -> ::std::result::Result<
126 crate::operation::list_objects_v2::ListObjectsV2Output,
127 ::aws_smithy_runtime_api::client::result::SdkError<
128 crate::operation::list_objects_v2::ListObjectsV2Error,
129 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
130 >,
131 > {
132 let input = self
133 .inner
134 .build()
135 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
136 let runtime_plugins = crate::operation::list_objects_v2::ListObjectsV2::operation_runtime_plugins(
137 self.handle.runtime_plugins.clone(),
138 &self.handle.conf,
139 self.config_override,
140 );
141 crate::operation::list_objects_v2::ListObjectsV2::orchestrate(&runtime_plugins, input).await
142 }
143
144 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
145 pub fn customize(
146 self,
147 ) -> crate::client::customize::CustomizableOperation<
148 crate::operation::list_objects_v2::ListObjectsV2Output,
149 crate::operation::list_objects_v2::ListObjectsV2Error,
150 Self,
151 > {
152 crate::client::customize::CustomizableOperation::new(self)
153 }
154 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
155 self.set_config_override(::std::option::Option::Some(config_override.into()));
156 self
157 }
158
159 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
160 self.config_override = config_override;
161 self
162 }
163 /// Create a paginator for this request
164 ///
165 /// 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).
166 pub fn into_paginator(self) -> crate::operation::list_objects_v2::paginator::ListObjectsV2Paginator {
167 crate::operation::list_objects_v2::paginator::ListObjectsV2Paginator::new(self.handle, self.inner)
168 }
169 /// <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>
170 /// <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>
171 /// <p>Object Lambda access points are not supported by directory buckets.</p>
172 /// </note>
173 /// <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>
174 pub fn bucket(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
175 self.inner = self.inner.bucket(input.into());
176 self
177 }
178 /// <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>
179 /// <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>
180 /// <p>Object Lambda access points are not supported by directory buckets.</p>
181 /// </note>
182 /// <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>
183 pub fn set_bucket(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
184 self.inner = self.inner.set_bucket(input);
185 self
186 }
187 /// <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>
188 /// <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>
189 /// <p>Object Lambda access points are not supported by directory buckets.</p>
190 /// </note>
191 /// <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>
192 pub fn get_bucket(&self) -> &::std::option::Option<::std::string::String> {
193 self.inner.get_bucket()
194 }
195 /// <p>A delimiter is a character that you use to group keys.</p>
196 /// <p><code>CommonPrefixes</code> is filtered out from results if it is not lexicographically greater than the <code>StartAfter</code> value.</p><note>
197 /// <ul>
198 /// <li>
199 /// <p><b>Directory buckets</b> - For directory buckets, <code>/</code> is the only supported delimiter.</p></li>
200 /// <li>
201 /// <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>
202 /// </ul>
203 /// </note>
204 pub fn delimiter(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
205 self.inner = self.inner.delimiter(input.into());
206 self
207 }
208 /// <p>A delimiter is a character that you use to group keys.</p>
209 /// <p><code>CommonPrefixes</code> is filtered out from results if it is not lexicographically greater than the <code>StartAfter</code> value.</p><note>
210 /// <ul>
211 /// <li>
212 /// <p><b>Directory buckets</b> - For directory buckets, <code>/</code> is the only supported delimiter.</p></li>
213 /// <li>
214 /// <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>
215 /// </ul>
216 /// </note>
217 pub fn set_delimiter(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
218 self.inner = self.inner.set_delimiter(input);
219 self
220 }
221 /// <p>A delimiter is a character that you use to group keys.</p>
222 /// <p><code>CommonPrefixes</code> is filtered out from results if it is not lexicographically greater than the <code>StartAfter</code> value.</p><note>
223 /// <ul>
224 /// <li>
225 /// <p><b>Directory buckets</b> - For directory buckets, <code>/</code> is the only supported delimiter.</p></li>
226 /// <li>
227 /// <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>
228 /// </ul>
229 /// </note>
230 pub fn get_delimiter(&self) -> &::std::option::Option<::std::string::String> {
231 self.inner.get_delimiter()
232 }
233 /// <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>
234 /// <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>
235 /// </note>
236 pub fn encoding_type(mut self, input: crate::types::EncodingType) -> Self {
237 self.inner = self.inner.encoding_type(input);
238 self
239 }
240 /// <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>
241 /// <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>
242 /// </note>
243 pub fn set_encoding_type(mut self, input: ::std::option::Option<crate::types::EncodingType>) -> Self {
244 self.inner = self.inner.set_encoding_type(input);
245 self
246 }
247 /// <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>
248 /// <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>
249 /// </note>
250 pub fn get_encoding_type(&self) -> &::std::option::Option<crate::types::EncodingType> {
251 self.inner.get_encoding_type()
252 }
253 /// <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>
254 pub fn max_keys(mut self, input: i32) -> Self {
255 self.inner = self.inner.max_keys(input);
256 self
257 }
258 /// <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>
259 pub fn set_max_keys(mut self, input: ::std::option::Option<i32>) -> Self {
260 self.inner = self.inner.set_max_keys(input);
261 self
262 }
263 /// <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>
264 pub fn get_max_keys(&self) -> &::std::option::Option<i32> {
265 self.inner.get_max_keys()
266 }
267 /// <p>Limits the response to keys that begin with the specified prefix.</p><note>
268 /// <p><b>Directory buckets</b> - For directory buckets, only prefixes that end in a delimiter (<code>/</code>) are supported.</p>
269 /// </note>
270 pub fn prefix(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
271 self.inner = self.inner.prefix(input.into());
272 self
273 }
274 /// <p>Limits the response to keys that begin with the specified prefix.</p><note>
275 /// <p><b>Directory buckets</b> - For directory buckets, only prefixes that end in a delimiter (<code>/</code>) are supported.</p>
276 /// </note>
277 pub fn set_prefix(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
278 self.inner = self.inner.set_prefix(input);
279 self
280 }
281 /// <p>Limits the response to keys that begin with the specified prefix.</p><note>
282 /// <p><b>Directory buckets</b> - For directory buckets, only prefixes that end in a delimiter (<code>/</code>) are supported.</p>
283 /// </note>
284 pub fn get_prefix(&self) -> &::std::option::Option<::std::string::String> {
285 self.inner.get_prefix()
286 }
287 /// <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>
288 pub fn continuation_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
289 self.inner = self.inner.continuation_token(input.into());
290 self
291 }
292 /// <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>
293 pub fn set_continuation_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
294 self.inner = self.inner.set_continuation_token(input);
295 self
296 }
297 /// <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>
298 pub fn get_continuation_token(&self) -> &::std::option::Option<::std::string::String> {
299 self.inner.get_continuation_token()
300 }
301 /// <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>
302 /// <p><b>Directory buckets</b> - For directory buckets, the bucket owner is returned as the object owner for all objects.</p>
303 /// </note>
304 pub fn fetch_owner(mut self, input: bool) -> Self {
305 self.inner = self.inner.fetch_owner(input);
306 self
307 }
308 /// <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>
309 /// <p><b>Directory buckets</b> - For directory buckets, the bucket owner is returned as the object owner for all objects.</p>
310 /// </note>
311 pub fn set_fetch_owner(mut self, input: ::std::option::Option<bool>) -> Self {
312 self.inner = self.inner.set_fetch_owner(input);
313 self
314 }
315 /// <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>
316 /// <p><b>Directory buckets</b> - For directory buckets, the bucket owner is returned as the object owner for all objects.</p>
317 /// </note>
318 pub fn get_fetch_owner(&self) -> &::std::option::Option<bool> {
319 self.inner.get_fetch_owner()
320 }
321 /// <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>
322 /// <p>This functionality is not supported for directory buckets.</p>
323 /// </note>
324 pub fn start_after(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
325 self.inner = self.inner.start_after(input.into());
326 self
327 }
328 /// <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>
329 /// <p>This functionality is not supported for directory buckets.</p>
330 /// </note>
331 pub fn set_start_after(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
332 self.inner = self.inner.set_start_after(input);
333 self
334 }
335 /// <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>
336 /// <p>This functionality is not supported for directory buckets.</p>
337 /// </note>
338 pub fn get_start_after(&self) -> &::std::option::Option<::std::string::String> {
339 self.inner.get_start_after()
340 }
341 /// <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>
342 /// <p>This functionality is not supported for directory buckets.</p>
343 /// </note>
344 pub fn request_payer(mut self, input: crate::types::RequestPayer) -> Self {
345 self.inner = self.inner.request_payer(input);
346 self
347 }
348 /// <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>
349 /// <p>This functionality is not supported for directory buckets.</p>
350 /// </note>
351 pub fn set_request_payer(mut self, input: ::std::option::Option<crate::types::RequestPayer>) -> Self {
352 self.inner = self.inner.set_request_payer(input);
353 self
354 }
355 /// <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>
356 /// <p>This functionality is not supported for directory buckets.</p>
357 /// </note>
358 pub fn get_request_payer(&self) -> &::std::option::Option<crate::types::RequestPayer> {
359 self.inner.get_request_payer()
360 }
361 /// <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>
362 pub fn expected_bucket_owner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
363 self.inner = self.inner.expected_bucket_owner(input.into());
364 self
365 }
366 /// <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>
367 pub fn set_expected_bucket_owner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
368 self.inner = self.inner.set_expected_bucket_owner(input);
369 self
370 }
371 /// <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>
372 pub fn get_expected_bucket_owner(&self) -> &::std::option::Option<::std::string::String> {
373 self.inner.get_expected_bucket_owner()
374 }
375 ///
376 /// Appends an item to `OptionalObjectAttributes`.
377 ///
378 /// To override the contents of this collection use [`set_optional_object_attributes`](Self::set_optional_object_attributes).
379 ///
380 /// <p>Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.</p><note>
381 /// <p>This functionality is not supported for directory buckets.</p>
382 /// </note>
383 pub fn optional_object_attributes(mut self, input: crate::types::OptionalObjectAttributes) -> Self {
384 self.inner = self.inner.optional_object_attributes(input);
385 self
386 }
387 /// <p>Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.</p><note>
388 /// <p>This functionality is not supported for directory buckets.</p>
389 /// </note>
390 pub fn set_optional_object_attributes(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::OptionalObjectAttributes>>) -> Self {
391 self.inner = self.inner.set_optional_object_attributes(input);
392 self
393 }
394 /// <p>Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.</p><note>
395 /// <p>This functionality is not supported for directory buckets.</p>
396 /// </note>
397 pub fn get_optional_object_attributes(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::OptionalObjectAttributes>> {
398 self.inner.get_optional_object_attributes()
399 }
400}