access_points

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

Overview

Name	`access_points`
Type	Resource
Id	`aws.s3control.access_points`

Fields

The following fields are returned by SELECT queries:

get_access_point
list_access_points

Name	Datatype	Description
`access_point_arn`	`string`	The ARN of the access point.
`alias`	`string`	The name or alias of the access point.
`bucket`	`string`	The name of the bucket associated with the specified access point.
`bucket_account_id`	`string`	The Amazon Web Services account ID associated with the S3 bucket associated with this access point.
`creation_date`	`string`	The date and time when the specified access point was created.
`data_source_id`	`string`	The 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.
`endpoints`	`string`	The VPC endpoint for the access point.
`name`	`string`	The name of the specified 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. This will always be true for an Amazon S3 on Outposts access point
`public_access_block_configuration`	`string`	The PublicAccessBlock configuration that you want to apply to this Amazon S3 account. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide. This data type is not supported for Amazon S3 on Outposts.
`vpc_configuration`	`string`	Contains the virtual private cloud (VPC) configuration for the specified access point. 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.

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
`get_access_point`	`select`	`x-amz-account-id`, `name`, `region`		Returns configuration information about the specified access point. 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. The following actions are related to GetAccessPoint: CreateAccessPoint DeleteAccessPoint ListAccessPoints
`list_access_points`	`select`	`x-amz-account-id`, `region`	`bucket`, `nextToken`, `maxResults`, `dataSourceId`, `dataSourceType`	This operation is not supported by directory buckets. Returns a list of the access points. You can retrieve up to 1,000 access points per call. If the call returns more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points. Returns only access points attached to S3 buckets by default. To return all access points specify DataSourceType as ALL. 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. The following actions are related to ListAccessPoints: CreateAccessPoint DeleteAccessPoint GetAccessPoint
`create_access_point`	`insert`	`x-amz-account-id`, `name`, `region`		Creates an access point and associates it to a specified bucket. For more information, see Managing access to shared datasets with access points or Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide. To create an access point and attach it to a volume on an Amazon FSx file system, see CreateAndAttachS3AccessPoint in the Amazon FSx API Reference. S3 on Outposts only supports VPC-style access points. For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points in the 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. The following actions are related to CreateAccessPoint: GetAccessPoint DeleteAccessPoint ListAccessPoints ListAccessPointsForDirectoryBuckets
`delete_access_point`	`delete`	`x-amz-account-id`, `name`, `region`		Deletes the specified access point. 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. The following actions are related to DeleteAccessPoint: CreateAccessPoint GetAccessPoint ListAccessPoints

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 you want to delete. 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 access point accessed in the format arn:aws:s3-outposts:`<Region>`:`<account-id>`:outpost/`<outpost-id>`/accesspoint/`<my-accesspoint-name>`. For example, to access the access point reports-ap 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/accesspoint/reports-ap. The value must be URL encoded.
`region`	`string`	AWS region (default: us-east-1)
`x-amz-account-id`	`string`	The Amazon Web Services account ID for the account that owns the specified access point.
`bucket`	`string`	The name of the bucket whose associated access points you want to list. 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.
`dataSourceId`	`string`	The unique identifier for the data source of the access point.
`dataSourceType`	`string`	The type of the data source that the access point is attached to. Returns only access points attached to S3 buckets by default. To return all access points specify DataSourceType as ALL.
`maxResults`	`integer`	The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.
`nextToken`	`string`	A continuation token. If a previous call to ListAccessPoints returned a continuation token in the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.

`SELECT` examples

get_access_point
list_access_points

Returns configuration information about the specified access point. 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. The following actions are related to GetAccessPoint: CreateAccessPoint DeleteAccessPoint ListAccessPoints

SELECT
access_point_arn,
alias,
bucket,
bucket_account_id,
creation_date,
data_source_id,
data_source_type,
endpoints,
name,
network_origin,
public_access_block_configuration,
vpc_configuration
FROM aws.s3control.access_points
WHERE `x-amz-account-id` = '{{ x-amz-account-id }}' -- required
AND name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

This operation is not supported by directory buckets. Returns a list of the access points. You can retrieve up to 1,000 access points per call. If the call returns more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points. Returns only access points attached to S3 buckets by default. To return all access points specify DataSourceType as ALL. 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. The following actions are related to ListAccessPoints: CreateAccessPoint DeleteAccessPoint GetAccessPoint

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
WHERE `x-amz-account-id` = '{{ x-amz-account-id }}' -- required
AND region = '{{ region }}' -- required
AND bucket = '{{ bucket }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND dataSourceId = '{{ dataSourceId }}'
AND dataSourceType = '{{ dataSourceType }}'
;

`INSERT` examples

create_access_point
Manifest

Creates an access point and associates it to a specified bucket. For more information, see Managing access to shared datasets with access points or Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide. To create an access point and attach it to a volume on an Amazon FSx file system, see CreateAndAttachS3AccessPoint in the Amazon FSx API Reference. S3 on Outposts only supports VPC-style access points. For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points in the 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. The following actions are related to CreateAccessPoint: GetAccessPoint DeleteAccessPoint ListAccessPoints ListAccessPointsForDirectoryBuckets

INSERT INTO aws.s3control.access_points (
Bucket,
VpcConfiguration,
PublicAccessBlockConfiguration,
BucketAccountId,
Scope,
Tags,
`x-amz-account-id`,
name,
region
)
SELECT 
'{{ Bucket }}',
'{{ VpcConfiguration }}',
'{{ PublicAccessBlockConfiguration }}',
'{{ BucketAccountId }}',
'{{ Scope }}',
'{{ Tags }}',
'{{ x-amz-account-id }}',
'{{ name }}',
'{{ region }}'
RETURNING
access_point_arn,
alias
;

# Description fields are for documentation purposes
- name: access_points
props:
  - name: x-amz-account-id
    value: "{{ x-amz-account-id }}"
    description: Required parameter for the access_points resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the access_points resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the access_points resource.
  - name: Bucket
    value: "{{ Bucket }}"
  - name: VpcConfiguration
    description: |
      The virtual private cloud (VPC) configuration for an access point.
    value:
      VpcId: "{{ VpcId }}"
  - name: PublicAccessBlockConfiguration
    description: |
      The PublicAccessBlock configuration that you want to apply to this Amazon S3 account. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide. This data type is not supported for Amazon S3 on Outposts.
    value:
      BlockPublicAcls: {{ BlockPublicAcls }}
      IgnorePublicAcls: {{ IgnorePublicAcls }}
      BlockPublicPolicy: {{ BlockPublicPolicy }}
      RestrictPublicBuckets: {{ RestrictPublicBuckets }}
  - name: BucketAccountId
    value: "{{ BucketAccountId }}"
  - name: Scope
    description: |
      You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both. For more information, see Manage the scope of your access points for directory buckets.
    value:
      Prefixes:
        - "{{ Prefixes }}"
      Permissions:
        - "{{ Permissions }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

`DELETE` examples

delete_access_point

Deletes the specified access point. 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. The following actions are related to DeleteAccessPoint: CreateAccessPoint GetAccessPoint ListAccessPoints

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

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

DELETE examples​