aws-sdk-storagegateway 1.42.1 → 1.47.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 11c17ff9df661fa81c697645f68eae6a17888414d5548c2b56b85ae582e82c56
4
- data.tar.gz: 3854e6f2b126eb667b76bb40d84ad29df0e29f7454d7680f746ab69175a018c7
3
+ metadata.gz: 1ad78eee66ee3ffcd55e69eed29c73d23c0ace6d1d7d8349c42d89470ebb6a4f
4
+ data.tar.gz: cf7b2b3b56f11375dd9fc74ee40855d81f7ec299f615df0346da88d6b1ae192c
5
5
  SHA512:
6
- metadata.gz: 6caa37736a42e977b2b336a60317c306d507727fe057c2584d2315a742344e7d04a8afc3171a65d56c1ec8c6a90b9857cdbbbd32329d571f1c5d79863114f805
7
- data.tar.gz: ad06c77ab2d773895e737b9c086d0c6245aa849960553004c9d6c028ec42b6846defa34927961091f3811fb7f97fbcd64eae8582a915304715f7f6bea555de92
6
+ metadata.gz: db52d9da9c84e28ba2349b9c34f9483ece3861ce600418022e9875054a171991f38280a686b3f20d38be11f476a9150d6f6b10b4ef78fa501e01804fe9c661fe
7
+ data.tar.gz: ac06897cf67cd637281e04e99e24d7df6df687e968e1a31ccb864d4aa39fdb95ad62cb0abab18eb35037ea919d02048b5ba83c7dc6958fc8d0602fa151028797
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -45,6 +47,6 @@ require_relative 'aws-sdk-storagegateway/customizations'
45
47
  # @service
46
48
  module Aws::StorageGateway
47
49
 
48
- GEM_VERSION = '1.42.1'
50
+ GEM_VERSION = '1.47.0'
49
51
 
50
52
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -325,7 +327,7 @@ module Aws::StorageGateway
325
327
  # that you want to use for storing snapshots or tapes, the time zone for
326
328
  # scheduled snapshots the gateway snapshot schedule window, an
327
329
  # activation key, and a name for your gateway. The activation process
328
- # also associates your gateway with your account; for more information,
330
+ # also associates your gateway with your account. For more information,
329
331
  # see UpdateGatewayInformation.
330
332
  #
331
333
  # <note markdown="1"> You must turn on the gateway VM before you can activate your gateway.
@@ -342,9 +344,12 @@ module Aws::StorageGateway
342
344
  # pass to the `ActivateGateway` API call determine the actual
343
345
  # configuration of your gateway.
344
346
  #
345
- # For more information, see
346
- # https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html
347
- # in the Storage Gateway User Guide.
347
+ # For more information, see [Getting activation key][1] in the *AWS
348
+ # Storage Gateway User Guide*.
349
+ #
350
+ #
351
+ #
352
+ # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html
348
353
  #
349
354
  # @option params [required, String] :gateway_name
350
355
  # The name you configured for your gateway.
@@ -362,34 +367,34 @@ module Aws::StorageGateway
362
367
  # data. The gateway AWS Region specified must be the same AWS Region as
363
368
  # the AWS Region in your `Host` header in the request. For more
364
369
  # information about available AWS Regions and endpoints for AWS Storage
365
- # Gateway, see [Regions and Endpoints][1] in the *Amazon Web Services
366
- # Glossary*.
370
+ # Gateway, see [AWS Storage Gateway endpoints and quotas][1] in the *AWS
371
+ # General Reference*.
367
372
  #
368
- # Valid Values: See [AWS Storage Gateway Regions and Endpoints][1] in
369
- # the AWS General Reference.
373
+ # Valid Values: See [AWS Storage Gateway endpoints and quotas][1] in the
374
+ # *AWS General Reference*.
370
375
  #
371
376
  #
372
377
  #
373
- # [1]: https://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region
378
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/sg.html
374
379
  #
375
380
  # @option params [String] :gateway_type
376
381
  # A value that defines the type of gateway to activate. The type
377
382
  # specified is critical to all later functions of the gateway and cannot
378
383
  # be changed after activation. The default value is `CACHED`.
379
384
  #
380
- # Valid Values: "STORED", "CACHED", "VTL", "FILE\_S3"
385
+ # Valid Values: `STORED` \| `CACHED` \| `VTL` \| `FILE_S3`
381
386
  #
382
387
  # @option params [String] :tape_drive_type
383
388
  # The value that indicates the type of tape drive to use for tape
384
389
  # gateway. This field is optional.
385
390
  #
386
- # Valid Values: "IBM-ULT3580-TD5"
391
+ # Valid Values: `IBM-ULT3580-TD5`
387
392
  #
388
393
  # @option params [String] :medium_changer_type
389
394
  # The value that indicates the type of medium changer to use for tape
390
395
  # gateway. This field is optional.
391
396
  #
392
- # Valid Values: "STK-L700", "AWS-Gateway-VTL"
397
+ # Valid Values: `STK-L700` \| `AWS-Gateway-VTL` \| `IBM-03584L32-0402`
393
398
  #
394
399
  # @option params [Array<Types::Tag>] :tags
395
400
  # A list of up to 50 tags that you can assign to the gateway. Each tag
@@ -459,8 +464,8 @@ module Aws::StorageGateway
459
464
  end
460
465
 
461
466
  # Configures one or more gateway local disks as cache for a gateway.
462
- # This operation is only supported in the cached volume, tape and file
463
- # gateway type (see [Storage Gateway Concepts][1]).
467
+ # This operation is only supported in the cached volume, tape, and file
468
+ # gateway type (see [How AWS Storage Gateway works (architecture)][1].
464
469
  #
465
470
  # In the request, you specify the gateway Amazon Resource Name (ARN) to
466
471
  # which you want to add cache, and one or more disk IDs that you want to
@@ -739,7 +744,7 @@ module Aws::StorageGateway
739
744
  # is archived directly into the S3 storage class (S3 Glacier or S3
740
745
  # Glacier Deep Archive) that corresponds to the pool.
741
746
  #
742
- # Valid values: "GLACIER", "DEEP\_ARCHIVE"
747
+ # Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
743
748
  #
744
749
  # @option params [required, String] :tape_arn
745
750
  # The unique Amazon Resource Name (ARN) of the virtual tape that you
@@ -752,7 +757,17 @@ module Aws::StorageGateway
752
757
  # eject the tape, the tape is archived directly into the storage class
753
758
  # (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
754
759
  #
755
- # Valid values: "GLACIER", "DEEP\_ARCHIVE"
760
+ # Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
761
+ #
762
+ # @option params [Boolean] :bypass_governance_retention
763
+ # Set permissions to bypass governance retention. If the lock type of
764
+ # the archived tape is `Governance`, the tape's archived age is not
765
+ # older than `RetentionLockInDays`, and the user does not already have
766
+ # `BypassGovernanceRetention`, setting this to TRUE enables the user to
767
+ # bypass the retention lock. This parameter is set to true by default
768
+ # for calls from the console.
769
+ #
770
+ # Valid values: `TRUE` \| `FALSE`
756
771
  #
757
772
  # @return [Types::AssignTapePoolOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
758
773
  #
@@ -763,6 +778,7 @@ module Aws::StorageGateway
763
778
  # resp = client.assign_tape_pool({
764
779
  # tape_arn: "TapeARN", # required
765
780
  # pool_id: "PoolId", # required
781
+ # bypass_governance_retention: false,
766
782
  # })
767
783
  #
768
784
  # @example Response structure
@@ -983,7 +999,7 @@ module Aws::StorageGateway
983
999
  # @option params [String] :snapshot_id
984
1000
  # The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as
985
1001
  # the new cached volume. Specify this field if you want to create the
986
- # iSCSI storage volume from a snapshot otherwise do not include this
1002
+ # iSCSI storage volume from a snapshot; otherwise, do not include this
987
1003
  # field. To list snapshots for your account use [DescribeSnapshots][1]
988
1004
  # in the *Amazon Elastic Compute Cloud API Reference*.
989
1005
  #
@@ -1021,13 +1037,16 @@ module Aws::StorageGateway
1021
1037
  # request.
1022
1038
  #
1023
1039
  # @option params [Boolean] :kms_encrypted
1024
- # True to use Amazon S3 server-side encryption with your own AWS KMS
1025
- # key, or false to use a key managed by Amazon S3. Optional.
1040
+ # Set to `true` to use Amazon S3 server-side encryption with your own
1041
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1042
+ #
1043
+ # Valid Values: `true` \| `false`
1026
1044
  #
1027
1045
  # @option params [String] :kms_key
1028
- # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
1029
- # server-side encryption. This value can only be set when KMSEncrypted
1030
- # is true. Optional.
1046
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
1047
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
1048
+ # not support asymmetric CMKs. This value can only be set when
1049
+ # `KMSEncrypted` is `true`. Optional.
1031
1050
  #
1032
1051
  # @option params [Array<Types::Tag>] :tags
1033
1052
  # A list of up to 50 tags that you can assign to a cached volume. Each
@@ -1110,13 +1129,17 @@ module Aws::StorageGateway
1110
1129
  # activated to enable you to create a file share. Make sure AWS STS is
1111
1130
  # activated in the AWS Region you are creating your file gateway in. If
1112
1131
  # AWS STS is not activated in the AWS Region, activate it. For
1113
- # information about how to activate AWS STS, see Activating and
1114
- # Deactivating AWS STS in an AWS Region in the AWS Identity and Access
1115
- # Management User Guide.
1132
+ # information about how to activate AWS STS, see [Activating and
1133
+ # deactivating AWS STS in an AWS Region][1] in the *AWS Identity and
1134
+ # Access Management User Guide*.
1116
1135
  #
1117
1136
  # File gateway does not support creating hard or symbolic links on a
1118
1137
  # file share.
1119
1138
  #
1139
+ #
1140
+ #
1141
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html
1142
+ #
1120
1143
  # @option params [required, String] :client_token
1121
1144
  # A unique string value that you supply that is used by file gateway to
1122
1145
  # ensure idempotent file share creation.
@@ -1129,61 +1152,72 @@ module Aws::StorageGateway
1129
1152
  # to create a file share.
1130
1153
  #
1131
1154
  # @option params [Boolean] :kms_encrypted
1132
- # True to use Amazon S3 server-side encryption with your own AWS KMS
1133
- # key, or false to use a key managed by Amazon S3. Optional.
1155
+ # Set to `true` to use Amazon S3 server-side encryption with your own
1156
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1157
+ #
1158
+ # Valid Values: `true` \| `false`
1134
1159
  #
1135
1160
  # @option params [String] :kms_key
1136
- # The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3
1137
- # server-side encryption. This value can only be set when KMSEncrypted
1138
- # is true. Optional.
1161
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
1162
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
1163
+ # not support asymmetric CMKs. This value can only be set when
1164
+ # `KMSEncrypted` is `true`. Optional.
1139
1165
  #
1140
1166
  # @option params [required, String] :role
1141
1167
  # The ARN of the AWS Identity and Access Management (IAM) role that a
1142
1168
  # file gateway assumes when it accesses the underlying storage.
1143
1169
  #
1144
1170
  # @option params [required, String] :location_arn
1145
- # The ARN of the backed storage used for storing file data.
1171
+ # The ARN of the backend storage used for storing file data. A prefix
1172
+ # name can be added to the S3 bucket name. It must end with a "/".
1146
1173
  #
1147
1174
  # @option params [String] :default_storage_class
1148
1175
  # The default storage class for objects put into an Amazon S3 bucket by
1149
- # the file gateway. Possible values are `S3_STANDARD`, `S3_STANDARD_IA`,
1150
- # or `S3_ONEZONE_IA`. If this field is not populated, the default value
1151
- # `S3_STANDARD` is used. Optional.
1176
+ # the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
1177
+ # Optional.
1178
+ #
1179
+ # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
1180
+ # `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
1152
1181
  #
1153
1182
  # @option params [String] :object_acl
1154
- # A value that sets the access control list permission for objects in
1155
- # the S3 bucket that a file gateway puts objects into. The default value
1156
- # is "private".
1183
+ # A value that sets the access control list (ACL) permission for objects
1184
+ # in the S3 bucket that a file gateway puts objects into. The default
1185
+ # value is `private`.
1157
1186
  #
1158
1187
  # @option params [Array<String>] :client_list
1159
1188
  # The list of clients that are allowed to access the file gateway. The
1160
1189
  # list must contain either valid IP addresses or valid CIDR blocks.
1161
1190
  #
1162
1191
  # @option params [String] :squash
1163
- # A value that maps a user to anonymous user. Valid options are the
1164
- # following:
1192
+ # A value that maps a user to anonymous user.
1165
1193
  #
1166
- # * `RootSquash` - Only root is mapped to anonymous user.
1194
+ # Valid values are the following:
1167
1195
  #
1168
- # * `NoSquash` - No one is mapped to anonymous user
1196
+ # * `RootSquash`\: Only root is mapped to anonymous user.
1169
1197
  #
1170
- # * `AllSquash` - Everyone is mapped to anonymous user.
1198
+ # * `NoSquash`\: No one is mapped to anonymous user.
1199
+ #
1200
+ # * `AllSquash`\: Everyone is mapped to anonymous user.
1171
1201
  #
1172
1202
  # @option params [Boolean] :read_only
1173
- # A value that sets the write status of a file share. This value is true
1174
- # if the write status is read-only, and otherwise false.
1203
+ # A value that sets the write status of a file share. Set this value to
1204
+ # `true` to set the write status to read-only, otherwise set to `false`.
1205
+ #
1206
+ # Valid Values: `true` \| `false`
1175
1207
  #
1176
1208
  # @option params [Boolean] :guess_mime_type_enabled
1177
1209
  # A value that enables guessing of the MIME type for uploaded objects
1178
- # based on file extensions. Set this value to true to enable MIME type
1179
- # guessing, and otherwise to false. The default value is true.
1210
+ # based on file extensions. Set this value to `true` to enable MIME type
1211
+ # guessing, otherwise set to `false`. The default value is `true`.
1212
+ #
1213
+ # Valid Values: `true` \| `false`
1180
1214
  #
1181
1215
  # @option params [Boolean] :requester_pays
1182
1216
  # A value that sets who pays the cost of the request and the cost
1183
1217
  # associated with data download from the S3 bucket. If this value is set
1184
- # to true, the requester pays the costs. Otherwise the S3 bucket owner
1185
- # pays. However, the S3 bucket owner always pays the cost of storing
1186
- # data.
1218
+ # to `true`, the requester pays the costs; otherwise, the S3 bucket
1219
+ # owner pays. However, the S3 bucket owner always pays the cost of
1220
+ # storing data.
1187
1221
  #
1188
1222
  # <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
1189
1223
  # file share, so make sure that the configuration on the file share is
@@ -1191,6 +1225,8 @@ module Aws::StorageGateway
1191
1225
  #
1192
1226
  # </note>
1193
1227
  #
1228
+ # Valid Values: `true` \| `false`
1229
+ #
1194
1230
  # @option params [Array<Types::Tag>] :tags
1195
1231
  # A list of up to 50 tags that can be assigned to the NFS file share.
1196
1232
  # Each tag is a key-value pair.
@@ -1202,6 +1238,17 @@ module Aws::StorageGateway
1202
1238
  #
1203
1239
  # </note>
1204
1240
  #
1241
+ # @option params [String] :file_share_name
1242
+ # The name of the file share. Optional.
1243
+ #
1244
+ # <note markdown="1"> `FileShareName` must be set if an S3 prefix name is set in
1245
+ # `LocationARN`.
1246
+ #
1247
+ # </note>
1248
+ #
1249
+ # @option params [Types::CacheAttributes] :cache_attributes
1250
+ # Refresh cache information.
1251
+ #
1205
1252
  # @return [Types::CreateNFSFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1206
1253
  #
1207
1254
  # * {Types::CreateNFSFileShareOutput#file_share_arn #file_share_arn} => String
@@ -1234,6 +1281,10 @@ module Aws::StorageGateway
1234
1281
  # value: "TagValue", # required
1235
1282
  # },
1236
1283
  # ],
1284
+ # file_share_name: "FileShareName",
1285
+ # cache_attributes: {
1286
+ # cache_stale_timeout_in_seconds: 1,
1287
+ # },
1237
1288
  # })
1238
1289
  #
1239
1290
  # @example Response structure
@@ -1251,7 +1302,7 @@ module Aws::StorageGateway
1251
1302
 
1252
1303
  # Creates a Server Message Block (SMB) file share on an existing file
1253
1304
  # gateway. In Storage Gateway, a file share is a file system mount point
1254
- # backed by Amazon S3 cloud storage. Storage Gateway expose file shares
1305
+ # backed by Amazon S3 cloud storage. Storage Gateway exposes file shares
1255
1306
  # using an SMB interface. This operation is only supported for file
1256
1307
  # gateways.
1257
1308
  #
@@ -1260,8 +1311,8 @@ module Aws::StorageGateway
1260
1311
  # is activated in the AWS Region you are creating your file gateway in.
1261
1312
  # If AWS STS is not activated in this AWS Region, activate it. For
1262
1313
  # information about how to activate AWS STS, see [Activating and
1263
- # Deactivating AWS STS in an AWS Region][1] in the *AWS Identity and
1264
- # Access Management User Guide.*
1314
+ # deactivating AWS STS in an AWS Region][1] in the *AWS Identity and
1315
+ # Access Management User Guide*.
1265
1316
  #
1266
1317
  # File gateways don't support creating hard or symbolic links on a
1267
1318
  # file
@@ -1279,47 +1330,57 @@ module Aws::StorageGateway
1279
1330
  # The ARN of the file gateway on which you want to create a file share.
1280
1331
  #
1281
1332
  # @option params [Boolean] :kms_encrypted
1282
- # True to use Amazon S3 server-side encryption with your own AWS KMS
1283
- # key, or false to use a key managed by Amazon S3. Optional.
1333
+ # Set to `true` to use Amazon S3 server-side encryption with your own
1334
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1335
+ #
1336
+ # Valid Values: `true` \| `false`
1284
1337
  #
1285
1338
  # @option params [String] :kms_key
1286
- # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
1287
- # server-side encryption. This value can only be set when KMSEncrypted
1288
- # is true. Optional.
1339
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
1340
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
1341
+ # not support asymmetric CMKs. This value can only be set when
1342
+ # `KMSEncrypted` is `true`. Optional.
1289
1343
  #
1290
1344
  # @option params [required, String] :role
1291
1345
  # The ARN of the AWS Identity and Access Management (IAM) role that a
1292
1346
  # file gateway assumes when it accesses the underlying storage.
1293
1347
  #
1294
1348
  # @option params [required, String] :location_arn
1295
- # The ARN of the backed storage used for storing file data.
1349
+ # The ARN of the backend storage used for storing file data. A prefix
1350
+ # name can be added to the S3 bucket name. It must end with a "/".
1296
1351
  #
1297
1352
  # @option params [String] :default_storage_class
1298
1353
  # The default storage class for objects put into an Amazon S3 bucket by
1299
- # the file gateway. Possible values are `S3_STANDARD`, `S3_STANDARD_IA`,
1300
- # or `S3_ONEZONE_IA`. If this field is not populated, the default value
1301
- # `S3_STANDARD` is used. Optional.
1354
+ # the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
1355
+ # Optional.
1356
+ #
1357
+ # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
1358
+ # `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
1302
1359
  #
1303
1360
  # @option params [String] :object_acl
1304
- # A value that sets the access control list permission for objects in
1305
- # the S3 bucket that a file gateway puts objects into. The default value
1306
- # is "private".
1361
+ # A value that sets the access control list (ACL) permission for objects
1362
+ # in the S3 bucket that a file gateway puts objects into. The default
1363
+ # value is `private`.
1307
1364
  #
1308
1365
  # @option params [Boolean] :read_only
1309
- # A value that sets the write status of a file share. This value is true
1310
- # if the write status is read-only, and otherwise false.
1366
+ # A value that sets the write status of a file share. Set this value to
1367
+ # `true` to set the write status to read-only, otherwise set to `false`.
1368
+ #
1369
+ # Valid Values: `true` \| `false`
1311
1370
  #
1312
1371
  # @option params [Boolean] :guess_mime_type_enabled
1313
1372
  # A value that enables guessing of the MIME type for uploaded objects
1314
- # based on file extensions. Set this value to true to enable MIME type
1315
- # guessing, and otherwise to false. The default value is true.
1373
+ # based on file extensions. Set this value to `true` to enable MIME type
1374
+ # guessing, otherwise set to `false`. The default value is `true`.
1375
+ #
1376
+ # Valid Values: `true` \| `false`
1316
1377
  #
1317
1378
  # @option params [Boolean] :requester_pays
1318
1379
  # A value that sets who pays the cost of the request and the cost
1319
1380
  # associated with data download from the S3 bucket. If this value is set
1320
- # to true, the requester pays the costs. Otherwise the S3 bucket owner
1321
- # pays. However, the S3 bucket owner always pays the cost of storing
1322
- # data.
1381
+ # to `true`, the requester pays the costs; otherwise, the S3 bucket
1382
+ # owner pays. However, the S3 bucket owner always pays the cost of
1383
+ # storing data.
1323
1384
  #
1324
1385
  # <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
1325
1386
  # file share, so make sure that the configuration on the file share is
@@ -1327,43 +1388,60 @@ module Aws::StorageGateway
1327
1388
  #
1328
1389
  # </note>
1329
1390
  #
1391
+ # Valid Values: `true` \| `false`
1392
+ #
1330
1393
  # @option params [Boolean] :smbacl_enabled
1331
- # Set this value to "true to enable ACL (access control list) on the
1332
- # SMB file share. Set it to "false" to map file and directory
1394
+ # Set this value to `true` to enable access control list (ACL) on the
1395
+ # SMB file share. Set it to `false` to map file and directory
1333
1396
  # permissions to the POSIX permissions.
1334
1397
  #
1335
- # For more information, see
1336
- # https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
1337
- # in the Storage Gateway User Guide.
1398
+ # For more information, see [Using Microsoft Windows ACLs to control
1399
+ # access to an SMB file share][1] in the *AWS Storage Gateway User
1400
+ # Guide*.
1401
+ #
1402
+ # Valid Values: `true` \| `false`
1403
+ #
1404
+ #
1405
+ #
1406
+ # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
1338
1407
  #
1339
1408
  # @option params [Array<String>] :admin_user_list
1340
- # A list of users in the Active Directory that will be granted
1409
+ # A list of users or groups in the Active Directory that will be granted
1341
1410
  # administrator privileges on the file share. These users can do all
1342
- # file operations as the super-user.
1411
+ # file operations as the super-user. Acceptable formats include:
1412
+ # `DOMAIN\User1`, `user1`, `@group1`, and `@DOMAIN\group1`.
1343
1413
  #
1344
1414
  # Use this option very carefully, because any user in this list can do
1345
1415
  # anything they like on the file share, regardless of file permissions.
1346
1416
  #
1347
1417
  # @option params [Array<String>] :valid_user_list
1348
1418
  # A list of users or groups in the Active Directory that are allowed to
1349
- # access the file share. A group must be prefixed with the @ character.
1350
- # For example `@group1`. Can only be set if Authentication is set to
1351
- # `ActiveDirectory`.
1419
+ # access the file []() share. A group must be prefixed with the @
1420
+ # character. Acceptable formats include: `DOMAIN\User1`, `user1`,
1421
+ # `@group1`, and `@DOMAIN\group1`. Can only be set if Authentication is
1422
+ # set to `ActiveDirectory`.
1352
1423
  #
1353
1424
  # @option params [Array<String>] :invalid_user_list
1354
1425
  # A list of users or groups in the Active Directory that are not allowed
1355
1426
  # to access the file share. A group must be prefixed with the @
1356
- # character. For example, `@group1`. Can only be set if Authentication
1357
- # is set to `ActiveDirectory`.
1427
+ # character. Acceptable formats include: `DOMAIN\User1`, `user1`,
1428
+ # `@group1`, and `@DOMAIN\group1`. Can only be set if Authentication is
1429
+ # set to `ActiveDirectory`.
1358
1430
  #
1359
1431
  # @option params [String] :audit_destination_arn
1360
1432
  # The Amazon Resource Name (ARN) of the storage used for the audit logs.
1361
1433
  #
1362
1434
  # @option params [String] :authentication
1363
- # The authentication method that users use to access the file share.
1435
+ # The authentication method that users use to access the file share. The
1436
+ # default is `ActiveDirectory`.
1364
1437
  #
1365
- # Valid values are `ActiveDirectory` or `GuestAccess`. The default is
1366
- # `ActiveDirectory`.
1438
+ # Valid Values: `ActiveDirectory` \| `GuestAccess`
1439
+ #
1440
+ # @option params [String] :case_sensitivity
1441
+ # The case of an object name in an Amazon S3 bucket. For
1442
+ # `ClientSpecified`, the client determines the case sensitivity. For
1443
+ # `CaseSensitive`, the gateway determines the case sensitivity. The
1444
+ # default value is `ClientSpecified`.
1367
1445
  #
1368
1446
  # @option params [Array<Types::Tag>] :tags
1369
1447
  # A list of up to 50 tags that can be assigned to the NFS file share.
@@ -1376,6 +1454,17 @@ module Aws::StorageGateway
1376
1454
  #
1377
1455
  # </note>
1378
1456
  #
1457
+ # @option params [String] :file_share_name
1458
+ # The name of the file share. Optional.
1459
+ #
1460
+ # <note markdown="1"> `FileShareName` must be set if an S3 prefix name is set in
1461
+ # `LocationARN`.
1462
+ #
1463
+ # </note>
1464
+ #
1465
+ # @option params [Types::CacheAttributes] :cache_attributes
1466
+ # Refresh cache information.
1467
+ #
1379
1468
  # @return [Types::CreateSMBFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1380
1469
  #
1381
1470
  # * {Types::CreateSMBFileShareOutput#file_share_arn #file_share_arn} => String
@@ -1400,12 +1489,17 @@ module Aws::StorageGateway
1400
1489
  # invalid_user_list: ["FileShareUser"],
1401
1490
  # audit_destination_arn: "AuditDestinationARN",
1402
1491
  # authentication: "Authentication",
1492
+ # case_sensitivity: "ClientSpecified", # accepts ClientSpecified, CaseSensitive
1403
1493
  # tags: [
1404
1494
  # {
1405
1495
  # key: "TagKey", # required
1406
1496
  # value: "TagValue", # required
1407
1497
  # },
1408
1498
  # ],
1499
+ # file_share_name: "FileShareName",
1500
+ # cache_attributes: {
1501
+ # cache_stale_timeout_in_seconds: 1,
1502
+ # },
1409
1503
  # })
1410
1504
  #
1411
1505
  # @example Response structure
@@ -1424,37 +1518,38 @@ module Aws::StorageGateway
1424
1518
  # Initiates a snapshot of a volume.
1425
1519
  #
1426
1520
  # AWS Storage Gateway provides the ability to back up point-in-time
1427
- # snapshots of your data to Amazon Simple Storage Service (Amazon S3)
1428
- # for durable off-site recovery, as well as import the data to an Amazon
1521
+ # snapshots of your data to Amazon Simple Storage (Amazon S3) for
1522
+ # durable off-site recovery, as well as import the data to an Amazon
1429
1523
  # Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud
1430
1524
  # (EC2). You can take snapshots of your gateway volume on a scheduled or
1431
1525
  # ad hoc basis. This API enables you to take an ad hoc snapshot. For
1432
- # more information, see [Editing a Snapshot Schedule][1].
1526
+ # more information, see [Editing a snapshot schedule][1].
1433
1527
  #
1434
- # In the CreateSnapshot request you identify the volume by providing its
1435
- # Amazon Resource Name (ARN). You must also provide description for the
1436
- # snapshot. When AWS Storage Gateway takes the snapshot of specified
1528
+ # In the `CreateSnapshot` request, you identify the volume by providing
1529
+ # its Amazon Resource Name (ARN). You must also provide description for
1530
+ # the snapshot. When AWS Storage Gateway takes the snapshot of specified
1437
1531
  # volume, the snapshot and description appears in the AWS Storage
1438
- # Gateway Console. In response, AWS Storage Gateway returns you a
1532
+ # Gateway console. In response, AWS Storage Gateway returns you a
1439
1533
  # snapshot ID. You can use this snapshot ID to check the snapshot
1440
1534
  # progress or later use it when you want to create a volume from a
1441
1535
  # snapshot. This operation is only supported in stored and cached volume
1442
1536
  # gateway type.
1443
1537
  #
1444
1538
  # <note markdown="1"> To list or delete a snapshot, you must use the Amazon EC2 API. For
1445
- # more information, see DescribeSnapshots or DeleteSnapshot in the [EC2
1446
- # API reference][2].
1539
+ # more information, see [DescribeSnapshots][2] or [DeleteSnapshot][3] in
1540
+ # the *Amazon Elastic Compute Cloud API Reference*.
1447
1541
  #
1448
1542
  # </note>
1449
1543
  #
1450
1544
  # Volume and snapshot IDs are changing to a longer length ID format. For
1451
- # more information, see the important note on the [Welcome][3] page.
1545
+ # more information, see the important note on the [Welcome][4] page.
1452
1546
  #
1453
1547
  #
1454
1548
  #
1455
1549
  # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#SchedulingSnapshot
1456
- # [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Operations.html
1457
- # [3]: https://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html
1550
+ # [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html
1551
+ # [3]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html
1552
+ # [4]: https://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html
1458
1553
  #
1459
1554
  # @option params [required, String] :volume_arn
1460
1555
  # The Amazon Resource Name (ARN) of the volume. Use the ListVolumes
@@ -1464,7 +1559,7 @@ module Aws::StorageGateway
1464
1559
  # Textual description of the snapshot that appears in the Amazon EC2
1465
1560
  # console, Elastic Block Store snapshots panel in the **Description**
1466
1561
  # field, and in the AWS Storage Gateway snapshot **Details** pane,
1467
- # **Description** field
1562
+ # **Description** field.
1468
1563
  #
1469
1564
  # @option params [Array<Types::Tag>] :tags
1470
1565
  # A list of up to 50 tags that can be assigned to a snapshot. Each tag
@@ -1543,10 +1638,16 @@ module Aws::StorageGateway
1543
1638
  # from a snapshot.
1544
1639
  #
1545
1640
  # <note markdown="1"> To list or delete a snapshot, you must use the Amazon EC2 API. For
1546
- # more information, in *Amazon Elastic Compute Cloud API Reference*.
1641
+ # more information, see [DescribeSnapshots][1] or [DeleteSnapshot][2] in
1642
+ # the *Amazon Elastic Compute Cloud API Reference*.
1547
1643
  #
1548
1644
  # </note>
1549
1645
  #
1646
+ #
1647
+ #
1648
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html
1649
+ # [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html
1650
+ #
1550
1651
  # @option params [required, String] :volume_arn
1551
1652
  # The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
1552
1653
  # DescribeStorediSCSIVolumes operation to return to retrieve the
@@ -1556,7 +1657,7 @@ module Aws::StorageGateway
1556
1657
  # Textual description of the snapshot that appears in the Amazon EC2
1557
1658
  # console, Elastic Block Store snapshots panel in the **Description**
1558
1659
  # field, and in the AWS Storage Gateway snapshot **Details** pane,
1559
- # **Description** field
1660
+ # **Description** field.
1560
1661
  #
1561
1662
  # @option params [Array<Types::Tag>] :tags
1562
1663
  # A list of up to 50 tags that can be assigned to a snapshot. Each tag
@@ -1629,7 +1730,7 @@ module Aws::StorageGateway
1629
1730
  # create an empty gateway volume, then any existing data on the disk is
1630
1731
  # erased.
1631
1732
  #
1632
- # In the request you must specify the gateway and the disk information
1733
+ # In the request, you must specify the gateway and the disk information
1633
1734
  # on which you are creating the volume. In response, the gateway creates
1634
1735
  # the volume and returns volume information such as the volume Amazon
1635
1736
  # Resource Name (ARN), its size, and the iSCSI target ARN that
@@ -1652,7 +1753,7 @@ module Aws::StorageGateway
1652
1753
  # @option params [String] :snapshot_id
1653
1754
  # The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as
1654
1755
  # the new stored volume. Specify this field if you want to create the
1655
- # iSCSI storage volume from a snapshot otherwise do not include this
1756
+ # iSCSI storage volume from a snapshot; otherwise, do not include this
1656
1757
  # field. To list snapshots for your account use [DescribeSnapshots][1]
1657
1758
  # in the *Amazon Elastic Compute Cloud API Reference*.
1658
1759
  #
@@ -1661,11 +1762,10 @@ module Aws::StorageGateway
1661
1762
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html
1662
1763
  #
1663
1764
  # @option params [required, Boolean] :preserve_existing_data
1664
- # Specify this field as true if you want to preserve the data on the
1665
- # local disk. Otherwise, specifying this field as false creates an empty
1666
- # volume.
1765
+ # Set to true `true` if you want to preserve the data on the local disk.
1766
+ # Otherwise, set to `false` to create an empty volume.
1667
1767
  #
1668
- # Valid Values: true, false
1768
+ # Valid Values: `true` \| `false`
1669
1769
  #
1670
1770
  # @option params [required, String] :target_name
1671
1771
  # The name of the iSCSI target used by an initiator to connect to a
@@ -1686,13 +1786,16 @@ module Aws::StorageGateway
1686
1786
  # Valid Values: A valid IP address.
1687
1787
  #
1688
1788
  # @option params [Boolean] :kms_encrypted
1689
- # True to use Amazon S3 server-side encryption with your own AWS KMS
1690
- # key, or false to use a key managed by Amazon S3. Optional.
1789
+ # Set to `true` to use Amazon S3 server-side encryption with your own
1790
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1791
+ #
1792
+ # Valid Values: `true` \| `false`
1691
1793
  #
1692
1794
  # @option params [String] :kms_key
1693
- # The Amazon Resource Name (ARN) of the KMS key used for Amazon S3
1694
- # server-side encryption. This value can only be set when KMSEncrypted
1695
- # is true. Optional.
1795
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
1796
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
1797
+ # not support asymmetric CMKs. This value can only be set when
1798
+ # `KMSEncrypted` is `true`. Optional.
1696
1799
  #
1697
1800
  # @option params [Array<Types::Tag>] :tags
1698
1801
  # A list of up to 50 tags that can be assigned to a stored volume. Each
@@ -1766,6 +1869,72 @@ module Aws::StorageGateway
1766
1869
  req.send_request(options)
1767
1870
  end
1768
1871
 
1872
+ # Creates a new custom tape pool. You can use custom tape pool to enable
1873
+ # tape retention lock on tapes that are archived in the custom pool.
1874
+ #
1875
+ # @option params [required, String] :pool_name
1876
+ # The name of the new custom tape pool.
1877
+ #
1878
+ # @option params [required, String] :storage_class
1879
+ # The storage class that is associated with the new custom pool. When
1880
+ # you use your backup application to eject the tape, the tape is
1881
+ # archived directly into the storage class (S3 Glacier or S3 Glacier
1882
+ # Deep Archive) that corresponds to the pool.
1883
+ #
1884
+ # @option params [String] :retention_lock_type
1885
+ # Tape retention lock can be configured in two modes. When configured in
1886
+ # governance mode, AWS accounts with specific IAM permissions are
1887
+ # authorized to remove the tape retention lock from archived virtual
1888
+ # tapes. When configured in compliance mode, the tape retention lock
1889
+ # cannot be removed by any user, including the root AWS account.
1890
+ #
1891
+ # @option params [Integer] :retention_lock_time_in_days
1892
+ # Tape retention lock time is set in days. Tape retention lock can be
1893
+ # enabled for up to 100 years (36,500 days).
1894
+ #
1895
+ # @option params [Array<Types::Tag>] :tags
1896
+ # A list of up to 50 tags that can be assigned to tape pool. Each tag is
1897
+ # a key-value pair.
1898
+ #
1899
+ # <note markdown="1"> Valid characters for key and value are letters, spaces, and numbers
1900
+ # representable in UTF-8 format, and the following special characters: +
1901
+ # - = . \_ : / @. The maximum length of a tag's key is 128 characters,
1902
+ # and the maximum length for a tag's value is 256.
1903
+ #
1904
+ # </note>
1905
+ #
1906
+ # @return [Types::CreateTapePoolOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1907
+ #
1908
+ # * {Types::CreateTapePoolOutput#pool_arn #pool_arn} => String
1909
+ #
1910
+ # @example Request syntax with placeholder values
1911
+ #
1912
+ # resp = client.create_tape_pool({
1913
+ # pool_name: "PoolName", # required
1914
+ # storage_class: "DEEP_ARCHIVE", # required, accepts DEEP_ARCHIVE, GLACIER
1915
+ # retention_lock_type: "COMPLIANCE", # accepts COMPLIANCE, GOVERNANCE, NONE
1916
+ # retention_lock_time_in_days: 1,
1917
+ # tags: [
1918
+ # {
1919
+ # key: "TagKey", # required
1920
+ # value: "TagValue", # required
1921
+ # },
1922
+ # ],
1923
+ # })
1924
+ #
1925
+ # @example Response structure
1926
+ #
1927
+ # resp.pool_arn #=> String
1928
+ #
1929
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateTapePool AWS API Documentation
1930
+ #
1931
+ # @overload create_tape_pool(params = {})
1932
+ # @param [Hash] params ({})
1933
+ def create_tape_pool(params = {}, options = {})
1934
+ req = build_request(:create_tape_pool, params)
1935
+ req.send_request(options)
1936
+ end
1937
+
1769
1938
  # Creates a virtual tape by using your own barcode. You write data to
1770
1939
  # the virtual tape and then archive the tape. A barcode is unique and
1771
1940
  # cannot be reused if it has already been used on a tape. This applies
@@ -1799,22 +1968,29 @@ module Aws::StorageGateway
1799
1968
  # </note>
1800
1969
  #
1801
1970
  # @option params [Boolean] :kms_encrypted
1802
- # True to use Amazon S3 server-side encryption with your own AWS KMS
1803
- # key, or false to use a key managed by Amazon S3. Optional.
1971
+ # Set to `true` to use Amazon S3 server-side encryption with your own
1972
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1973
+ #
1974
+ # Valid Values: `true` \| `false`
1804
1975
  #
1805
1976
  # @option params [String] :kms_key
1806
- # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
1807
- # server-side encryption. This value can only be set when KMSEncrypted
1808
- # is true. Optional.
1977
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
1978
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
1979
+ # not support asymmetric CMKs. This value can only be set when
1980
+ # `KMSEncrypted` is `true`. Optional.
1809
1981
  #
1810
1982
  # @option params [String] :pool_id
1811
1983
  # The ID of the pool that you want to add your tape to for archiving.
1812
1984
  # The tape in this pool is archived in the S3 storage class that is
1813
1985
  # associated with the pool. When you use your backup application to
1814
1986
  # eject the tape, the tape is archived directly into the storage class
1815
- # (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
1987
+ # (S3 Glacier or S3 Deep Archive) that corresponds to the pool.
1988
+ #
1989
+ # Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
1816
1990
  #
1817
- # Valid values: "GLACIER", "DEEP\_ARCHIVE"
1991
+ # @option params [Boolean] :worm
1992
+ # Set to `TRUE` if the tape you are creating is to be configured as a
1993
+ # write-once-read-many (WORM) tape.
1818
1994
  #
1819
1995
  # @option params [Array<Types::Tag>] :tags
1820
1996
  # A list of up to 50 tags that can be assigned to a virtual tape that
@@ -1856,6 +2032,7 @@ module Aws::StorageGateway
1856
2032
  # kms_encrypted: false,
1857
2033
  # kms_key: "KMSKey",
1858
2034
  # pool_id: "PoolId",
2035
+ # worm: false,
1859
2036
  # tags: [
1860
2037
  # {
1861
2038
  # key: "TagKey", # required
@@ -1922,13 +2099,16 @@ module Aws::StorageGateway
1922
2099
  # </note>
1923
2100
  #
1924
2101
  # @option params [Boolean] :kms_encrypted
1925
- # True to use Amazon S3 server-side encryption with your own AWS KMS
1926
- # key, or false to use a key managed by Amazon S3. Optional.
2102
+ # Set to `true` to use Amazon S3 server-side encryption with your own
2103
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
2104
+ #
2105
+ # Valid Values: `true` \| `false`
1927
2106
  #
1928
2107
  # @option params [String] :kms_key
1929
- # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
1930
- # server-side encryption. This value can only be set when KMSEncrypted
1931
- # is true. Optional.
2108
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
2109
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
2110
+ # not support asymmetric CMKs. This value can only be set when
2111
+ # `KMSEncrypted` is `true`. Optional.
1932
2112
  #
1933
2113
  # @option params [String] :pool_id
1934
2114
  # The ID of the pool that you want to add your tape to for archiving.
@@ -1937,7 +2117,11 @@ module Aws::StorageGateway
1937
2117
  # eject the tape, the tape is archived directly into the storage class
1938
2118
  # (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
1939
2119
  #
1940
- # Valid values: "GLACIER", "DEEP\_ARCHIVE"
2120
+ # Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
2121
+ #
2122
+ # @option params [Boolean] :worm
2123
+ # Set to `TRUE` if the tape you are creating is to be configured as a
2124
+ # write-once-read-many (WORM) tape.
1941
2125
  #
1942
2126
  # @option params [Array<Types::Tag>] :tags
1943
2127
  # A list of up to 50 tags that can be assigned to a virtual tape. Each
@@ -1987,6 +2171,7 @@ module Aws::StorageGateway
1987
2171
  # kms_encrypted: false,
1988
2172
  # kms_key: "KMSKey",
1989
2173
  # pool_id: "PoolId",
2174
+ # worm: false,
1990
2175
  # tags: [
1991
2176
  # {
1992
2177
  # key: "TagKey", # required
@@ -2058,7 +2243,7 @@ module Aws::StorageGateway
2058
2243
  # One of the BandwidthType values that indicates the gateway bandwidth
2059
2244
  # rate limit to delete.
2060
2245
  #
2061
- # Valid Values: `Upload`, `Download`, `All`.
2246
+ # Valid Values: `UPLOAD` \| `DOWNLOAD` \| `ALL`
2062
2247
  #
2063
2248
  # @return [Types::DeleteBandwidthRateLimitOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2064
2249
  #
@@ -2160,11 +2345,13 @@ module Aws::StorageGateway
2160
2345
  # The Amazon Resource Name (ARN) of the file share to be deleted.
2161
2346
  #
2162
2347
  # @option params [Boolean] :force_delete
2163
- # If this value is set to true, the operation deletes a file share
2348
+ # If this value is set to `true`, the operation deletes a file share
2164
2349
  # immediately and aborts all data uploads to AWS. Otherwise, the file
2165
2350
  # share is not deleted until all data is uploaded to AWS. This process
2166
2351
  # aborts the data upload process, and the file share enters the
2167
- # FORCE\_DELETING status.
2352
+ # `FORCE_DELETING` status.
2353
+ #
2354
+ # Valid Values: `true` \| `false`
2168
2355
  #
2169
2356
  # @return [Types::DeleteFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2170
2357
  #
@@ -2207,8 +2394,8 @@ module Aws::StorageGateway
2207
2394
  # all remaining Amazon EBS snapshots by canceling your Amazon EC2
2208
2395
  # subscription.  If you prefer not to cancel your Amazon EC2
2209
2396
  # subscription, you can delete your snapshots using the Amazon EC2
2210
- # console. For more information, see the [ AWS Storage Gateway Detail
2211
- # Page][1].
2397
+ # console. For more information, see the [AWS Storage Gateway detail
2398
+ # page][1].
2212
2399
  #
2213
2400
  #
2214
2401
  #
@@ -2260,7 +2447,7 @@ module Aws::StorageGateway
2260
2447
  #
2261
2448
  # You can take snapshots of your gateway volumes on a scheduled or ad
2262
2449
  # hoc basis. This API action enables you to delete a snapshot schedule
2263
- # for a volume. For more information, see [Working with Snapshots][1].
2450
+ # for a volume. For more information, see [Backing up your volumes][1].
2264
2451
  # In the `DeleteSnapshotSchedule` request, you identify the volume by
2265
2452
  # providing its Amazon Resource Name (ARN). This operation is only
2266
2453
  # supported in stored and cached volume gateway types.
@@ -2273,7 +2460,7 @@ module Aws::StorageGateway
2273
2460
  #
2274
2461
  #
2275
2462
  #
2276
- # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/WorkingWithSnapshots.html
2463
+ # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/backing-up-volumes.html
2277
2464
  # [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html
2278
2465
  #
2279
2466
  # @option params [required, String] :volume_arn
@@ -2327,6 +2514,12 @@ module Aws::StorageGateway
2327
2514
  # @option params [required, String] :tape_arn
2328
2515
  # The Amazon Resource Name (ARN) of the virtual tape to delete.
2329
2516
  #
2517
+ # @option params [Boolean] :bypass_governance_retention
2518
+ # Set to `TRUE` to delete an archived tape that belongs to a custom pool
2519
+ # with tape retention lock. Only archived tapes with tape retention lock
2520
+ # set to `governance` can be deleted. Archived tapes with tape retention
2521
+ # lock set to `compliance` can't be deleted.
2522
+ #
2330
2523
  # @return [Types::DeleteTapeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2331
2524
  #
2332
2525
  # * {Types::DeleteTapeOutput#tape_arn #tape_arn} => String
@@ -2351,6 +2544,7 @@ module Aws::StorageGateway
2351
2544
  # resp = client.delete_tape({
2352
2545
  # gateway_arn: "GatewayARN", # required
2353
2546
  # tape_arn: "TapeARN", # required
2547
+ # bypass_governance_retention: false,
2354
2548
  # })
2355
2549
  #
2356
2550
  # @example Response structure
@@ -2373,6 +2567,12 @@ module Aws::StorageGateway
2373
2567
  # The Amazon Resource Name (ARN) of the virtual tape to delete from the
2374
2568
  # virtual tape shelf (VTS).
2375
2569
  #
2570
+ # @option params [Boolean] :bypass_governance_retention
2571
+ # Set to `TRUE` to delete an archived tape that belongs to a custom pool
2572
+ # with tape retention lock. Only archived tapes with tape retention lock
2573
+ # set to `governance` can be deleted. Archived tapes with tape retention
2574
+ # lock set to `compliance` can't be deleted.
2575
+ #
2376
2576
  # @return [Types::DeleteTapeArchiveOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2377
2577
  #
2378
2578
  # * {Types::DeleteTapeArchiveOutput#tape_arn #tape_arn} => String
@@ -2395,6 +2595,7 @@ module Aws::StorageGateway
2395
2595
  #
2396
2596
  # resp = client.delete_tape_archive({
2397
2597
  # tape_arn: "TapeARN", # required
2598
+ # bypass_governance_retention: false,
2398
2599
  # })
2399
2600
  #
2400
2601
  # @example Response structure
@@ -2410,6 +2611,36 @@ module Aws::StorageGateway
2410
2611
  req.send_request(options)
2411
2612
  end
2412
2613
 
2614
+ # Delete a custom tape pool. A custom tape pool can only be deleted if
2615
+ # there are no tapes in the pool and if there are no automatic tape
2616
+ # creation policies that reference the custom tape pool.
2617
+ #
2618
+ # @option params [required, String] :pool_arn
2619
+ # The Amazon Resource Name (ARN) of the custom tape pool to delete.
2620
+ #
2621
+ # @return [Types::DeleteTapePoolOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2622
+ #
2623
+ # * {Types::DeleteTapePoolOutput#pool_arn #pool_arn} => String
2624
+ #
2625
+ # @example Request syntax with placeholder values
2626
+ #
2627
+ # resp = client.delete_tape_pool({
2628
+ # pool_arn: "PoolARN", # required
2629
+ # })
2630
+ #
2631
+ # @example Response structure
2632
+ #
2633
+ # resp.pool_arn #=> String
2634
+ #
2635
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteTapePool AWS API Documentation
2636
+ #
2637
+ # @overload delete_tape_pool(params = {})
2638
+ # @param [Hash] params ({})
2639
+ def delete_tape_pool(params = {}, options = {})
2640
+ req = build_request(:delete_tape_pool, params)
2641
+ req.send_request(options)
2642
+ end
2643
+
2413
2644
  # Deletes the specified storage volume that you previously created using
2414
2645
  # the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This
2415
2646
  # operation is only supported in the cached volume and stored volume
@@ -2513,7 +2744,7 @@ module Aws::StorageGateway
2513
2744
  # Returns the bandwidth rate limits of a gateway. By default, these
2514
2745
  # limits are not set, which means no bandwidth rate limiting is in
2515
2746
  # effect. This operation is supported for the stored volume, cached
2516
- # volume and tape gateway types.'
2747
+ # volume, and tape gateway types.
2517
2748
  #
2518
2749
  # This operation only returns a value for a bandwidth rate limit only if
2519
2750
  # the limit is set. If no limits are set for the gateway, then this
@@ -2809,6 +3040,9 @@ module Aws::StorageGateway
2809
3040
  # * {Types::DescribeGatewayInformationOutput#vpc_endpoint #vpc_endpoint} => String
2810
3041
  # * {Types::DescribeGatewayInformationOutput#cloud_watch_log_group_arn #cloud_watch_log_group_arn} => String
2811
3042
  # * {Types::DescribeGatewayInformationOutput#host_environment #host_environment} => String
3043
+ # * {Types::DescribeGatewayInformationOutput#endpoint_type #endpoint_type} => String
3044
+ # * {Types::DescribeGatewayInformationOutput#software_updates_end_date #software_updates_end_date} => String
3045
+ # * {Types::DescribeGatewayInformationOutput#deprecation_date #deprecation_date} => String
2812
3046
  #
2813
3047
  #
2814
3048
  # @example Example: To describe metadata about the gateway
@@ -2865,6 +3099,9 @@ module Aws::StorageGateway
2865
3099
  # resp.vpc_endpoint #=> String
2866
3100
  # resp.cloud_watch_log_group_arn #=> String
2867
3101
  # resp.host_environment #=> String, one of "VMWARE", "HYPER-V", "EC2", "KVM", "OTHER"
3102
+ # resp.endpoint_type #=> String
3103
+ # resp.software_updates_end_date #=> String
3104
+ # resp.deprecation_date #=> String
2868
3105
  #
2869
3106
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeGatewayInformation AWS API Documentation
2870
3107
  #
@@ -2980,6 +3217,8 @@ module Aws::StorageGateway
2980
3217
  # resp.nfs_file_share_info_list[0].tags #=> Array
2981
3218
  # resp.nfs_file_share_info_list[0].tags[0].key #=> String
2982
3219
  # resp.nfs_file_share_info_list[0].tags[0].value #=> String
3220
+ # resp.nfs_file_share_info_list[0].file_share_name #=> String
3221
+ # resp.nfs_file_share_info_list[0].cache_attributes.cache_stale_timeout_in_seconds #=> Integer
2983
3222
  #
2984
3223
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeNFSFileShares AWS API Documentation
2985
3224
  #
@@ -3034,9 +3273,12 @@ module Aws::StorageGateway
3034
3273
  # resp.smb_file_share_info_list[0].invalid_user_list[0] #=> String
3035
3274
  # resp.smb_file_share_info_list[0].audit_destination_arn #=> String
3036
3275
  # resp.smb_file_share_info_list[0].authentication #=> String
3276
+ # resp.smb_file_share_info_list[0].case_sensitivity #=> String, one of "ClientSpecified", "CaseSensitive"
3037
3277
  # resp.smb_file_share_info_list[0].tags #=> Array
3038
3278
  # resp.smb_file_share_info_list[0].tags[0].key #=> String
3039
3279
  # resp.smb_file_share_info_list[0].tags[0].value #=> String
3280
+ # resp.smb_file_share_info_list[0].file_share_name #=> String
3281
+ # resp.smb_file_share_info_list[0].cache_attributes.cache_stale_timeout_in_seconds #=> Integer
3040
3282
  #
3041
3283
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeSMBFileShares AWS API Documentation
3042
3284
  #
@@ -3152,7 +3394,7 @@ module Aws::StorageGateway
3152
3394
 
3153
3395
  # Returns the description of the gateway volumes specified in the
3154
3396
  # request. The list of gateway volumes in the request must be from one
3155
- # gateway. In the response AWS Storage Gateway returns volume
3397
+ # gateway. In the response, AWS Storage Gateway returns volume
3156
3398
  # information sorted by volume ARNs. This operation is only supported in
3157
3399
  # stored volume gateway type.
3158
3400
  #
@@ -3319,6 +3561,9 @@ module Aws::StorageGateway
3319
3561
  # resp.tape_archives[0].tape_used_in_bytes #=> Integer
3320
3562
  # resp.tape_archives[0].kms_key #=> String
3321
3563
  # resp.tape_archives[0].pool_id #=> String
3564
+ # resp.tape_archives[0].worm #=> Boolean
3565
+ # resp.tape_archives[0].retention_start_date #=> Time
3566
+ # resp.tape_archives[0].pool_entry_date #=> Time
3322
3567
  # resp.marker #=> String
3323
3568
  #
3324
3569
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeTapeArchives AWS API Documentation
@@ -3507,6 +3752,9 @@ module Aws::StorageGateway
3507
3752
  # resp.tapes[0].tape_used_in_bytes #=> Integer
3508
3753
  # resp.tapes[0].kms_key #=> String
3509
3754
  # resp.tapes[0].pool_id #=> String
3755
+ # resp.tapes[0].worm #=> Boolean
3756
+ # resp.tapes[0].retention_start_date #=> Time
3757
+ # resp.tapes[0].pool_entry_date #=> Time
3510
3758
  # resp.marker #=> String
3511
3759
  #
3512
3760
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeTapes AWS API Documentation
@@ -3519,7 +3767,7 @@ module Aws::StorageGateway
3519
3767
  end
3520
3768
 
3521
3769
  # Returns information about the upload buffer of a gateway. This
3522
- # operation is supported for the stored volume, cached volume and tape
3770
+ # operation is supported for the stored volume, cached volume, and tape
3523
3771
  # gateway types.
3524
3772
  #
3525
3773
  # The response includes disk IDs that are configured as upload buffer
@@ -3816,6 +4064,8 @@ module Aws::StorageGateway
3816
4064
  # set to `false`, you must manually disconnect the iSCSI connection from
3817
4065
  # the target volume.
3818
4066
  #
4067
+ # Valid Values: `true` \| `false`
4068
+ #
3819
4069
  # @return [Types::DetachVolumeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3820
4070
  #
3821
4071
  # * {Types::DetachVolumeOutput#volume_arn #volume_arn} => String
@@ -3990,6 +4240,7 @@ module Aws::StorageGateway
3990
4240
  # resp.automatic_tape_creation_policy_infos[0].automatic_tape_creation_rules[0].pool_id #=> String
3991
4241
  # resp.automatic_tape_creation_policy_infos[0].automatic_tape_creation_rules[0].tape_size_in_bytes #=> Integer
3992
4242
  # resp.automatic_tape_creation_policy_infos[0].automatic_tape_creation_rules[0].minimum_num_tapes #=> Integer
4243
+ # resp.automatic_tape_creation_policy_infos[0].automatic_tape_creation_rules[0].worm #=> Boolean
3993
4244
  # resp.automatic_tape_creation_policy_infos[0].gateway_arn #=> String
3994
4245
  #
3995
4246
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListAutomaticTapeCreationPolicies AWS API Documentation
@@ -4291,6 +4542,63 @@ module Aws::StorageGateway
4291
4542
  req.send_request(options)
4292
4543
  end
4293
4544
 
4545
+ # Lists custom tape pools. You specify custom tape pools to list by
4546
+ # specifying one or more custom tape pool Amazon Resource Names (ARNs).
4547
+ # If you don't specify a custom tape pool ARN, the operation lists all
4548
+ # custom tape pools.
4549
+ #
4550
+ # This operation supports pagination. You can optionally specify the
4551
+ # `Limit` parameter in the body to limit the number of tape pools in the
4552
+ # response. If the number of tape pools returned in the response is
4553
+ # truncated, the response includes a `Marker` element that you can use
4554
+ # in your subsequent request to retrieve the next set of tape pools.
4555
+ #
4556
+ # @option params [Array<String>] :pool_arns
4557
+ # The Amazon Resource Name (ARN) of each of the custom tape pools you
4558
+ # want to list. If you don't specify a custom tape pool ARN, the
4559
+ # response lists all custom tape pools.
4560
+ #
4561
+ # @option params [String] :marker
4562
+ # A string that indicates the position at which to begin the returned
4563
+ # list of tape pools.
4564
+ #
4565
+ # @option params [Integer] :limit
4566
+ # An optional number limit for the tape pools in the list returned by
4567
+ # this call.
4568
+ #
4569
+ # @return [Types::ListTapePoolsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4570
+ #
4571
+ # * {Types::ListTapePoolsOutput#pool_infos #pool_infos} => Array&lt;Types::PoolInfo&gt;
4572
+ # * {Types::ListTapePoolsOutput#marker #marker} => String
4573
+ #
4574
+ # @example Request syntax with placeholder values
4575
+ #
4576
+ # resp = client.list_tape_pools({
4577
+ # pool_arns: ["PoolARN"],
4578
+ # marker: "Marker",
4579
+ # limit: 1,
4580
+ # })
4581
+ #
4582
+ # @example Response structure
4583
+ #
4584
+ # resp.pool_infos #=> Array
4585
+ # resp.pool_infos[0].pool_arn #=> String
4586
+ # resp.pool_infos[0].pool_name #=> String
4587
+ # resp.pool_infos[0].storage_class #=> String, one of "DEEP_ARCHIVE", "GLACIER"
4588
+ # resp.pool_infos[0].retention_lock_type #=> String, one of "COMPLIANCE", "GOVERNANCE", "NONE"
4589
+ # resp.pool_infos[0].retention_lock_time_in_days #=> Integer
4590
+ # resp.pool_infos[0].pool_status #=> String, one of "ACTIVE", "DELETED"
4591
+ # resp.marker #=> String
4592
+ #
4593
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListTapePools AWS API Documentation
4594
+ #
4595
+ # @overload list_tape_pools(params = {})
4596
+ # @param [Hash] params ({})
4597
+ def list_tape_pools(params = {}, options = {})
4598
+ req = build_request(:list_tape_pools, params)
4599
+ req.send_request(options)
4600
+ end
4601
+
4294
4602
  # Lists virtual tapes in your virtual tape library (VTL) and your
4295
4603
  # virtual tape shelf (VTS). You specify the tapes to list by specifying
4296
4604
  # one or more tape Amazon Resource Names (ARNs). If you don't specify a
@@ -4342,6 +4650,8 @@ module Aws::StorageGateway
4342
4650
  # resp.tape_infos[0].tape_status #=> String
4343
4651
  # resp.tape_infos[0].gateway_arn #=> String
4344
4652
  # resp.tape_infos[0].pool_id #=> String
4653
+ # resp.tape_infos[0].retention_start_date #=> Time
4654
+ # resp.tape_infos[0].pool_entry_date #=> Time
4345
4655
  # resp.marker #=> String
4346
4656
  #
4347
4657
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListTapes AWS API Documentation
@@ -4565,9 +4875,12 @@ module Aws::StorageGateway
4565
4875
  # as Amazon SNS or AWS Lambda function. This operation is only supported
4566
4876
  # for file gateways.
4567
4877
  #
4568
- # For more information, see Getting File Upload Notification in the
4569
- # Storage Gateway User Guide
4570
- # (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification).
4878
+ # For more information, see [Getting file upload notification][1] in the
4879
+ # *AWS Storage Gateway User Guide*.
4880
+ #
4881
+ #
4882
+ #
4883
+ # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification
4571
4884
  #
4572
4885
  # @option params [required, String] :file_share_arn
4573
4886
  # The Amazon Resource Name (ARN) of the file share.
@@ -4598,12 +4911,13 @@ module Aws::StorageGateway
4598
4911
  end
4599
4912
 
4600
4913
  # Refreshes the cache for the specified file share. This operation finds
4601
- # objects in the Amazon S3 bucket that were added, removed or replaced
4914
+ # objects in the Amazon S3 bucket that were added, removed, or replaced
4602
4915
  # since the gateway last listed the bucket's contents and cached the
4603
4916
  # results. This operation is only supported in the file gateway type.
4604
4917
  # You can subscribe to be notified through an Amazon CloudWatch event
4605
4918
  # when your RefreshCache operation completes. For more information, see
4606
- # [Getting Notified About File Operations][1].
4919
+ # [Getting notified about file operations][1] in the *AWS Storage
4920
+ # Gateway User Guide*.
4607
4921
  #
4608
4922
  # When this API is called, it only initiates the refresh operation. When
4609
4923
  # the API call completes and returns a success code, it doesn't
@@ -4616,16 +4930,16 @@ module Aws::StorageGateway
4616
4930
  # Throttle limit: This API is asynchronous so the gateway will accept no
4617
4931
  # more than two refreshes at any time. We recommend using the
4618
4932
  # refresh-complete CloudWatch event notification before issuing
4619
- # additional requests. For more information, see [Getting Notified About
4620
- # File Operations][1].
4933
+ # additional requests. For more information, see [Getting notified about
4934
+ # file operations][1] in the *AWS Storage Gateway User Guide*.
4621
4935
  #
4622
4936
  # If you invoke the RefreshCache API when two requests are already being
4623
4937
  # processed, any new request will cause an
4624
4938
  # `InvalidGatewayRequestException` error because too many requests were
4625
4939
  # sent to the server.
4626
4940
  #
4627
- # For more information, see
4628
- # "https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification".
4941
+ # For more information, see [Getting notified about file operations][1]
4942
+ # in the *AWS Storage Gateway User Guide*.
4629
4943
  #
4630
4944
  #
4631
4945
  #
@@ -4638,18 +4952,19 @@ module Aws::StorageGateway
4638
4952
  # A comma-separated list of the paths of folders to refresh in the
4639
4953
  # cache. The default is \[`"/"`\]. The default refreshes objects and
4640
4954
  # folders at the root of the Amazon S3 bucket. If `Recursive` is set to
4641
- # "true", the entire S3 bucket that the file share has access to is
4955
+ # `true`, the entire S3 bucket that the file share has access to is
4642
4956
  # refreshed.
4643
4957
  #
4644
4958
  # @option params [Boolean] :recursive
4645
4959
  # A value that specifies whether to recursively refresh folders in the
4646
4960
  # cache. The refresh includes folders that were in the cache the last
4647
4961
  # time the gateway listed the folder's contents. If this value set to
4648
- # "true", each folder that is listed in `FolderList` is recursively
4962
+ # `true`, each folder that is listed in `FolderList` is recursively
4649
4963
  # updated. Otherwise, subfolders listed in `FolderList` are not
4650
4964
  # refreshed. Only objects that are in folders listed directly under
4651
- # `FolderList` are found and used for the update. The default is
4652
- # "true".
4965
+ # `FolderList` are found and used for the update. The default is `true`.
4966
+ #
4967
+ # Valid Values: `true` \| `false`
4653
4968
  #
4654
4969
  # @return [Types::RefreshCacheOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4655
4970
  #
@@ -4975,7 +5290,7 @@ module Aws::StorageGateway
4975
5290
  # is associated with.
4976
5291
  #
4977
5292
  # @option params [required, String] :password
4978
- # The password that you want to set for your SMB Server.
5293
+ # The password that you want to set for your SMB server.
4979
5294
  #
4980
5295
  # @return [Types::SetSMBGuestPasswordOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4981
5296
  #
@@ -5014,7 +5329,7 @@ module Aws::StorageGateway
5014
5329
  # </note>
5015
5330
  #
5016
5331
  # After the gateway is shutdown, you cannot call any other API except
5017
- # StartGateway, DescribeGatewayInformation and ListGateways. For more
5332
+ # StartGateway, DescribeGatewayInformation, and ListGateways. For more
5018
5333
  # information, see ActivateGateway. Your applications cannot read from
5019
5334
  # or write to the gateway's storage volumes, and there are no snapshots
5020
5335
  # taken.
@@ -5204,6 +5519,7 @@ module Aws::StorageGateway
5204
5519
  # pool_id: "PoolId", # required
5205
5520
  # tape_size_in_bytes: 1, # required
5206
5521
  # minimum_num_tapes: 1, # required
5522
+ # worm: false,
5207
5523
  # },
5208
5524
  # ],
5209
5525
  # gateway_arn: "GatewayARN", # required
@@ -5226,7 +5542,7 @@ module Aws::StorageGateway
5226
5542
  # the upload and download bandwidth rate limit or specify only one of
5227
5543
  # the two. If you don't set a bandwidth rate limit, the existing rate
5228
5544
  # limit remains. This operation is supported for the stored volume,
5229
- # cached volume and tape gateway types.'
5545
+ # cached volume, and tape gateway types.
5230
5546
  #
5231
5547
  # By default, a gateway's bandwidth rate limits are not set. If you
5232
5548
  # don't set any limit, the gateway does not have any limitations on its
@@ -5374,7 +5690,7 @@ module Aws::StorageGateway
5374
5690
  # time zone. To specify which gateway to update, use the Amazon Resource
5375
5691
  # Name (ARN) of the gateway in your request.
5376
5692
  #
5377
- # <note markdown="1"> For Gateways activated after September 2, 2015, the gateway's ARN
5693
+ # <note markdown="1"> For gateways activated after September 2, 2015, the gateway's ARN
5378
5694
  # contains the gateway ID rather than the gateway name. However,
5379
5695
  # changing the name of the gateway has no effect on the gateway's ARN.
5380
5696
  #
@@ -5395,7 +5711,7 @@ module Aws::StorageGateway
5395
5711
  # The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that
5396
5712
  # you want to use to monitor and log events in the gateway.
5397
5713
  #
5398
- # For more information, see [What Is Amazon CloudWatch Logs?][1].
5714
+ # For more information, see [What is Amazon CloudWatch Logs?][1]
5399
5715
  #
5400
5716
  #
5401
5717
  #
@@ -5460,8 +5776,8 @@ module Aws::StorageGateway
5460
5776
  # minimize the chance of any disruption to your applications by
5461
5777
  # increasing your iSCSI Initiators' timeouts. For more information
5462
5778
  # about increasing iSCSI Initiator timeouts for Windows and Linux, see
5463
- # [Customizing Your Windows iSCSI Settings][1] and [Customizing Your
5464
- # Linux iSCSI Settings][2], respectively.
5779
+ # [Customizing your Windows iSCSI settings][1] and [Customizing your
5780
+ # Linux iSCSI settings][2], respectively.
5465
5781
  #
5466
5782
  #
5467
5783
  #
@@ -5539,10 +5855,6 @@ module Aws::StorageGateway
5539
5855
  # represented as an ordinal number from 1 to 28, where 1 represents the
5540
5856
  # first day of the month and 28 represents the last day of the month.
5541
5857
  #
5542
- # <note markdown="1"> This value is only available for tape and volume gateways.
5543
- #
5544
- # </note>
5545
- #
5546
5858
  # @return [Types::UpdateMaintenanceStartTimeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5547
5859
  #
5548
5860
  # * {Types::UpdateMaintenanceStartTimeOutput#gateway_arn #gateway_arn} => String
@@ -5617,56 +5929,67 @@ module Aws::StorageGateway
5617
5929
  # The Amazon Resource Name (ARN) of the file share to be updated.
5618
5930
  #
5619
5931
  # @option params [Boolean] :kms_encrypted
5620
- # True to use Amazon S3 server-side encryption with your own AWS KMS
5621
- # key, or false to use a key managed by Amazon S3. Optional.
5932
+ # Set to `true` to use Amazon S3 server-side encryption with your own
5933
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
5934
+ #
5935
+ # Valid Values: `true` \| `false`
5622
5936
  #
5623
5937
  # @option params [String] :kms_key
5624
- # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
5625
- # server-side encryption. This value can only be set when KMSEncrypted
5626
- # is true. Optional.
5938
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
5939
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
5940
+ # not support asymmetric CMKs. This value can only be set when
5941
+ # `KMSEncrypted` is `true`. Optional.
5627
5942
  #
5628
5943
  # @option params [Types::NFSFileShareDefaults] :nfs_file_share_defaults
5629
5944
  # The default values for the file share. Optional.
5630
5945
  #
5631
5946
  # @option params [String] :default_storage_class
5632
5947
  # The default storage class for objects put into an Amazon S3 bucket by
5633
- # the file gateway. Possible values are `S3_STANDARD`, `S3_STANDARD_IA`,
5634
- # or `S3_ONEZONE_IA`. If this field is not populated, the default value
5635
- # `S3_STANDARD` is used. Optional.
5948
+ # the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
5949
+ # Optional.
5950
+ #
5951
+ # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
5952
+ # `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
5636
5953
  #
5637
5954
  # @option params [String] :object_acl
5638
- # A value that sets the access control list permission for objects in
5639
- # the S3 bucket that a file gateway puts objects into. The default value
5640
- # is "private".
5955
+ # A value that sets the access control list (ACL) permission for objects
5956
+ # in the S3 bucket that a file gateway puts objects into. The default
5957
+ # value is `private`.
5641
5958
  #
5642
5959
  # @option params [Array<String>] :client_list
5643
5960
  # The list of clients that are allowed to access the file gateway. The
5644
5961
  # list must contain either valid IP addresses or valid CIDR blocks.
5645
5962
  #
5646
5963
  # @option params [String] :squash
5647
- # The user mapped to anonymous user. Valid options are the following:
5964
+ # The user mapped to anonymous user.
5648
5965
  #
5649
- # * `RootSquash` - Only root is mapped to anonymous user.
5966
+ # Valid values are the following:
5650
5967
  #
5651
- # * `NoSquash` - No one is mapped to anonymous user
5968
+ # * `RootSquash`\: Only root is mapped to anonymous user.
5652
5969
  #
5653
- # * `AllSquash` - Everyone is mapped to anonymous user.
5970
+ # * `NoSquash`\: No one is mapped to anonymous user.
5971
+ #
5972
+ # * `AllSquash`\: Everyone is mapped to anonymous user.
5654
5973
  #
5655
5974
  # @option params [Boolean] :read_only
5656
- # A value that sets the write status of a file share. This value is true
5657
- # if the write status is read-only, and otherwise false.
5975
+ # A value that sets the write status of a file share. Set this value to
5976
+ # `true` to set the write status to read-only, otherwise set to `false`.
5977
+ #
5978
+ # Valid Values: `true` \| `false`
5658
5979
  #
5659
5980
  # @option params [Boolean] :guess_mime_type_enabled
5660
5981
  # A value that enables guessing of the MIME type for uploaded objects
5661
- # based on file extensions. Set this value to true to enable MIME type
5662
- # guessing, and otherwise to false. The default value is true.
5982
+ # based on file extensions. Set this value to `true` to enable MIME type
5983
+ # guessing, otherwise set to `false`. The default value is `true`.
5984
+ #
5985
+ # Valid Values: `true` \| `false`
5663
5986
  #
5664
5987
  # @option params [Boolean] :requester_pays
5665
5988
  # A value that sets who pays the cost of the request and the cost
5666
5989
  # associated with data download from the S3 bucket. If this value is set
5667
- # to true, the requester pays the costs. Otherwise the S3 bucket owner
5668
- # pays. However, the S3 bucket owner always pays the cost of storing
5669
- # data.
5990
+ # to `true`, the requester pays the costs; otherwise, the S3 bucket
5991
+ # owner pays. However, the S3 bucket owner always pays the cost of
5992
+ # storing data.
5670
5993
  #
5671
5994
  # <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
5672
5995
  # file share, so make sure that the configuration on the file share is
@@ -5674,6 +5997,19 @@ module Aws::StorageGateway
5674
5997
  #
5675
5998
  # </note>
5676
5999
  #
6000
+ # Valid Values: `true` \| `false`
6001
+ #
6002
+ # @option params [String] :file_share_name
6003
+ # The name of the file share. Optional.
6004
+ #
6005
+ # <note markdown="1"> `FileShareName` must be set if an S3 prefix name is set in
6006
+ # `LocationARN`.
6007
+ #
6008
+ # </note>
6009
+ #
6010
+ # @option params [Types::CacheAttributes] :cache_attributes
6011
+ # Refresh cache information.
6012
+ #
5677
6013
  # @return [Types::UpdateNFSFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5678
6014
  #
5679
6015
  # * {Types::UpdateNFSFileShareOutput#file_share_arn #file_share_arn} => String
@@ -5697,6 +6033,10 @@ module Aws::StorageGateway
5697
6033
  # read_only: false,
5698
6034
  # guess_mime_type_enabled: false,
5699
6035
  # requester_pays: false,
6036
+ # file_share_name: "FileShareName",
6037
+ # cache_attributes: {
6038
+ # cache_stale_timeout_in_seconds: 1,
6039
+ # },
5700
6040
  # })
5701
6041
  #
5702
6042
  # @example Response structure
@@ -5724,8 +6064,8 @@ module Aws::StorageGateway
5724
6064
  # is activated in the AWS Region you are creating your file gateway in.
5725
6065
  # If AWS STS is not activated in this AWS Region, activate it. For
5726
6066
  # information about how to activate AWS STS, see [Activating and
5727
- # Deactivating AWS STS in an AWS Region][1] in the *AWS Identity and
5728
- # Access Management User Guide.*
6067
+ # deactivating AWS STS in an AWS Region][1] in the *AWS Identity and
6068
+ # Access Management User Guide*.
5729
6069
  #
5730
6070
  # File gateways don't support creating hard or symbolic links on a
5731
6071
  # file
@@ -5740,40 +6080,49 @@ module Aws::StorageGateway
5740
6080
  # update.
5741
6081
  #
5742
6082
  # @option params [Boolean] :kms_encrypted
5743
- # True to use Amazon S3 server-side encryption with your own AWS KMS
5744
- # key, or false to use a key managed by Amazon S3. Optional.
6083
+ # Set to `true` to use Amazon S3 server-side encryption with your own
6084
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
6085
+ #
6086
+ # Valid Values: `true` \| `false`
5745
6087
  #
5746
6088
  # @option params [String] :kms_key
5747
- # The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3
5748
- # server-side encryption. This value can only be set when KMSEncrypted
5749
- # is true. Optional.
6089
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
6090
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
6091
+ # not support asymmetric CMKs. This value can only be set when
6092
+ # `KMSEncrypted` is `true`. Optional.
5750
6093
  #
5751
6094
  # @option params [String] :default_storage_class
5752
6095
  # The default storage class for objects put into an Amazon S3 bucket by
5753
- # the file gateway. Possible values are `S3_STANDARD`, `S3_STANDARD_IA`,
5754
- # or `S3_ONEZONE_IA`. If this field is not populated, the default value
5755
- # `S3_STANDARD` is used. Optional.
6096
+ # the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
6097
+ # Optional.
6098
+ #
6099
+ # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
6100
+ # `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
5756
6101
  #
5757
6102
  # @option params [String] :object_acl
5758
- # A value that sets the access control list permission for objects in
5759
- # the S3 bucket that a file gateway puts objects into. The default value
5760
- # is "private".
6103
+ # A value that sets the access control list (ACL) permission for objects
6104
+ # in the S3 bucket that a file gateway puts objects into. The default
6105
+ # value is `private`.
5761
6106
  #
5762
6107
  # @option params [Boolean] :read_only
5763
- # A value that sets the write status of a file share. This value is true
5764
- # if the write status is read-only, and otherwise false.
6108
+ # A value that sets the write status of a file share. Set this value to
6109
+ # `true` to set write status to read-only, otherwise set to `false`.
6110
+ #
6111
+ # Valid Values: `true` \| `false`
5765
6112
  #
5766
6113
  # @option params [Boolean] :guess_mime_type_enabled
5767
6114
  # A value that enables guessing of the MIME type for uploaded objects
5768
- # based on file extensions. Set this value to true to enable MIME type
5769
- # guessing, and otherwise to false. The default value is true.
6115
+ # based on file extensions. Set this value to `true` to enable MIME type
6116
+ # guessing, otherwise set to `false`. The default value is `true`.
6117
+ #
6118
+ # Valid Values: `true` \| `false`
5770
6119
  #
5771
6120
  # @option params [Boolean] :requester_pays
5772
6121
  # A value that sets who pays the cost of the request and the cost
5773
6122
  # associated with data download from the S3 bucket. If this value is set
5774
- # to true, the requester pays the costs. Otherwise the S3 bucket owner
5775
- # pays. However, the S3 bucket owner always pays the cost of storing
5776
- # data.
6123
+ # to `true`, the requester pays the costs; otherwise, the S3 bucket
6124
+ # owner pays. However, the S3 bucket owner always pays the cost of
6125
+ # storing data.
5777
6126
  #
5778
6127
  # <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
5779
6128
  # file share, so make sure that the configuration on the file share is
@@ -5781,36 +6130,64 @@ module Aws::StorageGateway
5781
6130
  #
5782
6131
  # </note>
5783
6132
  #
6133
+ # Valid Values: `true` \| `false`
6134
+ #
5784
6135
  # @option params [Boolean] :smbacl_enabled
5785
- # Set this value to "true to enable ACL (access control list) on the
5786
- # SMB file share. Set it to "false" to map file and directory
6136
+ # Set this value to `true` to enable access control list (ACL) on the
6137
+ # SMB file share. Set it to `false` to map file and directory
5787
6138
  # permissions to the POSIX permissions.
5788
6139
  #
5789
- # For more information, see
5790
- # https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.htmlin
5791
- # the Storage Gateway User Guide.
6140
+ # For more information, see [Using Microsoft Windows ACLs to control
6141
+ # access to an SMB file share][1] in the *AWS Storage Gateway User
6142
+ # Guide*.
6143
+ #
6144
+ # Valid Values: `true` \| `false`
6145
+ #
6146
+ #
6147
+ #
6148
+ # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
5792
6149
  #
5793
6150
  # @option params [Array<String>] :admin_user_list
5794
- # A list of users in the Active Directory that have administrator rights
5795
- # to the file share. A group must be prefixed with the @ character. For
5796
- # example `@group1`. Can only be set if Authentication is set to
5797
- # `ActiveDirectory`.
6151
+ # A list of users or groups in the Active Directory that have
6152
+ # administrator rights to the file share. A group must be prefixed with
6153
+ # the @ character. Acceptable formats include: `DOMAIN\User1`, `user1`,
6154
+ # `@group1`, and `@DOMAIN\group1`. Can only be set if Authentication is
6155
+ # set to `ActiveDirectory`.
5798
6156
  #
5799
6157
  # @option params [Array<String>] :valid_user_list
5800
6158
  # A list of users or groups in the Active Directory that are allowed to
5801
6159
  # access the file share. A group must be prefixed with the @ character.
5802
- # For example `@group1`. Can only be set if Authentication is set to
6160
+ # Acceptable formats include: `DOMAIN\User1`, `user1`, `@group1`, and
6161
+ # `@DOMAIN\group1`. Can only be set if Authentication is set to
5803
6162
  # `ActiveDirectory`.
5804
6163
  #
5805
6164
  # @option params [Array<String>] :invalid_user_list
5806
6165
  # A list of users or groups in the Active Directory that are not allowed
5807
6166
  # to access the file share. A group must be prefixed with the @
5808
- # character. For example `@group1`. Can only be set if Authentication is
6167
+ # character. Acceptable formats include: `DOMAIN\User1`, `user1`,
6168
+ # `@group1`, and `@DOMAIN\group1`. Can only be set if Authentication is
5809
6169
  # set to `ActiveDirectory`.
5810
6170
  #
5811
6171
  # @option params [String] :audit_destination_arn
5812
6172
  # The Amazon Resource Name (ARN) of the storage used for the audit logs.
5813
6173
  #
6174
+ # @option params [String] :case_sensitivity
6175
+ # The case of an object name in an Amazon S3 bucket. For
6176
+ # `ClientSpecified`, the client determines the case sensitivity. For
6177
+ # `CaseSensitive`, the gateway determines the case sensitivity. The
6178
+ # default value is `ClientSpecified`.
6179
+ #
6180
+ # @option params [String] :file_share_name
6181
+ # The name of the file share. Optional.
6182
+ #
6183
+ # <note markdown="1"> `FileShareName` must be set if an S3 prefix name is set in
6184
+ # `LocationARN`.
6185
+ #
6186
+ # </note>
6187
+ #
6188
+ # @option params [Types::CacheAttributes] :cache_attributes
6189
+ # Refresh cache information.
6190
+ #
5814
6191
  # @return [Types::UpdateSMBFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5815
6192
  #
5816
6193
  # * {Types::UpdateSMBFileShareOutput#file_share_arn #file_share_arn} => String
@@ -5831,6 +6208,11 @@ module Aws::StorageGateway
5831
6208
  # valid_user_list: ["FileShareUser"],
5832
6209
  # invalid_user_list: ["FileShareUser"],
5833
6210
  # audit_destination_arn: "AuditDestinationARN",
6211
+ # case_sensitivity: "ClientSpecified", # accepts ClientSpecified, CaseSensitive
6212
+ # file_share_name: "FileShareName",
6213
+ # cache_attributes: {
6214
+ # cache_stale_timeout_in_seconds: 1,
6215
+ # },
5834
6216
  # })
5835
6217
  #
5836
6218
  # @example Response structure
@@ -6005,7 +6387,7 @@ module Aws::StorageGateway
6005
6387
  # @option params [required, String] :device_type
6006
6388
  # The type of medium changer you want to select.
6007
6389
  #
6008
- # Valid Values: "STK-L700", "AWS-Gateway-VTL"
6390
+ # Valid Values: `STK-L700` \| `AWS-Gateway-VTL` \| `IBM-03584L32-0402`
6009
6391
  #
6010
6392
  # @return [Types::UpdateVTLDeviceTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6011
6393
  #
@@ -6059,7 +6441,7 @@ module Aws::StorageGateway
6059
6441
  params: params,
6060
6442
  config: config)
6061
6443
  context[:gem_name] = 'aws-sdk-storagegateway'
6062
- context[:gem_version] = '1.42.1'
6444
+ context[:gem_version] = '1.47.0'
6063
6445
  Seahorse::Client::Request.new(handlers, context)
6064
6446
  end
6065
6447