bucket/list_buckets

Types

ListAllMyBucketsResult

pub type ListAllMyBucketsResult {
  ListAllMyBucketsResult(
    buckets: List(Bucket),
    continuation_token: Option(String),
  )
}

Constructors

ListAllMyBucketsResult(
  buckets: List(Bucket),
  continuation_token: Option(String),
)

RequestBuilder

</>

The parameters for the API request

pub type RequestBuilder {
  RequestBuilder(
    continuation_token: Option(String),
    max_buckets: Option(Int),
  )
}

Constructors

RequestBuilder(
  continuation_token: Option(String),
  max_buckets: Option(Int),
)

Functions

build

</>

pub fn build(
  builder: RequestBuilder,
  creds: Credentials,
) -> Request(BitArray)

continuation_token

</>

pub fn continuation_token(
  builder: RequestBuilder,
  token: String,
) -> RequestBuilder

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.

max_buckets

</>

pub fn max_buckets(
  builder: RequestBuilder,
  count: Int,
) -> RequestBuilder

Maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an AWS account, return all the buckets in response.

Valid Range: Minimum value of 1. Maximum value of 1000.

request

</>

pub fn request() -> RequestBuilder

response

</>

pub fn response(
  response: Response(BitArray),
) -> Result(ListAllMyBucketsResult, BucketError)