aws_sdk_s3/client/
get_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 [`GetObjectAnnotation`](crate::operation::get_object_annotation::builders::GetObjectAnnotationFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`bucket(impl Into<String>)`](crate::operation::get_object_annotation::builders::GetObjectAnnotationFluentBuilder::bucket) / [`set_bucket(Option<String>)`](crate::operation::get_object_annotation::builders::GetObjectAnnotationFluentBuilder::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::get_object_annotation::builders::GetObjectAnnotationFluentBuilder::key) / [`set_key(Option<String>)`](crate::operation::get_object_annotation::builders::GetObjectAnnotationFluentBuilder::set_key):<br>required: **true**<br><p>The object key.</p><br>
8    ///   - [`annotation_name(impl Into<String>)`](crate::operation::get_object_annotation::builders::GetObjectAnnotationFluentBuilder::annotation_name) / [`set_annotation_name(Option<String>)`](crate::operation::get_object_annotation::builders::GetObjectAnnotationFluentBuilder::set_annotation_name):<br>required: **true**<br><p>The name of the annotation to retrieve.</p> <p>Length Constraints: Minimum length of 1. Maximum length of 512 bytes.</p><br>
9    ///   - [`version_id(impl Into<String>)`](crate::operation::get_object_annotation::builders::GetObjectAnnotationFluentBuilder::version_id) / [`set_version_id(Option<String>)`](crate::operation::get_object_annotation::builders::GetObjectAnnotationFluentBuilder::set_version_id):<br>required: **false**<br><p>The version ID of the object.</p><br>
10    ///   - [`request_payer(RequestPayer)`](crate::operation::get_object_annotation::builders::GetObjectAnnotationFluentBuilder::request_payer) / [`set_request_payer(Option<RequestPayer>)`](crate::operation::get_object_annotation::builders::GetObjectAnnotationFluentBuilder::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::get_object_annotation::builders::GetObjectAnnotationFluentBuilder::expected_bucket_owner) / [`set_expected_bucket_owner(Option<String>)`](crate::operation::get_object_annotation::builders::GetObjectAnnotationFluentBuilder::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>
12    ///   - [`checksum_mode(ChecksumMode)`](crate::operation::get_object_annotation::builders::GetObjectAnnotationFluentBuilder::checksum_mode) / [`set_checksum_mode(Option<ChecksumMode>)`](crate::operation::get_object_annotation::builders::GetObjectAnnotationFluentBuilder::set_checksum_mode):<br>required: **false**<br><p>Set to <code>ENABLED</code> to validate the checksum of the annotation payload on retrieval.</p><br>
13    /// - On success, responds with [`GetObjectAnnotationOutput`](crate::operation::get_object_annotation::GetObjectAnnotationOutput) with field(s):
14    ///   - [`annotation_payload(ByteStream)`](crate::operation::get_object_annotation::GetObjectAnnotationOutput::annotation_payload): <p>The annotation payload.</p>
15    ///   - [`object_version_id(Option<String>)`](crate::operation::get_object_annotation::GetObjectAnnotationOutput::object_version_id): <p>The version ID of the object that the annotation is attached to.</p>
16    ///   - [`last_modified(Option<DateTime>)`](crate::operation::get_object_annotation::GetObjectAnnotationOutput::last_modified): <p>The date and time the annotation was last modified.</p>
17    ///   - [`content_length(Option<i64>)`](crate::operation::get_object_annotation::GetObjectAnnotationOutput::content_length): <p>The size of the annotation payload, in bytes.</p>
18    ///   - [`e_tag(Option<String>)`](crate::operation::get_object_annotation::GetObjectAnnotationOutput::e_tag): <p>The entity tag of the annotation.</p>
19    ///   - [`checksum_crc32(Option<String>)`](crate::operation::get_object_annotation::GetObjectAnnotationOutput::checksum_crc32): <p>The CRC32 checksum of the annotation payload.</p>
20    ///   - [`checksum_crc32_c(Option<String>)`](crate::operation::get_object_annotation::GetObjectAnnotationOutput::checksum_crc32_c): <p>The CRC32C checksum of the annotation payload.</p>
21    ///   - [`checksum_crc64_nvme(Option<String>)`](crate::operation::get_object_annotation::GetObjectAnnotationOutput::checksum_crc64_nvme): <p>The CRC64NVME checksum of the annotation payload.</p>
22    ///   - [`checksum_sha1(Option<String>)`](crate::operation::get_object_annotation::GetObjectAnnotationOutput::checksum_sha1): <p>The SHA1 checksum of the annotation payload.</p>
23    ///   - [`checksum_sha256(Option<String>)`](crate::operation::get_object_annotation::GetObjectAnnotationOutput::checksum_sha256): <p>The SHA256 checksum of the annotation payload.</p>
24    ///   - [`checksum_sha512(Option<String>)`](crate::operation::get_object_annotation::GetObjectAnnotationOutput::checksum_sha512): <p>The SHA512 checksum of the annotation payload.</p>
25    ///   - [`checksum_md5(Option<String>)`](crate::operation::get_object_annotation::GetObjectAnnotationOutput::checksum_md5): <p>The MD5 checksum of the annotation payload.</p>
26    ///   - [`checksum_xxhash64(Option<String>)`](crate::operation::get_object_annotation::GetObjectAnnotationOutput::checksum_xxhash64): <p>The XXHASH64 checksum of the annotation payload.</p>
27    ///   - [`checksum_xxhash3(Option<String>)`](crate::operation::get_object_annotation::GetObjectAnnotationOutput::checksum_xxhash3): <p>The XXHASH3 checksum of the annotation payload.</p>
28    ///   - [`checksum_xxhash128(Option<String>)`](crate::operation::get_object_annotation::GetObjectAnnotationOutput::checksum_xxhash128): <p>The XXHASH128 checksum of the annotation payload.</p>
29    ///   - [`checksum_type(Option<ChecksumType>)`](crate::operation::get_object_annotation::GetObjectAnnotationOutput::checksum_type): <p>The type of checksum used.</p>
30    ///   - [`server_side_encryption(Option<ServerSideEncryption>)`](crate::operation::get_object_annotation::GetObjectAnnotationOutput::server_side_encryption): <p>The server-side encryption algorithm used.</p>
31    ///   - [`request_charged(Option<RequestCharged>)`](crate::operation::get_object_annotation::GetObjectAnnotationOutput::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>
32    ///   - [`replication_status(Option<ReplicationStatus>)`](crate::operation::get_object_annotation::GetObjectAnnotationOutput::replication_status): <p>The replication status of the annotation. Possible values include <code>PENDING</code>, <code>COMPLETED</code>, <code>FAILED</code>, and <code>REPLICA</code>.</p>
33    /// - On failure, responds with [`SdkError<GetObjectAnnotationError>`](crate::operation::get_object_annotation::GetObjectAnnotationError)
34    pub fn get_object_annotation(&self) -> crate::operation::get_object_annotation::builders::GetObjectAnnotationFluentBuilder {
35        crate::operation::get_object_annotation::builders::GetObjectAnnotationFluentBuilder::new(self.handle.clone())
36    }
37}
aws_sdk_s3/client/get_object_annotation.rs

aws_sdk_s3/client/
get_object_annotation.rs
