ListRegionalBuckets
Note
This operation is not supported by directory buckets.
Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts
endpoint hostname prefix and x-amz-outpost-id in your request, see the Examples section.
Request Syntax
GET /v20180820/bucket?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
Host: s3-control.amazonaws.com
x-amz-account-id: AccountId
x-amz-outpost-id: OutpostId
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
Valid Range: Minimum value of 0. Maximum value of 1000.
- nextToken
-
Length Constraints: Minimum length of 1. Maximum length of 1024.
- x-amz-account-id
-
The AWS account ID of the Outposts bucket.
Length Constraints: Maximum length of 64.
Pattern:
^\d{12}$Required: Yes
- x-amz-outpost-id
-
The ID of the AWS Outposts resource.
Note
This ID is required by Amazon S3 on Outposts buckets.
Length Constraints: Minimum length of 1. Maximum length of 64.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<ListRegionalBucketsResult>
<RegionalBucketList>
<RegionalBucket>
<Bucket>string</Bucket>
<BucketArn>string</BucketArn>
<CreationDate>timestamp</CreationDate>
<OutpostId>string</OutpostId>
<PublicAccessBlockEnabled>boolean</PublicAccessBlockEnabled>
</RegionalBucket>
</RegionalBucketList>
<NextToken>string</NextToken>
</ListRegionalBucketsResult>Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in XML format by the service.
- ListRegionalBucketsResult
-
Root level tag for the ListRegionalBucketsResult parameters.
Required: Yes
- NextToken
-
NextTokenis sent whenisTruncatedis true, which means there are more buckets that can be listed. The next list requests to Amazon S3 can be continued with thisNextToken.NextTokenis obfuscated and is not a real key.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
- RegionalBucketList
-
Type: Array of RegionalBucket data types
Examples
Sample request to list an account's Outposts buckets
This request lists regional buckets.
GET /v20180820/bucket HTTP /1.1 Host:s3-outposts.us-west-2.amazonaws.com Content-Length: 0 x-amz-outpost-id: op-01ac5d28a6a232904 x-amz-account-id: example-account-id Date: Wed, 01 Mar 2006 12:00:00 GMT Authorization: authorization string
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
