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