aws_sdk_s3/operation/put_object/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::put_object::_put_object_output::PutObjectOutputBuilder;
3
4pub use crate::operation::put_object::_put_object_input::PutObjectInputBuilder;
5
6impl crate::operation::put_object::builders::PutObjectInputBuilder {
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::put_object::PutObjectOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::put_object::PutObjectError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.put_object();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `PutObject`.
24///
25/// <important>
26/// <p>End of support notice: As of October 1, 2025, Amazon S3 has discontinued support for Email Grantee Access Control Lists (ACLs). If you attempt to use an Email Grantee ACL in a request after October 1, 2025, the request will receive an <code>HTTP 405</code> (Method Not Allowed) error.</p>
27/// <p>This change affects the following Amazon Web Services Regions: US East (N. Virginia), US West (N. California), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Europe (Ireland), and South America (São Paulo).</p>
28/// </important>
29/// <p>Adds an object to a bucket.</p><note>
30/// <ul>
31/// <li>
32/// <p>Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket. You cannot use <code>PutObject</code> to only update a single piece of metadata for an existing object. You must put the entire object with updated metadata if you want to update some values.</p></li>
33/// <li>
34/// <p>If your bucket uses the bucket owner enforced setting for Object Ownership, ACLs are disabled and no longer affect permissions. All objects written to the bucket by any account will be owned by the bucket owner.</p></li>
35/// <li>
36/// <p><b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p></li>
37/// </ul>
38/// </note>
39/// <p>Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. However, Amazon S3 provides features that can modify this behavior:</p>
40/// <ul>
41/// <li>
42/// <p><b>S3 Object Lock</b> - To prevent objects from being deleted or overwritten, you can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html">Amazon S3 Object Lock</a> in the <i>Amazon S3 User Guide</i>.</p><note>
43/// <p>This functionality is not supported for directory buckets.</p>
44/// </note></li>
45/// <li>
46/// <p><b>If-None-Match</b> - Uploads the object only if the object key name does not already exist in the specified bucket. Otherwise, Amazon S3 returns a <code>412 Precondition Failed</code> error. If a conflicting operation occurs during the upload, S3 returns a <code>409 ConditionalRequestConflict</code> response. On a 409 failure, retry the upload.</p>
47/// <p>Expects the * character (asterisk).</p>
48/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html">Add preconditions to S3 operations with conditional requests</a> in the <i>Amazon S3 User Guide</i> or <a href="https://datatracker.ietf.org/doc/rfc7232/">RFC 7232</a>.</p><note>
49/// <p>This functionality is not supported for S3 on Outposts.</p>
50/// </note></li>
51/// <li>
52/// <p><b>S3 Versioning</b> - When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all versions of the objects. For each write request that is made to the same object, Amazon S3 automatically generates a unique version ID of that object being stored in Amazon S3. You can retrieve, replace, or delete any version of the object. For more information about versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html">Adding Objects to Versioning-Enabled Buckets</a> in the <i>Amazon S3 User Guide</i>. For information about returning the versioning state of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a>.</p><note>
53/// <p>This functionality is not supported for directory buckets.</p>
54/// </note></li>
55/// </ul>
56/// <dl>
57/// <dt>
58/// Permissions
59/// </dt>
60/// <dd>
61/// <ul>
62/// <li>
63/// <p><b>General purpose bucket permissions</b> - The following permissions are required in your policies when your <code>PutObject</code> request includes specific headers.</p>
64/// <ul>
65/// <li>
66/// <p><b> <code>s3:PutObject</code> </b> - To successfully complete the <code>PutObject</code> request, you must always have the <code>s3:PutObject</code> permission on a bucket to add an object to it.</p></li>
67/// <li>
68/// <p><b> <code>s3:PutObjectAcl</code> </b> - To successfully change the objects ACL of your <code>PutObject</code> request, you must have the <code>s3:PutObjectAcl</code>.</p></li>
69/// <li>
70/// <p><b> <code>s3:PutObjectTagging</code> </b> - To successfully set the tag-set with your <code>PutObject</code> request, you must have the <code>s3:PutObjectTagging</code>.</p></li>
71/// </ul></li>
72/// <li>
73/// <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>
74/// <p>If the object is encrypted with SSE-KMS, you must also have the <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies for the KMS key.</p></li>
75/// </ul>
76/// </dd>
77/// <dt>
78/// Data integrity with Content-MD5
79/// </dt>
80/// <dd>
81/// <ul>
82/// <li>
83/// <p><b>General purpose bucket</b> - To ensure that data is not corrupted traversing the network, use the <code>Content-MD5</code> header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, Amazon S3 returns an error. Alternatively, when the object's ETag is its MD5 digest, you can calculate the MD5 while putting the object to Amazon S3 and compare the returned ETag to the calculated MD5 value.</p></li>
84/// <li>
85/// <p><b>Directory bucket</b> - This functionality is not supported for directory buckets.</p></li>
86/// </ul>
87/// </dd>
88/// <dt>
89/// HTTP Host header syntax
90/// </dt>
91/// <dd>
92/// <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>
93/// </dd>
94/// </dl>
95/// <p>For more information about related Amazon S3 APIs, see the following:</p>
96/// <ul>
97/// <li>
98/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a></p></li>
99/// <li>
100/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a></p></li>
101/// </ul><important>
102/// <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>
103/// </important>
104#[derive(::std::fmt::Debug)]
105pub struct PutObjectFluentBuilder {
106 handle: ::std::sync::Arc<crate::client::Handle>,
107 inner: crate::operation::put_object::builders::PutObjectInputBuilder,
108 config_override: ::std::option::Option<crate::config::Builder>,
109}
110impl crate::client::customize::internal::CustomizableSend<crate::operation::put_object::PutObjectOutput, crate::operation::put_object::PutObjectError>
111 for PutObjectFluentBuilder
112{
113 fn send(
114 self,
115 config_override: crate::config::Builder,
116 ) -> crate::client::customize::internal::BoxFuture<
117 crate::client::customize::internal::SendResult<crate::operation::put_object::PutObjectOutput, crate::operation::put_object::PutObjectError>,
118 > {
119 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
120 }
121}
122impl PutObjectFluentBuilder {
123 /// Creates a new `PutObjectFluentBuilder`.
124 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
125 Self {
126 handle,
127 inner: ::std::default::Default::default(),
128 config_override: ::std::option::Option::None,
129 }
130 }
131 /// Access the PutObject as a reference.
132 pub fn as_input(&self) -> &crate::operation::put_object::builders::PutObjectInputBuilder {
133 &self.inner
134 }
135 /// Sends the request and returns the response.
136 ///
137 /// If an error occurs, an `SdkError` will be returned with additional details that
138 /// can be matched against.
139 ///
140 /// By default, any retryable failures will be retried twice. Retry behavior
141 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
142 /// set when configuring the client.
143 pub async fn send(
144 self,
145 ) -> ::std::result::Result<
146 crate::operation::put_object::PutObjectOutput,
147 ::aws_smithy_runtime_api::client::result::SdkError<
148 crate::operation::put_object::PutObjectError,
149 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
150 >,
151 > {
152 let input = self
153 .inner
154 .build()
155 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
156 let runtime_plugins = crate::operation::put_object::PutObject::operation_runtime_plugins(
157 self.handle.runtime_plugins.clone(),
158 &self.handle.conf,
159 self.config_override,
160 );
161 crate::operation::put_object::PutObject::orchestrate(&runtime_plugins, input).await
162 }
163
164 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
165 pub fn customize(
166 self,
167 ) -> crate::client::customize::CustomizableOperation<
168 crate::operation::put_object::PutObjectOutput,
169 crate::operation::put_object::PutObjectError,
170 Self,
171 > {
172 crate::client::customize::CustomizableOperation::new(self)
173 }
174 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
175 self.set_config_override(::std::option::Option::Some(config_override.into()));
176 self
177 }
178
179 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
180 self.config_override = config_override;
181 self
182 }
183 ///
184 /// Creates a presigned request for this operation.
185 ///
186 /// The `presigning_config` provides additional presigning-specific config values, such as the
187 /// amount of time the request should be valid for after creation.
188 ///
189 /// Presigned requests can be given to other users or applications to access a resource or perform
190 /// an operation without having access to the AWS security credentials.
191 ///
192 /// _Important:_ If you're using credentials that can expire, such as those from STS AssumeRole or SSO, then
193 /// the presigned request can only be valid for as long as the credentials used to create it are.
194 ///
195 #[allow(unused_mut)]
196 pub async fn presigned(
197 mut self,
198 presigning_config: crate::presigning::PresigningConfig,
199 ) -> ::std::result::Result<
200 crate::presigning::PresignedRequest,
201 ::aws_smithy_runtime_api::client::result::SdkError<
202 crate::operation::put_object::PutObjectError,
203 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
204 >,
205 > {
206 let runtime_plugins = crate::operation::put_object::PutObject::operation_runtime_plugins(
207 self.handle.runtime_plugins.clone(),
208 &self.handle.conf,
209 self.config_override,
210 )
211 .with_client_plugin(crate::presigning_interceptors::SigV4PresigningRuntimePlugin::new(
212 presigning_config,
213 ::aws_sigv4::http_request::SignableBody::UnsignedPayload,
214 ));
215
216 let input = self
217 .inner
218 .build()
219 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
220 let mut context = crate::operation::put_object::PutObject::orchestrate_with_stop_point(
221 &runtime_plugins,
222 input,
223 ::aws_smithy_runtime::client::orchestrator::StopPoint::BeforeTransmit,
224 )
225 .await
226 .map_err(|err| {
227 err.map_service_error(|err| {
228 err.downcast::<crate::operation::put_object::PutObjectError>()
229 .expect("correct error type")
230 })
231 })?;
232 let request = context.take_request().expect("request set before transmit");
233 crate::presigning::PresignedRequest::new(request).map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)
234 }
235 /// <p>The canned ACL to apply to the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a> in the <i>Amazon S3 User Guide</i>.</p>
236 /// <p>When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. By default, all objects are private. Only the owner has full access control. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html">Managing ACLs Using the REST API</a> in the <i>Amazon S3 User Guide</i>.</p>
237 /// <p>If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the <code>bucket-owner-full-control</code> canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a <code>400</code> error with the error code <code>AccessControlListNotSupported</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling ownership of objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p><note>
238 /// <ul>
239 /// <li>
240 /// <p>This functionality is not supported for directory buckets.</p></li>
241 /// <li>
242 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
243 /// </ul>
244 /// </note>
245 pub fn acl(mut self, input: crate::types::ObjectCannedAcl) -> Self {
246 self.inner = self.inner.acl(input);
247 self
248 }
249 /// <p>The canned ACL to apply to the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a> in the <i>Amazon S3 User Guide</i>.</p>
250 /// <p>When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. By default, all objects are private. Only the owner has full access control. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html">Managing ACLs Using the REST API</a> in the <i>Amazon S3 User Guide</i>.</p>
251 /// <p>If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the <code>bucket-owner-full-control</code> canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a <code>400</code> error with the error code <code>AccessControlListNotSupported</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling ownership of objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p><note>
252 /// <ul>
253 /// <li>
254 /// <p>This functionality is not supported for directory buckets.</p></li>
255 /// <li>
256 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
257 /// </ul>
258 /// </note>
259 pub fn set_acl(mut self, input: ::std::option::Option<crate::types::ObjectCannedAcl>) -> Self {
260 self.inner = self.inner.set_acl(input);
261 self
262 }
263 /// <p>The canned ACL to apply to the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a> in the <i>Amazon S3 User Guide</i>.</p>
264 /// <p>When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. By default, all objects are private. Only the owner has full access control. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html">Managing ACLs Using the REST API</a> in the <i>Amazon S3 User Guide</i>.</p>
265 /// <p>If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the <code>bucket-owner-full-control</code> canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a <code>400</code> error with the error code <code>AccessControlListNotSupported</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling ownership of objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p><note>
266 /// <ul>
267 /// <li>
268 /// <p>This functionality is not supported for directory buckets.</p></li>
269 /// <li>
270 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
271 /// </ul>
272 /// </note>
273 pub fn get_acl(&self) -> &::std::option::Option<crate::types::ObjectCannedAcl> {
274 self.inner.get_acl()
275 }
276 /// <p>Object data.</p>
277 pub fn body(mut self, input: ::aws_smithy_types::byte_stream::ByteStream) -> Self {
278 self.inner = self.inner.body(input);
279 self
280 }
281 /// <p>Object data.</p>
282 pub fn set_body(mut self, input: ::std::option::Option<::aws_smithy_types::byte_stream::ByteStream>) -> Self {
283 self.inner = self.inner.set_body(input);
284 self
285 }
286 /// <p>Object data.</p>
287 pub fn get_body(&self) -> &::std::option::Option<::aws_smithy_types::byte_stream::ByteStream> {
288 self.inner.get_body()
289 }
290 /// <p>The bucket name to which the PUT action was initiated.</p>
291 /// <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>
292 /// <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>
293 /// <p>Object Lambda access points are not supported by directory buckets.</p>
294 /// </note>
295 /// <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>
296 pub fn bucket(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
297 self.inner = self.inner.bucket(input.into());
298 self
299 }
300 /// <p>The bucket name to which the PUT action was initiated.</p>
301 /// <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>
302 /// <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>
303 /// <p>Object Lambda access points are not supported by directory buckets.</p>
304 /// </note>
305 /// <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>
306 pub fn set_bucket(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
307 self.inner = self.inner.set_bucket(input);
308 self
309 }
310 /// <p>The bucket name to which the PUT action was initiated.</p>
311 /// <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>
312 /// <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>
313 /// <p>Object Lambda access points are not supported by directory buckets.</p>
314 /// </note>
315 /// <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>
316 pub fn get_bucket(&self) -> &::std::option::Option<::std::string::String> {
317 self.inner.get_bucket()
318 }
319 /// <p>Can be used to specify caching behavior along the request/reply chain. For more information, see <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9</a>.</p>
320 pub fn cache_control(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
321 self.inner = self.inner.cache_control(input.into());
322 self
323 }
324 /// <p>Can be used to specify caching behavior along the request/reply chain. For more information, see <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9</a>.</p>
325 pub fn set_cache_control(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
326 self.inner = self.inner.set_cache_control(input);
327 self
328 }
329 /// <p>Can be used to specify caching behavior along the request/reply chain. For more information, see <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9</a>.</p>
330 pub fn get_cache_control(&self) -> &::std::option::Option<::std::string::String> {
331 self.inner.get_cache_control()
332 }
333 /// <p>Specifies presentational information for the object. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc6266#section-4">https://www.rfc-editor.org/rfc/rfc6266#section-4</a>.</p>
334 pub fn content_disposition(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
335 self.inner = self.inner.content_disposition(input.into());
336 self
337 }
338 /// <p>Specifies presentational information for the object. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc6266#section-4">https://www.rfc-editor.org/rfc/rfc6266#section-4</a>.</p>
339 pub fn set_content_disposition(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
340 self.inner = self.inner.set_content_disposition(input);
341 self
342 }
343 /// <p>Specifies presentational information for the object. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc6266#section-4">https://www.rfc-editor.org/rfc/rfc6266#section-4</a>.</p>
344 pub fn get_content_disposition(&self) -> &::std::option::Option<::std::string::String> {
345 self.inner.get_content_disposition()
346 }
347 /// <p>Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding">https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding</a>.</p>
348 pub fn content_encoding(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
349 self.inner = self.inner.content_encoding(input.into());
350 self
351 }
352 /// <p>Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding">https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding</a>.</p>
353 pub fn set_content_encoding(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
354 self.inner = self.inner.set_content_encoding(input);
355 self
356 }
357 /// <p>Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding">https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding</a>.</p>
358 pub fn get_content_encoding(&self) -> &::std::option::Option<::std::string::String> {
359 self.inner.get_content_encoding()
360 }
361 /// <p>The language the content is in.</p>
362 pub fn content_language(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
363 self.inner = self.inner.content_language(input.into());
364 self
365 }
366 /// <p>The language the content is in.</p>
367 pub fn set_content_language(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
368 self.inner = self.inner.set_content_language(input);
369 self
370 }
371 /// <p>The language the content is in.</p>
372 pub fn get_content_language(&self) -> &::std::option::Option<::std::string::String> {
373 self.inner.get_content_language()
374 }
375 /// <p>Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length">https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length</a>.</p>
376 pub fn content_length(mut self, input: i64) -> Self {
377 self.inner = self.inner.content_length(input);
378 self
379 }
380 /// <p>Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length">https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length</a>.</p>
381 pub fn set_content_length(mut self, input: ::std::option::Option<i64>) -> Self {
382 self.inner = self.inner.set_content_length(input);
383 self
384 }
385 /// <p>Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length">https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length</a>.</p>
386 pub fn get_content_length(&self) -> &::std::option::Option<i64> {
387 self.inner.get_content_length()
388 }
389 /// <p>The Base64 encoded 128-bit <code>MD5</code> digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST Authentication</a>.</p><note>
390 /// <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object">Uploading objects to an Object Lock enabled bucket </a> in the <i>Amazon S3 User Guide</i>.</p>
391 /// </note> <note>
392 /// <p>This functionality is not supported for directory buckets.</p>
393 /// </note>
394 pub fn content_md5(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
395 self.inner = self.inner.content_md5(input.into());
396 self
397 }
398 /// <p>The Base64 encoded 128-bit <code>MD5</code> digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST Authentication</a>.</p><note>
399 /// <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object">Uploading objects to an Object Lock enabled bucket </a> in the <i>Amazon S3 User Guide</i>.</p>
400 /// </note> <note>
401 /// <p>This functionality is not supported for directory buckets.</p>
402 /// </note>
403 pub fn set_content_md5(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
404 self.inner = self.inner.set_content_md5(input);
405 self
406 }
407 /// <p>The Base64 encoded 128-bit <code>MD5</code> digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST Authentication</a>.</p><note>
408 /// <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object">Uploading objects to an Object Lock enabled bucket </a> in the <i>Amazon S3 User Guide</i>.</p>
409 /// </note> <note>
410 /// <p>This functionality is not supported for directory buckets.</p>
411 /// </note>
412 pub fn get_content_md5(&self) -> &::std::option::Option<::std::string::String> {
413 self.inner.get_content_md5()
414 }
415 /// <p>A standard MIME type describing the format of the contents. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type">https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type</a>.</p>
416 pub fn content_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
417 self.inner = self.inner.content_type(input.into());
418 self
419 }
420 /// <p>A standard MIME type describing the format of the contents. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type">https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type</a>.</p>
421 pub fn set_content_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
422 self.inner = self.inner.set_content_type(input);
423 self
424 }
425 /// <p>A standard MIME type describing the format of the contents. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type">https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type</a>.</p>
426 pub fn get_content_type(&self) -> &::std::option::Option<::std::string::String> {
427 self.inner.get_content_type()
428 }
429 /// <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>
430 /// <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>
431 /// <ul>
432 /// <li>
433 /// <p><code>CRC32</code></p></li>
434 /// <li>
435 /// <p><code>CRC32C</code></p></li>
436 /// <li>
437 /// <p><code>CRC64NVME</code></p></li>
438 /// <li>
439 /// <p><code>SHA1</code></p></li>
440 /// <li>
441 /// <p><code>SHA256</code></p></li>
442 /// </ul>
443 /// <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>
444 /// <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><note>
445 /// <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object">Uploading objects to an Object Lock enabled bucket </a> in the <i>Amazon S3 User Guide</i>.</p>
446 /// </note>
447 /// <p>For directory buckets, when you use Amazon Web Services SDKs, <code>CRC32</code> is the default checksum algorithm that's used for performance.</p>
448 pub fn checksum_algorithm(mut self, input: crate::types::ChecksumAlgorithm) -> Self {
449 self.inner = self.inner.checksum_algorithm(input);
450 self
451 }
452 /// <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>
453 /// <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>
454 /// <ul>
455 /// <li>
456 /// <p><code>CRC32</code></p></li>
457 /// <li>
458 /// <p><code>CRC32C</code></p></li>
459 /// <li>
460 /// <p><code>CRC64NVME</code></p></li>
461 /// <li>
462 /// <p><code>SHA1</code></p></li>
463 /// <li>
464 /// <p><code>SHA256</code></p></li>
465 /// </ul>
466 /// <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>
467 /// <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><note>
468 /// <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object">Uploading objects to an Object Lock enabled bucket </a> in the <i>Amazon S3 User Guide</i>.</p>
469 /// </note>
470 /// <p>For directory buckets, when you use Amazon Web Services SDKs, <code>CRC32</code> is the default checksum algorithm that's used for performance.</p>
471 pub fn set_checksum_algorithm(mut self, input: ::std::option::Option<crate::types::ChecksumAlgorithm>) -> Self {
472 self.inner = self.inner.set_checksum_algorithm(input);
473 self
474 }
475 /// <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>
476 /// <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>
477 /// <ul>
478 /// <li>
479 /// <p><code>CRC32</code></p></li>
480 /// <li>
481 /// <p><code>CRC32C</code></p></li>
482 /// <li>
483 /// <p><code>CRC64NVME</code></p></li>
484 /// <li>
485 /// <p><code>SHA1</code></p></li>
486 /// <li>
487 /// <p><code>SHA256</code></p></li>
488 /// </ul>
489 /// <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>
490 /// <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><note>
491 /// <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object">Uploading objects to an Object Lock enabled bucket </a> in the <i>Amazon S3 User Guide</i>.</p>
492 /// </note>
493 /// <p>For directory buckets, when you use Amazon Web Services SDKs, <code>CRC32</code> is the default checksum algorithm that's used for performance.</p>
494 pub fn get_checksum_algorithm(&self) -> &::std::option::Option<crate::types::ChecksumAlgorithm> {
495 self.inner.get_checksum_algorithm()
496 }
497 /// <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit <code>CRC32</code> checksum of the object. 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>
498 pub fn checksum_crc32(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
499 self.inner = self.inner.checksum_crc32(input.into());
500 self
501 }
502 /// <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit <code>CRC32</code> checksum of the object. 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>
503 pub fn set_checksum_crc32(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
504 self.inner = self.inner.set_checksum_crc32(input);
505 self
506 }
507 /// <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit <code>CRC32</code> checksum of the object. 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>
508 pub fn get_checksum_crc32(&self) -> &::std::option::Option<::std::string::String> {
509 self.inner.get_checksum_crc32()
510 }
511 /// <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. 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>
512 pub fn checksum_crc32_c(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
513 self.inner = self.inner.checksum_crc32_c(input.into());
514 self
515 }
516 /// <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. 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>
517 pub fn set_checksum_crc32_c(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
518 self.inner = self.inner.set_checksum_crc32_c(input);
519 self
520 }
521 /// <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. 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>
522 pub fn get_checksum_crc32_c(&self) -> &::std::option::Option<::std::string::String> {
523 self.inner.get_checksum_crc32_c()
524 }
525 /// <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the object. The <code>CRC64NVME</code> checksum is always a full object checksum. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity in the Amazon S3 User Guide</a>.</p>
526 pub fn checksum_crc64_nvme(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
527 self.inner = self.inner.checksum_crc64_nvme(input.into());
528 self
529 }
530 /// <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the object. The <code>CRC64NVME</code> checksum is always a full object checksum. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity in the Amazon S3 User Guide</a>.</p>
531 pub fn set_checksum_crc64_nvme(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
532 self.inner = self.inner.set_checksum_crc64_nvme(input);
533 self
534 }
535 /// <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the object. The <code>CRC64NVME</code> checksum is always a full object checksum. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity in the Amazon S3 User Guide</a>.</p>
536 pub fn get_checksum_crc64_nvme(&self) -> &::std::option::Option<::std::string::String> {
537 self.inner.get_checksum_crc64_nvme()
538 }
539 /// <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 160-bit <code>SHA1</code> digest of the object. 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>
540 pub fn checksum_sha1(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
541 self.inner = self.inner.checksum_sha1(input.into());
542 self
543 }
544 /// <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 160-bit <code>SHA1</code> digest of the object. 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>
545 pub fn set_checksum_sha1(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
546 self.inner = self.inner.set_checksum_sha1(input);
547 self
548 }
549 /// <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 160-bit <code>SHA1</code> digest of the object. 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>
550 pub fn get_checksum_sha1(&self) -> &::std::option::Option<::std::string::String> {
551 self.inner.get_checksum_sha1()
552 }
553 /// <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 256-bit <code>SHA256</code> digest of the object. 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>
554 pub fn checksum_sha256(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
555 self.inner = self.inner.checksum_sha256(input.into());
556 self
557 }
558 /// <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 256-bit <code>SHA256</code> digest of the object. 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>
559 pub fn set_checksum_sha256(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
560 self.inner = self.inner.set_checksum_sha256(input);
561 self
562 }
563 /// <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 256-bit <code>SHA256</code> digest of the object. 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>
564 pub fn get_checksum_sha256(&self) -> &::std::option::Option<::std::string::String> {
565 self.inner.get_checksum_sha256()
566 }
567 /// <p>The date and time at which the object is no longer cacheable. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc7234#section-5.3">https://www.rfc-editor.org/rfc/rfc7234#section-5.3</a>.</p>
568 pub fn expires(mut self, input: ::aws_smithy_types::DateTime) -> Self {
569 self.inner = self.inner.expires(input);
570 self
571 }
572 /// <p>The date and time at which the object is no longer cacheable. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc7234#section-5.3">https://www.rfc-editor.org/rfc/rfc7234#section-5.3</a>.</p>
573 pub fn set_expires(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
574 self.inner = self.inner.set_expires(input);
575 self
576 }
577 /// <p>The date and time at which the object is no longer cacheable. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc7234#section-5.3">https://www.rfc-editor.org/rfc/rfc7234#section-5.3</a>.</p>
578 pub fn get_expires(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
579 self.inner.get_expires()
580 }
581 /// <p>Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag of the object in S3. If the ETag values do not match, the operation returns a <code>412 Precondition Failed</code> error.</p>
582 /// <p>If a conflicting operation occurs during the upload S3 returns a <code>409 ConditionalRequestConflict</code> response. On a 409 failure you should fetch the object's ETag and retry the upload.</p>
583 /// <p>Expects the ETag value as a string.</p>
584 /// <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>, or <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html">Conditional requests</a> in the <i>Amazon S3 User Guide</i>.</p>
585 pub fn if_match(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
586 self.inner = self.inner.if_match(input.into());
587 self
588 }
589 /// <p>Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag of the object in S3. If the ETag values do not match, the operation returns a <code>412 Precondition Failed</code> error.</p>
590 /// <p>If a conflicting operation occurs during the upload S3 returns a <code>409 ConditionalRequestConflict</code> response. On a 409 failure you should fetch the object's ETag and retry the upload.</p>
591 /// <p>Expects the ETag value as a string.</p>
592 /// <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>, or <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html">Conditional requests</a> in the <i>Amazon S3 User Guide</i>.</p>
593 pub fn set_if_match(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
594 self.inner = self.inner.set_if_match(input);
595 self
596 }
597 /// <p>Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag of the object in S3. If the ETag values do not match, the operation returns a <code>412 Precondition Failed</code> error.</p>
598 /// <p>If a conflicting operation occurs during the upload S3 returns a <code>409 ConditionalRequestConflict</code> response. On a 409 failure you should fetch the object's ETag and retry the upload.</p>
599 /// <p>Expects the ETag value as a string.</p>
600 /// <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>, or <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html">Conditional requests</a> in the <i>Amazon S3 User Guide</i>.</p>
601 pub fn get_if_match(&self) -> &::std::option::Option<::std::string::String> {
602 self.inner.get_if_match()
603 }
604 /// <p>Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a <code>412 Precondition Failed</code> error.</p>
605 /// <p>If a conflicting operation occurs during the upload S3 returns a <code>409 ConditionalRequestConflict</code> response. On a 409 failure you should retry the upload.</p>
606 /// <p>Expects the '*' (asterisk) character.</p>
607 /// <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>, or <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html">Conditional requests</a> in the <i>Amazon S3 User Guide</i>.</p>
608 pub fn if_none_match(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
609 self.inner = self.inner.if_none_match(input.into());
610 self
611 }
612 /// <p>Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a <code>412 Precondition Failed</code> error.</p>
613 /// <p>If a conflicting operation occurs during the upload S3 returns a <code>409 ConditionalRequestConflict</code> response. On a 409 failure you should retry the upload.</p>
614 /// <p>Expects the '*' (asterisk) character.</p>
615 /// <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>, or <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html">Conditional requests</a> in the <i>Amazon S3 User Guide</i>.</p>
616 pub fn set_if_none_match(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
617 self.inner = self.inner.set_if_none_match(input);
618 self
619 }
620 /// <p>Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a <code>412 Precondition Failed</code> error.</p>
621 /// <p>If a conflicting operation occurs during the upload S3 returns a <code>409 ConditionalRequestConflict</code> response. On a 409 failure you should retry the upload.</p>
622 /// <p>Expects the '*' (asterisk) character.</p>
623 /// <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>, or <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html">Conditional requests</a> in the <i>Amazon S3 User Guide</i>.</p>
624 pub fn get_if_none_match(&self) -> &::std::option::Option<::std::string::String> {
625 self.inner.get_if_none_match()
626 }
627 /// <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.</p><note>
628 /// <ul>
629 /// <li>
630 /// <p>This functionality is not supported for directory buckets.</p></li>
631 /// <li>
632 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
633 /// </ul>
634 /// </note>
635 pub fn grant_full_control(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
636 self.inner = self.inner.grant_full_control(input.into());
637 self
638 }
639 /// <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.</p><note>
640 /// <ul>
641 /// <li>
642 /// <p>This functionality is not supported for directory buckets.</p></li>
643 /// <li>
644 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
645 /// </ul>
646 /// </note>
647 pub fn set_grant_full_control(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
648 self.inner = self.inner.set_grant_full_control(input);
649 self
650 }
651 /// <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.</p><note>
652 /// <ul>
653 /// <li>
654 /// <p>This functionality is not supported for directory buckets.</p></li>
655 /// <li>
656 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
657 /// </ul>
658 /// </note>
659 pub fn get_grant_full_control(&self) -> &::std::option::Option<::std::string::String> {
660 self.inner.get_grant_full_control()
661 }
662 /// <p>Allows grantee to read the object data and its metadata.</p><note>
663 /// <ul>
664 /// <li>
665 /// <p>This functionality is not supported for directory buckets.</p></li>
666 /// <li>
667 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
668 /// </ul>
669 /// </note>
670 pub fn grant_read(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
671 self.inner = self.inner.grant_read(input.into());
672 self
673 }
674 /// <p>Allows grantee to read the object data and its metadata.</p><note>
675 /// <ul>
676 /// <li>
677 /// <p>This functionality is not supported for directory buckets.</p></li>
678 /// <li>
679 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
680 /// </ul>
681 /// </note>
682 pub fn set_grant_read(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
683 self.inner = self.inner.set_grant_read(input);
684 self
685 }
686 /// <p>Allows grantee to read the object data and its metadata.</p><note>
687 /// <ul>
688 /// <li>
689 /// <p>This functionality is not supported for directory buckets.</p></li>
690 /// <li>
691 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
692 /// </ul>
693 /// </note>
694 pub fn get_grant_read(&self) -> &::std::option::Option<::std::string::String> {
695 self.inner.get_grant_read()
696 }
697 /// <p>Allows grantee to read the object ACL.</p><note>
698 /// <ul>
699 /// <li>
700 /// <p>This functionality is not supported for directory buckets.</p></li>
701 /// <li>
702 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
703 /// </ul>
704 /// </note>
705 pub fn grant_read_acp(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
706 self.inner = self.inner.grant_read_acp(input.into());
707 self
708 }
709 /// <p>Allows grantee to read the object ACL.</p><note>
710 /// <ul>
711 /// <li>
712 /// <p>This functionality is not supported for directory buckets.</p></li>
713 /// <li>
714 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
715 /// </ul>
716 /// </note>
717 pub fn set_grant_read_acp(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
718 self.inner = self.inner.set_grant_read_acp(input);
719 self
720 }
721 /// <p>Allows grantee to read the object ACL.</p><note>
722 /// <ul>
723 /// <li>
724 /// <p>This functionality is not supported for directory buckets.</p></li>
725 /// <li>
726 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
727 /// </ul>
728 /// </note>
729 pub fn get_grant_read_acp(&self) -> &::std::option::Option<::std::string::String> {
730 self.inner.get_grant_read_acp()
731 }
732 /// <p>Allows grantee to write the ACL for the applicable object.</p><note>
733 /// <ul>
734 /// <li>
735 /// <p>This functionality is not supported for directory buckets.</p></li>
736 /// <li>
737 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
738 /// </ul>
739 /// </note>
740 pub fn grant_write_acp(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
741 self.inner = self.inner.grant_write_acp(input.into());
742 self
743 }
744 /// <p>Allows grantee to write the ACL for the applicable object.</p><note>
745 /// <ul>
746 /// <li>
747 /// <p>This functionality is not supported for directory buckets.</p></li>
748 /// <li>
749 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
750 /// </ul>
751 /// </note>
752 pub fn set_grant_write_acp(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
753 self.inner = self.inner.set_grant_write_acp(input);
754 self
755 }
756 /// <p>Allows grantee to write the ACL for the applicable object.</p><note>
757 /// <ul>
758 /// <li>
759 /// <p>This functionality is not supported for directory buckets.</p></li>
760 /// <li>
761 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
762 /// </ul>
763 /// </note>
764 pub fn get_grant_write_acp(&self) -> &::std::option::Option<::std::string::String> {
765 self.inner.get_grant_write_acp()
766 }
767 /// <p>Object key for which the PUT action was initiated.</p>
768 pub fn key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
769 self.inner = self.inner.key(input.into());
770 self
771 }
772 /// <p>Object key for which the PUT action was initiated.</p>
773 pub fn set_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
774 self.inner = self.inner.set_key(input);
775 self
776 }
777 /// <p>Object key for which the PUT action was initiated.</p>
778 pub fn get_key(&self) -> &::std::option::Option<::std::string::String> {
779 self.inner.get_key()
780 }
781 /// <p>Specifies the offset for appending data to existing objects in bytes. The offset must be equal to the size of the existing object being appended to. If no object exists, setting this header to 0 will create a new object.</p><note>
782 /// <p>This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.</p>
783 /// </note>
784 pub fn write_offset_bytes(mut self, input: i64) -> Self {
785 self.inner = self.inner.write_offset_bytes(input);
786 self
787 }
788 /// <p>Specifies the offset for appending data to existing objects in bytes. The offset must be equal to the size of the existing object being appended to. If no object exists, setting this header to 0 will create a new object.</p><note>
789 /// <p>This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.</p>
790 /// </note>
791 pub fn set_write_offset_bytes(mut self, input: ::std::option::Option<i64>) -> Self {
792 self.inner = self.inner.set_write_offset_bytes(input);
793 self
794 }
795 /// <p>Specifies the offset for appending data to existing objects in bytes. The offset must be equal to the size of the existing object being appended to. If no object exists, setting this header to 0 will create a new object.</p><note>
796 /// <p>This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.</p>
797 /// </note>
798 pub fn get_write_offset_bytes(&self) -> &::std::option::Option<i64> {
799 self.inner.get_write_offset_bytes()
800 }
801 ///
802 /// Adds a key-value pair to `Metadata`.
803 ///
804 /// To override the contents of this collection use [`set_metadata`](Self::set_metadata).
805 ///
806 /// <p>A map of metadata to store with the object in S3.</p>
807 pub fn metadata(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
808 self.inner = self.inner.metadata(k.into(), v.into());
809 self
810 }
811 /// <p>A map of metadata to store with the object in S3.</p>
812 pub fn set_metadata(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
813 self.inner = self.inner.set_metadata(input);
814 self
815 }
816 /// <p>A map of metadata to store with the object in S3.</p>
817 pub fn get_metadata(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
818 self.inner.get_metadata()
819 }
820 /// <p>The server-side encryption algorithm that was used when you store this object in Amazon S3 or Amazon FSx.</p>
821 /// <ul>
822 /// <li>
823 /// <p><b>General purpose buckets </b> - You have four mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side encryption with other key options. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i>.</p></li>
824 /// <li>
825 /// <p><b>Directory buckets </b> - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) and server-side encryption with KMS keys (SSE-KMS) (<code>aws:kms</code>). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your <code>CreateSession</code> requests or <code>PUT</code> object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>. For more information about the encryption overriding behaviors in directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html">Specifying server-side encryption with KMS for new object uploads</a>.</p>
826 /// <p>In the Zonal endpoint API calls (except <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a>) using the REST API, the encryption request headers must match the encryption settings that are specified in the <code>CreateSession</code> request. You can't override the values of the encryption settings (<code>x-amz-server-side-encryption</code>, <code>x-amz-server-side-encryption-aws-kms-key-id</code>, <code>x-amz-server-side-encryption-context</code>, and <code>x-amz-server-side-encryption-bucket-key-enabled</code>) that are specified in the <code>CreateSession</code> request. You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the <code>CreateSession</code> request to protect new objects in the directory bucket.</p><note>
827 /// <p>When you use the CLI or the Amazon Web Services SDKs, for <code>CreateSession</code>, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the <code>CreateSession</code> request. It's not supported to override the encryption settings values in the <code>CreateSession</code> request. So in the Zonal endpoint API calls (except <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a>), the encryption request headers must match the default encryption configuration of the directory bucket.</p>
828 /// </note></li>
829 /// <li>
830 /// <p><b>S3 access points for Amazon FSx </b> - When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is <code>aws:fsx</code>. All Amazon FSx file systems have encryption configured by default and are encrypted at rest. Data is automatically encrypted before being written to the file system, and automatically decrypted as it is read. These processes are handled transparently by Amazon FSx.</p></li>
831 /// </ul>
832 pub fn server_side_encryption(mut self, input: crate::types::ServerSideEncryption) -> Self {
833 self.inner = self.inner.server_side_encryption(input);
834 self
835 }
836 /// <p>The server-side encryption algorithm that was used when you store this object in Amazon S3 or Amazon FSx.</p>
837 /// <ul>
838 /// <li>
839 /// <p><b>General purpose buckets </b> - You have four mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side encryption with other key options. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i>.</p></li>
840 /// <li>
841 /// <p><b>Directory buckets </b> - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) and server-side encryption with KMS keys (SSE-KMS) (<code>aws:kms</code>). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your <code>CreateSession</code> requests or <code>PUT</code> object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>. For more information about the encryption overriding behaviors in directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html">Specifying server-side encryption with KMS for new object uploads</a>.</p>
842 /// <p>In the Zonal endpoint API calls (except <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a>) using the REST API, the encryption request headers must match the encryption settings that are specified in the <code>CreateSession</code> request. You can't override the values of the encryption settings (<code>x-amz-server-side-encryption</code>, <code>x-amz-server-side-encryption-aws-kms-key-id</code>, <code>x-amz-server-side-encryption-context</code>, and <code>x-amz-server-side-encryption-bucket-key-enabled</code>) that are specified in the <code>CreateSession</code> request. You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the <code>CreateSession</code> request to protect new objects in the directory bucket.</p><note>
843 /// <p>When you use the CLI or the Amazon Web Services SDKs, for <code>CreateSession</code>, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the <code>CreateSession</code> request. It's not supported to override the encryption settings values in the <code>CreateSession</code> request. So in the Zonal endpoint API calls (except <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a>), the encryption request headers must match the default encryption configuration of the directory bucket.</p>
844 /// </note></li>
845 /// <li>
846 /// <p><b>S3 access points for Amazon FSx </b> - When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is <code>aws:fsx</code>. All Amazon FSx file systems have encryption configured by default and are encrypted at rest. Data is automatically encrypted before being written to the file system, and automatically decrypted as it is read. These processes are handled transparently by Amazon FSx.</p></li>
847 /// </ul>
848 pub fn set_server_side_encryption(mut self, input: ::std::option::Option<crate::types::ServerSideEncryption>) -> Self {
849 self.inner = self.inner.set_server_side_encryption(input);
850 self
851 }
852 /// <p>The server-side encryption algorithm that was used when you store this object in Amazon S3 or Amazon FSx.</p>
853 /// <ul>
854 /// <li>
855 /// <p><b>General purpose buckets </b> - You have four mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side encryption with other key options. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i>.</p></li>
856 /// <li>
857 /// <p><b>Directory buckets </b> - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) and server-side encryption with KMS keys (SSE-KMS) (<code>aws:kms</code>). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your <code>CreateSession</code> requests or <code>PUT</code> object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>. For more information about the encryption overriding behaviors in directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html">Specifying server-side encryption with KMS for new object uploads</a>.</p>
858 /// <p>In the Zonal endpoint API calls (except <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a>) using the REST API, the encryption request headers must match the encryption settings that are specified in the <code>CreateSession</code> request. You can't override the values of the encryption settings (<code>x-amz-server-side-encryption</code>, <code>x-amz-server-side-encryption-aws-kms-key-id</code>, <code>x-amz-server-side-encryption-context</code>, and <code>x-amz-server-side-encryption-bucket-key-enabled</code>) that are specified in the <code>CreateSession</code> request. You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the <code>CreateSession</code> request to protect new objects in the directory bucket.</p><note>
859 /// <p>When you use the CLI or the Amazon Web Services SDKs, for <code>CreateSession</code>, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the <code>CreateSession</code> request. It's not supported to override the encryption settings values in the <code>CreateSession</code> request. So in the Zonal endpoint API calls (except <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a>), the encryption request headers must match the default encryption configuration of the directory bucket.</p>
860 /// </note></li>
861 /// <li>
862 /// <p><b>S3 access points for Amazon FSx </b> - When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is <code>aws:fsx</code>. All Amazon FSx file systems have encryption configured by default and are encrypted at rest. Data is automatically encrypted before being written to the file system, and automatically decrypted as it is read. These processes are handled transparently by Amazon FSx.</p></li>
863 /// </ul>
864 pub fn get_server_side_encryption(&self) -> &::std::option::Option<crate::types::ServerSideEncryption> {
865 self.inner.get_server_side_encryption()
866 }
867 /// <p>By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> in the <i>Amazon S3 User Guide</i>.</p><note>
868 /// <ul>
869 /// <li>
870 /// <p>Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.</p></li>
871 /// <li>
872 /// <p>Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.</p></li>
873 /// </ul>
874 /// </note>
875 pub fn storage_class(mut self, input: crate::types::StorageClass) -> Self {
876 self.inner = self.inner.storage_class(input);
877 self
878 }
879 /// <p>By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> in the <i>Amazon S3 User Guide</i>.</p><note>
880 /// <ul>
881 /// <li>
882 /// <p>Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.</p></li>
883 /// <li>
884 /// <p>Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.</p></li>
885 /// </ul>
886 /// </note>
887 pub fn set_storage_class(mut self, input: ::std::option::Option<crate::types::StorageClass>) -> Self {
888 self.inner = self.inner.set_storage_class(input);
889 self
890 }
891 /// <p>By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> in the <i>Amazon S3 User Guide</i>.</p><note>
892 /// <ul>
893 /// <li>
894 /// <p>Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.</p></li>
895 /// <li>
896 /// <p>Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.</p></li>
897 /// </ul>
898 /// </note>
899 pub fn get_storage_class(&self) -> &::std::option::Option<crate::types::StorageClass> {
900 self.inner.get_storage_class()
901 }
902 /// <p>If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html">Object Key and Metadata</a> in the <i>Amazon S3 User Guide</i>.</p>
903 /// <p>In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:</p>
904 /// <p><code>x-amz-website-redirect-location: /anotherPage.html</code></p>
905 /// <p>In the following example, the request header sets the object redirect to another website:</p>
906 /// <p><code>x-amz-website-redirect-location: http://www.example.com/</code></p>
907 /// <p>For more information about website hosting in Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html">How to Configure Website Page Redirects</a> in the <i>Amazon S3 User Guide</i>.</p><note>
908 /// <p>This functionality is not supported for directory buckets.</p>
909 /// </note>
910 pub fn website_redirect_location(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
911 self.inner = self.inner.website_redirect_location(input.into());
912 self
913 }
914 /// <p>If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html">Object Key and Metadata</a> in the <i>Amazon S3 User Guide</i>.</p>
915 /// <p>In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:</p>
916 /// <p><code>x-amz-website-redirect-location: /anotherPage.html</code></p>
917 /// <p>In the following example, the request header sets the object redirect to another website:</p>
918 /// <p><code>x-amz-website-redirect-location: http://www.example.com/</code></p>
919 /// <p>For more information about website hosting in Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html">How to Configure Website Page Redirects</a> in the <i>Amazon S3 User Guide</i>.</p><note>
920 /// <p>This functionality is not supported for directory buckets.</p>
921 /// </note>
922 pub fn set_website_redirect_location(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
923 self.inner = self.inner.set_website_redirect_location(input);
924 self
925 }
926 /// <p>If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html">Object Key and Metadata</a> in the <i>Amazon S3 User Guide</i>.</p>
927 /// <p>In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:</p>
928 /// <p><code>x-amz-website-redirect-location: /anotherPage.html</code></p>
929 /// <p>In the following example, the request header sets the object redirect to another website:</p>
930 /// <p><code>x-amz-website-redirect-location: http://www.example.com/</code></p>
931 /// <p>For more information about website hosting in Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html">How to Configure Website Page Redirects</a> in the <i>Amazon S3 User Guide</i>.</p><note>
932 /// <p>This functionality is not supported for directory buckets.</p>
933 /// </note>
934 pub fn get_website_redirect_location(&self) -> &::std::option::Option<::std::string::String> {
935 self.inner.get_website_redirect_location()
936 }
937 /// <p>Specifies the algorithm to use when encrypting the object (for example, <code>AES256</code>).</p><note>
938 /// <p>This functionality is not supported for directory buckets.</p>
939 /// </note>
940 pub fn sse_customer_algorithm(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
941 self.inner = self.inner.sse_customer_algorithm(input.into());
942 self
943 }
944 /// <p>Specifies the algorithm to use when encrypting the object (for example, <code>AES256</code>).</p><note>
945 /// <p>This functionality is not supported for directory buckets.</p>
946 /// </note>
947 pub fn set_sse_customer_algorithm(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
948 self.inner = self.inner.set_sse_customer_algorithm(input);
949 self
950 }
951 /// <p>Specifies the algorithm to use when encrypting the object (for example, <code>AES256</code>).</p><note>
952 /// <p>This functionality is not supported for directory buckets.</p>
953 /// </note>
954 pub fn get_sse_customer_algorithm(&self) -> &::std::option::Option<::std::string::String> {
955 self.inner.get_sse_customer_algorithm()
956 }
957 /// <p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p><note>
958 /// <p>This functionality is not supported for directory buckets.</p>
959 /// </note>
960 pub fn sse_customer_key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
961 self.inner = self.inner.sse_customer_key(input.into());
962 self
963 }
964 /// <p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p><note>
965 /// <p>This functionality is not supported for directory buckets.</p>
966 /// </note>
967 pub fn set_sse_customer_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
968 self.inner = self.inner.set_sse_customer_key(input);
969 self
970 }
971 /// <p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p><note>
972 /// <p>This functionality is not supported for directory buckets.</p>
973 /// </note>
974 pub fn get_sse_customer_key(&self) -> &::std::option::Option<::std::string::String> {
975 self.inner.get_sse_customer_key()
976 }
977 /// <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.</p><note>
978 /// <p>This functionality is not supported for directory buckets.</p>
979 /// </note>
980 pub fn sse_customer_key_md5(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
981 self.inner = self.inner.sse_customer_key_md5(input.into());
982 self
983 }
984 /// <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.</p><note>
985 /// <p>This functionality is not supported for directory buckets.</p>
986 /// </note>
987 pub fn set_sse_customer_key_md5(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
988 self.inner = self.inner.set_sse_customer_key_md5(input);
989 self
990 }
991 /// <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.</p><note>
992 /// <p>This functionality is not supported for directory buckets.</p>
993 /// </note>
994 pub fn get_sse_customer_key_md5(&self) -> &::std::option::Option<::std::string::String> {
995 self.inner.get_sse_customer_key_md5()
996 }
997 /// <p>Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same account that's issuing the command, you must use the full Key ARN not the Key ID.</p>
998 /// <p><b>General purpose buckets</b> - If you specify <code>x-amz-server-side-encryption</code> with <code>aws:kms</code> or <code>aws:kms:dsse</code>, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specify <code>x-amz-server-side-encryption:aws:kms</code> or <code>x-amz-server-side-encryption:aws:kms:dsse</code>, but do not provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon Web Services managed key (<code>aws/s3</code>) to protect the data.</p>
999 /// <p><b>Directory buckets</b> - To encrypt data using SSE-KMS, it's recommended to specify the <code>x-amz-server-side-encryption</code> header to <code>aws:kms</code>. Then, the <code>x-amz-server-side-encryption-aws-kms-key-id</code> header implicitly uses the bucket's default KMS customer managed key ID. If you want to explicitly set the <code> x-amz-server-side-encryption-aws-kms-key-id</code> header, it must match the bucket's default customer managed key (using key ID or ARN, not alias). Your SSE-KMS configuration can only support 1 <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a> per directory bucket's lifetime. The <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a> (<code>aws/s3</code>) isn't supported. Incorrect key specification results in an HTTP <code>400 Bad Request</code> error.</p>
1000 pub fn ssekms_key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
1001 self.inner = self.inner.ssekms_key_id(input.into());
1002 self
1003 }
1004 /// <p>Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same account that's issuing the command, you must use the full Key ARN not the Key ID.</p>
1005 /// <p><b>General purpose buckets</b> - If you specify <code>x-amz-server-side-encryption</code> with <code>aws:kms</code> or <code>aws:kms:dsse</code>, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specify <code>x-amz-server-side-encryption:aws:kms</code> or <code>x-amz-server-side-encryption:aws:kms:dsse</code>, but do not provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon Web Services managed key (<code>aws/s3</code>) to protect the data.</p>
1006 /// <p><b>Directory buckets</b> - To encrypt data using SSE-KMS, it's recommended to specify the <code>x-amz-server-side-encryption</code> header to <code>aws:kms</code>. Then, the <code>x-amz-server-side-encryption-aws-kms-key-id</code> header implicitly uses the bucket's default KMS customer managed key ID. If you want to explicitly set the <code> x-amz-server-side-encryption-aws-kms-key-id</code> header, it must match the bucket's default customer managed key (using key ID or ARN, not alias). Your SSE-KMS configuration can only support 1 <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a> per directory bucket's lifetime. The <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a> (<code>aws/s3</code>) isn't supported. Incorrect key specification results in an HTTP <code>400 Bad Request</code> error.</p>
1007 pub fn set_ssekms_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
1008 self.inner = self.inner.set_ssekms_key_id(input);
1009 self
1010 }
1011 /// <p>Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same account that's issuing the command, you must use the full Key ARN not the Key ID.</p>
1012 /// <p><b>General purpose buckets</b> - If you specify <code>x-amz-server-side-encryption</code> with <code>aws:kms</code> or <code>aws:kms:dsse</code>, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specify <code>x-amz-server-side-encryption:aws:kms</code> or <code>x-amz-server-side-encryption:aws:kms:dsse</code>, but do not provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon Web Services managed key (<code>aws/s3</code>) to protect the data.</p>
1013 /// <p><b>Directory buckets</b> - To encrypt data using SSE-KMS, it's recommended to specify the <code>x-amz-server-side-encryption</code> header to <code>aws:kms</code>. Then, the <code>x-amz-server-side-encryption-aws-kms-key-id</code> header implicitly uses the bucket's default KMS customer managed key ID. If you want to explicitly set the <code> x-amz-server-side-encryption-aws-kms-key-id</code> header, it must match the bucket's default customer managed key (using key ID or ARN, not alias). Your SSE-KMS configuration can only support 1 <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a> per directory bucket's lifetime. The <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a> (<code>aws/s3</code>) isn't supported. Incorrect key specification results in an HTTP <code>400 Bad Request</code> error.</p>
1014 pub fn get_ssekms_key_id(&self) -> &::std::option::Option<::std::string::String> {
1015 self.inner.get_ssekms_key_id()
1016 }
1017 /// <p>Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future <code>GetObject</code> operations on this object.</p>
1018 /// <p><b>General purpose buckets</b> - This value must be explicitly added during <code>CopyObject</code> operations if you want an additional encryption context for your object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html#encryption-context">Encryption context</a> in the <i>Amazon S3 User Guide</i>.</p>
1019 /// <p><b>Directory buckets</b> - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.</p>
1020 pub fn ssekms_encryption_context(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
1021 self.inner = self.inner.ssekms_encryption_context(input.into());
1022 self
1023 }
1024 /// <p>Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future <code>GetObject</code> operations on this object.</p>
1025 /// <p><b>General purpose buckets</b> - This value must be explicitly added during <code>CopyObject</code> operations if you want an additional encryption context for your object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html#encryption-context">Encryption context</a> in the <i>Amazon S3 User Guide</i>.</p>
1026 /// <p><b>Directory buckets</b> - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.</p>
1027 pub fn set_ssekms_encryption_context(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
1028 self.inner = self.inner.set_ssekms_encryption_context(input);
1029 self
1030 }
1031 /// <p>Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future <code>GetObject</code> operations on this object.</p>
1032 /// <p><b>General purpose buckets</b> - This value must be explicitly added during <code>CopyObject</code> operations if you want an additional encryption context for your object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html#encryption-context">Encryption context</a> in the <i>Amazon S3 User Guide</i>.</p>
1033 /// <p><b>Directory buckets</b> - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.</p>
1034 pub fn get_ssekms_encryption_context(&self) -> &::std::option::Option<::std::string::String> {
1035 self.inner.get_ssekms_encryption_context()
1036 }
1037 /// <p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS).</p>
1038 /// <p><b>General purpose buckets</b> - Setting this header to <code>true</code> causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Also, specifying this header with a PUT action doesn't affect bucket-level settings for S3 Bucket Key.</p>
1039 /// <p><b>Directory buckets</b> - S3 Bucket Keys are always enabled for <code>GET</code> and <code>PUT</code> operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops">the Copy operation in Batch Operations</a>, or <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job">the import jobs</a>. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.</p>
1040 pub fn bucket_key_enabled(mut self, input: bool) -> Self {
1041 self.inner = self.inner.bucket_key_enabled(input);
1042 self
1043 }
1044 /// <p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS).</p>
1045 /// <p><b>General purpose buckets</b> - Setting this header to <code>true</code> causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Also, specifying this header with a PUT action doesn't affect bucket-level settings for S3 Bucket Key.</p>
1046 /// <p><b>Directory buckets</b> - S3 Bucket Keys are always enabled for <code>GET</code> and <code>PUT</code> operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops">the Copy operation in Batch Operations</a>, or <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job">the import jobs</a>. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.</p>
1047 pub fn set_bucket_key_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
1048 self.inner = self.inner.set_bucket_key_enabled(input);
1049 self
1050 }
1051 /// <p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS).</p>
1052 /// <p><b>General purpose buckets</b> - Setting this header to <code>true</code> causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Also, specifying this header with a PUT action doesn't affect bucket-level settings for S3 Bucket Key.</p>
1053 /// <p><b>Directory buckets</b> - S3 Bucket Keys are always enabled for <code>GET</code> and <code>PUT</code> operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops">the Copy operation in Batch Operations</a>, or <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job">the import jobs</a>. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.</p>
1054 pub fn get_bucket_key_enabled(&self) -> &::std::option::Option<bool> {
1055 self.inner.get_bucket_key_enabled()
1056 }
1057 /// <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>
1058 /// <p>This functionality is not supported for directory buckets.</p>
1059 /// </note>
1060 pub fn request_payer(mut self, input: crate::types::RequestPayer) -> Self {
1061 self.inner = self.inner.request_payer(input);
1062 self
1063 }
1064 /// <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>
1065 /// <p>This functionality is not supported for directory buckets.</p>
1066 /// </note>
1067 pub fn set_request_payer(mut self, input: ::std::option::Option<crate::types::RequestPayer>) -> Self {
1068 self.inner = self.inner.set_request_payer(input);
1069 self
1070 }
1071 /// <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>
1072 /// <p>This functionality is not supported for directory buckets.</p>
1073 /// </note>
1074 pub fn get_request_payer(&self) -> &::std::option::Option<crate::types::RequestPayer> {
1075 self.inner.get_request_payer()
1076 }
1077 /// <p>The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")</p><note>
1078 /// <p>This functionality is not supported for directory buckets.</p>
1079 /// </note>
1080 pub fn tagging(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
1081 self.inner = self.inner.tagging(input.into());
1082 self
1083 }
1084 /// <p>The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")</p><note>
1085 /// <p>This functionality is not supported for directory buckets.</p>
1086 /// </note>
1087 pub fn set_tagging(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
1088 self.inner = self.inner.set_tagging(input);
1089 self
1090 }
1091 /// <p>The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")</p><note>
1092 /// <p>This functionality is not supported for directory buckets.</p>
1093 /// </note>
1094 pub fn get_tagging(&self) -> &::std::option::Option<::std::string::String> {
1095 self.inner.get_tagging()
1096 }
1097 /// <p>The Object Lock mode that you want to apply to this object.</p><note>
1098 /// <p>This functionality is not supported for directory buckets.</p>
1099 /// </note>
1100 pub fn object_lock_mode(mut self, input: crate::types::ObjectLockMode) -> Self {
1101 self.inner = self.inner.object_lock_mode(input);
1102 self
1103 }
1104 /// <p>The Object Lock mode that you want to apply to this object.</p><note>
1105 /// <p>This functionality is not supported for directory buckets.</p>
1106 /// </note>
1107 pub fn set_object_lock_mode(mut self, input: ::std::option::Option<crate::types::ObjectLockMode>) -> Self {
1108 self.inner = self.inner.set_object_lock_mode(input);
1109 self
1110 }
1111 /// <p>The Object Lock mode that you want to apply to this object.</p><note>
1112 /// <p>This functionality is not supported for directory buckets.</p>
1113 /// </note>
1114 pub fn get_object_lock_mode(&self) -> &::std::option::Option<crate::types::ObjectLockMode> {
1115 self.inner.get_object_lock_mode()
1116 }
1117 /// <p>The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.</p><note>
1118 /// <p>This functionality is not supported for directory buckets.</p>
1119 /// </note>
1120 pub fn object_lock_retain_until_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
1121 self.inner = self.inner.object_lock_retain_until_date(input);
1122 self
1123 }
1124 /// <p>The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.</p><note>
1125 /// <p>This functionality is not supported for directory buckets.</p>
1126 /// </note>
1127 pub fn set_object_lock_retain_until_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
1128 self.inner = self.inner.set_object_lock_retain_until_date(input);
1129 self
1130 }
1131 /// <p>The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.</p><note>
1132 /// <p>This functionality is not supported for directory buckets.</p>
1133 /// </note>
1134 pub fn get_object_lock_retain_until_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
1135 self.inner.get_object_lock_retain_until_date()
1136 }
1137 /// <p>Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a> in the <i>Amazon S3 User Guide</i>.</p><note>
1138 /// <p>This functionality is not supported for directory buckets.</p>
1139 /// </note>
1140 pub fn object_lock_legal_hold_status(mut self, input: crate::types::ObjectLockLegalHoldStatus) -> Self {
1141 self.inner = self.inner.object_lock_legal_hold_status(input);
1142 self
1143 }
1144 /// <p>Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a> in the <i>Amazon S3 User Guide</i>.</p><note>
1145 /// <p>This functionality is not supported for directory buckets.</p>
1146 /// </note>
1147 pub fn set_object_lock_legal_hold_status(mut self, input: ::std::option::Option<crate::types::ObjectLockLegalHoldStatus>) -> Self {
1148 self.inner = self.inner.set_object_lock_legal_hold_status(input);
1149 self
1150 }
1151 /// <p>Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a> in the <i>Amazon S3 User Guide</i>.</p><note>
1152 /// <p>This functionality is not supported for directory buckets.</p>
1153 /// </note>
1154 pub fn get_object_lock_legal_hold_status(&self) -> &::std::option::Option<crate::types::ObjectLockLegalHoldStatus> {
1155 self.inner.get_object_lock_legal_hold_status()
1156 }
1157 /// <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>
1158 pub fn expected_bucket_owner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
1159 self.inner = self.inner.expected_bucket_owner(input.into());
1160 self
1161 }
1162 /// <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>
1163 pub fn set_expected_bucket_owner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
1164 self.inner = self.inner.set_expected_bucket_owner(input);
1165 self
1166 }
1167 /// <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>
1168 pub fn get_expected_bucket_owner(&self) -> &::std::option::Option<::std::string::String> {
1169 self.inner.get_expected_bucket_owner()
1170 }
1171}
1172
1173impl crate::client::customize::internal::CustomizablePresigned<crate::operation::put_object::PutObjectError> for PutObjectFluentBuilder {
1174 fn presign(
1175 self,
1176 config_override: crate::config::Builder,
1177 presigning_config: crate::presigning::PresigningConfig,
1178 ) -> crate::client::customize::internal::BoxFuture<
1179 crate::client::customize::internal::SendResult<crate::presigning::PresignedRequest, crate::operation::put_object::PutObjectError>,
1180 > {
1181 ::std::boxed::Box::pin(async move { self.config_override(config_override).presigned(presigning_config).await })
1182 }
1183}