Skip to content

Commit 1eadcc8

Browse files
author
awstools
committed
docs(client-storage-gateway): Documentation update: Amazon FSx File Gateway will no longer be available to new customers.
1 parent 02407f8 commit 1eadcc8

File tree

6 files changed

+80
-25
lines changed

6 files changed

+80
-25
lines changed

‎clients/client-storage-gateway/README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,12 @@
77
AWS SDK for JavaScript StorageGateway Client for Node.js, Browser and React Native.
88

99
<fullname>Storage Gateway Service</fullname>
10+
<important>
1011

12+
<p>Amazon FSx File Gateway is no longer available to new customers. Existing
13+
customers of FSx File Gateway can continue to use the service normally. For
14+
capabilities similar to FSx File Gateway, visit <a href="https://aws.amazon.com/blogs/storage/switch-your-file-share-access-from-amazon-fsx-file-gateway-to-amazon-fsx-for-windows-file-server/">this blog post</a>.</p>
15+
</important>
1116
<p>Storage Gateway is the service that connects an on-premises software appliance
1217
with cloud-based storage to provide seamless and secure integration between an
1318
organization's on-premises IT environment and the Amazon Web Services storage
@@ -69,7 +74,7 @@ Heads-up – Longer Storage Gateway volume and snapshot IDs coming in
6974

7075
## Installing
7176

72-
To install the this package, simply type add or install @aws-sdk/client-storage-gateway
77+
To install this package, simply type add or install @aws-sdk/client-storage-gateway
7378
using your favorite package manager:
7479

7580
- `npm install @aws-sdk/client-storage-gateway`

‎clients/client-storage-gateway/src/StorageGateway.ts

+5
Original file line numberDiff line numberDiff line change
@@ -1920,6 +1920,11 @@ export interface StorageGateway {
19201920

19211921
/**
19221922
* <fullname>Storage Gateway Service</fullname>
1923+
* <important>
1924+
* <p>Amazon FSx File Gateway is no longer available to new customers. Existing
1925+
* customers of FSx File Gateway can continue to use the service normally. For
1926+
* capabilities similar to FSx File Gateway, visit <a href="https://aws.amazon.com/blogs/storage/switch-your-file-share-access-from-amazon-fsx-file-gateway-to-amazon-fsx-for-windows-file-server/">this blog post</a>.</p>
1927+
* </important>
19231928
* <p>Storage Gateway is the service that connects an on-premises software appliance
19241929
* with cloud-based storage to provide seamless and secure integration between an
19251930
* organization's on-premises IT environment and the Amazon Web Services storage

‎clients/client-storage-gateway/src/StorageGatewayClient.ts

+5
Original file line numberDiff line numberDiff line change
@@ -670,6 +670,11 @@ export interface StorageGatewayClientResolvedConfig extends StorageGatewayClient
670670

671671
/**
672672
* <fullname>Storage Gateway Service</fullname>
673+
* <important>
674+
* <p>Amazon FSx File Gateway is no longer available to new customers. Existing
675+
* customers of FSx File Gateway can continue to use the service normally. For
676+
* capabilities similar to FSx File Gateway, visit <a href="https://aws.amazon.com/blogs/storage/switch-your-file-share-access-from-amazon-fsx-file-gateway-to-amazon-fsx-for-windows-file-server/">this blog post</a>.</p>
677+
* </important>
673678
* <p>Storage Gateway is the service that connects an on-premises software appliance
674679
* with cloud-based storage to provide seamless and secure integration between an
675680
* organization's on-premises IT environment and the Amazon Web Services storage

‎clients/client-storage-gateway/src/index.ts

+5
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
/* eslint-disable */
33
/**
44
* <fullname>Storage Gateway Service</fullname>
5+
* <important>
6+
* <p>Amazon FSx File Gateway is no longer available to new customers. Existing
7+
* customers of FSx File Gateway can continue to use the service normally. For
8+
* capabilities similar to FSx File Gateway, visit <a href="https://aws.amazon.com/blogs/storage/switch-your-file-share-access-from-amazon-fsx-file-gateway-to-amazon-fsx-for-windows-file-server/">this blog post</a>.</p>
9+
* </important>
510
* <p>Storage Gateway is the service that connects an on-premises software appliance
611
* with cloud-based storage to provide seamless and secure integration between an
712
* organization's on-premises IT environment and the Amazon Web Services storage

‎clients/client-storage-gateway/src/models/models_0.ts

+45-10
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,11 @@ export interface ActivateGatewayInput {
115115
* <p>A value that defines the type of gateway to activate. The type specified is critical to
116116
* all later functions of the gateway and cannot be changed after activation. The default
117117
* value is <code>CACHED</code>.</p>
118+
* <important>
119+
* <p>Amazon FSx File Gateway is no longer available to new customers. Existing
120+
* customers of FSx File Gateway can continue to use the service normally. For
121+
* capabilities similar to FSx File Gateway, visit <a href="https://aws.amazon.com/blogs/storage/switch-your-file-share-access-from-amazon-fsx-file-gateway-to-amazon-fsx-for-windows-file-server/">this blog post</a>.</p>
122+
* </important>
118123
* <p>Valid Values: <code>STORED</code> | <code>CACHED</code> | <code>VTL</code>
119124
* | <code>FILE_S3</code> |
120125
* <code>FILE_FSX_SMB</code>
@@ -822,10 +827,13 @@ export type AvailabilityMonitorTestStatus =
822827
(typeof AvailabilityMonitorTestStatus)[keyof typeof AvailabilityMonitorTestStatus];
823828

824829
/**
825-
* <p> Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit
826-
* schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit
827-
* interval defines a period of time on one or more days of the week, during which bandwidth
828-
* rate limits are specified for uploading, downloading, or both. </p>
830+
* <p>Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule
831+
* consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval
832+
* defines a period of time on one or more days of the week, during which bandwidth rate
833+
* limits are specified for uploading, downloading, or both.</p>
834+
* <note>
835+
* <p>FSx File Gateway does not support this feature.</p>
836+
* </note>
829837
* @public
830838
*/
831839
export interface BandwidthRateLimitInterval {
@@ -871,8 +879,8 @@ export interface BandwidthRateLimitInterval {
871879
* per second. This field does not appear in the response if the upload rate limit is not set. </p>
872880
* <note>
873881
* <p>For Tape Gateway and Volume Gateway, the minimum value is <code>51200</code>.</p>
874-
* <p>For S3 File Gateway and FSx File Gateway, the minimum value is
875-
* <code>104857600</code>.</p>
882+
* <p>This field is required for S3 File Gateway, and the minimum value is
883+
* <code>104857600</code>.</p>
876884
* </note>
877885
* @public
878886
*/
@@ -882,6 +890,9 @@ export interface BandwidthRateLimitInterval {
882890
* <p> The average download rate limit component of the bandwidth rate limit interval, in bits
883891
* per second. This field does not appear in the response if the download rate limit is not
884892
* set. </p>
893+
* <note>
894+
* <p>S3 File Gateway does not support this feature.</p>
895+
* </note>
885896
* @public
886897
*/
887898
AverageDownloadRateLimitInBitsPerSec?: number;
@@ -1425,7 +1436,7 @@ export interface CreateNFSFileShareInput {
14251436
* as shown in the following examples.</p>
14261437
* <p>Bucket ARN:</p>
14271438
* <p>
1428-
* <code>arn:aws:s3:::my-bucket/prefix/</code>
1439+
* <code>arn:aws:s3:::amzn-s3-demo-bucket/prefix/</code>
14291440
* </p>
14301441
* <p>Access point ARN:</p>
14311442
* <p>
@@ -1542,6 +1553,10 @@ export interface CreateNFSFileShareInput {
15421553
* <p>
15431554
* <code>FileShareName</code> must be set if an S3 prefix name is set in
15441555
* <code>LocationARN</code>, or if an access point or access point alias is used.</p>
1556+
* <p>A valid NFS file share name can only contain the following characters:
1557+
* <code>a</code>-<code>z</code>, <code>A</code>-<code>Z</code>,
1558+
* <code>0</code>-<code>9</code>, <code>-</code>, <code>.</code>, and
1559+
* <code>_</code>.</p>
15451560
* </note>
15461561
* @public
15471562
*/
@@ -1705,7 +1720,7 @@ export interface CreateSMBFileShareInput {
17051720
* as shown in the following examples.</p>
17061721
* <p>Bucket ARN:</p>
17071722
* <p>
1708-
* <code>arn:aws:s3:::my-bucket/prefix/</code>
1723+
* <code>arn:aws:s3:::amzn-s3-demo-bucket/prefix/</code>
17091724
* </p>
17101725
* <p>Access point ARN:</p>
17111726
* <p>
@@ -1871,6 +1886,9 @@ export interface CreateSMBFileShareInput {
18711886
* <p>
18721887
* <code>FileShareName</code> must be set if an S3 prefix name is set in
18731888
* <code>LocationARN</code>, or if an access point or access point alias is used.</p>
1889+
* <p>A valid SMB file share name cannot contain the following characters:
1890+
* <code>[</code>,<code>]</code>,<code>#</code>,<code>;</code>,<code><</code>,<code>></code>,<code>:</code>,<code>"</code>,<code>\</code>,<code>/</code>,<code>|</code>,<code>?</code>,<code>*</code>,<code>+</code>,
1891+
* or ASCII control characters <code>1-31</code>.</p>
18741892
* </note>
18751893
* @public
18761894
*/
@@ -3353,6 +3371,11 @@ export interface DescribeGatewayInformationOutput {
33533371

33543372
/**
33553373
* <p>The type of the gateway.</p>
3374+
* <important>
3375+
* <p>Amazon FSx File Gateway is no longer available to new customers. Existing
3376+
* customers of FSx File Gateway can continue to use the service normally. For
3377+
* capabilities similar to FSx File Gateway, visit <a href="https://aws.amazon.com/blogs/storage/switch-your-file-share-access-from-amazon-fsx-file-gateway-to-amazon-fsx-for-windows-file-server/">this blog post</a>.</p>
3378+
* </important>
33563379
* @public
33573380
*/
33583381
GatewayType?: string;
@@ -3728,7 +3751,7 @@ export interface NFSFileShareInfo {
37283751
* as shown in the following examples.</p>
37293752
* <p>Bucket ARN:</p>
37303753
* <p>
3731-
* <code>arn:aws:s3:::my-bucket/prefix/</code>
3754+
* <code>arn:aws:s3:::amzn-s3-demo-bucket/prefix/</code>
37323755
* </p>
37333756
* <p>Access point ARN:</p>
37343757
* <p>
@@ -4039,7 +4062,7 @@ export interface SMBFileShareInfo {
40394062
* as shown in the following examples.</p>
40404063
* <p>Bucket ARN:</p>
40414064
* <p>
4042-
* <code>arn:aws:s3:::my-bucket/prefix/</code>
4065+
* <code>arn:aws:s3:::amzn-s3-demo-bucket/prefix/</code>
40434066
* </p>
40444067
* <p>Access point ARN:</p>
40454068
* <p>
@@ -5621,6 +5644,11 @@ export interface GatewayInfo {
56215644

56225645
/**
56235646
* <p>The type of the gateway.</p>
5647+
* <important>
5648+
* <p>Amazon FSx File Gateway is no longer available to new customers. Existing
5649+
* customers of FSx File Gateway can continue to use the service normally. For
5650+
* capabilities similar to FSx File Gateway, visit <a href="https://aws.amazon.com/blogs/storage/switch-your-file-share-access-from-amazon-fsx-file-gateway-to-amazon-fsx-for-windows-file-server/">this blog post</a>.</p>
5651+
* </important>
56245652
* @public
56255653
*/
56265654
GatewayType?: string;
@@ -7478,6 +7506,10 @@ export interface UpdateNFSFileShareInput {
74787506
* <p>
74797507
* <code>FileShareName</code> must be set if an S3 prefix name is set in
74807508
* <code>LocationARN</code>, or if an access point or access point alias is used.</p>
7509+
* <p>A valid NFS file share name can only contain the following characters:
7510+
* <code>a</code>-<code>z</code>, <code>A</code>-<code>Z</code>,
7511+
* <code>0</code>-<code>9</code>, <code>-</code>, <code>.</code>, and
7512+
* <code>_</code>.</p>
74817513
* </note>
74827514
* @public
74837515
*/
@@ -7719,6 +7751,9 @@ export interface UpdateSMBFileShareInput {
77197751
* <p>
77207752
* <code>FileShareName</code> must be set if an S3 prefix name is set in
77217753
* <code>LocationARN</code>, or if an access point or access point alias is used.</p>
7754+
* <p>A valid SMB file share name cannot contain the following characters:
7755+
* <code>[</code>,<code>]</code>,<code>#</code>,<code>;</code>,<code><</code>,<code>></code>,<code>:</code>,<code>"</code>,<code>\</code>,<code>/</code>,<code>|</code>,<code>?</code>,<code>*</code>,<code>+</code>,
7756+
* or ASCII control characters <code>1-31</code>.</p>
77227757
* </note>
77237758
* @public
77247759
*/

0 commit comments

Comments
 (0)