aws_sdk_lightsail/client/
get_buckets.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 [`GetBuckets`](crate::operation::get_buckets::builders::GetBucketsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`bucket_name(impl Into<String>)`](crate::operation::get_buckets::builders::GetBucketsFluentBuilder::bucket_name) / [`set_bucket_name(Option<String>)`](crate::operation::get_buckets::builders::GetBucketsFluentBuilder::set_bucket_name):<br>required: **false**<br><p>The name of the bucket for which to return information.</p> <p>When omitted, the response includes all of your buckets in the Amazon Web Services Region where the request is made.</p><br>
7    ///   - [`page_token(impl Into<String>)`](crate::operation::get_buckets::builders::GetBucketsFluentBuilder::page_token) / [`set_page_token(Option<String>)`](crate::operation::get_buckets::builders::GetBucketsFluentBuilder::set_page_token):<br>required: **false**<br><p>The token to advance to the next page of results from your request.</p> <p>To get a page token, perform an initial <code>GetBuckets</code> request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.</p><br>
8    ///   - [`include_connected_resources(bool)`](crate::operation::get_buckets::builders::GetBucketsFluentBuilder::include_connected_resources) / [`set_include_connected_resources(Option<bool>)`](crate::operation::get_buckets::builders::GetBucketsFluentBuilder::set_include_connected_resources):<br>required: **false**<br><p>A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html">SetResourceAccessForBucket</a> action.</p><br>
9    ///   - [`include_cors(bool)`](crate::operation::get_buckets::builders::GetBucketsFluentBuilder::include_cors) / [`set_include_cors(Option<bool>)`](crate::operation::get_buckets::builders::GetBucketsFluentBuilder::set_include_cors):<br>required: **false**<br><p>A Boolean value that indicates whether to include Lightsail bucket CORS configuration in the response. For more information, see <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/configure-cors.html">Configuring cross-origin resource sharing (CORS)</a>.</p><note>  <p>This parameter is only supported when getting a single bucket with <code>bucketName</code> specified. The default value for this parameter is <code>False</code>.</p> </note><br>
10    /// - On success, responds with [`GetBucketsOutput`](crate::operation::get_buckets::GetBucketsOutput) with field(s):
11    ///   - [`buckets(Option<Vec::<Bucket>>)`](crate::operation::get_buckets::GetBucketsOutput::buckets): <p>An array of objects that describe buckets.</p>
12    ///   - [`next_page_token(Option<String>)`](crate::operation::get_buckets::GetBucketsOutput::next_page_token): <p>The token to advance to the next page of results from your request.</p> <p>A next page token is not returned if there are no more results to display.</p> <p>To get the next page of results, perform another <code>GetBuckets</code> request and specify the next page token using the <code>pageToken</code> parameter.</p>
13    ///   - [`account_level_bpa_sync(Option<AccountLevelBpaSync>)`](crate::operation::get_buckets::GetBucketsOutput::account_level_bpa_sync): <p>An object that describes the synchronization status of the Amazon S3 account-level block public access feature for your Lightsail buckets.</p> <p>For more information about this feature and how it affects Lightsail buckets, see <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-block-public-access-for-buckets">Block public access for buckets in Amazon Lightsail</a>.</p>
14    /// - On failure, responds with [`SdkError<GetBucketsError>`](crate::operation::get_buckets::GetBucketsError)
15    pub fn get_buckets(&self) -> crate::operation::get_buckets::builders::GetBucketsFluentBuilder {
16        crate::operation::get_buckets::builders::GetBucketsFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_lightsail/client/get_buckets.rs

aws_sdk_lightsail/client/
get_buckets.rs
