Skip to content

List Buckets

s3_list_buckets R Documentation

This operation is not supported by directory buckets

Description

This operation is not supported by directory buckets.

Returns a list of all buckets owned by the authenticated sender of the request. To use this operation, you must have the s3:ListAllMyBuckets permission.

For information about Amazon S3 buckets, see Creating, configuring, and working with Amazon S3 buckets.

Usage

s3_list_buckets(MaxBuckets, ContinuationToken)

Arguments

MaxBuckets

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.

ContinuationToken

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.

Value

A list with the following syntax:

list(
  Buckets = list(
    list(
      Name = "string",
      CreationDate = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  Owner = list(
    DisplayName = "string",
    ID = "string"
  ),
  ContinuationToken = "string"
)

Request syntax

svc$list_buckets(
  MaxBuckets = 123,
  ContinuationToken = "string"
)

Examples

## Not run: 
# The following example returns all the buckets owned by the sender of
# this request.
svc$list_buckets()

## End(Not run)