aws_sdk_s3/client/
list_object_annotations.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 [`ListObjectAnnotations`](crate::operation::list_object_annotations::builders::ListObjectAnnotationsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_object_annotations::builders::ListObjectAnnotationsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`bucket(impl Into<String>)`](crate::operation::list_object_annotations::builders::ListObjectAnnotationsFluentBuilder::bucket) / [`set_bucket(Option<String>)`](crate::operation::list_object_annotations::builders::ListObjectAnnotationsFluentBuilder::set_bucket):<br>required: **true**<br><p>The name of the bucket that contains the object.</p><br>
8    ///   - [`key(impl Into<String>)`](crate::operation::list_object_annotations::builders::ListObjectAnnotationsFluentBuilder::key) / [`set_key(Option<String>)`](crate::operation::list_object_annotations::builders::ListObjectAnnotationsFluentBuilder::set_key):<br>required: **true**<br><p>The object key.</p><br>
9    ///   - [`version_id(impl Into<String>)`](crate::operation::list_object_annotations::builders::ListObjectAnnotationsFluentBuilder::version_id) / [`set_version_id(Option<String>)`](crate::operation::list_object_annotations::builders::ListObjectAnnotationsFluentBuilder::set_version_id):<br>required: **false**<br><p>The version ID of the object.</p><br>
10    ///   - [`max_annotation_results(i32)`](crate::operation::list_object_annotations::builders::ListObjectAnnotationsFluentBuilder::max_annotation_results) / [`set_max_annotation_results(Option<i32>)`](crate::operation::list_object_annotations::builders::ListObjectAnnotationsFluentBuilder::set_max_annotation_results):<br>required: **false**<br><p>The maximum number of annotations to return in the response. Maximum is 1,000.</p><br>
11    ///   - [`annotation_prefix(impl Into<String>)`](crate::operation::list_object_annotations::builders::ListObjectAnnotationsFluentBuilder::annotation_prefix) / [`set_annotation_prefix(Option<String>)`](crate::operation::list_object_annotations::builders::ListObjectAnnotationsFluentBuilder::set_annotation_prefix):<br>required: **false**<br><p>Filter results to annotations whose name begins with the specified prefix.</p><br>
12    ///   - [`continuation_token(impl Into<String>)`](crate::operation::list_object_annotations::builders::ListObjectAnnotationsFluentBuilder::continuation_token) / [`set_continuation_token(Option<String>)`](crate::operation::list_object_annotations::builders::ListObjectAnnotationsFluentBuilder::set_continuation_token):<br>required: **false**<br><p>Continuation token returned by a previous request to retrieve the next page.</p><br>
13    ///   - [`request_payer(RequestPayer)`](crate::operation::list_object_annotations::builders::ListObjectAnnotationsFluentBuilder::request_payer) / [`set_request_payer(Option<RequestPayer>)`](crate::operation::list_object_annotations::builders::ListObjectAnnotationsFluentBuilder::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>
14    ///   - [`expected_bucket_owner(impl Into<String>)`](crate::operation::list_object_annotations::builders::ListObjectAnnotationsFluentBuilder::expected_bucket_owner) / [`set_expected_bucket_owner(Option<String>)`](crate::operation::list_object_annotations::builders::ListObjectAnnotationsFluentBuilder::set_expected_bucket_owner):<br>required: **false**<br><p>The account ID of the expected bucket owner.</p><br>
15    /// - On success, responds with [`ListObjectAnnotationsOutput`](crate::operation::list_object_annotations::ListObjectAnnotationsOutput) with field(s):
16    ///   - [`annotations(Option<Vec::<AnnotationEntry>>)`](crate::operation::list_object_annotations::ListObjectAnnotationsOutput::annotations): <p>The list of annotations attached to the object.</p>
17    ///   - [`bucket(Option<String>)`](crate::operation::list_object_annotations::ListObjectAnnotationsOutput::bucket): <p>The bucket name.</p>
18    ///   - [`key(Option<String>)`](crate::operation::list_object_annotations::ListObjectAnnotationsOutput::key): <p>The object key.</p>
19    ///   - [`object_version_id(Option<String>)`](crate::operation::list_object_annotations::ListObjectAnnotationsOutput::object_version_id): <p>The version ID of the object.</p>
20    ///   - [`annotation_prefix(Option<String>)`](crate::operation::list_object_annotations::ListObjectAnnotationsOutput::annotation_prefix): <p>The prefix used to filter the response.</p>
21    ///   - [`max_annotation_results(Option<i32>)`](crate::operation::list_object_annotations::ListObjectAnnotationsOutput::max_annotation_results): <p>The maximum number of annotations returned in the response.</p>
22    ///   - [`annotation_count(Option<i32>)`](crate::operation::list_object_annotations::ListObjectAnnotationsOutput::annotation_count): <p>The number of annotations returned.</p>
23    ///   - [`continuation_token(Option<String>)`](crate::operation::list_object_annotations::ListObjectAnnotationsOutput::continuation_token): <p>The continuation token used in this request.</p>
24    ///   - [`next_continuation_token(Option<String>)`](crate::operation::list_object_annotations::ListObjectAnnotationsOutput::next_continuation_token): <p>The continuation token to use to retrieve the next page of results.</p>
25    ///   - [`request_charged(Option<RequestCharged>)`](crate::operation::list_object_annotations::ListObjectAnnotationsOutput::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>
26    /// - On failure, responds with [`SdkError<ListObjectAnnotationsError>`](crate::operation::list_object_annotations::ListObjectAnnotationsError)
27    pub fn list_object_annotations(&self) -> crate::operation::list_object_annotations::builders::ListObjectAnnotationsFluentBuilder {
28        crate::operation::list_object_annotations::builders::ListObjectAnnotationsFluentBuilder::new(self.handle.clone())
29    }
30}
aws_sdk_s3/client/list_object_annotations.rs

aws_sdk_s3/client/
list_object_annotations.rs
