regional_buckets

Creates, updates, deletes, gets or lists a regional_buckets resource.

Overview

Name	regional_buckets
Type	Resource
Id	aws.s3control.regional_buckets

Fields

The following fields are returned by SELECT queries:

list_regional_buckets

Name	Datatype	Description
bucket	string
bucket_arn	string	The Amazon Resource Name (ARN) for the regional bucket.
creation_date	string	The creation date of the regional bucket
outpost_id	string	The Outposts ID of the regional bucket.
public_access_block_enabled	boolean

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_regional_buckets	select	x-amz-account-id, region	nextToken, maxResults, x-amz-outpost-id	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
x-amz-account-id	string	The Amazon Web Services account ID of the Outposts bucket.
maxResults	integer
nextToken	string
x-amz-outpost-id	string	The ID of the Outposts resource. This ID is required by Amazon S3 on Outposts buckets.

SELECT examples

list_regional_buckets

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.

SELECT
bucket,
bucket_arn,
creation_date,
outpost_id,
public_access_block_enabled
FROM aws.s3control.regional_buckets
WHERE `x-amz-account-id` = '{{ x-amz-account-id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND `x-amz-outpost-id` = '{{ x-amz-outpost-id }}'
;