access_points_for_directory_buckets

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

Overview

Name	access_points_for_directory_buckets
Type	Resource
Id	aws.s3control.access_points_for_directory_buckets

Fields

The following fields are returned by SELECT queries:

list_access_points_for_directory_buckets

Name	Datatype	Description
access_point_arn	string	The ARN for the access point.
alias	string	The name or alias of the access point.
bucket	string	The name of the bucket associated with this access point.
bucket_account_id	string	The Amazon Web Services account ID associated with the S3 bucket associated with this access point.
data_source_id	string	A unique identifier for the data source of the access point.
data_source_type	string	The type of the data source that the access point is attached to.
name	string	The name of this access point.
network_origin	string	Indicates whether this access point allows access from the public internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, and the access point doesn't allow access from the public internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the public internet, subject to the access point and bucket access policies.
vpc_configuration	string	The virtual private cloud (VPC) configuration for this access point, if one exists. This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other Amazon Web Services services.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_access_points_for_directory_buckets	select	x-amz-account-id, region	directoryBucket, nextToken, maxResults	Returns a list of the access points that are owned by the Amazon Web Services account and that are associated with the specified directory bucket. To list access points for general purpose buckets, see ListAccesspoints. To use this operation, you must have the permission to perform the s3express:ListAccessPointsForDirectoryBuckets 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
region	string	AWS region (default: us-east-1)
x-amz-account-id	string	The Amazon Web Services account ID that owns the access points.
directoryBucket	string	The name of the directory bucket associated with the access points you want to list.
maxResults	integer	The maximum number of access points that you would like returned in the ListAccessPointsForDirectoryBuckets response. If the directory bucket is associated with more than this number of access points, the results include the pagination token NextToken. Make another call using the NextToken to retrieve more results.
nextToken	string	If NextToken is returned, there are more access points available than requested in the maxResults value. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

SELECT examples

list_access_points_for_directory_buckets

Returns a list of the access points that are owned by the Amazon Web Services account and that are associated with the specified directory bucket. To list access points for general purpose buckets, see ListAccesspoints. To use this operation, you must have the permission to perform the s3express:ListAccessPointsForDirectoryBuckets action. For information about REST API errors, see REST error responses.

SELECT
access_point_arn,
alias,
bucket,
bucket_account_id,
data_source_id,
data_source_type,
name,
network_origin,
vpc_configuration
FROM aws.s3control.access_points_for_directory_buckets
WHERE `x-amz-account-id` = '{{ x-amz-account-id }}' -- required
AND region = '{{ region }}' -- required
AND directoryBucket = '{{ directoryBucket }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;