aws_sdk_s3/client/
put_object_legal_hold.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`PutObjectLegalHold`](crate::operation::put_object_legal_hold::builders::PutObjectLegalHoldFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`bucket(impl Into<String>)`](crate::operation::put_object_legal_hold::builders::PutObjectLegalHoldFluentBuilder::bucket) / [`set_bucket(Option<String>)`](crate::operation::put_object_legal_hold::builders::PutObjectLegalHoldFluentBuilder::set_bucket):<br>required: **true**<br><p>The bucket name containing the object that you want to place a legal hold on.</p> <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><br>
    ///   - [`key(impl Into<String>)`](crate::operation::put_object_legal_hold::builders::PutObjectLegalHoldFluentBuilder::key) / [`set_key(Option<String>)`](crate::operation::put_object_legal_hold::builders::PutObjectLegalHoldFluentBuilder::set_key):<br>required: **true**<br><p>The key name for the object that you want to place a legal hold on.</p><br>
    ///   - [`legal_hold(ObjectLockLegalHold)`](crate::operation::put_object_legal_hold::builders::PutObjectLegalHoldFluentBuilder::legal_hold) / [`set_legal_hold(Option<ObjectLockLegalHold>)`](crate::operation::put_object_legal_hold::builders::PutObjectLegalHoldFluentBuilder::set_legal_hold):<br>required: **false**<br><p>Container element for the legal hold configuration you want to apply to the specified object.</p><br>
    ///   - [`request_payer(RequestPayer)`](crate::operation::put_object_legal_hold::builders::PutObjectLegalHoldFluentBuilder::request_payer) / [`set_request_payer(Option<RequestPayer>)`](crate::operation::put_object_legal_hold::builders::PutObjectLegalHoldFluentBuilder::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 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>  <p>This functionality is not supported for directory buckets.</p> </note><br>
    ///   - [`version_id(impl Into<String>)`](crate::operation::put_object_legal_hold::builders::PutObjectLegalHoldFluentBuilder::version_id) / [`set_version_id(Option<String>)`](crate::operation::put_object_legal_hold::builders::PutObjectLegalHoldFluentBuilder::set_version_id):<br>required: **false**<br><p>The version ID of the object that you want to place a legal hold on.</p><br>
    ///   - [`content_md5(impl Into<String>)`](crate::operation::put_object_legal_hold::builders::PutObjectLegalHoldFluentBuilder::content_md5) / [`set_content_md5(Option<String>)`](crate::operation::put_object_legal_hold::builders::PutObjectLegalHoldFluentBuilder::set_content_md5):<br>required: **false**<br><p>The MD5 hash for the request body.</p> <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p><br>
    ///   - [`checksum_algorithm(ChecksumAlgorithm)`](crate::operation::put_object_legal_hold::builders::PutObjectLegalHoldFluentBuilder::checksum_algorithm) / [`set_checksum_algorithm(Option<ChecksumAlgorithm>)`](crate::operation::put_object_legal_hold::builders::PutObjectLegalHoldFluentBuilder::set_checksum_algorithm):<br>required: **false**<br><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</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>
    ///   - [`expected_bucket_owner(impl Into<String>)`](crate::operation::put_object_legal_hold::builders::PutObjectLegalHoldFluentBuilder::expected_bucket_owner) / [`set_expected_bucket_owner(Option<String>)`](crate::operation::put_object_legal_hold::builders::PutObjectLegalHoldFluentBuilder::set_expected_bucket_owner):<br>required: **false**<br><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><br>
    /// - On success, responds with [`PutObjectLegalHoldOutput`](crate::operation::put_object_legal_hold::PutObjectLegalHoldOutput) with field(s):
    ///   - [`request_charged(Option<RequestCharged>)`](crate::operation::put_object_legal_hold::PutObjectLegalHoldOutput::request_charged): <p>If present, indicates that the requester was successfully charged for the request.</p><note>  <p>This functionality is not supported for directory buckets.</p> </note>
    /// - On failure, responds with [`SdkError<PutObjectLegalHoldError>`](crate::operation::put_object_legal_hold::PutObjectLegalHoldError)
    pub fn put_object_legal_hold(&self) -> crate::operation::put_object_legal_hold::builders::PutObjectLegalHoldFluentBuilder {
        crate::operation::put_object_legal_hold::builders::PutObjectLegalHoldFluentBuilder::new(self.handle.clone())
    }
}