aws_sdk_s3/operation/list_object_versions/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_object_versions::_list_object_versions_input::ListObjectVersionsInputBuilder;
3
4pub use crate::operation::list_object_versions::_list_object_versions_output::ListObjectVersionsOutputBuilder;
5
6impl crate::operation::list_object_versions::builders::ListObjectVersionsInputBuilder {
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_object_versions::ListObjectVersionsOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::list_object_versions::ListObjectVersionsError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.list_object_versions();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `ListObjectVersions`.
24///
25/// <note>
26/// <p>This operation is not supported for directory buckets.</p>
27/// </note>
28/// <p>Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.</p><important>
29/// <p>To use this operation, you must have permission to perform the <code>s3:ListBucketVersions</code> action. Be aware of the name difference.</p>
30/// </important> <note>
31/// <p>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.</p>
32/// </note>
33/// <p>To use this operation, you must have READ access to the bucket.</p>
34/// <p>The following operations are related to <code>ListObjectVersions</code>:</p>
35/// <ul>
36/// <li>
37/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a></p></li>
38/// <li>
39/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a></p></li>
40/// <li>
41/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a></p></li>
42/// <li>
43/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a></p></li>
44/// </ul><important>
45/// <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>
46/// </important>
47#[derive(::std::clone::Clone, ::std::fmt::Debug)]
48pub struct ListObjectVersionsFluentBuilder {
49 handle: ::std::sync::Arc<crate::client::Handle>,
50 inner: crate::operation::list_object_versions::builders::ListObjectVersionsInputBuilder,
51 config_override: ::std::option::Option<crate::config::Builder>,
52}
53impl
54 crate::client::customize::internal::CustomizableSend<
55 crate::operation::list_object_versions::ListObjectVersionsOutput,
56 crate::operation::list_object_versions::ListObjectVersionsError,
57 > for ListObjectVersionsFluentBuilder
58{
59 fn send(
60 self,
61 config_override: crate::config::Builder,
62 ) -> crate::client::customize::internal::BoxFuture<
63 crate::client::customize::internal::SendResult<
64 crate::operation::list_object_versions::ListObjectVersionsOutput,
65 crate::operation::list_object_versions::ListObjectVersionsError,
66 >,
67 > {
68 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
69 }
70}
71impl ListObjectVersionsFluentBuilder {
72 /// Creates a new `ListObjectVersionsFluentBuilder`.
73 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
74 Self {
75 handle,
76 inner: ::std::default::Default::default(),
77 config_override: ::std::option::Option::None,
78 }
79 }
80 /// Access the ListObjectVersions as a reference.
81 pub fn as_input(&self) -> &crate::operation::list_object_versions::builders::ListObjectVersionsInputBuilder {
82 &self.inner
83 }
84 /// Sends the request and returns the response.
85 ///
86 /// If an error occurs, an `SdkError` will be returned with additional details that
87 /// can be matched against.
88 ///
89 /// By default, any retryable failures will be retried twice. Retry behavior
90 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
91 /// set when configuring the client.
92 pub async fn send(
93 self,
94 ) -> ::std::result::Result<
95 crate::operation::list_object_versions::ListObjectVersionsOutput,
96 ::aws_smithy_runtime_api::client::result::SdkError<
97 crate::operation::list_object_versions::ListObjectVersionsError,
98 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
99 >,
100 > {
101 let input = self
102 .inner
103 .build()
104 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
105 let runtime_plugins = crate::operation::list_object_versions::ListObjectVersions::operation_runtime_plugins(
106 self.handle.runtime_plugins.clone(),
107 &self.handle.conf,
108 self.config_override,
109 );
110 crate::operation::list_object_versions::ListObjectVersions::orchestrate(&runtime_plugins, input).await
111 }
112
113 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
114 pub fn customize(
115 self,
116 ) -> crate::client::customize::CustomizableOperation<
117 crate::operation::list_object_versions::ListObjectVersionsOutput,
118 crate::operation::list_object_versions::ListObjectVersionsError,
119 Self,
120 > {
121 crate::client::customize::CustomizableOperation::new(self)
122 }
123 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
124 self.set_config_override(::std::option::Option::Some(config_override.into()));
125 self
126 }
127
128 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
129 self.config_override = config_override;
130 self
131 }
132 ///
133 /// Creates a presigned request for this operation.
134 ///
135 /// The `presigning_config` provides additional presigning-specific config values, such as the
136 /// amount of time the request should be valid for after creation.
137 ///
138 /// Presigned requests can be given to other users or applications to access a resource or perform
139 /// an operation without having access to the AWS security credentials.
140 ///
141 /// _Important:_ If you're using credentials that can expire, such as those from STS AssumeRole or SSO, then
142 /// the presigned request can only be valid for as long as the credentials used to create it are.
143 ///
144 #[allow(unused_mut)]
145 pub async fn presigned(
146 mut self,
147 presigning_config: crate::presigning::PresigningConfig,
148 ) -> ::std::result::Result<
149 crate::presigning::PresignedRequest,
150 ::aws_smithy_runtime_api::client::result::SdkError<
151 crate::operation::list_object_versions::ListObjectVersionsError,
152 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
153 >,
154 > {
155 let runtime_plugins = crate::operation::list_object_versions::ListObjectVersions::operation_runtime_plugins(
156 self.handle.runtime_plugins.clone(),
157 &self.handle.conf,
158 self.config_override,
159 )
160 .with_client_plugin(crate::presigning_interceptors::SigV4PresigningRuntimePlugin::new(
161 presigning_config,
162 ::aws_sigv4::http_request::SignableBody::UnsignedPayload,
163 ));
164
165 let input = self
166 .inner
167 .build()
168 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
169 let mut context = crate::operation::list_object_versions::ListObjectVersions::orchestrate_with_stop_point(
170 &runtime_plugins,
171 input,
172 ::aws_smithy_runtime::client::orchestrator::StopPoint::BeforeTransmit,
173 )
174 .await
175 .map_err(|err| {
176 err.map_service_error(|err| {
177 err.downcast::<crate::operation::list_object_versions::ListObjectVersionsError>()
178 .expect("correct error type")
179 })
180 })?;
181 let request = context.take_request().expect("request set before transmit");
182 crate::presigning::PresignedRequest::new(request).map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)
183 }
184 /// <p>The bucket name that contains the objects.</p>
185 pub fn bucket(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
186 self.inner = self.inner.bucket(input.into());
187 self
188 }
189 /// <p>The bucket name that contains the objects.</p>
190 pub fn set_bucket(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
191 self.inner = self.inner.set_bucket(input);
192 self
193 }
194 /// <p>The bucket name that contains the objects.</p>
195 pub fn get_bucket(&self) -> &::std::option::Option<::std::string::String> {
196 self.inner.get_bucket()
197 }
198 /// <p>A delimiter is a character that you specify to group keys. All keys that contain the same string between the <code>prefix</code> and the first occurrence of the delimiter are grouped under a single result element in <code>CommonPrefixes</code>. These groups are counted as one result against the <code>max-keys</code> limitation. These keys are not returned elsewhere in the response.</p>
199 /// <p><code>CommonPrefixes</code> is filtered out from results if it is not lexicographically greater than the key-marker.</p>
200 pub fn delimiter(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
201 self.inner = self.inner.delimiter(input.into());
202 self
203 }
204 /// <p>A delimiter is a character that you specify to group keys. All keys that contain the same string between the <code>prefix</code> and the first occurrence of the delimiter are grouped under a single result element in <code>CommonPrefixes</code>. These groups are counted as one result against the <code>max-keys</code> limitation. These keys are not returned elsewhere in the response.</p>
205 /// <p><code>CommonPrefixes</code> is filtered out from results if it is not lexicographically greater than the key-marker.</p>
206 pub fn set_delimiter(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
207 self.inner = self.inner.set_delimiter(input);
208 self
209 }
210 /// <p>A delimiter is a character that you specify to group keys. All keys that contain the same string between the <code>prefix</code> and the first occurrence of the delimiter are grouped under a single result element in <code>CommonPrefixes</code>. These groups are counted as one result against the <code>max-keys</code> limitation. These keys are not returned elsewhere in the response.</p>
211 /// <p><code>CommonPrefixes</code> is filtered out from results if it is not lexicographically greater than the key-marker.</p>
212 pub fn get_delimiter(&self) -> &::std::option::Option<::std::string::String> {
213 self.inner.get_delimiter()
214 }
215 /// <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>
216 /// <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>
217 /// </note>
218 pub fn encoding_type(mut self, input: crate::types::EncodingType) -> Self {
219 self.inner = self.inner.encoding_type(input);
220 self
221 }
222 /// <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>
223 /// <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>
224 /// </note>
225 pub fn set_encoding_type(mut self, input: ::std::option::Option<crate::types::EncodingType>) -> Self {
226 self.inner = self.inner.set_encoding_type(input);
227 self
228 }
229 /// <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>
230 /// <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>
231 /// </note>
232 pub fn get_encoding_type(&self) -> &::std::option::Option<crate::types::EncodingType> {
233 self.inner.get_encoding_type()
234 }
235 /// <p>Specifies the key to start with when listing objects in a bucket.</p>
236 pub fn key_marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
237 self.inner = self.inner.key_marker(input.into());
238 self
239 }
240 /// <p>Specifies the key to start with when listing objects in a bucket.</p>
241 pub fn set_key_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
242 self.inner = self.inner.set_key_marker(input);
243 self
244 }
245 /// <p>Specifies the key to start with when listing objects in a bucket.</p>
246 pub fn get_key_marker(&self) -> &::std::option::Option<::std::string::String> {
247 self.inner.get_key_marker()
248 }
249 /// <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. If additional keys satisfy the search criteria, but were not returned because <code>max-keys</code> was exceeded, the response contains <code><istruncated>
250 /// true
251 /// </istruncated></code>. To return the additional keys, see <code>key-marker</code> and <code>version-id-marker</code>.</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. If additional keys satisfy the search criteria, but were not returned because <code>max-keys</code> was exceeded, the response contains <code><istruncated>
257 /// true
258 /// </istruncated></code>. To return the additional keys, see <code>key-marker</code> and <code>version-id-marker</code>.</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. If additional keys satisfy the search criteria, but were not returned because <code>max-keys</code> was exceeded, the response contains <code><istruncated>
264 /// true
265 /// </istruncated></code>. To return the additional keys, see <code>key-marker</code> and <code>version-id-marker</code>.</p>
266 pub fn get_max_keys(&self) -> &::std::option::Option<i32> {
267 self.inner.get_max_keys()
268 }
269 /// <p>Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using <code>prefix</code> to make groups in the same way that you'd use a folder in a file system.) You can use <code>prefix</code> with <code>delimiter</code> to roll up numerous objects into a single result under <code>CommonPrefixes</code>.</p>
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>Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using <code>prefix</code> to make groups in the same way that you'd use a folder in a file system.) You can use <code>prefix</code> with <code>delimiter</code> to roll up numerous objects into a single result under <code>CommonPrefixes</code>.</p>
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>Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using <code>prefix</code> to make groups in the same way that you'd use a folder in a file system.) You can use <code>prefix</code> with <code>delimiter</code> to roll up numerous objects into a single result under <code>CommonPrefixes</code>.</p>
280 pub fn get_prefix(&self) -> &::std::option::Option<::std::string::String> {
281 self.inner.get_prefix()
282 }
283 /// <p>Specifies the object version you want to start listing from.</p>
284 pub fn version_id_marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
285 self.inner = self.inner.version_id_marker(input.into());
286 self
287 }
288 /// <p>Specifies the object version you want to start listing from.</p>
289 pub fn set_version_id_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
290 self.inner = self.inner.set_version_id_marker(input);
291 self
292 }
293 /// <p>Specifies the object version you want to start listing from.</p>
294 pub fn get_version_id_marker(&self) -> &::std::option::Option<::std::string::String> {
295 self.inner.get_version_id_marker()
296 }
297 /// <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>
298 pub fn expected_bucket_owner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
299 self.inner = self.inner.expected_bucket_owner(input.into());
300 self
301 }
302 /// <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>
303 pub fn set_expected_bucket_owner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
304 self.inner = self.inner.set_expected_bucket_owner(input);
305 self
306 }
307 /// <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>
308 pub fn get_expected_bucket_owner(&self) -> &::std::option::Option<::std::string::String> {
309 self.inner.get_expected_bucket_owner()
310 }
311 /// <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for the corresponding charges. For information about downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p><note>
312 /// <p>This functionality is not supported for directory buckets.</p>
313 /// </note>
314 pub fn request_payer(mut self, input: crate::types::RequestPayer) -> Self {
315 self.inner = self.inner.request_payer(input);
316 self
317 }
318 /// <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for the corresponding charges. For information about downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p><note>
319 /// <p>This functionality is not supported for directory buckets.</p>
320 /// </note>
321 pub fn set_request_payer(mut self, input: ::std::option::Option<crate::types::RequestPayer>) -> Self {
322 self.inner = self.inner.set_request_payer(input);
323 self
324 }
325 /// <p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for the corresponding charges. For information about downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p><note>
326 /// <p>This functionality is not supported for directory buckets.</p>
327 /// </note>
328 pub fn get_request_payer(&self) -> &::std::option::Option<crate::types::RequestPayer> {
329 self.inner.get_request_payer()
330 }
331 ///
332 /// Appends an item to `OptionalObjectAttributes`.
333 ///
334 /// To override the contents of this collection use [`set_optional_object_attributes`](Self::set_optional_object_attributes).
335 ///
336 /// <p>Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.</p>
337 pub fn optional_object_attributes(mut self, input: crate::types::OptionalObjectAttributes) -> Self {
338 self.inner = self.inner.optional_object_attributes(input);
339 self
340 }
341 /// <p>Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.</p>
342 pub fn set_optional_object_attributes(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::OptionalObjectAttributes>>) -> Self {
343 self.inner = self.inner.set_optional_object_attributes(input);
344 self
345 }
346 /// <p>Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.</p>
347 pub fn get_optional_object_attributes(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::OptionalObjectAttributes>> {
348 self.inner.get_optional_object_attributes()
349 }
350}
351
352impl crate::client::customize::internal::CustomizablePresigned<crate::operation::list_object_versions::ListObjectVersionsError>
353 for ListObjectVersionsFluentBuilder
354{
355 fn presign(
356 self,
357 config_override: crate::config::Builder,
358 presigning_config: crate::presigning::PresigningConfig,
359 ) -> crate::client::customize::internal::BoxFuture<
360 crate::client::customize::internal::SendResult<
361 crate::presigning::PresignedRequest,
362 crate::operation::list_object_versions::ListObjectVersionsError,
363 >,
364 > {
365 ::std::boxed::Box::pin(async move { self.config_override(config_override).presigned(presigning_config).await })
366 }
367}