Skip to content

Commit ef8e581

Browse files
author
AWS
committed
AWS S3 Control Update: Add support for the ability to use Amazon S3 Access Points with Amazon FSx for OpenZFS file systems.
1 parent 525e428 commit ef8e581

File tree

2 files changed

+51
-8
lines changed

2 files changed

+51
-8
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS S3 Control",
4+
"contributor": "",
5+
"description": "Add support for the ability to use Amazon S3 Access Points with Amazon FSx for OpenZFS file systems."
6+
}

services/s3control/src/main/resources/codegen-resources/service-2.json

Lines changed: 45 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@
108108
"xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"}
109109
},
110110
"output":{"shape":"CreateAccessPointResult"},
111-
"documentation":"<p>Creates an access point and associates it to a specified bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html\">Managing access to shared datasets in general purpose buckets with access points</a> or <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets.html\">Managing access to shared datasets in directory buckets with access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p/> <note> <p>S3 on Outposts only supports VPC-style access points. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\"> Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html#API_control_CreateAccessPoint_Examples\">Examples</a> section.</p> <p/> <p>The following actions are related to <code>CreateAccessPoint</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html\">GetAccessPoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html\">DeleteAccessPoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html\">ListAccessPoints</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForDirectoryBuckets.html\">ListAccessPointsForDirectoryBuckets</a> </p> </li> </ul>",
111+
"documentation":"<p>Creates an access point and associates it to a specified bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html\">Managing access to shared datasets with access points</a> or <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets.html\">Managing access to shared datasets in directory buckets with access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>To create an access point and attach it to a volume on an Amazon FSx file system, see <a href=\"https://docs.aws.amazon.com/fsx/latest/APIReference/API_CreateAndAttachS3AccessPoint.html\">CreateAndAttachS3AccessPoint</a> in the <i>Amazon FSx API Reference</i>.</p> <p/> <note> <p>S3 on Outposts only supports VPC-style access points. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\"> Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html#API_control_CreateAccessPoint_Examples\">Examples</a> section.</p> <p/> <p>The following actions are related to <code>CreateAccessPoint</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html\">GetAccessPoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html\">DeleteAccessPoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html\">ListAccessPoints</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForDirectoryBuckets.html\">ListAccessPointsForDirectoryBuckets</a> </p> </li> </ul>",
112112
"endpoint":{
113113
"hostPrefix":"{AccountId}."
114114
},
@@ -1129,7 +1129,7 @@
11291129
},
11301130
"input":{"shape":"ListAccessPointsRequest"},
11311131
"output":{"shape":"ListAccessPointsResult"},
1132-
"documentation":"<note> <p>This operation is not supported by directory buckets.</p> </note> <p>Returns a list of the access points that are owned by the current account that's associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in <code>maxResults</code>, whichever is less), the response will include a continuation token that you can use to list the additional access points.</p> <p/> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples\">Examples</a> section.</p> <p>The following actions are related to <code>ListAccessPoints</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html\">CreateAccessPoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html\">DeleteAccessPoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html\">GetAccessPoint</a> </p> </li> </ul>",
1132+
"documentation":"<note> <p>This operation is not supported by directory buckets.</p> </note> <p>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 <code>maxResults</code>, whichever is less), the response will include a continuation token that you can use to list the additional access points.</p> <p>Returns only access points attached to S3 buckets by default. To return all access points specify <code>DataSourceType</code> as <code>ALL</code>.</p> <p/> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples\">Examples</a> section.</p> <p>The following actions are related to <code>ListAccessPoints</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html\">CreateAccessPoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html\">DeleteAccessPoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html\">GetAccessPoint</a> </p> </li> </ul>",
11331133
"endpoint":{
11341134
"hostPrefix":"{AccountId}."
11351135
},
@@ -1826,7 +1826,7 @@
18261826
"documentation":"<p>The virtual private cloud (VPC) configuration for this access point, if one exists.</p> <note> <p>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.</p> </note>"
18271827
},
18281828
"Bucket":{
1829-
"shape":"BucketName",
1829+
"shape":"AccessPointBucketName",
18301830
"documentation":"<p>The name of the bucket associated with this access point.</p>"
18311831
},
18321832
"AccessPointArn":{
@@ -1840,10 +1840,22 @@
18401840
"BucketAccountId":{
18411841
"shape":"AccountId",
18421842
"documentation":"<p>The Amazon Web Services account ID associated with the S3 bucket associated with this access point.</p>"
1843+
},
1844+
"DataSourceId":{
1845+
"shape":"DataSourceId",
1846+
"documentation":"<p>A unique identifier for the data source of the access point.</p>"
1847+
},
1848+
"DataSourceType":{
1849+
"shape":"DataSourceType",
1850+
"documentation":"<p>The type of the data source that the access point is attached to.</p>"
18431851
}
18441852
},
18451853
"documentation":"<p>An access point used to access a bucket.</p>"
18461854
},
1855+
"AccessPointBucketName":{
1856+
"type":"string",
1857+
"max":255
1858+
},
18471859
"AccessPointList":{
18481860
"type":"list",
18491861
"member":{
@@ -2444,7 +2456,7 @@
24442456
},
24452457
"Name":{
24462458
"shape":"AccessPointName",
2447-
"documentation":"<p>The name you want to assign to this access point.</p> <p>For directory buckets, the access point name must consist of a base name that you provide and suffix that includes the <code>ZoneID</code> (Amazon Web Services Availability Zone or Local Zone) of your bucket location, followed by <code>--xa-s3</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets.html\">Managing access to shared datasets in directory buckets with access points</a> in the Amazon S3 User Guide.</p>",
2459+
"documentation":"<p>The name you want to assign to this access point.</p> <p>For directory buckets, the access point name must consist of a base name that you provide and suffix that includes the <code>ZoneID</code> (Amazon Web Services Availability Zone or Local Zone) of your bucket location, followed by <code>--xa-s3</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets.html\">Managing access to shared datasets in directory buckets with access points</a> in the <i>Amazon S3 User Guide</i>.</p>",
24482460
"contextParam":{"name":"AccessPointName"},
24492461
"location":"uri",
24502462
"locationName":"name"
@@ -2468,7 +2480,7 @@
24682480
},
24692481
"Scope":{
24702482
"shape":"Scope",
2471-
"documentation":"<p>For directory buckets, you can filter access control to specific prefixes, API operations, or a combination of both. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets.html\">Managing access to shared datasets in directory buckets with access points</a> in the Amazon S3 User Guide.</p> <note> <p>Scope is not supported for access points for general purpose buckets.</p> </note>"
2483+
"documentation":"<p>For directory buckets, you can filter access control to specific prefixes, API operations, or a combination of both. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets.html\">Managing access to shared datasets in directory buckets with access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Scope is only supported for access points attached to directory buckets.</p> </note>"
24722484
}
24732485
}
24742486
},
@@ -2757,6 +2769,11 @@
27572769
"documentation":"<p>The Amazon Web Services Security Token Service temporary credential that S3 Access Grants vends to grantees and client applications. </p>",
27582770
"sensitive":true
27592771
},
2772+
"DataSourceId":{
2773+
"type":"string",
2774+
"max":191
2775+
},
2776+
"DataSourceType":{"type":"string"},
27602777
"Date":{"type":"timestamp"},
27612778
"Days":{"type":"integer"},
27622779
"DaysAfterInitiation":{"type":"integer"},
@@ -3944,7 +3961,7 @@
39443961
"documentation":"<p>The name of the specified access point.</p>"
39453962
},
39463963
"Bucket":{
3947-
"shape":"BucketName",
3964+
"shape":"AccessPointBucketName",
39483965
"documentation":"<p>The name of the bucket associated with the specified access point.</p>"
39493966
},
39503967
"NetworkOrigin":{
@@ -3975,6 +3992,14 @@
39753992
"BucketAccountId":{
39763993
"shape":"AccountId",
39773994
"documentation":"<p>The Amazon Web Services account ID associated with the S3 bucket associated with this access point.</p>"
3995+
},
3996+
"DataSourceId":{
3997+
"shape":"DataSourceId",
3998+
"documentation":"<p>The unique identifier for the data source of the access point.</p>"
3999+
},
4000+
"DataSourceType":{
4001+
"shape":"DataSourceType",
4002+
"documentation":"<p>The type of the data source that the access point is attached to.</p>"
39784003
}
39794004
}
39804005
},
@@ -5689,6 +5714,18 @@
56895714
"documentation":"<p>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 <code>NextToken</code> field that you can use to retrieve the next page of access points.</p>",
56905715
"location":"querystring",
56915716
"locationName":"maxResults"
5717+
},
5718+
"DataSourceId":{
5719+
"shape":"DataSourceId",
5720+
"documentation":"<p>The unique identifier for the data source of the access point.</p>",
5721+
"location":"querystring",
5722+
"locationName":"dataSourceId"
5723+
},
5724+
"DataSourceType":{
5725+
"shape":"DataSourceType",
5726+
"documentation":"<p>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 <code>DataSourceType</code> as <code>ALL</code>.</p>",
5727+
"location":"querystring",
5728+
"locationName":"dataSourceType"
56925729
}
56935730
}
56945731
},
@@ -6803,7 +6840,7 @@
68036840
},
68046841
"Policy":{
68056842
"shape":"Policy",
6806-
"documentation":"<p>The policy that you want to apply to the specified access point. For more information about access point policies, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html\">Managing access to shared datasets in general purpose buckets with access points</a> or <a href=\"AmazonS3/latest/userguide/access-points-directory-buckets.html\">Managing access to shared datasets in directory bucekts with access points</a> in the <i>Amazon S3 User Guide</i>.</p>"
6843+
"documentation":"<p>The policy that you want to apply to the specified access point. For more information about access point policies, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html\">Managing data access with Amazon S3 access points</a> or <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets.html\">Managing access to shared datasets in directory buckets with access points</a> in the <i>Amazon S3 User Guide</i>.</p>"
68076844
}
68086845
}
68096846
},
@@ -8144,7 +8181,7 @@
81448181
"locationName":"Permissions"
81458182
}
81468183
},
8147-
"documentation":"<p>You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets-manage-scope.html\">Manage the scope of your access points for directory buckets.</a> </p>"
8184+
"documentation":"<p>You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets-manage-scope.html\">Manage the scope of your access points for directory buckets</a>.</p>"
81488185
},
81498186
"ScopePermission":{
81508187
"type":"string",

0 commit comments

Comments
 (0)