2024/10/16 - Amazon Simple Storage Service - 2 updated api methods
Changes Add support for the new optional bucket-region and prefix query parameters in the ListBuckets API. For ListBuckets requests that express pagination, Amazon S3 will now return both the bucket names and associated AWS regions in the response.
{'BucketRegion': 'string', 'Prefix': 'string'}
Response {'Buckets': {'BucketRegion': 'string'}, 'Prefix': 'string'}
Note
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.
See also: AWS API Documentation
Request Syntax
client.list_buckets(
MaxBuckets=123,
ContinuationToken='string',
Prefix='string',
BucketRegion='string'
)
integer
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.
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.
string
Limits the response to bucket names that begin with the specified bucket name prefix.
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.
Note
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 .
dict
Response Syntax
{
'Buckets': [
{
'Name': 'string',
'CreationDate': datetime(2015, 1, 1),
'BucketRegion': 'string'
},
],
'Owner': {
'DisplayName': 'string',
'ID': 'string'
},
'ContinuationToken': 'string',
'Prefix': 'string'
}
Response Structure
(dict) --
Buckets (list) --
The list of buckets owned by the requester.
(dict) --
In terms of implementation, a Bucket is a resource.
Name (string) --
The name of the bucket.
CreationDate (datetime) --
Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy.
BucketRegion (string) --
BucketRegion indicates the Amazon Web Services region where the bucket is located. If the request contains at least one valid parameter, it is included in the response.
Owner (dict) --
The owner of the buckets listed.
DisplayName (string) --
Container for the display name of the owner. This value is only supported in the following Amazon Web Services Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
Note
This functionality is not supported for directory buckets.
ID (string) --
Container for the ID of the owner.
ContinuationToken (string) --
ContinuationToken is included in the response when there are more buckets that can be listed with pagination. The next ListBuckets request to Amazon S3 can be continued with this ContinuationToken . ContinuationToken is obfuscated and is not a real bucket.
Prefix (string) --
If Prefix was sent with the request, it is included in the response.
All bucket names in the response begin with the specified bucket name prefix.
{'Buckets': {'BucketRegion': 'string'}}
Returns a list of all Amazon S3 directory buckets owned by the authenticated sender of the request. For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide .
Note
Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide .
Permissions
You must have the s3express:ListAllMyDirectoryBuckets permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide .
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com .
See also: AWS API Documentation
Request Syntax
client.list_directory_buckets(
ContinuationToken='string',
MaxDirectoryBuckets=123
)
string
ContinuationToken indicates to Amazon S3 that the list is being continued on buckets in this account with a token. ContinuationToken is obfuscated and is not a real bucket name. You can use this ContinuationToken for the pagination of the list results.
integer
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.
dict
Response Syntax
{
'Buckets': [
{
'Name': 'string',
'CreationDate': datetime(2015, 1, 1),
'BucketRegion': 'string'
},
],
'ContinuationToken': 'string'
}
Response Structure
(dict) --
Buckets (list) --
The list of buckets owned by the requester.
(dict) --
In terms of implementation, a Bucket is a resource.
Name (string) --
The name of the bucket.
CreationDate (datetime) --
Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy.
BucketRegion (string) --
BucketRegion indicates the Amazon Web Services region where the bucket is located. If the request contains at least one valid parameter, it is included in the response.
ContinuationToken (string) --
If ContinuationToken was sent with the request, it is included in the response. You can use the returned ContinuationToken for pagination of the list response.