aws_sdk_s3/operation/list_buckets/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_buckets::_list_buckets_output::ListBucketsOutputBuilder;
3
4pub use crate::operation::list_buckets::_list_buckets_input::ListBucketsInputBuilder;
5
6impl crate::operation::list_buckets::builders::ListBucketsInputBuilder {
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_buckets::ListBucketsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::list_buckets::ListBucketsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.list_buckets();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ListBuckets`.
24///
25/// <note>
26/// <p>This operation is not supported by directory buckets.</p>
27/// </note>
28/// <p>Returns a list of all buckets owned by the authenticated sender of the request. To use this operation, you must have the <code>s3:ListAllMyBuckets</code> permission.</p>
29/// <p>For information about Amazon S3 buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html">Creating, configuring, and working with Amazon S3 buckets</a>.</p>
30#[derive(::std::clone::Clone, ::std::fmt::Debug)]
31pub struct ListBucketsFluentBuilder {
32    handle: ::std::sync::Arc<crate::client::Handle>,
33    inner: crate::operation::list_buckets::builders::ListBucketsInputBuilder,
34    config_override: ::std::option::Option<crate::config::Builder>,
35}
36impl
37    crate::client::customize::internal::CustomizableSend<
38        crate::operation::list_buckets::ListBucketsOutput,
39        crate::operation::list_buckets::ListBucketsError,
40    > for ListBucketsFluentBuilder
41{
42    fn send(
43        self,
44        config_override: crate::config::Builder,
45    ) -> crate::client::customize::internal::BoxFuture<
46        crate::client::customize::internal::SendResult<
47            crate::operation::list_buckets::ListBucketsOutput,
48            crate::operation::list_buckets::ListBucketsError,
49        >,
50    > {
51        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
52    }
53}
54impl ListBucketsFluentBuilder {
55    /// Creates a new `ListBucketsFluentBuilder`.
56    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
57        Self {
58            handle,
59            inner: ::std::default::Default::default(),
60            config_override: ::std::option::Option::None,
61        }
62    }
63    /// Access the ListBuckets as a reference.
64    pub fn as_input(&self) -> &crate::operation::list_buckets::builders::ListBucketsInputBuilder {
65        &self.inner
66    }
67    /// Sends the request and returns the response.
68    ///
69    /// If an error occurs, an `SdkError` will be returned with additional details that
70    /// can be matched against.
71    ///
72    /// By default, any retryable failures will be retried twice. Retry behavior
73    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
74    /// set when configuring the client.
75    pub async fn send(
76        self,
77    ) -> ::std::result::Result<
78        crate::operation::list_buckets::ListBucketsOutput,
79        ::aws_smithy_runtime_api::client::result::SdkError<
80            crate::operation::list_buckets::ListBucketsError,
81            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
82        >,
83    > {
84        let input = self
85            .inner
86            .build()
87            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
88        let runtime_plugins = crate::operation::list_buckets::ListBuckets::operation_runtime_plugins(
89            self.handle.runtime_plugins.clone(),
90            &self.handle.conf,
91            self.config_override,
92        );
93        crate::operation::list_buckets::ListBuckets::orchestrate(&runtime_plugins, input).await
94    }
95
96    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
97    pub fn customize(
98        self,
99    ) -> crate::client::customize::CustomizableOperation<
100        crate::operation::list_buckets::ListBucketsOutput,
101        crate::operation::list_buckets::ListBucketsError,
102        Self,
103    > {
104        crate::client::customize::CustomizableOperation::new(self)
105    }
106    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
107        self.set_config_override(::std::option::Option::Some(config_override.into()));
108        self
109    }
110
111    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
112        self.config_override = config_override;
113        self
114    }
115    /// Create a paginator for this request
116    ///
117    /// Paginators are used by calling [`send().await`](crate::operation::list_buckets::paginator::ListBucketsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
118    pub fn into_paginator(self) -> crate::operation::list_buckets::paginator::ListBucketsPaginator {
119        crate::operation::list_buckets::paginator::ListBucketsPaginator::new(self.handle, self.inner)
120    }
121    /// <p>Maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an Amazon Web Services account, return all the buckets in response.</p>
122    pub fn max_buckets(mut self, input: i32) -> Self {
123        self.inner = self.inner.max_buckets(input);
124        self
125    }
126    /// <p>Maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an Amazon Web Services account, return all the buckets in response.</p>
127    pub fn set_max_buckets(mut self, input: ::std::option::Option<i32>) -> Self {
128        self.inner = self.inner.set_max_buckets(input);
129        self
130    }
131    /// <p>Maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an Amazon Web Services account, return all the buckets in response.</p>
132    pub fn get_max_buckets(&self) -> &::std::option::Option<i32> {
133        self.inner.get_max_buckets()
134    }
135    /// <p><code>ContinuationToken</code> indicates to Amazon S3 that the list is being continued on this bucket with a token. <code>ContinuationToken</code> is obfuscated and is not a real key. You can use this <code>ContinuationToken</code> for pagination of the list results.</p>
136    /// <p>Length Constraints: Minimum length of 0. Maximum length of 1024.</p>
137    /// <p>Required: No.</p>
138    pub fn continuation_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
139        self.inner = self.inner.continuation_token(input.into());
140        self
141    }
142    /// <p><code>ContinuationToken</code> indicates to Amazon S3 that the list is being continued on this bucket with a token. <code>ContinuationToken</code> is obfuscated and is not a real key. You can use this <code>ContinuationToken</code> for pagination of the list results.</p>
143    /// <p>Length Constraints: Minimum length of 0. Maximum length of 1024.</p>
144    /// <p>Required: No.</p>
145    pub fn set_continuation_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
146        self.inner = self.inner.set_continuation_token(input);
147        self
148    }
149    /// <p><code>ContinuationToken</code> indicates to Amazon S3 that the list is being continued on this bucket with a token. <code>ContinuationToken</code> is obfuscated and is not a real key. You can use this <code>ContinuationToken</code> for pagination of the list results.</p>
150    /// <p>Length Constraints: Minimum length of 0. Maximum length of 1024.</p>
151    /// <p>Required: No.</p>
152    pub fn get_continuation_token(&self) -> &::std::option::Option<::std::string::String> {
153        self.inner.get_continuation_token()
154    }
155}
aws_sdk_s3/operation/list_buckets/builders.rs

aws_sdk_s3/operation/list_buckets/
builders.rs
