// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::put_object_annotation::_put_object_annotation_input::PutObjectAnnotationInputBuilder;
pub use crate::operation::put_object_annotation::_put_object_annotation_output::PutObjectAnnotationOutputBuilder;
impl crate::operation::put_object_annotation::builders::PutObjectAnnotationInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::put_object_annotation::PutObjectAnnotationOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::put_object_annotation::PutObjectAnnotationError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.put_object_annotation();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `PutObjectAnnotation`.
///
/// <p>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.</p>
/// <p>For annotation naming rules and restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/annotations-overview.html">Annotation naming guidelines</a> in the <i>Amazon S3 User Guide</i>.</p>
/// <p>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.</p>
/// <p>To use this operation, you must have the <code>s3:PutObjectAnnotation</code> permission. If the bucket has Requester Pays enabled, you must include the <code>x-amz-request-payer</code> header.</p><note>
/// <p>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).</p>
/// </note>
/// <p>The following operations are related to <code>PutObjectAnnotation</code>:</p>
/// <ul>
/// <li>
/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAnnotation.html">GetObjectAnnotation</a></p></li>
/// <li>
/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectAnnotations.html">ListObjectAnnotations</a></p></li>
/// <li>
/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectAnnotation.html">DeleteObjectAnnotation</a></p></li>
/// </ul>
#[derive(::std::fmt::Debug)]
pub struct PutObjectAnnotationFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::put_object_annotation::builders::PutObjectAnnotationInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::put_object_annotation::PutObjectAnnotationOutput,
crate::operation::put_object_annotation::PutObjectAnnotationError,
> for PutObjectAnnotationFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::put_object_annotation::PutObjectAnnotationOutput,
crate::operation::put_object_annotation::PutObjectAnnotationError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl PutObjectAnnotationFluentBuilder {
/// Creates a new `PutObjectAnnotationFluentBuilder`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the PutObjectAnnotation as a reference.
pub fn as_input(&self) -> &crate::operation::put_object_annotation::builders::PutObjectAnnotationInputBuilder {
&self.inner
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::put_object_annotation::PutObjectAnnotationOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::put_object_annotation::PutObjectAnnotationError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::put_object_annotation::PutObjectAnnotation::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::put_object_annotation::PutObjectAnnotation::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::put_object_annotation::PutObjectAnnotationOutput,
crate::operation::put_object_annotation::PutObjectAnnotationError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The name of the bucket that contains the object.</p>
pub fn bucket(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.bucket(input.into());
self
}
/// <p>The name of the bucket that contains the object.</p>
pub fn set_bucket(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_bucket(input);
self
}
/// <p>The name of the bucket that contains the object.</p>
pub fn get_bucket(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_bucket()
}
/// <p>The object key.</p>
pub fn key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.key(input.into());
self
}
/// <p>The object key.</p>
pub fn set_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_key(input);
self
}
/// <p>The object key.</p>
pub fn get_key(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_key()
}
/// <p>The version ID of the object to attach the annotation to.</p>
pub fn version_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.version_id(input.into());
self
}
/// <p>The version ID of the object to attach the annotation to.</p>
pub fn set_version_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_version_id(input);
self
}
/// <p>The version ID of the object to attach the annotation to.</p>
pub fn get_version_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_version_id()
}
/// <p>The name of the annotation.</p>
/// <p>Length Constraints: Minimum length of 1. Maximum length of 512 bytes.</p>
pub fn annotation_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.annotation_name(input.into());
self
}
/// <p>The name of the annotation.</p>
/// <p>Length Constraints: Minimum length of 1. Maximum length of 512 bytes.</p>
pub fn set_annotation_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_annotation_name(input);
self
}
/// <p>The name of the annotation.</p>
/// <p>Length Constraints: Minimum length of 1. Maximum length of 512 bytes.</p>
pub fn get_annotation_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_annotation_name()
}
/// <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>
pub fn annotation_payload(mut self, input: ::aws_smithy_types::byte_stream::ByteStream) -> Self {
self.inner = self.inner.annotation_payload(input);
self
}
/// <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>
pub fn set_annotation_payload(mut self, input: ::std::option::Option<::aws_smithy_types::byte_stream::ByteStream>) -> Self {
self.inner = self.inner.set_annotation_payload(input);
self
}
/// <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>
pub fn get_annotation_payload(&self) -> &::std::option::Option<::aws_smithy_types::byte_stream::ByteStream> {
self.inner.get_annotation_payload()
}
/// <p>If specified, the operation only succeeds if the object's ETag matches the provided value.</p>
pub fn object_if_match(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.object_if_match(input.into());
self
}
/// <p>If specified, the operation only succeeds if the object's ETag matches the provided value.</p>
pub fn set_object_if_match(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_object_if_match(input);
self
}
/// <p>If specified, the operation only succeeds if the object's ETag matches the provided value.</p>
pub fn get_object_if_match(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_object_if_match()
}
/// <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>
pub fn checksum_algorithm(mut self, input: crate::types::ChecksumAlgorithm) -> Self {
self.inner = self.inner.checksum_algorithm(input);
self
}
/// <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>
pub fn set_checksum_algorithm(mut self, input: ::std::option::Option<crate::types::ChecksumAlgorithm>) -> Self {
self.inner = self.inner.set_checksum_algorithm(input);
self
}
/// <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>
pub fn get_checksum_algorithm(&self) -> &::std::option::Option<crate::types::ChecksumAlgorithm> {
self.inner.get_checksum_algorithm()
}
/// <p>Base64-encoded CRC32 checksum of the annotation payload.</p>
pub fn checksum_crc32(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.checksum_crc32(input.into());
self
}
/// <p>Base64-encoded CRC32 checksum of the annotation payload.</p>
pub fn set_checksum_crc32(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_checksum_crc32(input);
self
}
/// <p>Base64-encoded CRC32 checksum of the annotation payload.</p>
pub fn get_checksum_crc32(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_checksum_crc32()
}
/// <p>Base64-encoded CRC32C checksum of the annotation payload.</p>
pub fn checksum_crc32_c(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.checksum_crc32_c(input.into());
self
}
/// <p>Base64-encoded CRC32C checksum of the annotation payload.</p>
pub fn set_checksum_crc32_c(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_checksum_crc32_c(input);
self
}
/// <p>Base64-encoded CRC32C checksum of the annotation payload.</p>
pub fn get_checksum_crc32_c(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_checksum_crc32_c()
}
/// <p>Base64-encoded CRC64NVME checksum of the annotation payload.</p>
pub fn checksum_crc64_nvme(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.checksum_crc64_nvme(input.into());
self
}
/// <p>Base64-encoded CRC64NVME checksum of the annotation payload.</p>
pub fn set_checksum_crc64_nvme(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_checksum_crc64_nvme(input);
self
}
/// <p>Base64-encoded CRC64NVME checksum of the annotation payload.</p>
pub fn get_checksum_crc64_nvme(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_checksum_crc64_nvme()
}
/// <p>Base64-encoded SHA1 checksum of the annotation payload.</p>
pub fn checksum_sha1(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.checksum_sha1(input.into());
self
}
/// <p>Base64-encoded SHA1 checksum of the annotation payload.</p>
pub fn set_checksum_sha1(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_checksum_sha1(input);
self
}
/// <p>Base64-encoded SHA1 checksum of the annotation payload.</p>
pub fn get_checksum_sha1(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_checksum_sha1()
}
/// <p>Base64-encoded SHA256 checksum of the annotation payload.</p>
pub fn checksum_sha256(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.checksum_sha256(input.into());
self
}
/// <p>Base64-encoded SHA256 checksum of the annotation payload.</p>
pub fn set_checksum_sha256(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_checksum_sha256(input);
self
}
/// <p>Base64-encoded SHA256 checksum of the annotation payload.</p>
pub fn get_checksum_sha256(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_checksum_sha256()
}
/// <p>Base64-encoded SHA512 checksum of the annotation payload.</p>
pub fn checksum_sha512(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.checksum_sha512(input.into());
self
}
/// <p>Base64-encoded SHA512 checksum of the annotation payload.</p>
pub fn set_checksum_sha512(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_checksum_sha512(input);
self
}
/// <p>Base64-encoded SHA512 checksum of the annotation payload.</p>
pub fn get_checksum_sha512(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_checksum_sha512()
}
/// <p>Base64-encoded MD5 checksum of the annotation payload.</p>
pub fn checksum_md5(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.checksum_md5(input.into());
self
}
/// <p>Base64-encoded MD5 checksum of the annotation payload.</p>
pub fn set_checksum_md5(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_checksum_md5(input);
self
}
/// <p>Base64-encoded MD5 checksum of the annotation payload.</p>
pub fn get_checksum_md5(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_checksum_md5()
}
/// <p>Base64-encoded XXHASH64 checksum of the annotation payload.</p>
pub fn checksum_xxhash64(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.checksum_xxhash64(input.into());
self
}
/// <p>Base64-encoded XXHASH64 checksum of the annotation payload.</p>
pub fn set_checksum_xxhash64(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_checksum_xxhash64(input);
self
}
/// <p>Base64-encoded XXHASH64 checksum of the annotation payload.</p>
pub fn get_checksum_xxhash64(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_checksum_xxhash64()
}
/// <p>Base64-encoded XXHASH3 checksum of the annotation payload.</p>
pub fn checksum_xxhash3(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.checksum_xxhash3(input.into());
self
}
/// <p>Base64-encoded XXHASH3 checksum of the annotation payload.</p>
pub fn set_checksum_xxhash3(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_checksum_xxhash3(input);
self
}
/// <p>Base64-encoded XXHASH3 checksum of the annotation payload.</p>
pub fn get_checksum_xxhash3(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_checksum_xxhash3()
}
/// <p>Base64-encoded XXHASH128 checksum of the annotation payload.</p>
pub fn checksum_xxhash128(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.checksum_xxhash128(input.into());
self
}
/// <p>Base64-encoded XXHASH128 checksum of the annotation payload.</p>
pub fn set_checksum_xxhash128(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_checksum_xxhash128(input);
self
}
/// <p>Base64-encoded XXHASH128 checksum of the annotation payload.</p>
pub fn get_checksum_xxhash128(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_checksum_xxhash128()
}
/// <p>Base64-encoded MD5 digest of the message.</p>
pub fn content_md5(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.content_md5(input.into());
self
}
/// <p>Base64-encoded MD5 digest of the message.</p>
pub fn set_content_md5(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_content_md5(input);
self
}
/// <p>Base64-encoded MD5 digest of the message.</p>
pub fn get_content_md5(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_content_md5()
}
/// <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>
pub fn request_payer(mut self, input: crate::types::RequestPayer) -> Self {
self.inner = self.inner.request_payer(input);
self
}
/// <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>
pub fn set_request_payer(mut self, input: ::std::option::Option<crate::types::RequestPayer>) -> Self {
self.inner = self.inner.set_request_payer(input);
self
}
/// <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>
pub fn get_request_payer(&self) -> &::std::option::Option<crate::types::RequestPayer> {
self.inner.get_request_payer()
}
/// <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>
pub fn expected_bucket_owner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.expected_bucket_owner(input.into());
self
}
/// <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>
pub fn set_expected_bucket_owner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_expected_bucket_owner(input);
self
}
/// <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>
pub fn get_expected_bucket_owner(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_expected_bucket_owner()
}
}