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 |
Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No. If you specify the |
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
Requests made to a Regional endpoint that is different from the
|
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"
)