aws_sdk_s3/client/
put_object_annotation.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 [`PutObjectAnnotation`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`bucket(impl Into<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::bucket) / [`set_bucket(Option<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::set_bucket):<br>required: **true**<br><p>The name of the bucket that contains the object.</p><br>
7    ///   - [`key(impl Into<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::key) / [`set_key(Option<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::set_key):<br>required: **true**<br><p>The object key.</p><br>
8    ///   - [`version_id(impl Into<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::version_id) / [`set_version_id(Option<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::set_version_id):<br>required: **false**<br><p>The version ID of the object to attach the annotation to.</p><br>
9    ///   - [`annotation_name(impl Into<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::annotation_name) / [`set_annotation_name(Option<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::set_annotation_name):<br>required: **true**<br><p>The name of the annotation.</p> <p>Length Constraints: Minimum length of 1. Maximum length of 512 bytes.</p><br>
10    ///   - [`annotation_payload(ByteStream)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::annotation_payload) / [`set_annotation_payload(ByteStream)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::set_annotation_payload):<br>required: **true**<br><p>The annotation payload. Must be between 1 byte and 1 MiB in size, and must be valid UTF-8 encoded text. If the payload contains invalid UTF-8 bytes, the request fails with HTTP 415 (Unsupported Media Type). To store binary data, encode the payload using Base64 before uploading.</p><br>
11    ///   - [`object_if_match(impl Into<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::object_if_match) / [`set_object_if_match(Option<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::set_object_if_match):<br>required: **false**<br><p>If specified, the operation only succeeds if the object's ETag matches the provided value.</p><br>
12    ///   - [`checksum_algorithm(ChecksumAlgorithm)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::checksum_algorithm) / [`set_checksum_algorithm(Option<ChecksumAlgorithm>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::set_checksum_algorithm):<br>required: **false**<br><p>The checksum algorithm to use. Supported values: <code>CRC32</code>, <code>CRC32C</code>, <code>CRC64NVME</code>, <code>SHA1</code>, <code>SHA256</code>, <code>SHA512</code>, <code>MD5</code>, <code>XXHASH64</code>, <code>XXHASH3</code>, <code>XXHASH128</code>.</p><br>
13    ///   - [`checksum_crc32(impl Into<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::checksum_crc32) / [`set_checksum_crc32(Option<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::set_checksum_crc32):<br>required: **false**<br><p>Base64-encoded CRC32 checksum of the annotation payload.</p><br>
14    ///   - [`checksum_crc32_c(impl Into<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::checksum_crc32_c) / [`set_checksum_crc32_c(Option<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::set_checksum_crc32_c):<br>required: **false**<br><p>Base64-encoded CRC32C checksum of the annotation payload.</p><br>
15    ///   - [`checksum_crc64_nvme(impl Into<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::checksum_crc64_nvme) / [`set_checksum_crc64_nvme(Option<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::set_checksum_crc64_nvme):<br>required: **false**<br><p>Base64-encoded CRC64NVME checksum of the annotation payload.</p><br>
16    ///   - [`checksum_sha1(impl Into<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::checksum_sha1) / [`set_checksum_sha1(Option<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::set_checksum_sha1):<br>required: **false**<br><p>Base64-encoded SHA1 checksum of the annotation payload.</p><br>
17    ///   - [`checksum_sha256(impl Into<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::checksum_sha256) / [`set_checksum_sha256(Option<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::set_checksum_sha256):<br>required: **false**<br><p>Base64-encoded SHA256 checksum of the annotation payload.</p><br>
18    ///   - [`checksum_sha512(impl Into<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::checksum_sha512) / [`set_checksum_sha512(Option<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::set_checksum_sha512):<br>required: **false**<br><p>Base64-encoded SHA512 checksum of the annotation payload.</p><br>
19    ///   - [`checksum_md5(impl Into<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::checksum_md5) / [`set_checksum_md5(Option<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::set_checksum_md5):<br>required: **false**<br><p>Base64-encoded MD5 checksum of the annotation payload.</p><br>
20    ///   - [`checksum_xxhash64(impl Into<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::checksum_xxhash64) / [`set_checksum_xxhash64(Option<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::set_checksum_xxhash64):<br>required: **false**<br><p>Base64-encoded XXHASH64 checksum of the annotation payload.</p><br>
21    ///   - [`checksum_xxhash3(impl Into<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::checksum_xxhash3) / [`set_checksum_xxhash3(Option<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::set_checksum_xxhash3):<br>required: **false**<br><p>Base64-encoded XXHASH3 checksum of the annotation payload.</p><br>
22    ///   - [`checksum_xxhash128(impl Into<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::checksum_xxhash128) / [`set_checksum_xxhash128(Option<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::set_checksum_xxhash128):<br>required: **false**<br><p>Base64-encoded XXHASH128 checksum of the annotation payload.</p><br>
23    ///   - [`content_md5(impl Into<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::content_md5) / [`set_content_md5(Option<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::set_content_md5):<br>required: **false**<br><p>Base64-encoded MD5 digest of the message.</p><br>
24    ///   - [`request_payer(RequestPayer)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::request_payer) / [`set_request_payer(Option<RequestPayer>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::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>
25    ///   - [`expected_bucket_owner(impl Into<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::expected_bucket_owner) / [`set_expected_bucket_owner(Option<String>)`](crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::set_expected_bucket_owner):<br>required: **false**<br><p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with an HTTP 403 (Access Denied) error.</p><br>
26    /// - On success, responds with [`PutObjectAnnotationOutput`](crate::operation::put_object_annotation::PutObjectAnnotationOutput) with field(s):
27    ///   - [`key(Option<String>)`](crate::operation::put_object_annotation::PutObjectAnnotationOutput::key): <p>The object key.</p>
28    ///   - [`annotation_name(Option<String>)`](crate::operation::put_object_annotation::PutObjectAnnotationOutput::annotation_name): <p>The name of the annotation.</p>
29    ///   - [`object_version_id(Option<String>)`](crate::operation::put_object_annotation::PutObjectAnnotationOutput::object_version_id): <p>The version ID of the object that the annotation was attached to.</p>
30    ///   - [`e_tag(Option<String>)`](crate::operation::put_object_annotation::PutObjectAnnotationOutput::e_tag): <p>The entity tag of the annotation.</p>
31    ///   - [`checksum_crc32(Option<String>)`](crate::operation::put_object_annotation::PutObjectAnnotationOutput::checksum_crc32): <p>The CRC32 checksum of the stored annotation.</p>
32    ///   - [`checksum_crc32_c(Option<String>)`](crate::operation::put_object_annotation::PutObjectAnnotationOutput::checksum_crc32_c): <p>The CRC32C checksum of the stored annotation.</p>
33    ///   - [`checksum_crc64_nvme(Option<String>)`](crate::operation::put_object_annotation::PutObjectAnnotationOutput::checksum_crc64_nvme): <p>The CRC64NVME checksum of the stored annotation.</p>
34    ///   - [`checksum_sha1(Option<String>)`](crate::operation::put_object_annotation::PutObjectAnnotationOutput::checksum_sha1): <p>The SHA1 checksum of the stored annotation.</p>
35    ///   - [`checksum_sha256(Option<String>)`](crate::operation::put_object_annotation::PutObjectAnnotationOutput::checksum_sha256): <p>The SHA256 checksum of the stored annotation.</p>
36    ///   - [`checksum_sha512(Option<String>)`](crate::operation::put_object_annotation::PutObjectAnnotationOutput::checksum_sha512): <p>The SHA512 checksum of the stored annotation.</p>
37    ///   - [`checksum_md5(Option<String>)`](crate::operation::put_object_annotation::PutObjectAnnotationOutput::checksum_md5): <p>The MD5 checksum of the stored annotation.</p>
38    ///   - [`checksum_xxhash64(Option<String>)`](crate::operation::put_object_annotation::PutObjectAnnotationOutput::checksum_xxhash64): <p>The XXHASH64 checksum of the stored annotation.</p>
39    ///   - [`checksum_xxhash3(Option<String>)`](crate::operation::put_object_annotation::PutObjectAnnotationOutput::checksum_xxhash3): <p>The XXHASH3 checksum of the stored annotation.</p>
40    ///   - [`checksum_xxhash128(Option<String>)`](crate::operation::put_object_annotation::PutObjectAnnotationOutput::checksum_xxhash128): <p>The XXHASH128 checksum of the stored annotation.</p>
41    ///   - [`checksum_type(Option<ChecksumType>)`](crate::operation::put_object_annotation::PutObjectAnnotationOutput::checksum_type): <p>The type of checksum used.</p>
42    ///   - [`server_side_encryption(Option<ServerSideEncryption>)`](crate::operation::put_object_annotation::PutObjectAnnotationOutput::server_side_encryption): <p>The server-side encryption algorithm used to encrypt the annotation.</p>
43    ///   - [`request_charged(Option<RequestCharged>)`](crate::operation::put_object_annotation::PutObjectAnnotationOutput::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>
44    /// - On failure, responds with [`SdkError<PutObjectAnnotationError>`](crate::operation::put_object_annotation::PutObjectAnnotationError)
45    pub fn put_object_annotation(&self) -> crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder {
46        crate::operation::put_object_annotation::builders::PutObjectAnnotationFluentBuilder::new(self.handle.clone())
47    }
48}
aws_sdk_s3/client/put_object_annotation.rs

aws_sdk_s3/client/
put_object_annotation.rs
