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