aws_sdk_s3/client/
list_buckets.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListBuckets`](crate::operation::list_buckets::builders::ListBucketsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_buckets::builders::ListBucketsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`max_buckets(i32)`](crate::operation::list_buckets::builders::ListBucketsFluentBuilder::max_buckets) / [`set_max_buckets(Option<i32>)`](crate::operation::list_buckets::builders::ListBucketsFluentBuilder::set_max_buckets):<br>required: **false**<br><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><br>
    ///   - [`continuation_token(impl Into<String>)`](crate::operation::list_buckets::builders::ListBucketsFluentBuilder::continuation_token) / [`set_continuation_token(Option<String>)`](crate::operation::list_buckets::builders::ListBucketsFluentBuilder::set_continuation_token):<br>required: **false**<br><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> <p>Length Constraints: Minimum length of 0. Maximum length of 1024.</p> <p>Required: No.</p><br>
    /// - On success, responds with [`ListBucketsOutput`](crate::operation::list_buckets::ListBucketsOutput) with field(s):
    ///   - [`buckets(Option<Vec::<Bucket>>)`](crate::operation::list_buckets::ListBucketsOutput::buckets): <p>The list of buckets owned by the requester.</p>
    ///   - [`owner(Option<Owner>)`](crate::operation::list_buckets::ListBucketsOutput::owner): <p>The owner of the buckets listed.</p>
    ///   - [`continuation_token(Option<String>)`](crate::operation::list_buckets::ListBucketsOutput::continuation_token): <p><code>ContinuationToken</code> is included in the response when there are more buckets that can be listed with pagination. The next <code>ListBuckets</code> request to Amazon S3 can be continued with this <code>ContinuationToken</code>. <code>ContinuationToken</code> is obfuscated and is not a real bucket.</p>
    /// - On failure, responds with [`SdkError<ListBucketsError>`](crate::operation::list_buckets::ListBucketsError)
    pub fn list_buckets(&self) -> crate::operation::list_buckets::builders::ListBucketsFluentBuilder {
        crate::operation::list_buckets::builders::ListBucketsFluentBuilder::new(self.handle.clone())
    }
}