Struct PutObjectAnnotationFluentBuilder 

pub struct PutObjectAnnotationFluentBuilder { /* private fields */ }

Fluent builder constructing a request to PutObjectAnnotation.

Attaches an annotation to an Amazon S3 object. An annotation is a named payload of 1 byte to 1 MiB that you can associate with a specific object or object version. Each object can have up to 1,000 annotations.

For annotation naming rules and restrictions, see Annotation naming guidelines in the Amazon S3 User Guide.

Annotations inherit the encryption of their parent object. For objects without server-side encryption, annotations are encrypted with SSE-S3 (the default for new objects). Objects encrypted with SSE-C cannot have annotations.

To use this operation, you must have the s3:PutObjectAnnotation permission. If the bucket has Requester Pays enabled, you must include the x-amz-request-payer header.

Annotations are not supported by the following features: S3 Inventory Reports, API Gateway, S3 Storage Lens, Amazon S3 File Gateway, Amazon FSx, S3 on Outposts, and S3 Express One Zone (directory buckets).

The following operations are related to PutObjectAnnotation:

• GetObjectAnnotation

• ListObjectAnnotations

• DeleteObjectAnnotation

Implementations

impl PutObjectAnnotationFluentBuilder

pub fn as_input(&self) -> &PutObjectAnnotationInputBuilder

Access the PutObjectAnnotation as a reference.

pub async fn send( self, ) -> Result<PutObjectAnnotationOutput, SdkError<PutObjectAnnotationError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<PutObjectAnnotationOutput, PutObjectAnnotationError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn bucket(self, input: impl Into<String>) -> Self

The name of the bucket that contains the object.

pub fn set_bucket(self, input: Option<String>) -> Self

The name of the bucket that contains the object.

pub fn get_bucket(&self) -> &Option<String>

The name of the bucket that contains the object.

pub fn key(self, input: impl Into<String>) -> Self

The object key.

pub fn set_key(self, input: Option<String>) -> Self

The object key.

pub fn get_key(&self) -> &Option<String>

The object key.

pub fn version_id(self, input: impl Into<String>) -> Self

The version ID of the object to attach the annotation to.

pub fn set_version_id(self, input: Option<String>) -> Self

The version ID of the object to attach the annotation to.

pub fn get_version_id(&self) -> &Option<String>

The version ID of the object to attach the annotation to.

pub fn annotation_name(self, input: impl Into<String>) -> Self

The name of the annotation.

Length Constraints: Minimum length of 1. Maximum length of 512 bytes.

pub fn set_annotation_name(self, input: Option<String>) -> Self

The name of the annotation.

Length Constraints: Minimum length of 1. Maximum length of 512 bytes.

pub fn get_annotation_name(&self) -> &Option<String>

The name of the annotation.

Length Constraints: Minimum length of 1. Maximum length of 512 bytes.

pub fn annotation_payload(self, input: ByteStream) -> Self

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.

pub fn set_annotation_payload(self, input: Option<ByteStream>) -> Self

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.

pub fn get_annotation_payload(&self) -> &Option<ByteStream>

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.

pub fn object_if_match(self, input: impl Into<String>) -> Self

If specified, the operation only succeeds if the object's ETag matches the provided value.

pub fn set_object_if_match(self, input: Option<String>) -> Self

If specified, the operation only succeeds if the object's ETag matches the provided value.

pub fn get_object_if_match(&self) -> &Option<String>

If specified, the operation only succeeds if the object's ETag matches the provided value.

pub fn checksum_algorithm(self, input: ChecksumAlgorithm) -> Self

The checksum algorithm to use. Supported values: CRC32, CRC32C, CRC64NVME, SHA1, SHA256, SHA512, MD5, XXHASH64, XXHASH3, XXHASH128.

pub fn set_checksum_algorithm(self, input: Option<ChecksumAlgorithm>) -> Self

The checksum algorithm to use. Supported values: CRC32, CRC32C, CRC64NVME, SHA1, SHA256, SHA512, MD5, XXHASH64, XXHASH3, XXHASH128.

pub fn get_checksum_algorithm(&self) -> &Option<ChecksumAlgorithm>

The checksum algorithm to use. Supported values: CRC32, CRC32C, CRC64NVME, SHA1, SHA256, SHA512, MD5, XXHASH64, XXHASH3, XXHASH128.

pub fn checksum_crc32(self, input: impl Into<String>) -> Self

Base64-encoded CRC32 checksum of the annotation payload.

pub fn set_checksum_crc32(self, input: Option<String>) -> Self

Base64-encoded CRC32 checksum of the annotation payload.

pub fn get_checksum_crc32(&self) -> &Option<String>

Base64-encoded CRC32 checksum of the annotation payload.

pub fn checksum_crc32_c(self, input: impl Into<String>) -> Self

Base64-encoded CRC32C checksum of the annotation payload.

pub fn set_checksum_crc32_c(self, input: Option<String>) -> Self

Base64-encoded CRC32C checksum of the annotation payload.

pub fn get_checksum_crc32_c(&self) -> &Option<String>

Base64-encoded CRC32C checksum of the annotation payload.

pub fn checksum_crc64_nvme(self, input: impl Into<String>) -> Self

Base64-encoded CRC64NVME checksum of the annotation payload.

pub fn set_checksum_crc64_nvme(self, input: Option<String>) -> Self

Base64-encoded CRC64NVME checksum of the annotation payload.

pub fn get_checksum_crc64_nvme(&self) -> &Option<String>

Base64-encoded CRC64NVME checksum of the annotation payload.

pub fn checksum_sha1(self, input: impl Into<String>) -> Self

Base64-encoded SHA1 checksum of the annotation payload.

pub fn set_checksum_sha1(self, input: Option<String>) -> Self

Base64-encoded SHA1 checksum of the annotation payload.

pub fn get_checksum_sha1(&self) -> &Option<String>

Base64-encoded SHA1 checksum of the annotation payload.

pub fn checksum_sha256(self, input: impl Into<String>) -> Self

Base64-encoded SHA256 checksum of the annotation payload.

pub fn set_checksum_sha256(self, input: Option<String>) -> Self

Base64-encoded SHA256 checksum of the annotation payload.

pub fn get_checksum_sha256(&self) -> &Option<String>

Base64-encoded SHA256 checksum of the annotation payload.

pub fn checksum_sha512(self, input: impl Into<String>) -> Self

Base64-encoded SHA512 checksum of the annotation payload.

pub fn set_checksum_sha512(self, input: Option<String>) -> Self

Base64-encoded SHA512 checksum of the annotation payload.

pub fn get_checksum_sha512(&self) -> &Option<String>

Base64-encoded SHA512 checksum of the annotation payload.

pub fn checksum_md5(self, input: impl Into<String>) -> Self

Base64-encoded MD5 checksum of the annotation payload.

pub fn set_checksum_md5(self, input: Option<String>) -> Self

Base64-encoded MD5 checksum of the annotation payload.

pub fn get_checksum_md5(&self) -> &Option<String>

Base64-encoded MD5 checksum of the annotation payload.

pub fn checksum_xxhash64(self, input: impl Into<String>) -> Self

Base64-encoded XXHASH64 checksum of the annotation payload.

pub fn set_checksum_xxhash64(self, input: Option<String>) -> Self

Base64-encoded XXHASH64 checksum of the annotation payload.

pub fn get_checksum_xxhash64(&self) -> &Option<String>

Base64-encoded XXHASH64 checksum of the annotation payload.

pub fn checksum_xxhash3(self, input: impl Into<String>) -> Self

Base64-encoded XXHASH3 checksum of the annotation payload.

pub fn set_checksum_xxhash3(self, input: Option<String>) -> Self

Base64-encoded XXHASH3 checksum of the annotation payload.

pub fn get_checksum_xxhash3(&self) -> &Option<String>

Base64-encoded XXHASH3 checksum of the annotation payload.

pub fn checksum_xxhash128(self, input: impl Into<String>) -> Self

Base64-encoded XXHASH128 checksum of the annotation payload.

pub fn set_checksum_xxhash128(self, input: Option<String>) -> Self

Base64-encoded XXHASH128 checksum of the annotation payload.

pub fn get_checksum_xxhash128(&self) -> &Option<String>

Base64-encoded XXHASH128 checksum of the annotation payload.

pub fn content_md5(self, input: impl Into<String>) -> Self

Base64-encoded MD5 digest of the message.

pub fn set_content_md5(self, input: Option<String>) -> Self

Base64-encoded MD5 digest of the message.

pub fn get_content_md5(&self) -> &Option<String>

Base64-encoded MD5 digest of the message.

pub fn request_payer(self, input: RequestPayer) -> Self

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 Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

pub fn set_request_payer(self, input: Option<RequestPayer>) -> Self

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 Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

pub fn get_request_payer(&self) -> &Option<RequestPayer>

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 Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

pub fn expected_bucket_owner(self, input: impl Into<String>) -> Self

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.

pub fn set_expected_bucket_owner(self, input: Option<String>) -> Self

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.

pub fn get_expected_bucket_owner(&self) -> &Option<String>

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.

Trait Implementations

impl Debug for PutObjectAnnotationFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.