Skip to content

List Buckets

s3_list_buckets R Documentation

This operation is not supported for directory buckets

Description

This operation is not supported for directory buckets.

Returns a list of all buckets owned by the authenticated sender of the request. To grant IAM permission to use this operation, you must add the s3:ListAllMyBuckets policy action.

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

We strongly recommend using only paginated list_buckets requests. Unpaginated list_buckets requests are only supported for Amazon Web Services accounts set to the default general purpose bucket quota of 10,000. If you have an approved general purpose bucket quota above 10,000, you must send paginated list_buckets requests to list your account’s buckets. All unpaginated list_buckets requests will be rejected for Amazon Web Services accounts with a general purpose bucket quota greater than 10,000.

Usage

s3_list_buckets(MaxBuckets, ContinuationToken, Prefix, BucketRegion)

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.

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.

Prefix

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

BucketRegion

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.

Value

A list with the following syntax: 

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

Request syntax

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