aws_sdk_s3/operation/delete_objects/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::delete_objects::_delete_objects_output::DeleteObjectsOutputBuilder;
3
4pub use crate::operation::delete_objects::_delete_objects_input::DeleteObjectsInputBuilder;
5
6impl crate::operation::delete_objects::builders::DeleteObjectsInputBuilder {
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::delete_objects::DeleteObjectsOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::delete_objects::DeleteObjectsError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.delete_objects();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `DeleteObjects`.
24///
25/// <p>This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.</p>
26/// <p>The request can contain a list of up to 1,000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete operation and returns the result of that delete, success or failure, in the response. If the object specified in the request isn't found, Amazon S3 confirms the deletion by returning the result as deleted.</p><note>
27/// <ul>
28/// <li>
29/// <p><b>Directory buckets</b> - S3 Versioning isn't enabled and supported for directory buckets.</p></li>
30/// <li>
31/// <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>
32/// </ul>
33/// </note>
34/// <p>The operation supports two modes for the response: verbose and quiet. By default, the operation uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete operation encountered an error. For a successful deletion in a quiet mode, the operation does not return any information about the delete in the response body.</p>
35/// <p>When performing this action on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete">MFA Delete</a> in the <i>Amazon S3 User Guide</i>.</p><note>
36/// <p><b>Directory buckets</b> - MFA delete is not supported by directory buckets.</p>
37/// </note>
38/// <dl>
39/// <dt>
40/// Permissions
41/// </dt>
42/// <dd>
43/// <ul>
44/// <li>
45/// <p><b>General purpose bucket permissions</b> - The following permissions are required in your policies when your <code>DeleteObjects</code> request includes specific headers.</p>
46/// <ul>
47/// <li>
48/// <p><b> <code>s3:DeleteObject</code> </b> - To delete an object from a bucket, you must always specify the <code>s3:DeleteObject</code> permission.</p></li>
49/// <li>
50/// <p><b> <code>s3:DeleteObjectVersion</code> </b> - To delete a specific version of an object from a versioning-enabled bucket, you must specify the <code>s3:DeleteObjectVersion</code> permission.</p></li>
51/// </ul></li>
52/// <li>
53/// <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>
54/// </ul>
55/// </dd>
56/// <dt>
57/// Content-MD5 request header
58/// </dt>
59/// <dd>
60/// <ul>
61/// <li>
62/// <p><b>General purpose bucket</b> - The Content-MD5 request header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.</p></li>
63/// <li>
64/// <p><b>Directory bucket</b> - The Content-MD5 request header or a additional checksum request header (including <code>x-amz-checksum-crc32</code>, <code>x-amz-checksum-crc32c</code>, <code>x-amz-checksum-sha1</code>, or <code>x-amz-checksum-sha256</code>) is required for all Multi-Object Delete requests.</p></li>
65/// </ul>
66/// </dd>
67/// <dt>
68/// HTTP Host header syntax
69/// </dt>
70/// <dd>
71/// <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>
72/// </dd>
73/// </dl>
74/// <p>The following operations are related to <code>DeleteObjects</code>:</p>
75/// <ul>
76/// <li>
77/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a></p></li>
78/// <li>
79/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a></p></li>
80/// <li>
81/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a></p></li>
82/// <li>
83/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a></p></li>
84/// <li>
85/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a></p></li>
86/// </ul>
87#[derive(::std::clone::Clone, ::std::fmt::Debug)]
88pub struct DeleteObjectsFluentBuilder {
89 handle: ::std::sync::Arc<crate::client::Handle>,
90 inner: crate::operation::delete_objects::builders::DeleteObjectsInputBuilder,
91 config_override: ::std::option::Option<crate::config::Builder>,
92}
93impl
94 crate::client::customize::internal::CustomizableSend<
95 crate::operation::delete_objects::DeleteObjectsOutput,
96 crate::operation::delete_objects::DeleteObjectsError,
97 > for DeleteObjectsFluentBuilder
98{
99 fn send(
100 self,
101 config_override: crate::config::Builder,
102 ) -> crate::client::customize::internal::BoxFuture<
103 crate::client::customize::internal::SendResult<
104 crate::operation::delete_objects::DeleteObjectsOutput,
105 crate::operation::delete_objects::DeleteObjectsError,
106 >,
107 > {
108 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
109 }
110}
111impl DeleteObjectsFluentBuilder {
112 /// Creates a new `DeleteObjectsFluentBuilder`.
113 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
114 Self {
115 handle,
116 inner: ::std::default::Default::default(),
117 config_override: ::std::option::Option::None,
118 }
119 }
120 /// Access the DeleteObjects as a reference.
121 pub fn as_input(&self) -> &crate::operation::delete_objects::builders::DeleteObjectsInputBuilder {
122 &self.inner
123 }
124 /// Sends the request and returns the response.
125 ///
126 /// If an error occurs, an `SdkError` will be returned with additional details that
127 /// can be matched against.
128 ///
129 /// By default, any retryable failures will be retried twice. Retry behavior
130 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
131 /// set when configuring the client.
132 pub async fn send(
133 self,
134 ) -> ::std::result::Result<
135 crate::operation::delete_objects::DeleteObjectsOutput,
136 ::aws_smithy_runtime_api::client::result::SdkError<
137 crate::operation::delete_objects::DeleteObjectsError,
138 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
139 >,
140 > {
141 let input = self
142 .inner
143 .build()
144 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
145 let runtime_plugins = crate::operation::delete_objects::DeleteObjects::operation_runtime_plugins(
146 self.handle.runtime_plugins.clone(),
147 &self.handle.conf,
148 self.config_override,
149 );
150 crate::operation::delete_objects::DeleteObjects::orchestrate(&runtime_plugins, input).await
151 }
152
153 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
154 pub fn customize(
155 self,
156 ) -> crate::client::customize::CustomizableOperation<
157 crate::operation::delete_objects::DeleteObjectsOutput,
158 crate::operation::delete_objects::DeleteObjectsError,
159 Self,
160 > {
161 crate::client::customize::CustomizableOperation::new(self)
162 }
163 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
164 self.set_config_override(::std::option::Option::Some(config_override.into()));
165 self
166 }
167
168 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
169 self.config_override = config_override;
170 self
171 }
172 /// <p>The bucket name containing the objects to delete.</p>
173 /// <p><b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p>
174 /// <p><b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p><note>
175 /// <p>Access points and Object Lambda access points are not supported by directory buckets.</p>
176 /// </note>
177 /// <p><b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>
178 pub fn bucket(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
179 self.inner = self.inner.bucket(input.into());
180 self
181 }
182 /// <p>The bucket name containing the objects to delete.</p>
183 /// <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>
184 /// <p><b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. 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>
185 /// <p>Access points and Object Lambda access points are not supported by directory buckets.</p>
186 /// </note>
187 /// <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>
188 pub fn set_bucket(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
189 self.inner = self.inner.set_bucket(input);
190 self
191 }
192 /// <p>The bucket name containing the objects to delete.</p>
193 /// <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>
194 /// <p><b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. 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>
195 /// <p>Access points and Object Lambda access points are not supported by directory buckets.</p>
196 /// </note>
197 /// <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>
198 pub fn get_bucket(&self) -> &::std::option::Option<::std::string::String> {
199 self.inner.get_bucket()
200 }
201 /// <p>Container for the request.</p>
202 pub fn delete(mut self, input: crate::types::Delete) -> Self {
203 self.inner = self.inner.delete(input);
204 self
205 }
206 /// <p>Container for the request.</p>
207 pub fn set_delete(mut self, input: ::std::option::Option<crate::types::Delete>) -> Self {
208 self.inner = self.inner.set_delete(input);
209 self
210 }
211 /// <p>Container for the request.</p>
212 pub fn get_delete(&self) -> &::std::option::Option<crate::types::Delete> {
213 self.inner.get_delete()
214 }
215 /// <p>The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.</p>
216 /// <p>When performing the <code>DeleteObjects</code> operation on an MFA delete enabled bucket, which attempts to delete the specified versioned objects, you must include an MFA token. If you don't provide an MFA token, the entire request will fail, even if there are non-versioned objects that you are trying to delete. If you provide an invalid token, whether there are versioned object keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete"> MFA Delete</a> in the <i>Amazon S3 User Guide</i>.</p><note>
217 /// <p>This functionality is not supported for directory buckets.</p>
218 /// </note>
219 pub fn mfa(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
220 self.inner = self.inner.mfa(input.into());
221 self
222 }
223 /// <p>The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.</p>
224 /// <p>When performing the <code>DeleteObjects</code> operation on an MFA delete enabled bucket, which attempts to delete the specified versioned objects, you must include an MFA token. If you don't provide an MFA token, the entire request will fail, even if there are non-versioned objects that you are trying to delete. If you provide an invalid token, whether there are versioned object keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete"> MFA Delete</a> in the <i>Amazon S3 User Guide</i>.</p><note>
225 /// <p>This functionality is not supported for directory buckets.</p>
226 /// </note>
227 pub fn set_mfa(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
228 self.inner = self.inner.set_mfa(input);
229 self
230 }
231 /// <p>The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.</p>
232 /// <p>When performing the <code>DeleteObjects</code> operation on an MFA delete enabled bucket, which attempts to delete the specified versioned objects, you must include an MFA token. If you don't provide an MFA token, the entire request will fail, even if there are non-versioned objects that you are trying to delete. If you provide an invalid token, whether there are versioned object keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete"> MFA Delete</a> in the <i>Amazon S3 User Guide</i>.</p><note>
233 /// <p>This functionality is not supported for directory buckets.</p>
234 /// </note>
235 pub fn get_mfa(&self) -> &::std::option::Option<::std::string::String> {
236 self.inner.get_mfa()
237 }
238 /// <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 corresponding charges to copy the object. 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>
239 /// <p>This functionality is not supported for directory buckets.</p>
240 /// </note>
241 pub fn request_payer(mut self, input: crate::types::RequestPayer) -> Self {
242 self.inner = self.inner.request_payer(input);
243 self
244 }
245 /// <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 corresponding charges to copy the object. 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>
246 /// <p>This functionality is not supported for directory buckets.</p>
247 /// </note>
248 pub fn set_request_payer(mut self, input: ::std::option::Option<crate::types::RequestPayer>) -> Self {
249 self.inner = self.inner.set_request_payer(input);
250 self
251 }
252 /// <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 corresponding charges to copy the object. 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>
253 /// <p>This functionality is not supported for directory buckets.</p>
254 /// </note>
255 pub fn get_request_payer(&self) -> &::std::option::Option<crate::types::RequestPayer> {
256 self.inner.get_request_payer()
257 }
258 /// <p>Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To use this header, you must have the <code>s3:BypassGovernanceRetention</code> permission.</p><note>
259 /// <p>This functionality is not supported for directory buckets.</p>
260 /// </note>
261 pub fn bypass_governance_retention(mut self, input: bool) -> Self {
262 self.inner = self.inner.bypass_governance_retention(input);
263 self
264 }
265 /// <p>Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To use this header, you must have the <code>s3:BypassGovernanceRetention</code> permission.</p><note>
266 /// <p>This functionality is not supported for directory buckets.</p>
267 /// </note>
268 pub fn set_bypass_governance_retention(mut self, input: ::std::option::Option<bool>) -> Self {
269 self.inner = self.inner.set_bypass_governance_retention(input);
270 self
271 }
272 /// <p>Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To use this header, you must have the <code>s3:BypassGovernanceRetention</code> permission.</p><note>
273 /// <p>This functionality is not supported for directory buckets.</p>
274 /// </note>
275 pub fn get_bypass_governance_retention(&self) -> &::std::option::Option<bool> {
276 self.inner.get_bypass_governance_retention()
277 }
278 /// <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>
279 pub fn expected_bucket_owner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
280 self.inner = self.inner.expected_bucket_owner(input.into());
281 self
282 }
283 /// <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>
284 pub fn set_expected_bucket_owner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
285 self.inner = self.inner.set_expected_bucket_owner(input);
286 self
287 }
288 /// <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>
289 pub fn get_expected_bucket_owner(&self) -> &::std::option::Option<::std::string::String> {
290 self.inner.get_expected_bucket_owner()
291 }
292 /// <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum-<i>algorithm</i> </code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>.</p>
293 /// <p>For the <code>x-amz-checksum-<i>algorithm</i> </code> header, replace <code> <i>algorithm</i> </code> with the supported algorithm from the following list:</p>
294 /// <ul>
295 /// <li>
296 /// <p><code>CRC32</code></p></li>
297 /// <li>
298 /// <p><code>CRC32C</code></p></li>
299 /// <li>
300 /// <p><code>CRC64NVME</code></p></li>
301 /// <li>
302 /// <p><code>SHA1</code></p></li>
303 /// <li>
304 /// <p><code>SHA256</code></p></li>
305 /// </ul>
306 /// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
307 /// <p>If the individual checksum value you provide through <code>x-amz-checksum-<i>algorithm</i> </code> doesn't match the checksum algorithm you set through <code>x-amz-sdk-checksum-algorithm</code>, Amazon S3 fails the request with a <code>BadDigest</code> error.</p>
308 /// <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>
309 pub fn checksum_algorithm(mut self, input: crate::types::ChecksumAlgorithm) -> Self {
310 self.inner = self.inner.checksum_algorithm(input);
311 self
312 }
313 /// <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum-<i>algorithm</i> </code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>.</p>
314 /// <p>For the <code>x-amz-checksum-<i>algorithm</i> </code> header, replace <code> <i>algorithm</i> </code> with the supported algorithm from the following list:</p>
315 /// <ul>
316 /// <li>
317 /// <p><code>CRC32</code></p></li>
318 /// <li>
319 /// <p><code>CRC32C</code></p></li>
320 /// <li>
321 /// <p><code>CRC64NVME</code></p></li>
322 /// <li>
323 /// <p><code>SHA1</code></p></li>
324 /// <li>
325 /// <p><code>SHA256</code></p></li>
326 /// </ul>
327 /// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
328 /// <p>If the individual checksum value you provide through <code>x-amz-checksum-<i>algorithm</i> </code> doesn't match the checksum algorithm you set through <code>x-amz-sdk-checksum-algorithm</code>, Amazon S3 fails the request with a <code>BadDigest</code> error.</p>
329 /// <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>
330 pub fn set_checksum_algorithm(mut self, input: ::std::option::Option<crate::types::ChecksumAlgorithm>) -> Self {
331 self.inner = self.inner.set_checksum_algorithm(input);
332 self
333 }
334 /// <p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum-<i>algorithm</i> </code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>.</p>
335 /// <p>For the <code>x-amz-checksum-<i>algorithm</i> </code> header, replace <code> <i>algorithm</i> </code> with the supported algorithm from the following list:</p>
336 /// <ul>
337 /// <li>
338 /// <p><code>CRC32</code></p></li>
339 /// <li>
340 /// <p><code>CRC32C</code></p></li>
341 /// <li>
342 /// <p><code>CRC64NVME</code></p></li>
343 /// <li>
344 /// <p><code>SHA1</code></p></li>
345 /// <li>
346 /// <p><code>SHA256</code></p></li>
347 /// </ul>
348 /// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
349 /// <p>If the individual checksum value you provide through <code>x-amz-checksum-<i>algorithm</i> </code> doesn't match the checksum algorithm you set through <code>x-amz-sdk-checksum-algorithm</code>, Amazon S3 fails the request with a <code>BadDigest</code> error.</p>
350 /// <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>
351 pub fn get_checksum_algorithm(&self) -> &::std::option::Option<crate::types::ChecksumAlgorithm> {
352 self.inner.get_checksum_algorithm()
353 }
354}