aws_sdk_s3/operation/list_bucket_analytics_configurations/
builders.rs

Help
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_bucket_analytics_configurations::_list_bucket_analytics_configurations_output::ListBucketAnalyticsConfigurationsOutputBuilder;
3
4pub use crate::operation::list_bucket_analytics_configurations::_list_bucket_analytics_configurations_input::ListBucketAnalyticsConfigurationsInputBuilder;
5
6impl crate::operation::list_bucket_analytics_configurations::builders::ListBucketAnalyticsConfigurationsInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::list_bucket_analytics_configurations::ListBucketAnalyticsConfigurationsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::list_bucket_analytics_configurations::ListBucketAnalyticsConfigurationsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.list_bucket_analytics_configurations();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ListBucketAnalyticsConfigurations`.
24///
25/// <note>
26/// <p>This operation is not supported for directory buckets.</p>
27/// </note>
28/// <p>Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.</p>
29/// <p>This action supports list pagination and does not return more than 100 configurations at a time. You should always check the <code>IsTruncated</code> element in the response. If there are no more configurations to list, <code>IsTruncated</code> is set to false. If there are more configurations to list, <code>IsTruncated</code> is set to true, and there will be a value in <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> value to continue the pagination of the list by passing the value in continuation-token in the request to <code>GET</code> the next page.</p>
30/// <p>To use this operation, you must have permissions to perform the <code>s3:GetAnalyticsConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3 Resources</a>.</p>
31/// <p>For information about Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class Analysis</a>.</p>
32/// <p>The following operations are related to <code>ListBucketAnalyticsConfigurations</code>:</p>
33/// <ul>
34/// <li>
35/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html">GetBucketAnalyticsConfiguration</a></p></li>
36/// <li>
37/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html">DeleteBucketAnalyticsConfiguration</a></p></li>
38/// <li>
39/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html">PutBucketAnalyticsConfiguration</a></p></li>
40/// </ul>
41#[derive(::std::clone::Clone, ::std::fmt::Debug)]
42pub struct ListBucketAnalyticsConfigurationsFluentBuilder {
43    handle: ::std::sync::Arc<crate::client::Handle>,
44    inner: crate::operation::list_bucket_analytics_configurations::builders::ListBucketAnalyticsConfigurationsInputBuilder,
45    config_override: ::std::option::Option<crate::config::Builder>,
46}
47impl
48    crate::client::customize::internal::CustomizableSend<
49        crate::operation::list_bucket_analytics_configurations::ListBucketAnalyticsConfigurationsOutput,
50        crate::operation::list_bucket_analytics_configurations::ListBucketAnalyticsConfigurationsError,
51    > for ListBucketAnalyticsConfigurationsFluentBuilder
52{
53    fn send(
54        self,
55        config_override: crate::config::Builder,
56    ) -> crate::client::customize::internal::BoxFuture<
57        crate::client::customize::internal::SendResult<
58            crate::operation::list_bucket_analytics_configurations::ListBucketAnalyticsConfigurationsOutput,
59            crate::operation::list_bucket_analytics_configurations::ListBucketAnalyticsConfigurationsError,
60        >,
61    > {
62        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
63    }
64}
65impl ListBucketAnalyticsConfigurationsFluentBuilder {
66    /// Creates a new `ListBucketAnalyticsConfigurationsFluentBuilder`.
67    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
68        Self {
69            handle,
70            inner: ::std::default::Default::default(),
71            config_override: ::std::option::Option::None,
72        }
73    }
74    /// Access the ListBucketAnalyticsConfigurations as a reference.
75    pub fn as_input(&self) -> &crate::operation::list_bucket_analytics_configurations::builders::ListBucketAnalyticsConfigurationsInputBuilder {
76        &self.inner
77    }
78    /// Sends the request and returns the response.
79    ///
80    /// If an error occurs, an `SdkError` will be returned with additional details that
81    /// can be matched against.
82    ///
83    /// By default, any retryable failures will be retried twice. Retry behavior
84    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
85    /// set when configuring the client.
86    pub async fn send(
87        self,
88    ) -> ::std::result::Result<
89        crate::operation::list_bucket_analytics_configurations::ListBucketAnalyticsConfigurationsOutput,
90        ::aws_smithy_runtime_api::client::result::SdkError<
91            crate::operation::list_bucket_analytics_configurations::ListBucketAnalyticsConfigurationsError,
92            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
93        >,
94    > {
95        let input = self
96            .inner
97            .build()
98            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
99        let runtime_plugins = crate::operation::list_bucket_analytics_configurations::ListBucketAnalyticsConfigurations::operation_runtime_plugins(
100            self.handle.runtime_plugins.clone(),
101            &self.handle.conf,
102            self.config_override,
103        );
104        crate::operation::list_bucket_analytics_configurations::ListBucketAnalyticsConfigurations::orchestrate(&runtime_plugins, input).await
105    }
106
107    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
108    pub fn customize(
109        self,
110    ) -> crate::client::customize::CustomizableOperation<
111        crate::operation::list_bucket_analytics_configurations::ListBucketAnalyticsConfigurationsOutput,
112        crate::operation::list_bucket_analytics_configurations::ListBucketAnalyticsConfigurationsError,
113        Self,
114    > {
115        crate::client::customize::CustomizableOperation::new(self)
116    }
117    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
118        self.set_config_override(::std::option::Option::Some(config_override.into()));
119        self
120    }
121
122    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
123        self.config_override = config_override;
124        self
125    }
126    /// <p>The name of the bucket from which analytics configurations are retrieved.</p>
127    pub fn bucket(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128        self.inner = self.inner.bucket(input.into());
129        self
130    }
131    /// <p>The name of the bucket from which analytics configurations are retrieved.</p>
132    pub fn set_bucket(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
133        self.inner = self.inner.set_bucket(input);
134        self
135    }
136    /// <p>The name of the bucket from which analytics configurations are retrieved.</p>
137    pub fn get_bucket(&self) -> &::std::option::Option<::std::string::String> {
138        self.inner.get_bucket()
139    }
140    /// <p>The <code>ContinuationToken</code> that represents a placeholder from where this request should begin.</p>
141    pub fn continuation_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
142        self.inner = self.inner.continuation_token(input.into());
143        self
144    }
145    /// <p>The <code>ContinuationToken</code> that represents a placeholder from where this request should begin.</p>
146    pub fn set_continuation_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
147        self.inner = self.inner.set_continuation_token(input);
148        self
149    }
150    /// <p>The <code>ContinuationToken</code> that represents a placeholder from where this request should begin.</p>
151    pub fn get_continuation_token(&self) -> &::std::option::Option<::std::string::String> {
152        self.inner.get_continuation_token()
153    }
154    /// <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
155    pub fn expected_bucket_owner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
156        self.inner = self.inner.expected_bucket_owner(input.into());
157        self
158    }
159    /// <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
160    pub fn set_expected_bucket_owner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
161        self.inner = self.inner.set_expected_bucket_owner(input);
162        self
163    }
164    /// <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
165    pub fn get_expected_bucket_owner(&self) -> &::std::option::Option<::std::string::String> {
166        self.inner.get_expected_bucket_owner()
167    }
168}
aws_sdk_s3/operation/list_bucket_analytics_configurations/builders.rs

aws_sdk_s3/operation/list_bucket_analytics_configurations/
builders.rs
