@aws-sdk/client-storage-gateway 3.649.0 → 3.651.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (101) hide show
  1. package/dist-cjs/index.js +97 -270
  2. package/dist-es/commands/ActivateGatewayCommand.js +1 -3
  3. package/dist-es/commands/AddCacheCommand.js +1 -3
  4. package/dist-es/commands/AddTagsToResourceCommand.js +1 -3
  5. package/dist-es/commands/AddUploadBufferCommand.js +1 -3
  6. package/dist-es/commands/AddWorkingStorageCommand.js +1 -3
  7. package/dist-es/commands/AssignTapePoolCommand.js +1 -3
  8. package/dist-es/commands/AssociateFileSystemCommand.js +1 -3
  9. package/dist-es/commands/AttachVolumeCommand.js +1 -3
  10. package/dist-es/commands/CancelArchivalCommand.js +1 -3
  11. package/dist-es/commands/CancelRetrievalCommand.js +1 -3
  12. package/dist-es/commands/CreateCachediSCSIVolumeCommand.js +1 -3
  13. package/dist-es/commands/CreateNFSFileShareCommand.js +1 -3
  14. package/dist-es/commands/CreateSMBFileShareCommand.js +1 -3
  15. package/dist-es/commands/CreateSnapshotCommand.js +1 -3
  16. package/dist-es/commands/CreateSnapshotFromVolumeRecoveryPointCommand.js +1 -3
  17. package/dist-es/commands/CreateStorediSCSIVolumeCommand.js +1 -3
  18. package/dist-es/commands/CreateTapePoolCommand.js +1 -3
  19. package/dist-es/commands/CreateTapeWithBarcodeCommand.js +1 -3
  20. package/dist-es/commands/CreateTapesCommand.js +1 -3
  21. package/dist-es/commands/DeleteAutomaticTapeCreationPolicyCommand.js +1 -3
  22. package/dist-es/commands/DeleteBandwidthRateLimitCommand.js +1 -3
  23. package/dist-es/commands/DeleteChapCredentialsCommand.js +1 -3
  24. package/dist-es/commands/DeleteFileShareCommand.js +1 -3
  25. package/dist-es/commands/DeleteGatewayCommand.js +1 -3
  26. package/dist-es/commands/DeleteSnapshotScheduleCommand.js +1 -3
  27. package/dist-es/commands/DeleteTapeArchiveCommand.js +1 -3
  28. package/dist-es/commands/DeleteTapeCommand.js +1 -3
  29. package/dist-es/commands/DeleteTapePoolCommand.js +1 -3
  30. package/dist-es/commands/DeleteVolumeCommand.js +1 -3
  31. package/dist-es/commands/DescribeAvailabilityMonitorTestCommand.js +1 -3
  32. package/dist-es/commands/DescribeBandwidthRateLimitCommand.js +1 -3
  33. package/dist-es/commands/DescribeBandwidthRateLimitScheduleCommand.js +1 -3
  34. package/dist-es/commands/DescribeCacheCommand.js +1 -3
  35. package/dist-es/commands/DescribeCachediSCSIVolumesCommand.js +1 -3
  36. package/dist-es/commands/DescribeChapCredentialsCommand.js +1 -3
  37. package/dist-es/commands/DescribeFileSystemAssociationsCommand.js +1 -3
  38. package/dist-es/commands/DescribeGatewayInformationCommand.js +1 -3
  39. package/dist-es/commands/DescribeMaintenanceStartTimeCommand.js +1 -3
  40. package/dist-es/commands/DescribeNFSFileSharesCommand.js +1 -3
  41. package/dist-es/commands/DescribeSMBFileSharesCommand.js +1 -3
  42. package/dist-es/commands/DescribeSMBSettingsCommand.js +1 -3
  43. package/dist-es/commands/DescribeSnapshotScheduleCommand.js +1 -3
  44. package/dist-es/commands/DescribeStorediSCSIVolumesCommand.js +1 -3
  45. package/dist-es/commands/DescribeTapeArchivesCommand.js +1 -3
  46. package/dist-es/commands/DescribeTapeRecoveryPointsCommand.js +1 -3
  47. package/dist-es/commands/DescribeTapesCommand.js +1 -3
  48. package/dist-es/commands/DescribeUploadBufferCommand.js +1 -3
  49. package/dist-es/commands/DescribeVTLDevicesCommand.js +1 -3
  50. package/dist-es/commands/DescribeWorkingStorageCommand.js +1 -3
  51. package/dist-es/commands/DetachVolumeCommand.js +1 -3
  52. package/dist-es/commands/DisableGatewayCommand.js +1 -3
  53. package/dist-es/commands/DisassociateFileSystemCommand.js +1 -3
  54. package/dist-es/commands/JoinDomainCommand.js +1 -3
  55. package/dist-es/commands/ListAutomaticTapeCreationPoliciesCommand.js +1 -3
  56. package/dist-es/commands/ListFileSharesCommand.js +1 -3
  57. package/dist-es/commands/ListFileSystemAssociationsCommand.js +1 -3
  58. package/dist-es/commands/ListGatewaysCommand.js +1 -3
  59. package/dist-es/commands/ListLocalDisksCommand.js +1 -3
  60. package/dist-es/commands/ListTagsForResourceCommand.js +1 -3
  61. package/dist-es/commands/ListTapePoolsCommand.js +1 -3
  62. package/dist-es/commands/ListTapesCommand.js +1 -3
  63. package/dist-es/commands/ListVolumeInitiatorsCommand.js +1 -3
  64. package/dist-es/commands/ListVolumeRecoveryPointsCommand.js +1 -3
  65. package/dist-es/commands/ListVolumesCommand.js +1 -3
  66. package/dist-es/commands/NotifyWhenUploadedCommand.js +1 -3
  67. package/dist-es/commands/RefreshCacheCommand.js +1 -3
  68. package/dist-es/commands/RemoveTagsFromResourceCommand.js +1 -3
  69. package/dist-es/commands/ResetCacheCommand.js +1 -3
  70. package/dist-es/commands/RetrieveTapeArchiveCommand.js +1 -3
  71. package/dist-es/commands/RetrieveTapeRecoveryPointCommand.js +1 -3
  72. package/dist-es/commands/SetLocalConsolePasswordCommand.js +1 -3
  73. package/dist-es/commands/SetSMBGuestPasswordCommand.js +1 -3
  74. package/dist-es/commands/ShutdownGatewayCommand.js +1 -3
  75. package/dist-es/commands/StartAvailabilityMonitorTestCommand.js +1 -3
  76. package/dist-es/commands/StartGatewayCommand.js +1 -3
  77. package/dist-es/commands/UpdateAutomaticTapeCreationPolicyCommand.js +1 -3
  78. package/dist-es/commands/UpdateBandwidthRateLimitCommand.js +1 -3
  79. package/dist-es/commands/UpdateBandwidthRateLimitScheduleCommand.js +1 -3
  80. package/dist-es/commands/UpdateChapCredentialsCommand.js +1 -3
  81. package/dist-es/commands/UpdateFileSystemAssociationCommand.js +1 -3
  82. package/dist-es/commands/UpdateGatewayInformationCommand.js +1 -3
  83. package/dist-es/commands/UpdateGatewaySoftwareNowCommand.js +1 -3
  84. package/dist-es/commands/UpdateMaintenanceStartTimeCommand.js +1 -3
  85. package/dist-es/commands/UpdateNFSFileShareCommand.js +1 -3
  86. package/dist-es/commands/UpdateSMBFileShareCommand.js +1 -3
  87. package/dist-es/commands/UpdateSMBFileShareVisibilityCommand.js +1 -3
  88. package/dist-es/commands/UpdateSMBLocalGroupsCommand.js +1 -3
  89. package/dist-es/commands/UpdateSMBSecurityStrategyCommand.js +1 -3
  90. package/dist-es/commands/UpdateSnapshotScheduleCommand.js +1 -3
  91. package/dist-es/commands/UpdateVTLDeviceTypeCommand.js +1 -3
  92. package/dist-es/models/models_0.js +5 -0
  93. package/dist-types/commands/CreateNFSFileShareCommand.d.ts +1 -0
  94. package/dist-types/commands/CreateSMBFileShareCommand.d.ts +1 -0
  95. package/dist-types/commands/DescribeNFSFileSharesCommand.d.ts +1 -0
  96. package/dist-types/commands/DescribeSMBFileSharesCommand.d.ts +1 -0
  97. package/dist-types/commands/UpdateNFSFileShareCommand.d.ts +1 -0
  98. package/dist-types/commands/UpdateSMBFileShareCommand.d.ts +1 -0
  99. package/dist-types/models/models_0.d.ts +288 -54
  100. package/dist-types/ts3.4/models/models_0.d.ts +13 -0
  101. package/package.json +4 -4
@@ -905,8 +905,10 @@ export interface CachediSCSIVolume {
905
905
  */
906
906
  VolumeUsedInBytes?: number;
907
907
  /**
908
- * <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
909
- * value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
908
+ * <p>Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
909
+ * for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
910
+ * CMKs. This value must be set if <code>KMSEncrypted</code> is <code>true</code>, or if
911
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>.</p>
910
912
  * @public
911
913
  */
912
914
  KMSKey?: string;
@@ -1124,6 +1126,19 @@ export interface CreateCachediSCSIVolumeOutput {
1124
1126
  */
1125
1127
  TargetARN?: string;
1126
1128
  }
1129
+ /**
1130
+ * @public
1131
+ * @enum
1132
+ */
1133
+ export declare const EncryptionType: {
1134
+ readonly DsseKms: "DsseKms";
1135
+ readonly SseKms: "SseKms";
1136
+ readonly SseS3: "SseS3";
1137
+ };
1138
+ /**
1139
+ * @public
1140
+ */
1141
+ export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType];
1127
1142
  /**
1128
1143
  * <p>Describes Network File System (NFS) file share default values. Files and folders stored
1129
1144
  * as Amazon S3 objects in S3 buckets don't, by default, have Unix file
@@ -1199,17 +1214,48 @@ export interface CreateNFSFileShareInput {
1199
1214
  */
1200
1215
  GatewayARN: string | undefined;
1201
1216
  /**
1202
- * <p>Set to <code>true</code> to use Amazon S3 server-side encryption with your own
1203
- * KMS key, or <code>false</code> to use a key managed by Amazon S3.
1204
- * Optional.</p>
1217
+ * <p>A value that specifies the type of server-side encryption that the file share will use
1218
+ * for the data that it stores in Amazon S3.</p>
1219
+ * <note>
1220
+ * <p>We recommend using <code>EncryptionType</code> instead of <code>KMSEncrypted</code>
1221
+ * to set the file share encryption method. You do not need to provide values for both
1222
+ * parameters.</p>
1223
+ * <p>If values for both parameters exist in the same request, then the specified
1224
+ * encryption methods must not conflict. For example, if <code>EncryptionType</code> is
1225
+ * <code>SseS3</code>, then <code>KMSEncrypted</code> must be <code>false</code>. If
1226
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>, then
1227
+ * <code>KMSEncrypted</code> must be <code>true</code>.</p>
1228
+ * </note>
1229
+ * @public
1230
+ */
1231
+ EncryptionType?: EncryptionType;
1232
+ /**
1233
+ * @deprecated
1234
+ *
1235
+ * <p>Optional. Set to <code>true</code> to use Amazon S3 server-side encryption with
1236
+ * your own KMS key (SSE-KMS), or <code>false</code> to use a key managed by
1237
+ * Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the
1238
+ * <code>EncryptionType</code> parameter instead.</p>
1239
+ * <note>
1240
+ * <p>We recommend using <code>EncryptionType</code> instead of <code>KMSEncrypted</code>
1241
+ * to set the file share encryption method. You do not need to provide values for both
1242
+ * parameters.</p>
1243
+ * <p>If values for both parameters exist in the same request, then the specified
1244
+ * encryption methods must not conflict. For example, if <code>EncryptionType</code> is
1245
+ * <code>SseS3</code>, then <code>KMSEncrypted</code> must be <code>false</code>. If
1246
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>, then
1247
+ * <code>KMSEncrypted</code> must be <code>true</code>.</p>
1248
+ * </note>
1205
1249
  * <p>Valid Values: <code>true</code> | <code>false</code>
1206
1250
  * </p>
1207
1251
  * @public
1208
1252
  */
1209
1253
  KMSEncrypted?: boolean;
1210
1254
  /**
1211
- * <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
1212
- * value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
1255
+ * <p>Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
1256
+ * for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
1257
+ * CMKs. This value must be set if <code>KMSEncrypted</code> is <code>true</code>, or if
1258
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>.</p>
1213
1259
  * @public
1214
1260
  */
1215
1261
  KMSKey?: string;
@@ -1355,6 +1401,9 @@ export interface CreateNFSFileShareInput {
1355
1401
  * <p>
1356
1402
  * <code>SettlingTimeInSeconds</code> has no effect on the timing of the object
1357
1403
  * uploading to Amazon S3, only the timing of the notification.</p>
1404
+ * <p>This setting is not meant to specify an exact time at which the notification will be
1405
+ * sent. In some cases, the gateway might require more than the specified delay time to
1406
+ * generate and send notifications.</p>
1358
1407
  * </note>
1359
1408
  * <p>The following example sets <code>NotificationPolicy</code> on with
1360
1409
  * <code>SettlingTimeInSeconds</code> set to 60.</p>
@@ -1423,17 +1472,48 @@ export interface CreateSMBFileShareInput {
1423
1472
  */
1424
1473
  GatewayARN: string | undefined;
1425
1474
  /**
1426
- * <p>Set to <code>true</code> to use Amazon S3 server-side encryption with your own
1427
- * KMS key, or <code>false</code> to use a key managed by Amazon S3.
1428
- * Optional.</p>
1475
+ * <p>A value that specifies the type of server-side encryption that the file share will use
1476
+ * for the data that it stores in Amazon S3.</p>
1477
+ * <note>
1478
+ * <p>We recommend using <code>EncryptionType</code> instead of <code>KMSEncrypted</code>
1479
+ * to set the file share encryption method. You do not need to provide values for both
1480
+ * parameters.</p>
1481
+ * <p>If values for both parameters exist in the same request, then the specified
1482
+ * encryption methods must not conflict. For example, if <code>EncryptionType</code> is
1483
+ * <code>SseS3</code>, then <code>KMSEncrypted</code> must be <code>false</code>. If
1484
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>, then
1485
+ * <code>KMSEncrypted</code> must be <code>true</code>.</p>
1486
+ * </note>
1487
+ * @public
1488
+ */
1489
+ EncryptionType?: EncryptionType;
1490
+ /**
1491
+ * @deprecated
1492
+ *
1493
+ * <p>Optional. Set to <code>true</code> to use Amazon S3 server-side encryption with
1494
+ * your own KMS key (SSE-KMS), or <code>false</code> to use a key managed by
1495
+ * Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the
1496
+ * <code>EncryptionType</code> parameter instead.</p>
1497
+ * <note>
1498
+ * <p>We recommend using <code>EncryptionType</code> instead of <code>KMSEncrypted</code>
1499
+ * to set the file share encryption method. You do not need to provide values for both
1500
+ * parameters.</p>
1501
+ * <p>If values for both parameters exist in the same request, then the specified
1502
+ * encryption methods must not conflict. For example, if <code>EncryptionType</code> is
1503
+ * <code>SseS3</code>, then <code>KMSEncrypted</code> must be <code>false</code>. If
1504
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>, then
1505
+ * <code>KMSEncrypted</code> must be <code>true</code>.</p>
1506
+ * </note>
1429
1507
  * <p>Valid Values: <code>true</code> | <code>false</code>
1430
1508
  * </p>
1431
1509
  * @public
1432
1510
  */
1433
1511
  KMSEncrypted?: boolean;
1434
1512
  /**
1435
- * <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
1436
- * value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
1513
+ * <p>Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
1514
+ * for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
1515
+ * CMKs. This value must be set if <code>KMSEncrypted</code> is <code>true</code>, or if
1516
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>.</p>
1437
1517
  * @public
1438
1518
  */
1439
1519
  KMSKey?: string;
@@ -1520,9 +1600,9 @@ export interface CreateSMBFileShareInput {
1520
1600
  * <p>Set this value to <code>true</code> to enable access control list (ACL) on the SMB file
1521
1601
  * share. Set it to <code>false</code> to map file and directory permissions to the POSIX
1522
1602
  * permissions.</p>
1523
- * <p>For more information, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html">Using Microsoft Windows ACLs to
1524
- * control access to an SMB file share</a> in the <i>Storage Gateway User
1525
- * Guide</i>.</p>
1603
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/filegateway/latest/files3/smb-acl.html">Using Windows ACLs to limit SMB file share
1604
+ * access</a> in the <i>Amazon S3 File Gateway User
1605
+ * Guide</i>.</p>
1526
1606
  * <p>Valid Values: <code>true</code> | <code>false</code>
1527
1607
  * </p>
1528
1608
  * @public
@@ -1622,6 +1702,9 @@ export interface CreateSMBFileShareInput {
1622
1702
  * <p>
1623
1703
  * <code>SettlingTimeInSeconds</code> has no effect on the timing of the object
1624
1704
  * uploading to Amazon S3, only the timing of the notification.</p>
1705
+ * <p>This setting is not meant to specify an exact time at which the notification will be
1706
+ * sent. In some cases, the gateway might require more than the specified delay time to
1707
+ * generate and send notifications.</p>
1625
1708
  * </note>
1626
1709
  * <p>The following example sets <code>NotificationPolicy</code> on with
1627
1710
  * <code>SettlingTimeInSeconds</code> set to 60.</p>
@@ -3056,8 +3139,11 @@ export interface SoftwareUpdatePreferences {
3056
3139
  * <p>
3057
3140
  * <code>ALL_VERSIONS</code> - Enables regular gateway maintenance updates.</p>
3058
3141
  * <p>
3059
- * <code>EMERGENCY_VERSIONS_ONLY</code> - Disables regular gateway maintenance
3060
- * updates.</p>
3142
+ * <code>EMERGENCY_VERSIONS_ONLY</code> - Disables regular gateway maintenance updates. The
3143
+ * gateway will still receive emergency version updates on rare occasions if necessary to
3144
+ * remedy highly critical security or durability issues. You will be notified before an
3145
+ * emergency version update is applied. These updates are applied during your gateway's
3146
+ * scheduled maintenance window.</p>
3061
3147
  * @public
3062
3148
  */
3063
3149
  AutomaticUpdatePolicy?: AutomaticUpdatePolicy;
@@ -3141,12 +3227,15 @@ export interface DescribeMaintenanceStartTimeOutput {
3141
3227
  Timezone?: string;
3142
3228
  /**
3143
3229
  * <p>A set of variables indicating the software update preferences for the gateway.</p>
3144
- * <p>Includes <code>AutomaticUpdatePolicy</code> field with the following inputs:</p>
3230
+ * <p>Includes <code>AutomaticUpdatePolicy</code> parameter with the following inputs:</p>
3145
3231
  * <p>
3146
3232
  * <code>ALL_VERSIONS</code> - Enables regular gateway maintenance updates.</p>
3147
3233
  * <p>
3148
- * <code>EMERGENCY_VERSIONS_ONLY</code> - Disables regular gateway maintenance
3149
- * updates.</p>
3234
+ * <code>EMERGENCY_VERSIONS_ONLY</code> - Disables regular gateway maintenance updates. The
3235
+ * gateway will still receive emergency version updates on rare occasions if necessary to
3236
+ * remedy highly critical security or durability issues. You will be notified before an
3237
+ * emergency version update is applied. These updates are applied during your gateway's
3238
+ * scheduled maintenance window.</p>
3150
3239
  * @public
3151
3240
  */
3152
3241
  SoftwareUpdatePreferences?: SoftwareUpdatePreferences;
@@ -3204,17 +3293,48 @@ export interface NFSFileShareInfo {
3204
3293
  */
3205
3294
  GatewayARN?: string;
3206
3295
  /**
3207
- * <p>Set to <code>true</code> to use Amazon S3 server-side encryption with your own
3208
- * KMS key, or <code>false</code> to use a key managed by Amazon S3.
3209
- * Optional.</p>
3296
+ * <p>A value that specifies the type of server-side encryption that the file share will use
3297
+ * for the data that it stores in Amazon S3.</p>
3298
+ * <note>
3299
+ * <p>We recommend using <code>EncryptionType</code> instead of <code>KMSEncrypted</code>
3300
+ * to set the file share encryption method. You do not need to provide values for both
3301
+ * parameters.</p>
3302
+ * <p>If values for both parameters exist in the same request, then the specified
3303
+ * encryption methods must not conflict. For example, if <code>EncryptionType</code> is
3304
+ * <code>SseS3</code>, then <code>KMSEncrypted</code> must be <code>false</code>. If
3305
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>, then
3306
+ * <code>KMSEncrypted</code> must be <code>true</code>.</p>
3307
+ * </note>
3308
+ * @public
3309
+ */
3310
+ EncryptionType?: EncryptionType;
3311
+ /**
3312
+ * @deprecated
3313
+ *
3314
+ * <p>Optional. Set to <code>true</code> to use Amazon S3 server-side encryption with
3315
+ * your own KMS key (SSE-KMS), or <code>false</code> to use a key managed by
3316
+ * Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the
3317
+ * <code>EncryptionType</code> parameter instead.</p>
3318
+ * <note>
3319
+ * <p>We recommend using <code>EncryptionType</code> instead of <code>KMSEncrypted</code>
3320
+ * to set the file share encryption method. You do not need to provide values for both
3321
+ * parameters.</p>
3322
+ * <p>If values for both parameters exist in the same request, then the specified
3323
+ * encryption methods must not conflict. For example, if <code>EncryptionType</code> is
3324
+ * <code>SseS3</code>, then <code>KMSEncrypted</code> must be <code>false</code>. If
3325
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>, then
3326
+ * <code>KMSEncrypted</code> must be <code>true</code>.</p>
3327
+ * </note>
3210
3328
  * <p>Valid Values: <code>true</code> | <code>false</code>
3211
3329
  * </p>
3212
3330
  * @public
3213
3331
  */
3214
3332
  KMSEncrypted?: boolean;
3215
3333
  /**
3216
- * <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
3217
- * value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
3334
+ * <p>Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
3335
+ * for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
3336
+ * CMKs. This value must be set if <code>KMSEncrypted</code> is <code>true</code>, or if
3337
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>.</p>
3218
3338
  * @public
3219
3339
  */
3220
3340
  KMSKey?: string;
@@ -3360,6 +3480,9 @@ export interface NFSFileShareInfo {
3360
3480
  * <p>
3361
3481
  * <code>SettlingTimeInSeconds</code> has no effect on the timing of the object
3362
3482
  * uploading to Amazon S3, only the timing of the notification.</p>
3483
+ * <p>This setting is not meant to specify an exact time at which the notification will be
3484
+ * sent. In some cases, the gateway might require more than the specified delay time to
3485
+ * generate and send notifications.</p>
3363
3486
  * </note>
3364
3487
  * <p>The following example sets <code>NotificationPolicy</code> on with
3365
3488
  * <code>SettlingTimeInSeconds</code> set to 60.</p>
@@ -3455,17 +3578,48 @@ export interface SMBFileShareInfo {
3455
3578
  */
3456
3579
  GatewayARN?: string;
3457
3580
  /**
3458
- * <p>Set to <code>true</code> to use Amazon S3 server-side encryption with your own
3459
- * KMS key, or <code>false</code> to use a key managed by Amazon S3.
3460
- * Optional.</p>
3581
+ * <p>A value that specifies the type of server-side encryption that the file share will use
3582
+ * for the data that it stores in Amazon S3.</p>
3583
+ * <note>
3584
+ * <p>We recommend using <code>EncryptionType</code> instead of <code>KMSEncrypted</code>
3585
+ * to set the file share encryption method. You do not need to provide values for both
3586
+ * parameters.</p>
3587
+ * <p>If values for both parameters exist in the same request, then the specified
3588
+ * encryption methods must not conflict. For example, if <code>EncryptionType</code> is
3589
+ * <code>SseS3</code>, then <code>KMSEncrypted</code> must be <code>false</code>. If
3590
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>, then
3591
+ * <code>KMSEncrypted</code> must be <code>true</code>.</p>
3592
+ * </note>
3593
+ * @public
3594
+ */
3595
+ EncryptionType?: EncryptionType;
3596
+ /**
3597
+ * @deprecated
3598
+ *
3599
+ * <p>Optional. Set to <code>true</code> to use Amazon S3 server-side encryption with
3600
+ * your own KMS key (SSE-KMS), or <code>false</code> to use a key managed by
3601
+ * Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the
3602
+ * <code>EncryptionType</code> parameter instead.</p>
3603
+ * <note>
3604
+ * <p>We recommend using <code>EncryptionType</code> instead of <code>KMSEncrypted</code>
3605
+ * to set the file share encryption method. You do not need to provide values for both
3606
+ * parameters.</p>
3607
+ * <p>If values for both parameters exist in the same request, then the specified
3608
+ * encryption methods must not conflict. For example, if <code>EncryptionType</code> is
3609
+ * <code>SseS3</code>, then <code>KMSEncrypted</code> must be <code>false</code>. If
3610
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>, then
3611
+ * <code>KMSEncrypted</code> must be <code>true</code>.</p>
3612
+ * </note>
3461
3613
  * <p>Valid Values: <code>true</code> | <code>false</code>
3462
3614
  * </p>
3463
3615
  * @public
3464
3616
  */
3465
3617
  KMSEncrypted?: boolean;
3466
3618
  /**
3467
- * <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
3468
- * value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
3619
+ * <p>Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
3620
+ * for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
3621
+ * CMKs. This value must be set if <code>KMSEncrypted</code> is <code>true</code>, or if
3622
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>.</p>
3469
3623
  * @public
3470
3624
  */
3471
3625
  KMSKey?: string;
@@ -3558,9 +3712,9 @@ export interface SMBFileShareInfo {
3558
3712
  * <p>If this value is set to <code>true</code>, it indicates that access control list (ACL)
3559
3713
  * is enabled on the SMB file share. If it is set to <code>false</code>, it indicates that
3560
3714
  * file and directory permissions are mapped to the POSIX permission.</p>
3561
- * <p>For more information, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html">Using Microsoft Windows ACLs to
3562
- * control access to an SMB file share</a> in the <i>Storage Gateway User
3563
- * Guide</i>.</p>
3715
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/filegateway/latest/files3/smb-acl.html">Using Windows ACLs to limit SMB file share
3716
+ * access</a> in the <i>Amazon S3 File Gateway User
3717
+ * Guide</i>.</p>
3564
3718
  * @public
3565
3719
  */
3566
3720
  SMBACLEnabled?: boolean;
@@ -3649,6 +3803,9 @@ export interface SMBFileShareInfo {
3649
3803
  * <p>
3650
3804
  * <code>SettlingTimeInSeconds</code> has no effect on the timing of the object
3651
3805
  * uploading to Amazon S3, only the timing of the notification.</p>
3806
+ * <p>This setting is not meant to specify an exact time at which the notification will be
3807
+ * sent. In some cases, the gateway might require more than the specified delay time to
3808
+ * generate and send notifications.</p>
3652
3809
  * </note>
3653
3810
  * <p>The following example sets <code>NotificationPolicy</code> on with
3654
3811
  * <code>SettlingTimeInSeconds</code> set to 60.</p>
@@ -4015,8 +4172,10 @@ export interface StorediSCSIVolume {
4015
4172
  */
4016
4173
  VolumeUsedInBytes?: number;
4017
4174
  /**
4018
- * <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
4019
- * value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
4175
+ * <p>Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
4176
+ * for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
4177
+ * CMKs. This value must be set if <code>KMSEncrypted</code> is <code>true</code>, or if
4178
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>.</p>
4020
4179
  * @public
4021
4180
  */
4022
4181
  KMSKey?: string;
@@ -4201,8 +4360,10 @@ export interface TapeArchive {
4201
4360
  */
4202
4361
  TapeUsedInBytes?: number;
4203
4362
  /**
4204
- * <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
4205
- * value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
4363
+ * <p>Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
4364
+ * for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
4365
+ * CMKs. This value must be set if <code>KMSEncrypted</code> is <code>true</code>, or if
4366
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>.</p>
4206
4367
  * @public
4207
4368
  */
4208
4369
  KMSKey?: string;
@@ -4419,8 +4580,10 @@ export interface Tape {
4419
4580
  */
4420
4581
  TapeUsedInBytes?: number;
4421
4582
  /**
4422
- * <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
4423
- * value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
4583
+ * <p>Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
4584
+ * for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
4585
+ * CMKs. This value must be set if <code>KMSEncrypted</code> is <code>true</code>, or if
4586
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>.</p>
4424
4587
  * @public
4425
4588
  */
4426
4589
  KMSKey?: string;
@@ -6423,8 +6586,11 @@ export interface UpdateMaintenanceStartTimeInput {
6423
6586
  * <p>
6424
6587
  * <code>ALL_VERSIONS</code> - Enables regular gateway maintenance updates.</p>
6425
6588
  * <p>
6426
- * <code>EMERGENCY_VERSIONS_ONLY</code> - Disables regular gateway maintenance
6427
- * updates.</p>
6589
+ * <code>EMERGENCY_VERSIONS_ONLY</code> - Disables regular gateway maintenance updates. The
6590
+ * gateway will still receive emergency version updates on rare occasions if necessary to
6591
+ * remedy highly critical security or durability issues. You will be notified before an
6592
+ * emergency version update is applied. These updates are applied during your gateway's
6593
+ * scheduled maintenance window.</p>
6428
6594
  * @public
6429
6595
  */
6430
6596
  SoftwareUpdatePreferences?: SoftwareUpdatePreferences;
@@ -6453,17 +6619,48 @@ export interface UpdateNFSFileShareInput {
6453
6619
  */
6454
6620
  FileShareARN: string | undefined;
6455
6621
  /**
6456
- * <p>Set to <code>true</code> to use Amazon S3 server-side encryption with your own
6457
- * KMS key, or <code>false</code> to use a key managed by Amazon S3.
6458
- * Optional.</p>
6622
+ * <p>A value that specifies the type of server-side encryption that the file share will use
6623
+ * for the data that it stores in Amazon S3.</p>
6624
+ * <note>
6625
+ * <p>We recommend using <code>EncryptionType</code> instead of <code>KMSEncrypted</code>
6626
+ * to set the file share encryption method. You do not need to provide values for both
6627
+ * parameters.</p>
6628
+ * <p>If values for both parameters exist in the same request, then the specified
6629
+ * encryption methods must not conflict. For example, if <code>EncryptionType</code> is
6630
+ * <code>SseS3</code>, then <code>KMSEncrypted</code> must be <code>false</code>. If
6631
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>, then
6632
+ * <code>KMSEncrypted</code> must be <code>true</code>.</p>
6633
+ * </note>
6634
+ * @public
6635
+ */
6636
+ EncryptionType?: EncryptionType;
6637
+ /**
6638
+ * @deprecated
6639
+ *
6640
+ * <p>Optional. Set to <code>true</code> to use Amazon S3 server-side encryption with
6641
+ * your own KMS key (SSE-KMS), or <code>false</code> to use a key managed by
6642
+ * Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the
6643
+ * <code>EncryptionType</code> parameter instead.</p>
6644
+ * <note>
6645
+ * <p>We recommend using <code>EncryptionType</code> instead of <code>KMSEncrypted</code>
6646
+ * to set the file share encryption method. You do not need to provide values for both
6647
+ * parameters.</p>
6648
+ * <p>If values for both parameters exist in the same request, then the specified
6649
+ * encryption methods must not conflict. For example, if <code>EncryptionType</code> is
6650
+ * <code>SseS3</code>, then <code>KMSEncrypted</code> must be <code>false</code>. If
6651
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>, then
6652
+ * <code>KMSEncrypted</code> must be <code>true</code>.</p>
6653
+ * </note>
6459
6654
  * <p>Valid Values: <code>true</code> | <code>false</code>
6460
6655
  * </p>
6461
6656
  * @public
6462
6657
  */
6463
6658
  KMSEncrypted?: boolean;
6464
6659
  /**
6465
- * <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
6466
- * value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
6660
+ * <p>Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
6661
+ * for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
6662
+ * CMKs. This value must be set if <code>KMSEncrypted</code> is <code>true</code>, or if
6663
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>.</p>
6467
6664
  * @public
6468
6665
  */
6469
6666
  KMSKey?: string;
@@ -6571,6 +6768,9 @@ export interface UpdateNFSFileShareInput {
6571
6768
  * <p>
6572
6769
  * <code>SettlingTimeInSeconds</code> has no effect on the timing of the object
6573
6770
  * uploading to Amazon S3, only the timing of the notification.</p>
6771
+ * <p>This setting is not meant to specify an exact time at which the notification will be
6772
+ * sent. In some cases, the gateway might require more than the specified delay time to
6773
+ * generate and send notifications.</p>
6574
6774
  * </note>
6575
6775
  * <p>The following example sets <code>NotificationPolicy</code> on with
6576
6776
  * <code>SettlingTimeInSeconds</code> set to 60.</p>
@@ -6612,17 +6812,48 @@ export interface UpdateSMBFileShareInput {
6612
6812
  */
6613
6813
  FileShareARN: string | undefined;
6614
6814
  /**
6615
- * <p>Set to <code>true</code> to use Amazon S3 server-side encryption with your own
6616
- * KMS key, or <code>false</code> to use a key managed by Amazon S3.
6617
- * Optional.</p>
6815
+ * <p>A value that specifies the type of server-side encryption that the file share will use
6816
+ * for the data that it stores in Amazon S3.</p>
6817
+ * <note>
6818
+ * <p>We recommend using <code>EncryptionType</code> instead of <code>KMSEncrypted</code>
6819
+ * to set the file share encryption method. You do not need to provide values for both
6820
+ * parameters.</p>
6821
+ * <p>If values for both parameters exist in the same request, then the specified
6822
+ * encryption methods must not conflict. For example, if <code>EncryptionType</code> is
6823
+ * <code>SseS3</code>, then <code>KMSEncrypted</code> must be <code>false</code>. If
6824
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>, then
6825
+ * <code>KMSEncrypted</code> must be <code>true</code>.</p>
6826
+ * </note>
6827
+ * @public
6828
+ */
6829
+ EncryptionType?: EncryptionType;
6830
+ /**
6831
+ * @deprecated
6832
+ *
6833
+ * <p>Optional. Set to <code>true</code> to use Amazon S3 server-side encryption with
6834
+ * your own KMS key (SSE-KMS), or <code>false</code> to use a key managed by
6835
+ * Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the
6836
+ * <code>EncryptionType</code> parameter instead.</p>
6837
+ * <note>
6838
+ * <p>We recommend using <code>EncryptionType</code> instead of <code>KMSEncrypted</code>
6839
+ * to set the file share encryption method. You do not need to provide values for both
6840
+ * parameters.</p>
6841
+ * <p>If values for both parameters exist in the same request, then the specified
6842
+ * encryption methods must not conflict. For example, if <code>EncryptionType</code> is
6843
+ * <code>SseS3</code>, then <code>KMSEncrypted</code> must be <code>false</code>. If
6844
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>, then
6845
+ * <code>KMSEncrypted</code> must be <code>true</code>.</p>
6846
+ * </note>
6618
6847
  * <p>Valid Values: <code>true</code> | <code>false</code>
6619
6848
  * </p>
6620
6849
  * @public
6621
6850
  */
6622
6851
  KMSEncrypted?: boolean;
6623
6852
  /**
6624
- * <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
6625
- * value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
6853
+ * <p>Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used
6854
+ * for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric
6855
+ * CMKs. This value must be set if <code>KMSEncrypted</code> is <code>true</code>, or if
6856
+ * <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>.</p>
6626
6857
  * @public
6627
6858
  */
6628
6859
  KMSKey?: string;
@@ -6678,9 +6909,9 @@ export interface UpdateSMBFileShareInput {
6678
6909
  * <p>Set this value to <code>true</code> to enable access control list (ACL) on the SMB file
6679
6910
  * share. Set it to <code>false</code> to map file and directory permissions to the POSIX
6680
6911
  * permissions.</p>
6681
- * <p>For more information, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html">Using Microsoft Windows ACLs to
6682
- * control access to an SMB file share</a> in the <i>Storage Gateway User
6683
- * Guide</i>.</p>
6912
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/filegateway/latest/files3/smb-acl.html">Using Windows ACLs to limit SMB file share
6913
+ * access</a> in the <i>Amazon S3 File Gateway User
6914
+ * Guide</i>.</p>
6684
6915
  * <p>Valid Values: <code>true</code> | <code>false</code>
6685
6916
  * </p>
6686
6917
  * @public
@@ -6757,6 +6988,9 @@ export interface UpdateSMBFileShareInput {
6757
6988
  * <p>
6758
6989
  * <code>SettlingTimeInSeconds</code> has no effect on the timing of the object
6759
6990
  * uploading to Amazon S3, only the timing of the notification.</p>
6991
+ * <p>This setting is not meant to specify an exact time at which the notification will be
6992
+ * sent. In some cases, the gateway might require more than the specified delay time to
6993
+ * generate and send notifications.</p>
6760
6994
  * </note>
6761
6995
  * <p>The following example sets <code>NotificationPolicy</code> on with
6762
6996
  * <code>SettlingTimeInSeconds</code> set to 60.</p>
@@ -277,6 +277,13 @@ export interface CreateCachediSCSIVolumeOutput {
277
277
  VolumeARN?: string;
278
278
  TargetARN?: string;
279
279
  }
280
+ export declare const EncryptionType: {
281
+ readonly DsseKms: "DsseKms";
282
+ readonly SseKms: "SseKms";
283
+ readonly SseS3: "SseS3";
284
+ };
285
+ export type EncryptionType =
286
+ (typeof EncryptionType)[keyof typeof EncryptionType];
280
287
  export interface NFSFileShareDefaults {
281
288
  FileMode?: string;
282
289
  DirectoryMode?: string;
@@ -297,6 +304,7 @@ export interface CreateNFSFileShareInput {
297
304
  ClientToken: string | undefined;
298
305
  NFSFileShareDefaults?: NFSFileShareDefaults;
299
306
  GatewayARN: string | undefined;
307
+ EncryptionType?: EncryptionType;
300
308
  KMSEncrypted?: boolean;
301
309
  KMSKey?: string;
302
310
  Role: string | undefined;
@@ -322,6 +330,7 @@ export interface CreateNFSFileShareOutput {
322
330
  export interface CreateSMBFileShareInput {
323
331
  ClientToken: string | undefined;
324
332
  GatewayARN: string | undefined;
333
+ EncryptionType?: EncryptionType;
325
334
  KMSEncrypted?: boolean;
326
335
  KMSKey?: string;
327
336
  Role: string | undefined;
@@ -651,6 +660,7 @@ export interface NFSFileShareInfo {
651
660
  FileShareId?: string;
652
661
  FileShareStatus?: string;
653
662
  GatewayARN?: string;
663
+ EncryptionType?: EncryptionType;
654
664
  KMSEncrypted?: boolean;
655
665
  KMSKey?: string;
656
666
  Path?: string;
@@ -682,6 +692,7 @@ export interface SMBFileShareInfo {
682
692
  FileShareId?: string;
683
693
  FileShareStatus?: string;
684
694
  GatewayARN?: string;
695
+ EncryptionType?: EncryptionType;
685
696
  KMSEncrypted?: boolean;
686
697
  KMSKey?: string;
687
698
  Path?: string;
@@ -1226,6 +1237,7 @@ export interface UpdateMaintenanceStartTimeOutput {
1226
1237
  }
1227
1238
  export interface UpdateNFSFileShareInput {
1228
1239
  FileShareARN: string | undefined;
1240
+ EncryptionType?: EncryptionType;
1229
1241
  KMSEncrypted?: boolean;
1230
1242
  KMSKey?: string;
1231
1243
  NFSFileShareDefaults?: NFSFileShareDefaults;
@@ -1246,6 +1258,7 @@ export interface UpdateNFSFileShareOutput {
1246
1258
  }
1247
1259
  export interface UpdateSMBFileShareInput {
1248
1260
  FileShareARN: string | undefined;
1261
+ EncryptionType?: EncryptionType;
1249
1262
  KMSEncrypted?: boolean;
1250
1263
  KMSKey?: string;
1251
1264
  DefaultStorageClass?: string;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-storage-gateway",
3
3
  "description": "AWS SDK for JavaScript Storage Gateway Client for Node.js, Browser and React Native",
4
- "version": "3.649.0",
4
+ "version": "3.651.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-storage-gateway",
@@ -20,10 +20,10 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/client-sso-oidc": "3.649.0",
24
- "@aws-sdk/client-sts": "3.649.0",
23
+ "@aws-sdk/client-sso-oidc": "3.650.0",
24
+ "@aws-sdk/client-sts": "3.650.0",
25
25
  "@aws-sdk/core": "3.649.0",
26
- "@aws-sdk/credential-provider-node": "3.649.0",
26
+ "@aws-sdk/credential-provider-node": "3.650.0",
27
27
  "@aws-sdk/middleware-host-header": "3.649.0",
28
28
  "@aws-sdk/middleware-logger": "3.649.0",
29
29
  "@aws-sdk/middleware-recursion-detection": "3.649.0",