access_grants_instance_for_prefixes

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

Overview

Name	access_grants_instance_for_prefixes
Type	Resource
Id	aws.s3control.access_grants_instance_for_prefixes

Fields

The following fields are returned by SELECT queries:

get_access_grants_instance_for_prefix

Name	Datatype	Description
access_grants_instance_arn	string	The Amazon Resource Name (ARN) of the S3 Access Grants instance.
access_grants_instance_id	string	The ID of the S3 Access Grants instance. The ID is default. You can have one S3 Access Grants instance per Region per account.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_access_grants_instance_for_prefix	select	x-amz-account-id, s3prefix, region		Retrieve the S3 Access Grants instance that contains a particular prefix. Permissions You must have the s3:GetAccessGrantsInstanceForPrefix permission for the caller account to use this operation. Additional Permissions The prefix owner account must grant you the following permissions to their S3 Access Grants instance: s3:GetAccessGrantsInstanceForPrefix.

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)
s3prefix	string	The S3 prefix of the access grants that you would like to retrieve.
x-amz-account-id	string	The ID of the Amazon Web Services account that is making this request.

SELECT examples

get_access_grants_instance_for_prefix

Retrieve the S3 Access Grants instance that contains a particular prefix. Permissions You must have the s3:GetAccessGrantsInstanceForPrefix permission for the caller account to use this operation. Additional Permissions The prefix owner account must grant you the following permissions to their S3 Access Grants instance: s3:GetAccessGrantsInstanceForPrefix.

SELECT
access_grants_instance_arn,
access_grants_instance_id
FROM aws.s3control.access_grants_instance_for_prefixes
WHERE `x-amz-account-id` = '{{ x-amz-account-id }}' -- required
AND s3prefix = '{{ s3prefix }}' -- required
AND region = '{{ region }}' -- required
;