Struct ListBucketsInputBuilder

#[non_exhaustive]
pub struct ListBucketsInputBuilder { /* private fields */ }

A builder for ListBucketsInput.

Implementations

impl ListBucketsInputBuilder

pub fn max_buckets(self, input: i32) -> Self

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.

pub fn set_max_buckets(self, input: Option<i32>) -> Self

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.

pub fn get_max_buckets(&self) -> &Option<i32>

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.

pub fn continuation_token(self, input: impl Into<String>) -> Self

ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. You can use this ContinuationToken for pagination of the list results.

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No.

If you specify the bucket-region, prefix, or continuation-token query parameters without using max-buckets to set the maximum number of buckets returned in the response, Amazon S3 applies a default page size of 10,000 and provides a continuation token if there are more buckets.

pub fn set_continuation_token(self, input: Option<String>) -> Self

ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. You can use this ContinuationToken for pagination of the list results.

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No.

If you specify the bucket-region, prefix, or continuation-token query parameters without using max-buckets to set the maximum number of buckets returned in the response, Amazon S3 applies a default page size of 10,000 and provides a continuation token if there are more buckets.

pub fn get_continuation_token(&self) -> &Option<String>

ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. You can use this ContinuationToken for pagination of the list results.

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No.

If you specify the bucket-region, prefix, or continuation-token query parameters without using max-buckets to set the maximum number of buckets returned in the response, Amazon S3 applies a default page size of 10,000 and provides a continuation token if there are more buckets.

pub fn prefix(self, input: impl Into<String>) -> Self

Limits the response to bucket names that begin with the specified bucket name prefix.

pub fn set_prefix(self, input: Option<String>) -> Self

Limits the response to bucket names that begin with the specified bucket name prefix.

pub fn get_prefix(&self) -> &Option<String>

Limits the response to bucket names that begin with the specified bucket name prefix.

pub fn bucket_region(self, input: impl Into<String>) -> Self

Limits the response to buckets that are located in the specified Amazon Web Services Region. The Amazon Web Services Region must be expressed according to the Amazon Web Services Region code, such as us-west-2 for the US West (Oregon) Region. For a list of the valid values for all of the Amazon Web Services Regions, see Regions and Endpoints.

Requests made to a Regional endpoint that is different from the bucket-region parameter are not supported. For example, if you want to limit the response to your buckets in Region us-west-2, the request must be made to an endpoint in Region us-west-2.

pub fn set_bucket_region(self, input: Option<String>) -> Self

Limits the response to buckets that are located in the specified Amazon Web Services Region. The Amazon Web Services Region must be expressed according to the Amazon Web Services Region code, such as us-west-2 for the US West (Oregon) Region. For a list of the valid values for all of the Amazon Web Services Regions, see Regions and Endpoints.

Requests made to a Regional endpoint that is different from the bucket-region parameter are not supported. For example, if you want to limit the response to your buckets in Region us-west-2, the request must be made to an endpoint in Region us-west-2.

pub fn get_bucket_region(&self) -> &Option<String>

Limits the response to buckets that are located in the specified Amazon Web Services Region. The Amazon Web Services Region must be expressed according to the Amazon Web Services Region code, such as us-west-2 for the US West (Oregon) Region. For a list of the valid values for all of the Amazon Web Services Regions, see Regions and Endpoints.

Requests made to a Regional endpoint that is different from the bucket-region parameter are not supported. For example, if you want to limit the response to your buckets in Region us-west-2, the request must be made to an endpoint in Region us-west-2.

pub fn build(self) -> Result<ListBucketsInput, BuildError>

Consumes the builder and constructs a ListBucketsInput.

impl ListBucketsInputBuilder

pub async fn send_with( self, client: &Client, ) -> Result<ListBucketsOutput, SdkError<ListBucketsError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for ListBucketsInputBuilder

fn clone(&self) -> ListBucketsInputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListBucketsInputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListBucketsInputBuilder

fn default() -> ListBucketsInputBuilder

Returns the “default value” for a type.

impl PartialEq for ListBucketsInputBuilder

fn eq(&self, other: &ListBucketsInputBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ListBucketsInputBuilder