buckets

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

Overview

Name	buckets
Type	Resource
Id	aws.s3control.buckets

Fields

The following fields are returned by SELECT queries:

get_bucket

Name	Datatype	Description
bucket	string	The Outposts bucket requested.
creation_date	string	The creation date of the Outposts bucket.
public_access_block_enabled	boolean

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_bucket	select	x-amz-account-id, name, region		Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide. If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the s3-outposts:GetBucket permissions on the specified Outposts bucket and belong to the Outposts bucket owner's account in order to use this action. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don't have s3-outposts:GetBucket permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error. The following actions are related to GetBucket for Amazon S3 on Outposts: All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. PutObject CreateBucket DeleteBucket
create_bucket	insert	name, region	x-amz-acl, x-amz-grant-full-control, x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write, x-amz-grant-write-acp, x-amz-bucket-object-lock-enabled, x-amz-outpost-id	This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon S3 API Reference. Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide. Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets. S3 on Outposts buckets support: Tags LifecycleConfigurations for deleting expired objects For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see Amazon S3 on Outposts Restrictions and Limitations. 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 API request, see the Examples section. The following actions are related to CreateBucket for Amazon S3 on Outposts: PutObject GetBucket DeleteBucket CreateAccessPoint PutAccessPointPolicy
delete_bucket	delete	x-amz-account-id, name, region		This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon S3 API Reference. Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. Related Resources CreateBucket GetBucket DeleteObject

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
name	string	Specifies the bucket being deleted. For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well. For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
region	string	AWS region (default: us-east-1)
x-amz-account-id	string	The account ID that owns the Outposts bucket.
x-amz-acl	string	The canned ACL to apply to the bucket. This is not supported by Amazon S3 on Outposts buckets.
x-amz-bucket-object-lock-enabled	boolean	Specifies whether you want S3 Object Lock to be enabled for the new bucket. This is not supported by Amazon S3 on Outposts buckets.
x-amz-grant-full-control	string	Allows grantee the read, write, read ACP, and write ACP permissions on the bucket. This is not supported by Amazon S3 on Outposts buckets.
x-amz-grant-read	string	Allows grantee to list the objects in the bucket. This is not supported by Amazon S3 on Outposts buckets.
x-amz-grant-read-acp	string	Allows grantee to read the bucket ACL. This is not supported by Amazon S3 on Outposts buckets.
x-amz-grant-write	string	Allows grantee to create, overwrite, and delete any object in the bucket. This is not supported by Amazon S3 on Outposts buckets.
x-amz-grant-write-acp	string	Allows grantee to write the ACL for the applicable bucket. This is not supported by Amazon S3 on Outposts buckets.
x-amz-outpost-id	string	The ID of the Outposts where the bucket is being created. This ID is required by Amazon S3 on Outposts buckets.

SELECT examples

get_bucket

Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide. If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the s3-outposts:GetBucket permissions on the specified Outposts bucket and belong to the Outposts bucket owner's account in order to use this action. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don't have s3-outposts:GetBucket permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error. The following actions are related to GetBucket for Amazon S3 on Outposts: All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. PutObject CreateBucket DeleteBucket

SELECT
bucket,
creation_date,
public_access_block_enabled
FROM aws.s3control.buckets
WHERE `x-amz-account-id` = '{{ x-amz-account-id }}' -- required
AND name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_bucket

This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon S3 API Reference. Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide. Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets. S3 on Outposts buckets support: Tags LifecycleConfigurations for deleting expired objects For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see Amazon S3 on Outposts Restrictions and Limitations. 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 API request, see the Examples section. The following actions are related to CreateBucket for Amazon S3 on Outposts: PutObject GetBucket DeleteBucket CreateAccessPoint PutAccessPointPolicy

INSERT INTO aws.s3control.buckets (
CreateBucketConfiguration,
name,
region,
`x-amz-acl`,
`x-amz-grant-full-control`,
`x-amz-grant-read`,
`x-amz-grant-read-acp`,
`x-amz-grant-write`,
`x-amz-grant-write-acp`,
`x-amz-bucket-object-lock-enabled`,
`x-amz-outpost-id`
)
SELECT 
'{{ CreateBucketConfiguration }}',
'{{ name }}',
'{{ region }}',
'{{ x-amz-acl }}',
'{{ x-amz-grant-full-control }}',
'{{ x-amz-grant-read }}',
'{{ x-amz-grant-read-acp }}',
'{{ x-amz-grant-write }}',
'{{ x-amz-grant-write-acp }}',
'{{ x-amz-bucket-object-lock-enabled }}',
'{{ x-amz-outpost-id }}'
RETURNING
bucket_arn,
location
;

Manifest

# Description fields are for documentation purposes
- name: buckets
props:
  - name: name
    value: "{{ name }}"
    description: Required parameter for the buckets resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the buckets resource.
  - name: CreateBucketConfiguration
    description: |
      The container for the bucket configuration. This is not supported by Amazon S3 on Outposts buckets.
    value:
      LocationConstraint: "{{ LocationConstraint }}"
  - name: x-amz-acl
    value: "{{ x-amz-acl }}"
    description: The canned ACL to apply to the bucket. This is not supported by Amazon S3 on Outposts buckets.
    description: The canned ACL to apply to the bucket. This is not supported by Amazon S3 on Outposts buckets.
  - name: x-amz-grant-full-control
    value: "{{ x-amz-grant-full-control }}"
    description: Allows grantee the read, write, read ACP, and write ACP permissions on the bucket. This is not supported by Amazon S3 on Outposts buckets.
    description: Allows grantee the read, write, read ACP, and write ACP permissions on the bucket. This is not supported by Amazon S3 on Outposts buckets.
  - name: x-amz-grant-read
    value: "{{ x-amz-grant-read }}"
    description: Allows grantee to list the objects in the bucket. This is not supported by Amazon S3 on Outposts buckets.
    description: Allows grantee to list the objects in the bucket. This is not supported by Amazon S3 on Outposts buckets.
  - name: x-amz-grant-read-acp
    value: "{{ x-amz-grant-read-acp }}"
    description: Allows grantee to read the bucket ACL. This is not supported by Amazon S3 on Outposts buckets.
    description: Allows grantee to read the bucket ACL. This is not supported by Amazon S3 on Outposts buckets.
  - name: x-amz-grant-write
    value: "{{ x-amz-grant-write }}"
    description: Allows grantee to create, overwrite, and delete any object in the bucket. This is not supported by Amazon S3 on Outposts buckets.
    description: Allows grantee to create, overwrite, and delete any object in the bucket. This is not supported by Amazon S3 on Outposts buckets.
  - name: x-amz-grant-write-acp
    value: "{{ x-amz-grant-write-acp }}"
    description: Allows grantee to write the ACL for the applicable bucket. This is not supported by Amazon S3 on Outposts buckets.
    description: Allows grantee to write the ACL for the applicable bucket. This is not supported by Amazon S3 on Outposts buckets.
  - name: x-amz-bucket-object-lock-enabled
    value: {{ x-amz-bucket-object-lock-enabled }}
    description: Specifies whether you want S3 Object Lock to be enabled for the new bucket. This is not supported by Amazon S3 on Outposts buckets.
    description: Specifies whether you want S3 Object Lock to be enabled for the new bucket. This is not supported by Amazon S3 on Outposts buckets.
  - name: x-amz-outpost-id
    value: "{{ x-amz-outpost-id }}"
    description: The ID of the Outposts where the bucket is being created. This ID is required by Amazon S3 on Outposts buckets.
    description: The ID of the Outposts where the bucket is being created. This ID is required by Amazon S3 on Outposts buckets.

DELETE examples

delete_bucket

This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon S3 API Reference. Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide. All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section. Related Resources CreateBucket GetBucket DeleteObject

DELETE FROM aws.s3control.buckets
WHERE `x-amz-account-id` = '{{ x-amz-account-id }}' --required
AND name = '{{ name }}' --required
AND region = '{{ region }}' --required
;