access_point_scopes

Creates, updates, deletes, gets or lists an access_point_scopes resource.

Overview

Name	access_point_scopes
Type	Resource
Id	aws.s3control.access_point_scopes

Fields

The following fields are returned by SELECT queries:

get_access_point_scope

Name	Datatype	Description
permissions	string	You can include one or more API operations as permissions.
prefixes	string	You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 256 bytes in size.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_access_point_scope	select	x-amz-account-id, name, region		Returns the access point scope for a directory bucket. To use this operation, you must have the permission to perform the s3express:GetAccessPointScope action. For information about REST API errors, see REST error responses.
put_access_point_scope	replace	x-amz-account-id, name, region, Scope		Creates or replaces the access point scope for a directory bucket. You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both. You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 256 bytes in size. To use this operation, you must have the permission to perform the s3express:PutAccessPointScope action. For information about REST API errors, see REST error responses.
delete_access_point_scope	delete	x-amz-account-id, name, region		Deletes an existing access point scope for a directory bucket. When you delete the scope of an access point, all prefixes and permissions are deleted. To use this operation, you must have the permission to perform the s3express:DeleteAccessPointScope action. For information about REST API errors, see REST error responses.

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	The name of the access point with the scope that you want to delete.
region	string	AWS region (default: us-east-1)
x-amz-account-id	string	The Amazon Web Services account ID that owns the access point with the scope that you want to delete.

SELECT examples

get_access_point_scope

Returns the access point scope for a directory bucket. To use this operation, you must have the permission to perform the s3express:GetAccessPointScope action. For information about REST API errors, see REST error responses.

SELECT
permissions,
prefixes
FROM aws.s3control.access_point_scopes
WHERE `x-amz-account-id` = '{{ x-amz-account-id }}' -- required
AND name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_access_point_scope

Creates or replaces the access point scope for a directory bucket. You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both. You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 256 bytes in size. To use this operation, you must have the permission to perform the s3express:PutAccessPointScope action. For information about REST API errors, see REST error responses.

REPLACE aws.s3control.access_point_scopes
SET 
Scope = '{{ Scope }}'
WHERE 
`x-amz-account-id` = '{{ x-amz-account-id }}' --required
AND name = '{{ name }}' --required
AND region = '{{ region }}' --required
AND Scope = '{{ Scope }}' --required;

DELETE examples

delete_access_point_scope

Deletes an existing access point scope for a directory bucket. When you delete the scope of an access point, all prefixes and permissions are deleted. To use this operation, you must have the permission to perform the s3express:DeleteAccessPointScope action. For information about REST API errors, see REST error responses.

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