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: Beginning October 1, 2025, Amazon S3 will discontinue support for creating new Email Grantee Access Control Lists (ACL). Email Grantee ACLs created prior to this date will continue to work and remain accessible through the Amazon Web Services Management Console, Command Line Interface (CLI), SDKs, and REST API. However, you will no longer be able to create new Email Grantee ACLs.</p>
27/// <p>This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.</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>
102#[derive(::std::fmt::Debug)]
103pub struct PutObjectFluentBuilder {
104 handle: ::std::sync::Arc<crate::client::Handle>,
105 inner: crate::operation::put_object::builders::PutObjectInputBuilder,
106 config_override: ::std::option::Option<crate::config::Builder>,
107}
108impl crate::client::customize::internal::CustomizableSend<crate::operation::put_object::PutObjectOutput, crate::operation::put_object::PutObjectError>
109 for PutObjectFluentBuilder
110{
111 fn send(
112 self,
113 config_override: crate::config::Builder,
114 ) -> crate::client::customize::internal::BoxFuture<
115 crate::client::customize::internal::SendResult<crate::operation::put_object::PutObjectOutput, crate::operation::put_object::PutObjectError>,
116 > {
117 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
118 }
119}
120impl PutObjectFluentBuilder {
121 /// Creates a new `PutObjectFluentBuilder`.
122 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
123 Self {
124 handle,
125 inner: ::std::default::Default::default(),
126 config_override: ::std::option::Option::None,
127 }
128 }
129 /// Access the PutObject as a reference.
130 pub fn as_input(&self) -> &crate::operation::put_object::builders::PutObjectInputBuilder {
131 &self.inner
132 }
133 /// Sends the request and returns the response.
134 ///
135 /// If an error occurs, an `SdkError` will be returned with additional details that
136 /// can be matched against.
137 ///
138 /// By default, any retryable failures will be retried twice. Retry behavior
139 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
140 /// set when configuring the client.
141 pub async fn send(
142 self,
143 ) -> ::std::result::Result<
144 crate::operation::put_object::PutObjectOutput,
145 ::aws_smithy_runtime_api::client::result::SdkError<
146 crate::operation::put_object::PutObjectError,
147 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
148 >,
149 > {
150 let input = self
151 .inner
152 .build()
153 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
154 let runtime_plugins = crate::operation::put_object::PutObject::operation_runtime_plugins(
155 self.handle.runtime_plugins.clone(),
156 &self.handle.conf,
157 self.config_override,
158 );
159 crate::operation::put_object::PutObject::orchestrate(&runtime_plugins, input).await
160 }
161
162 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
163 pub fn customize(
164 self,
165 ) -> crate::client::customize::CustomizableOperation<
166 crate::operation::put_object::PutObjectOutput,
167 crate::operation::put_object::PutObjectError,
168 Self,
169 > {
170 crate::client::customize::CustomizableOperation::new(self)
171 }
172 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
173 self.set_config_override(::std::option::Option::Some(config_override.into()));
174 self
175 }
176
177 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
178 self.config_override = config_override;
179 self
180 }
181 ///
182 /// Creates a presigned request for this operation.
183 ///
184 /// The `presigning_config` provides additional presigning-specific config values, such as the
185 /// amount of time the request should be valid for after creation.
186 ///
187 /// Presigned requests can be given to other users or applications to access a resource or perform
188 /// an operation without having access to the AWS security credentials.
189 ///
190 /// _Important:_ If you're using credentials that can expire, such as those from STS AssumeRole or SSO, then
191 /// the presigned request can only be valid for as long as the credentials used to create it are.
192 ///
193 #[allow(unused_mut)]
194 pub async fn presigned(
195 mut self,
196 presigning_config: crate::presigning::PresigningConfig,
197 ) -> ::std::result::Result<
198 crate::presigning::PresignedRequest,
199 ::aws_smithy_runtime_api::client::result::SdkError<
200 crate::operation::put_object::PutObjectError,
201 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
202 >,
203 > {
204 let runtime_plugins = crate::operation::put_object::PutObject::operation_runtime_plugins(
205 self.handle.runtime_plugins.clone(),
206 &self.handle.conf,
207 self.config_override,
208 )
209 .with_client_plugin(crate::presigning_interceptors::SigV4PresigningRuntimePlugin::new(
210 presigning_config,
211 ::aws_sigv4::http_request::SignableBody::UnsignedPayload,
212 ));
213
214 let input = self
215 .inner
216 .build()
217 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
218 let mut context = crate::operation::put_object::PutObject::orchestrate_with_stop_point(
219 &runtime_plugins,
220 input,
221 ::aws_smithy_runtime::client::orchestrator::StopPoint::BeforeTransmit,
222 )
223 .await
224 .map_err(|err| {
225 err.map_service_error(|err| {
226 err.downcast::<crate::operation::put_object::PutObjectError>()
227 .expect("correct error type")
228 })
229 })?;
230 let request = context.take_request().expect("request set before transmit");
231 crate::presigning::PresignedRequest::new(request).map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)
232 }
233 /// <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>
234 /// <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>
235 /// <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>
236 /// <ul>
237 /// <li>
238 /// <p>This functionality is not supported for directory buckets.</p></li>
239 /// <li>
240 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
241 /// </ul>
242 /// </note>
243 pub fn acl(mut self, input: crate::types::ObjectCannedAcl) -> Self {
244 self.inner = self.inner.acl(input);
245 self
246 }
247 /// <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>
248 /// <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>
249 /// <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>
250 /// <ul>
251 /// <li>
252 /// <p>This functionality is not supported for directory buckets.</p></li>
253 /// <li>
254 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
255 /// </ul>
256 /// </note>
257 pub fn set_acl(mut self, input: ::std::option::Option<crate::types::ObjectCannedAcl>) -> Self {
258 self.inner = self.inner.set_acl(input);
259 self
260 }
261 /// <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>
262 /// <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>
263 /// <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>
264 /// <ul>
265 /// <li>
266 /// <p>This functionality is not supported for directory buckets.</p></li>
267 /// <li>
268 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
269 /// </ul>
270 /// </note>
271 pub fn get_acl(&self) -> &::std::option::Option<crate::types::ObjectCannedAcl> {
272 self.inner.get_acl()
273 }
274 /// <p>Object data.</p>
275 pub fn body(mut self, input: ::aws_smithy_types::byte_stream::ByteStream) -> Self {
276 self.inner = self.inner.body(input);
277 self
278 }
279 /// <p>Object data.</p>
280 pub fn set_body(mut self, input: ::std::option::Option<::aws_smithy_types::byte_stream::ByteStream>) -> Self {
281 self.inner = self.inner.set_body(input);
282 self
283 }
284 /// <p>Object data.</p>
285 pub fn get_body(&self) -> &::std::option::Option<::aws_smithy_types::byte_stream::ByteStream> {
286 self.inner.get_body()
287 }
288 /// <p>The bucket name to which the PUT action was initiated.</p>
289 /// <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>
290 /// <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>
291 /// <p>Object Lambda access points are not supported by directory buckets.</p>
292 /// </note>
293 /// <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>
294 pub fn bucket(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
295 self.inner = self.inner.bucket(input.into());
296 self
297 }
298 /// <p>The bucket name to which the PUT action was initiated.</p>
299 /// <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>
300 /// <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>
301 /// <p>Object Lambda access points are not supported by directory buckets.</p>
302 /// </note>
303 /// <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>
304 pub fn set_bucket(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
305 self.inner = self.inner.set_bucket(input);
306 self
307 }
308 /// <p>The bucket name to which the PUT action was initiated.</p>
309 /// <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>
310 /// <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>
311 /// <p>Object Lambda access points are not supported by directory buckets.</p>
312 /// </note>
313 /// <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>
314 pub fn get_bucket(&self) -> &::std::option::Option<::std::string::String> {
315 self.inner.get_bucket()
316 }
317 /// <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>
318 pub fn cache_control(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
319 self.inner = self.inner.cache_control(input.into());
320 self
321 }
322 /// <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>
323 pub fn set_cache_control(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
324 self.inner = self.inner.set_cache_control(input);
325 self
326 }
327 /// <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>
328 pub fn get_cache_control(&self) -> &::std::option::Option<::std::string::String> {
329 self.inner.get_cache_control()
330 }
331 /// <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>
332 pub fn content_disposition(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
333 self.inner = self.inner.content_disposition(input.into());
334 self
335 }
336 /// <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>
337 pub fn set_content_disposition(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
338 self.inner = self.inner.set_content_disposition(input);
339 self
340 }
341 /// <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>
342 pub fn get_content_disposition(&self) -> &::std::option::Option<::std::string::String> {
343 self.inner.get_content_disposition()
344 }
345 /// <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>
346 pub fn content_encoding(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
347 self.inner = self.inner.content_encoding(input.into());
348 self
349 }
350 /// <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>
351 pub fn set_content_encoding(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
352 self.inner = self.inner.set_content_encoding(input);
353 self
354 }
355 /// <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>
356 pub fn get_content_encoding(&self) -> &::std::option::Option<::std::string::String> {
357 self.inner.get_content_encoding()
358 }
359 /// <p>The language the content is in.</p>
360 pub fn content_language(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
361 self.inner = self.inner.content_language(input.into());
362 self
363 }
364 /// <p>The language the content is in.</p>
365 pub fn set_content_language(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
366 self.inner = self.inner.set_content_language(input);
367 self
368 }
369 /// <p>The language the content is in.</p>
370 pub fn get_content_language(&self) -> &::std::option::Option<::std::string::String> {
371 self.inner.get_content_language()
372 }
373 /// <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>
374 pub fn content_length(mut self, input: i64) -> Self {
375 self.inner = self.inner.content_length(input);
376 self
377 }
378 /// <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>
379 pub fn set_content_length(mut self, input: ::std::option::Option<i64>) -> Self {
380 self.inner = self.inner.set_content_length(input);
381 self
382 }
383 /// <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>
384 pub fn get_content_length(&self) -> &::std::option::Option<i64> {
385 self.inner.get_content_length()
386 }
387 /// <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>
388 /// <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>
389 /// </note> <note>
390 /// <p>This functionality is not supported for directory buckets.</p>
391 /// </note>
392 pub fn content_md5(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
393 self.inner = self.inner.content_md5(input.into());
394 self
395 }
396 /// <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>
397 /// <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>
398 /// </note> <note>
399 /// <p>This functionality is not supported for directory buckets.</p>
400 /// </note>
401 pub fn set_content_md5(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
402 self.inner = self.inner.set_content_md5(input);
403 self
404 }
405 /// <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>
406 /// <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>
407 /// </note> <note>
408 /// <p>This functionality is not supported for directory buckets.</p>
409 /// </note>
410 pub fn get_content_md5(&self) -> &::std::option::Option<::std::string::String> {
411 self.inner.get_content_md5()
412 }
413 /// <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>
414 pub fn content_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
415 self.inner = self.inner.content_type(input.into());
416 self
417 }
418 /// <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>
419 pub fn set_content_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
420 self.inner = self.inner.set_content_type(input);
421 self
422 }
423 /// <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>
424 pub fn get_content_type(&self) -> &::std::option::Option<::std::string::String> {
425 self.inner.get_content_type()
426 }
427 /// <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>
428 /// <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>
429 /// <ul>
430 /// <li>
431 /// <p><code>CRC32</code></p></li>
432 /// <li>
433 /// <p><code>CRC32C</code></p></li>
434 /// <li>
435 /// <p><code>CRC64NVME</code></p></li>
436 /// <li>
437 /// <p><code>SHA1</code></p></li>
438 /// <li>
439 /// <p><code>SHA256</code></p></li>
440 /// </ul>
441 /// <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>
442 /// <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>
443 /// <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>
444 /// </note>
445 /// <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>
446 pub fn checksum_algorithm(mut self, input: crate::types::ChecksumAlgorithm) -> Self {
447 self.inner = self.inner.checksum_algorithm(input);
448 self
449 }
450 /// <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>
451 /// <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>
452 /// <ul>
453 /// <li>
454 /// <p><code>CRC32</code></p></li>
455 /// <li>
456 /// <p><code>CRC32C</code></p></li>
457 /// <li>
458 /// <p><code>CRC64NVME</code></p></li>
459 /// <li>
460 /// <p><code>SHA1</code></p></li>
461 /// <li>
462 /// <p><code>SHA256</code></p></li>
463 /// </ul>
464 /// <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>
465 /// <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>
466 /// <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>
467 /// </note>
468 /// <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>
469 pub fn set_checksum_algorithm(mut self, input: ::std::option::Option<crate::types::ChecksumAlgorithm>) -> Self {
470 self.inner = self.inner.set_checksum_algorithm(input);
471 self
472 }
473 /// <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>
474 /// <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>
475 /// <ul>
476 /// <li>
477 /// <p><code>CRC32</code></p></li>
478 /// <li>
479 /// <p><code>CRC32C</code></p></li>
480 /// <li>
481 /// <p><code>CRC64NVME</code></p></li>
482 /// <li>
483 /// <p><code>SHA1</code></p></li>
484 /// <li>
485 /// <p><code>SHA256</code></p></li>
486 /// </ul>
487 /// <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>
488 /// <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>
489 /// <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>
490 /// </note>
491 /// <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>
492 pub fn get_checksum_algorithm(&self) -> &::std::option::Option<crate::types::ChecksumAlgorithm> {
493 self.inner.get_checksum_algorithm()
494 }
495 /// <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>
496 pub fn checksum_crc32(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
497 self.inner = self.inner.checksum_crc32(input.into());
498 self
499 }
500 /// <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>
501 pub fn set_checksum_crc32(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
502 self.inner = self.inner.set_checksum_crc32(input);
503 self
504 }
505 /// <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>
506 pub fn get_checksum_crc32(&self) -> &::std::option::Option<::std::string::String> {
507 self.inner.get_checksum_crc32()
508 }
509 /// <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>
510 pub fn checksum_crc32_c(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
511 self.inner = self.inner.checksum_crc32_c(input.into());
512 self
513 }
514 /// <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>
515 pub fn set_checksum_crc32_c(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
516 self.inner = self.inner.set_checksum_crc32_c(input);
517 self
518 }
519 /// <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>
520 pub fn get_checksum_crc32_c(&self) -> &::std::option::Option<::std::string::String> {
521 self.inner.get_checksum_crc32_c()
522 }
523 /// <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>
524 pub fn checksum_crc64_nvme(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
525 self.inner = self.inner.checksum_crc64_nvme(input.into());
526 self
527 }
528 /// <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>
529 pub fn set_checksum_crc64_nvme(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
530 self.inner = self.inner.set_checksum_crc64_nvme(input);
531 self
532 }
533 /// <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>
534 pub fn get_checksum_crc64_nvme(&self) -> &::std::option::Option<::std::string::String> {
535 self.inner.get_checksum_crc64_nvme()
536 }
537 /// <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>
538 pub fn checksum_sha1(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
539 self.inner = self.inner.checksum_sha1(input.into());
540 self
541 }
542 /// <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>
543 pub fn set_checksum_sha1(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
544 self.inner = self.inner.set_checksum_sha1(input);
545 self
546 }
547 /// <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>
548 pub fn get_checksum_sha1(&self) -> &::std::option::Option<::std::string::String> {
549 self.inner.get_checksum_sha1()
550 }
551 /// <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>
552 pub fn checksum_sha256(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
553 self.inner = self.inner.checksum_sha256(input.into());
554 self
555 }
556 /// <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>
557 pub fn set_checksum_sha256(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
558 self.inner = self.inner.set_checksum_sha256(input);
559 self
560 }
561 /// <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>
562 pub fn get_checksum_sha256(&self) -> &::std::option::Option<::std::string::String> {
563 self.inner.get_checksum_sha256()
564 }
565 /// <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>
566 pub fn expires(mut self, input: ::aws_smithy_types::DateTime) -> Self {
567 self.inner = self.inner.expires(input);
568 self
569 }
570 /// <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>
571 pub fn set_expires(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
572 self.inner = self.inner.set_expires(input);
573 self
574 }
575 /// <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>
576 pub fn get_expires(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
577 self.inner.get_expires()
578 }
579 /// <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>
580 /// <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>
581 /// <p>Expects the ETag value as a string.</p>
582 /// <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>
583 pub fn if_match(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
584 self.inner = self.inner.if_match(input.into());
585 self
586 }
587 /// <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>
588 /// <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>
589 /// <p>Expects the ETag value as a string.</p>
590 /// <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>
591 pub fn set_if_match(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
592 self.inner = self.inner.set_if_match(input);
593 self
594 }
595 /// <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>
596 /// <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>
597 /// <p>Expects the ETag value as a string.</p>
598 /// <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>
599 pub fn get_if_match(&self) -> &::std::option::Option<::std::string::String> {
600 self.inner.get_if_match()
601 }
602 /// <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>
603 /// <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>
604 /// <p>Expects the '*' (asterisk) character.</p>
605 /// <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>
606 pub fn if_none_match(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
607 self.inner = self.inner.if_none_match(input.into());
608 self
609 }
610 /// <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>
611 /// <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>
612 /// <p>Expects the '*' (asterisk) character.</p>
613 /// <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>
614 pub fn set_if_none_match(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
615 self.inner = self.inner.set_if_none_match(input);
616 self
617 }
618 /// <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>
619 /// <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>
620 /// <p>Expects the '*' (asterisk) character.</p>
621 /// <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>
622 pub fn get_if_none_match(&self) -> &::std::option::Option<::std::string::String> {
623 self.inner.get_if_none_match()
624 }
625 /// <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.</p><note>
626 /// <ul>
627 /// <li>
628 /// <p>This functionality is not supported for directory buckets.</p></li>
629 /// <li>
630 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
631 /// </ul>
632 /// </note>
633 pub fn grant_full_control(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
634 self.inner = self.inner.grant_full_control(input.into());
635 self
636 }
637 /// <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.</p><note>
638 /// <ul>
639 /// <li>
640 /// <p>This functionality is not supported for directory buckets.</p></li>
641 /// <li>
642 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
643 /// </ul>
644 /// </note>
645 pub fn set_grant_full_control(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
646 self.inner = self.inner.set_grant_full_control(input);
647 self
648 }
649 /// <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.</p><note>
650 /// <ul>
651 /// <li>
652 /// <p>This functionality is not supported for directory buckets.</p></li>
653 /// <li>
654 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
655 /// </ul>
656 /// </note>
657 pub fn get_grant_full_control(&self) -> &::std::option::Option<::std::string::String> {
658 self.inner.get_grant_full_control()
659 }
660 /// <p>Allows grantee to read the object data and its metadata.</p><note>
661 /// <ul>
662 /// <li>
663 /// <p>This functionality is not supported for directory buckets.</p></li>
664 /// <li>
665 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
666 /// </ul>
667 /// </note>
668 pub fn grant_read(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
669 self.inner = self.inner.grant_read(input.into());
670 self
671 }
672 /// <p>Allows grantee to read the object data and its metadata.</p><note>
673 /// <ul>
674 /// <li>
675 /// <p>This functionality is not supported for directory buckets.</p></li>
676 /// <li>
677 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
678 /// </ul>
679 /// </note>
680 pub fn set_grant_read(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
681 self.inner = self.inner.set_grant_read(input);
682 self
683 }
684 /// <p>Allows grantee to read the object data and its metadata.</p><note>
685 /// <ul>
686 /// <li>
687 /// <p>This functionality is not supported for directory buckets.</p></li>
688 /// <li>
689 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
690 /// </ul>
691 /// </note>
692 pub fn get_grant_read(&self) -> &::std::option::Option<::std::string::String> {
693 self.inner.get_grant_read()
694 }
695 /// <p>Allows grantee to read the object ACL.</p><note>
696 /// <ul>
697 /// <li>
698 /// <p>This functionality is not supported for directory buckets.</p></li>
699 /// <li>
700 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
701 /// </ul>
702 /// </note>
703 pub fn grant_read_acp(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
704 self.inner = self.inner.grant_read_acp(input.into());
705 self
706 }
707 /// <p>Allows grantee to read the object ACL.</p><note>
708 /// <ul>
709 /// <li>
710 /// <p>This functionality is not supported for directory buckets.</p></li>
711 /// <li>
712 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
713 /// </ul>
714 /// </note>
715 pub fn set_grant_read_acp(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
716 self.inner = self.inner.set_grant_read_acp(input);
717 self
718 }
719 /// <p>Allows grantee to read the object ACL.</p><note>
720 /// <ul>
721 /// <li>
722 /// <p>This functionality is not supported for directory buckets.</p></li>
723 /// <li>
724 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
725 /// </ul>
726 /// </note>
727 pub fn get_grant_read_acp(&self) -> &::std::option::Option<::std::string::String> {
728 self.inner.get_grant_read_acp()
729 }
730 /// <p>Allows grantee to write the ACL for the applicable object.</p><note>
731 /// <ul>
732 /// <li>
733 /// <p>This functionality is not supported for directory buckets.</p></li>
734 /// <li>
735 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
736 /// </ul>
737 /// </note>
738 pub fn grant_write_acp(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
739 self.inner = self.inner.grant_write_acp(input.into());
740 self
741 }
742 /// <p>Allows grantee to write the ACL for the applicable object.</p><note>
743 /// <ul>
744 /// <li>
745 /// <p>This functionality is not supported for directory buckets.</p></li>
746 /// <li>
747 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
748 /// </ul>
749 /// </note>
750 pub fn set_grant_write_acp(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
751 self.inner = self.inner.set_grant_write_acp(input);
752 self
753 }
754 /// <p>Allows grantee to write the ACL for the applicable object.</p><note>
755 /// <ul>
756 /// <li>
757 /// <p>This functionality is not supported for directory buckets.</p></li>
758 /// <li>
759 /// <p>This functionality is not supported for Amazon S3 on Outposts.</p></li>
760 /// </ul>
761 /// </note>
762 pub fn get_grant_write_acp(&self) -> &::std::option::Option<::std::string::String> {
763 self.inner.get_grant_write_acp()
764 }
765 /// <p>Object key for which the PUT action was initiated.</p>
766 pub fn key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
767 self.inner = self.inner.key(input.into());
768 self
769 }
770 /// <p>Object key for which the PUT action was initiated.</p>
771 pub fn set_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
772 self.inner = self.inner.set_key(input);
773 self
774 }
775 /// <p>Object key for which the PUT action was initiated.</p>
776 pub fn get_key(&self) -> &::std::option::Option<::std::string::String> {
777 self.inner.get_key()
778 }
779 /// <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>
780 /// <p>This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.</p>
781 /// </note>
782 pub fn write_offset_bytes(mut self, input: i64) -> Self {
783 self.inner = self.inner.write_offset_bytes(input);
784 self
785 }
786 /// <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>
787 /// <p>This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.</p>
788 /// </note>
789 pub fn set_write_offset_bytes(mut self, input: ::std::option::Option<i64>) -> Self {
790 self.inner = self.inner.set_write_offset_bytes(input);
791 self
792 }
793 /// <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>
794 /// <p>This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.</p>
795 /// </note>
796 pub fn get_write_offset_bytes(&self) -> &::std::option::Option<i64> {
797 self.inner.get_write_offset_bytes()
798 }
799 ///
800 /// Adds a key-value pair to `Metadata`.
801 ///
802 /// To override the contents of this collection use [`set_metadata`](Self::set_metadata).
803 ///
804 /// <p>A map of metadata to store with the object in S3.</p>
805 pub fn metadata(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
806 self.inner = self.inner.metadata(k.into(), v.into());
807 self
808 }
809 /// <p>A map of metadata to store with the object in S3.</p>
810 pub fn set_metadata(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
811 self.inner = self.inner.set_metadata(input);
812 self
813 }
814 /// <p>A map of metadata to store with the object in S3.</p>
815 pub fn get_metadata(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
816 self.inner.get_metadata()
817 }
818 /// <p>The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example, <code>AES256</code>, <code>aws:kms</code>, <code>aws:kms:dsse</code>).</p>
819 /// <ul>
820 /// <li>
821 /// <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>
822 /// <li>
823 /// <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>
824 /// <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>
825 /// <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>
826 /// </note></li>
827 /// </ul>
828 pub fn server_side_encryption(mut self, input: crate::types::ServerSideEncryption) -> Self {
829 self.inner = self.inner.server_side_encryption(input);
830 self
831 }
832 /// <p>The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example, <code>AES256</code>, <code>aws:kms</code>, <code>aws:kms:dsse</code>).</p>
833 /// <ul>
834 /// <li>
835 /// <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>
836 /// <li>
837 /// <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>
838 /// <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>
839 /// <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>
840 /// </note></li>
841 /// </ul>
842 pub fn set_server_side_encryption(mut self, input: ::std::option::Option<crate::types::ServerSideEncryption>) -> Self {
843 self.inner = self.inner.set_server_side_encryption(input);
844 self
845 }
846 /// <p>The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example, <code>AES256</code>, <code>aws:kms</code>, <code>aws:kms:dsse</code>).</p>
847 /// <ul>
848 /// <li>
849 /// <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>
850 /// <li>
851 /// <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>
852 /// <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>
853 /// <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>
854 /// </note></li>
855 /// </ul>
856 pub fn get_server_side_encryption(&self) -> &::std::option::Option<crate::types::ServerSideEncryption> {
857 self.inner.get_server_side_encryption()
858 }
859 /// <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>
860 /// <ul>
861 /// <li>
862 /// <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>
863 /// <li>
864 /// <p>Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.</p></li>
865 /// </ul>
866 /// </note>
867 pub fn storage_class(mut self, input: crate::types::StorageClass) -> Self {
868 self.inner = self.inner.storage_class(input);
869 self
870 }
871 /// <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>
872 /// <ul>
873 /// <li>
874 /// <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>
875 /// <li>
876 /// <p>Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.</p></li>
877 /// </ul>
878 /// </note>
879 pub fn set_storage_class(mut self, input: ::std::option::Option<crate::types::StorageClass>) -> Self {
880 self.inner = self.inner.set_storage_class(input);
881 self
882 }
883 /// <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>
884 /// <ul>
885 /// <li>
886 /// <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>
887 /// <li>
888 /// <p>Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.</p></li>
889 /// </ul>
890 /// </note>
891 pub fn get_storage_class(&self) -> &::std::option::Option<crate::types::StorageClass> {
892 self.inner.get_storage_class()
893 }
894 /// <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>
895 /// <p>In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:</p>
896 /// <p><code>x-amz-website-redirect-location: /anotherPage.html</code></p>
897 /// <p>In the following example, the request header sets the object redirect to another website:</p>
898 /// <p><code>x-amz-website-redirect-location: http://www.example.com/</code></p>
899 /// <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>
900 /// <p>This functionality is not supported for directory buckets.</p>
901 /// </note>
902 pub fn website_redirect_location(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
903 self.inner = self.inner.website_redirect_location(input.into());
904 self
905 }
906 /// <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>
907 /// <p>In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:</p>
908 /// <p><code>x-amz-website-redirect-location: /anotherPage.html</code></p>
909 /// <p>In the following example, the request header sets the object redirect to another website:</p>
910 /// <p><code>x-amz-website-redirect-location: http://www.example.com/</code></p>
911 /// <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>
912 /// <p>This functionality is not supported for directory buckets.</p>
913 /// </note>
914 pub fn set_website_redirect_location(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
915 self.inner = self.inner.set_website_redirect_location(input);
916 self
917 }
918 /// <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>
919 /// <p>In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:</p>
920 /// <p><code>x-amz-website-redirect-location: /anotherPage.html</code></p>
921 /// <p>In the following example, the request header sets the object redirect to another website:</p>
922 /// <p><code>x-amz-website-redirect-location: http://www.example.com/</code></p>
923 /// <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>
924 /// <p>This functionality is not supported for directory buckets.</p>
925 /// </note>
926 pub fn get_website_redirect_location(&self) -> &::std::option::Option<::std::string::String> {
927 self.inner.get_website_redirect_location()
928 }
929 /// <p>Specifies the algorithm to use when encrypting the object (for example, <code>AES256</code>).</p><note>
930 /// <p>This functionality is not supported for directory buckets.</p>
931 /// </note>
932 pub fn sse_customer_algorithm(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
933 self.inner = self.inner.sse_customer_algorithm(input.into());
934 self
935 }
936 /// <p>Specifies the algorithm to use when encrypting the object (for example, <code>AES256</code>).</p><note>
937 /// <p>This functionality is not supported for directory buckets.</p>
938 /// </note>
939 pub fn set_sse_customer_algorithm(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
940 self.inner = self.inner.set_sse_customer_algorithm(input);
941 self
942 }
943 /// <p>Specifies the algorithm to use when encrypting the object (for example, <code>AES256</code>).</p><note>
944 /// <p>This functionality is not supported for directory buckets.</p>
945 /// </note>
946 pub fn get_sse_customer_algorithm(&self) -> &::std::option::Option<::std::string::String> {
947 self.inner.get_sse_customer_algorithm()
948 }
949 /// <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>
950 /// <p>This functionality is not supported for directory buckets.</p>
951 /// </note>
952 pub fn sse_customer_key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
953 self.inner = self.inner.sse_customer_key(input.into());
954 self
955 }
956 /// <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>
957 /// <p>This functionality is not supported for directory buckets.</p>
958 /// </note>
959 pub fn set_sse_customer_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
960 self.inner = self.inner.set_sse_customer_key(input);
961 self
962 }
963 /// <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>
964 /// <p>This functionality is not supported for directory buckets.</p>
965 /// </note>
966 pub fn get_sse_customer_key(&self) -> &::std::option::Option<::std::string::String> {
967 self.inner.get_sse_customer_key()
968 }
969 /// <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>
970 /// <p>This functionality is not supported for directory buckets.</p>
971 /// </note>
972 pub fn sse_customer_key_md5(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
973 self.inner = self.inner.sse_customer_key_md5(input.into());
974 self
975 }
976 /// <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>
977 /// <p>This functionality is not supported for directory buckets.</p>
978 /// </note>
979 pub fn set_sse_customer_key_md5(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
980 self.inner = self.inner.set_sse_customer_key_md5(input);
981 self
982 }
983 /// <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>
984 /// <p>This functionality is not supported for directory buckets.</p>
985 /// </note>
986 pub fn get_sse_customer_key_md5(&self) -> &::std::option::Option<::std::string::String> {
987 self.inner.get_sse_customer_key_md5()
988 }
989 /// <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>
990 /// <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>
991 /// <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>
992 pub fn ssekms_key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
993 self.inner = self.inner.ssekms_key_id(input.into());
994 self
995 }
996 /// <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>
997 /// <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>
998 /// <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>
999 pub fn set_ssekms_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
1000 self.inner = self.inner.set_ssekms_key_id(input);
1001 self
1002 }
1003 /// <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>
1004 /// <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>
1005 /// <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>
1006 pub fn get_ssekms_key_id(&self) -> &::std::option::Option<::std::string::String> {
1007 self.inner.get_ssekms_key_id()
1008 }
1009 /// <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>
1010 /// <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>
1011 /// <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>
1012 pub fn ssekms_encryption_context(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
1013 self.inner = self.inner.ssekms_encryption_context(input.into());
1014 self
1015 }
1016 /// <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>
1017 /// <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>
1018 /// <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>
1019 pub fn set_ssekms_encryption_context(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
1020 self.inner = self.inner.set_ssekms_encryption_context(input);
1021 self
1022 }
1023 /// <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>
1024 /// <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>
1025 /// <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>
1026 pub fn get_ssekms_encryption_context(&self) -> &::std::option::Option<::std::string::String> {
1027 self.inner.get_ssekms_encryption_context()
1028 }
1029 /// <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>
1030 /// <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>
1031 /// <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>
1032 pub fn bucket_key_enabled(mut self, input: bool) -> Self {
1033 self.inner = self.inner.bucket_key_enabled(input);
1034 self
1035 }
1036 /// <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>
1037 /// <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>
1038 /// <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>
1039 pub fn set_bucket_key_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
1040 self.inner = self.inner.set_bucket_key_enabled(input);
1041 self
1042 }
1043 /// <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>
1044 /// <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>
1045 /// <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>
1046 pub fn get_bucket_key_enabled(&self) -> &::std::option::Option<bool> {
1047 self.inner.get_bucket_key_enabled()
1048 }
1049 /// <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>
1050 /// <p>This functionality is not supported for directory buckets.</p>
1051 /// </note>
1052 pub fn request_payer(mut self, input: crate::types::RequestPayer) -> Self {
1053 self.inner = self.inner.request_payer(input);
1054 self
1055 }
1056 /// <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>
1057 /// <p>This functionality is not supported for directory buckets.</p>
1058 /// </note>
1059 pub fn set_request_payer(mut self, input: ::std::option::Option<crate::types::RequestPayer>) -> Self {
1060 self.inner = self.inner.set_request_payer(input);
1061 self
1062 }
1063 /// <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>
1064 /// <p>This functionality is not supported for directory buckets.</p>
1065 /// </note>
1066 pub fn get_request_payer(&self) -> &::std::option::Option<crate::types::RequestPayer> {
1067 self.inner.get_request_payer()
1068 }
1069 /// <p>The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")</p><note>
1070 /// <p>This functionality is not supported for directory buckets.</p>
1071 /// </note>
1072 pub fn tagging(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
1073 self.inner = self.inner.tagging(input.into());
1074 self
1075 }
1076 /// <p>The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")</p><note>
1077 /// <p>This functionality is not supported for directory buckets.</p>
1078 /// </note>
1079 pub fn set_tagging(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
1080 self.inner = self.inner.set_tagging(input);
1081 self
1082 }
1083 /// <p>The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")</p><note>
1084 /// <p>This functionality is not supported for directory buckets.</p>
1085 /// </note>
1086 pub fn get_tagging(&self) -> &::std::option::Option<::std::string::String> {
1087 self.inner.get_tagging()
1088 }
1089 /// <p>The Object Lock mode that you want to apply to this object.</p><note>
1090 /// <p>This functionality is not supported for directory buckets.</p>
1091 /// </note>
1092 pub fn object_lock_mode(mut self, input: crate::types::ObjectLockMode) -> Self {
1093 self.inner = self.inner.object_lock_mode(input);
1094 self
1095 }
1096 /// <p>The Object Lock mode that you want to apply to this object.</p><note>
1097 /// <p>This functionality is not supported for directory buckets.</p>
1098 /// </note>
1099 pub fn set_object_lock_mode(mut self, input: ::std::option::Option<crate::types::ObjectLockMode>) -> Self {
1100 self.inner = self.inner.set_object_lock_mode(input);
1101 self
1102 }
1103 /// <p>The Object Lock mode that you want to apply to this object.</p><note>
1104 /// <p>This functionality is not supported for directory buckets.</p>
1105 /// </note>
1106 pub fn get_object_lock_mode(&self) -> &::std::option::Option<crate::types::ObjectLockMode> {
1107 self.inner.get_object_lock_mode()
1108 }
1109 /// <p>The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.</p><note>
1110 /// <p>This functionality is not supported for directory buckets.</p>
1111 /// </note>
1112 pub fn object_lock_retain_until_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
1113 self.inner = self.inner.object_lock_retain_until_date(input);
1114 self
1115 }
1116 /// <p>The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.</p><note>
1117 /// <p>This functionality is not supported for directory buckets.</p>
1118 /// </note>
1119 pub fn set_object_lock_retain_until_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
1120 self.inner = self.inner.set_object_lock_retain_until_date(input);
1121 self
1122 }
1123 /// <p>The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.</p><note>
1124 /// <p>This functionality is not supported for directory buckets.</p>
1125 /// </note>
1126 pub fn get_object_lock_retain_until_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
1127 self.inner.get_object_lock_retain_until_date()
1128 }
1129 /// <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>
1130 /// <p>This functionality is not supported for directory buckets.</p>
1131 /// </note>
1132 pub fn object_lock_legal_hold_status(mut self, input: crate::types::ObjectLockLegalHoldStatus) -> Self {
1133 self.inner = self.inner.object_lock_legal_hold_status(input);
1134 self
1135 }
1136 /// <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>
1137 /// <p>This functionality is not supported for directory buckets.</p>
1138 /// </note>
1139 pub fn set_object_lock_legal_hold_status(mut self, input: ::std::option::Option<crate::types::ObjectLockLegalHoldStatus>) -> Self {
1140 self.inner = self.inner.set_object_lock_legal_hold_status(input);
1141 self
1142 }
1143 /// <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>
1144 /// <p>This functionality is not supported for directory buckets.</p>
1145 /// </note>
1146 pub fn get_object_lock_legal_hold_status(&self) -> &::std::option::Option<crate::types::ObjectLockLegalHoldStatus> {
1147 self.inner.get_object_lock_legal_hold_status()
1148 }
1149 /// <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>
1150 pub fn expected_bucket_owner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
1151 self.inner = self.inner.expected_bucket_owner(input.into());
1152 self
1153 }
1154 /// <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>
1155 pub fn set_expected_bucket_owner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
1156 self.inner = self.inner.set_expected_bucket_owner(input);
1157 self
1158 }
1159 /// <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>
1160 pub fn get_expected_bucket_owner(&self) -> &::std::option::Option<::std::string::String> {
1161 self.inner.get_expected_bucket_owner()
1162 }
1163}
1164
1165impl crate::client::customize::internal::CustomizablePresigned<crate::operation::put_object::PutObjectError> for PutObjectFluentBuilder {
1166 fn presign(
1167 self,
1168 config_override: crate::config::Builder,
1169 presigning_config: crate::presigning::PresigningConfig,
1170 ) -> crate::client::customize::internal::BoxFuture<
1171 crate::client::customize::internal::SendResult<crate::presigning::PresignedRequest, crate::operation::put_object::PutObjectError>,
1172 > {
1173 ::std::boxed::Box::pin(async move { self.config_override(config_override).presigned(presigning_config).await })
1174 }
1175}