aws_sdk_s3/client/
update_object_encryption.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`UpdateObjectEncryption`](crate::operation::update_object_encryption::builders::UpdateObjectEncryptionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`bucket(impl Into<String>)`](crate::operation::update_object_encryption::builders::UpdateObjectEncryptionFluentBuilder::bucket) / [`set_bucket(Option<String>)`](crate::operation::update_object_encryption::builders::UpdateObjectEncryptionFluentBuilder::set_bucket):<br>required: **true**<br><p>The name of the general purpose bucket that contains the specified object key name.</p> <p>When you use this operation with an access point attached to a general purpose bucket, you must either provide the alias of the access point in place of the bucket name or you must specify the access point Amazon Resource Name (ARN). When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com</code>. When using this operation 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/access-points-naming.html"> Referencing access points</a> in the <i>Amazon S3 User Guide</i>.</p><br>
7    ///   - [`key(impl Into<String>)`](crate::operation::update_object_encryption::builders::UpdateObjectEncryptionFluentBuilder::key) / [`set_key(Option<String>)`](crate::operation::update_object_encryption::builders::UpdateObjectEncryptionFluentBuilder::set_key):<br>required: **true**<br><p>The key name of the object that you want to update the server-side encryption type for.</p><br>
8    ///   - [`version_id(impl Into<String>)`](crate::operation::update_object_encryption::builders::UpdateObjectEncryptionFluentBuilder::version_id) / [`set_version_id(Option<String>)`](crate::operation::update_object_encryption::builders::UpdateObjectEncryptionFluentBuilder::set_version_id):<br>required: **false**<br><p>The version ID of the object that you want to update the server-side encryption type for.</p><br>
9    ///   - [`object_encryption(ObjectEncryption)`](crate::operation::update_object_encryption::builders::UpdateObjectEncryptionFluentBuilder::object_encryption) / [`set_object_encryption(Option<ObjectEncryption>)`](crate::operation::update_object_encryption::builders::UpdateObjectEncryptionFluentBuilder::set_object_encryption):<br>required: **true**<br><p>The updated server-side encryption type for this object. The <code>UpdateObjectEncryption</code> operation supports the SSE-S3 and SSE-KMS encryption types.</p> <p>Valid Values: <code>SSES3</code> | <code>SSEKMS</code></p><br>
10    ///   - [`request_payer(RequestPayer)`](crate::operation::update_object_encryption::builders::UpdateObjectEncryptionFluentBuilder::request_payer) / [`set_request_payer(Option<RequestPayer>)`](crate::operation::update_object_encryption::builders::UpdateObjectEncryptionFluentBuilder::set_request_payer):<br>required: **false**<br><p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for the corresponding charges. For information about downloading objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p><note>  <p>This functionality is not supported for directory buckets.</p> </note><br>
11    ///   - [`expected_bucket_owner(impl Into<String>)`](crate::operation::update_object_encryption::builders::UpdateObjectEncryptionFluentBuilder::expected_bucket_owner) / [`set_expected_bucket_owner(Option<String>)`](crate::operation::update_object_encryption::builders::UpdateObjectEncryptionFluentBuilder::set_expected_bucket_owner):<br>required: **false**<br><p>The account ID of the expected bucket owner. If the account ID that you provide doesn't match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p><br>
12    ///   - [`content_md5(impl Into<String>)`](crate::operation::update_object_encryption::builders::UpdateObjectEncryptionFluentBuilder::content_md5) / [`set_content_md5(Option<String>)`](crate::operation::update_object_encryption::builders::UpdateObjectEncryptionFluentBuilder::set_content_md5):<br>required: **false**<br><p>The MD5 hash for the request body. For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p><br>
13    ///   - [`checksum_algorithm(ChecksumAlgorithm)`](crate::operation::update_object_encryption::builders::UpdateObjectEncryptionFluentBuilder::checksum_algorithm) / [`set_checksum_algorithm(Option<ChecksumAlgorithm>)`](crate::operation::update_object_encryption::builders::UpdateObjectEncryptionFluentBuilder::set_checksum_algorithm):<br>required: **false**<br><p>Indicates the algorithm used to create the checksum for the object when you use an Amazon Web Services SDK. This header doesn't 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</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>. 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> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p><br>
14    /// - On success, responds with [`UpdateObjectEncryptionOutput`](crate::operation::update_object_encryption::UpdateObjectEncryptionOutput) with field(s):
15    ///   - [`request_charged(Option<RequestCharged>)`](crate::operation::update_object_encryption::UpdateObjectEncryptionOutput::request_charged): <p>If present, indicates that the requester was successfully charged for the request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p><note>  <p>This functionality is not supported for directory buckets.</p> </note>
16    /// - On failure, responds with [`SdkError<UpdateObjectEncryptionError>`](crate::operation::update_object_encryption::UpdateObjectEncryptionError)
17    pub fn update_object_encryption(&self) -> crate::operation::update_object_encryption::builders::UpdateObjectEncryptionFluentBuilder {
18        crate::operation::update_object_encryption::builders::UpdateObjectEncryptionFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_s3/client/update_object_encryption.rs

aws_sdk_s3/client/
update_object_encryption.rs
