Skip to main content

aws_sdk_s3/client/
delete_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 [`DeleteObjectAnnotation`](crate::operation::delete_object_annotation::builders::DeleteObjectAnnotationFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`bucket(impl Into<String>)`](crate::operation::delete_object_annotation::builders::DeleteObjectAnnotationFluentBuilder::bucket) / [`set_bucket(Option<String>)`](crate::operation::delete_object_annotation::builders::DeleteObjectAnnotationFluentBuilder::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::delete_object_annotation::builders::DeleteObjectAnnotationFluentBuilder::key) / [`set_key(Option<String>)`](crate::operation::delete_object_annotation::builders::DeleteObjectAnnotationFluentBuilder::set_key):<br>required: **true**<br><p>The object key.</p><br>
8    ///   - [`annotation_name(impl Into<String>)`](crate::operation::delete_object_annotation::builders::DeleteObjectAnnotationFluentBuilder::annotation_name) / [`set_annotation_name(Option<String>)`](crate::operation::delete_object_annotation::builders::DeleteObjectAnnotationFluentBuilder::set_annotation_name):<br>required: **true**<br><p>The name of the annotation to delete. Annotation names are UTF-8 encoded and cannot start with <code>aws</code> or <code>s3</code> (case-insensitive).</p> <p>Length Constraints: Minimum length of 1. Maximum length of 512 bytes.</p><br>
9    ///   - [`version_id(impl Into<String>)`](crate::operation::delete_object_annotation::builders::DeleteObjectAnnotationFluentBuilder::version_id) / [`set_version_id(Option<String>)`](crate::operation::delete_object_annotation::builders::DeleteObjectAnnotationFluentBuilder::set_version_id):<br>required: **false**<br><p>The version ID of the object.</p><br>
10    ///   - [`request_payer(RequestPayer)`](crate::operation::delete_object_annotation::builders::DeleteObjectAnnotationFluentBuilder::request_payer) / [`set_request_payer(Option<RequestPayer>)`](crate::operation::delete_object_annotation::builders::DeleteObjectAnnotationFluentBuilder::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::delete_object_annotation::builders::DeleteObjectAnnotationFluentBuilder::expected_bucket_owner) / [`set_expected_bucket_owner(Option<String>)`](crate::operation::delete_object_annotation::builders::DeleteObjectAnnotationFluentBuilder::set_expected_bucket_owner):<br>required: **false**<br><p>The account ID of the expected bucket owner.</p><br>
12    ///   - [`object_if_match(impl Into<String>)`](crate::operation::delete_object_annotation::builders::DeleteObjectAnnotationFluentBuilder::object_if_match) / [`set_object_if_match(Option<String>)`](crate::operation::delete_object_annotation::builders::DeleteObjectAnnotationFluentBuilder::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>
13    /// - On success, responds with [`DeleteObjectAnnotationOutput`](crate::operation::delete_object_annotation::DeleteObjectAnnotationOutput) with field(s):
14    ///   - [`object_version_id(Option<String>)`](crate::operation::delete_object_annotation::DeleteObjectAnnotationOutput::object_version_id): <p>The version ID of the object that the annotation was deleted from.</p>
15    ///   - [`request_charged(Option<RequestCharged>)`](crate::operation::delete_object_annotation::DeleteObjectAnnotationOutput::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<DeleteObjectAnnotationError>`](crate::operation::delete_object_annotation::DeleteObjectAnnotationError)
17    pub fn delete_object_annotation(&self) -> crate::operation::delete_object_annotation::builders::DeleteObjectAnnotationFluentBuilder {
18        crate::operation::delete_object_annotation::builders::DeleteObjectAnnotationFluentBuilder::new(self.handle.clone())
19    }
20}