aws-sdk-storagegateway 1.42.1 → 1.43.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: f5669dfd19d46585b533d8ec2bd2a7baaccc9561ad0aed7c8238230e88417a7b
4
+ data.tar.gz: 36d90bb39cc46d874659280bcdb047fb6d781b991528a0a554e920d87ce59b6a
5
5
  SHA512:
6
- metadata.gz: 6caa37736a42e977b2b336a60317c306d507727fe057c2584d2315a742344e7d04a8afc3171a65d56c1ec8c6a90b9857cdbbbd32329d571f1c5d79863114f805
7
- data.tar.gz: ad06c77ab2d773895e737b9c086d0c6245aa849960553004c9d6c028ec42b6846defa34927961091f3811fb7f97fbcd64eae8582a915304715f7f6bea555de92
6
+ metadata.gz: 62353f4c2a5306ff473c791dcacb4df64dd979a5c5645e7f97d33fbcce9a970de6d24900531cd268a56209c76e0117acba99641b6ae987d2c85312df1aea3f1f
7
+ data.tar.gz: 36a7f347cc8e347d317738f643cbc7dfc897dfd7c1a5a3f1cac13ab65a4624125b88bfa533569bd1665492cd7aaa3810ce57e883284a173f1d28780f8d54e4b9
@@ -45,6 +45,6 @@ require_relative 'aws-sdk-storagegateway/customizations'
45
45
  # @service
46
46
  module Aws::StorageGateway
47
47
 
48
- GEM_VERSION = '1.42.1'
48
+ GEM_VERSION = '1.43.0'
49
49
 
50
50
  end
@@ -325,7 +325,7 @@ module Aws::StorageGateway
325
325
  # that you want to use for storing snapshots or tapes, the time zone for
326
326
  # scheduled snapshots the gateway snapshot schedule window, an
327
327
  # activation key, and a name for your gateway. The activation process
328
- # also associates your gateway with your account; for more information,
328
+ # also associates your gateway with your account. For more information,
329
329
  # see UpdateGatewayInformation.
330
330
  #
331
331
  # <note markdown="1"> You must turn on the gateway VM before you can activate your gateway.
@@ -342,9 +342,12 @@ module Aws::StorageGateway
342
342
  # pass to the `ActivateGateway` API call determine the actual
343
343
  # configuration of your gateway.
344
344
  #
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.
345
+ # For more information, see [Getting activation key][1] in the *AWS
346
+ # Storage Gateway User Guide*.
347
+ #
348
+ #
349
+ #
350
+ # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html
348
351
  #
349
352
  # @option params [required, String] :gateway_name
350
353
  # The name you configured for your gateway.
@@ -362,34 +365,34 @@ module Aws::StorageGateway
362
365
  # data. The gateway AWS Region specified must be the same AWS Region as
363
366
  # the AWS Region in your `Host` header in the request. For more
364
367
  # information about available AWS Regions and endpoints for AWS Storage
365
- # Gateway, see [Regions and Endpoints][1] in the *Amazon Web Services
366
- # Glossary*.
368
+ # Gateway, see [AWS Storage Gateway endpoints and quotas][1] in the *AWS
369
+ # General Reference*.
367
370
  #
368
- # Valid Values: See [AWS Storage Gateway Regions and Endpoints][1] in
369
- # the AWS General Reference.
371
+ # Valid Values: See [AWS Storage Gateway endpoints and quotas][1] in the
372
+ # *AWS General Reference*.
370
373
  #
371
374
  #
372
375
  #
373
- # [1]: https://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region
376
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/sg.html
374
377
  #
375
378
  # @option params [String] :gateway_type
376
379
  # A value that defines the type of gateway to activate. The type
377
380
  # specified is critical to all later functions of the gateway and cannot
378
381
  # be changed after activation. The default value is `CACHED`.
379
382
  #
380
- # Valid Values: "STORED", "CACHED", "VTL", "FILE\_S3"
383
+ # Valid Values: `STORED` \| `CACHED` \| `VTL` \| `FILE_S3`
381
384
  #
382
385
  # @option params [String] :tape_drive_type
383
386
  # The value that indicates the type of tape drive to use for tape
384
387
  # gateway. This field is optional.
385
388
  #
386
- # Valid Values: "IBM-ULT3580-TD5"
389
+ # Valid Values: `IBM-ULT3580-TD5`
387
390
  #
388
391
  # @option params [String] :medium_changer_type
389
392
  # The value that indicates the type of medium changer to use for tape
390
393
  # gateway. This field is optional.
391
394
  #
392
- # Valid Values: "STK-L700", "AWS-Gateway-VTL"
395
+ # Valid Values: `STK-L700` \| `AWS-Gateway-VTL`
393
396
  #
394
397
  # @option params [Array<Types::Tag>] :tags
395
398
  # A list of up to 50 tags that you can assign to the gateway. Each tag
@@ -459,8 +462,8 @@ module Aws::StorageGateway
459
462
  end
460
463
 
461
464
  # 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]).
465
+ # This operation is only supported in the cached volume, tape, and file
466
+ # gateway type (see [How AWS Storage Gateway works (architecture)][1].
464
467
  #
465
468
  # In the request, you specify the gateway Amazon Resource Name (ARN) to
466
469
  # which you want to add cache, and one or more disk IDs that you want to
@@ -739,7 +742,7 @@ module Aws::StorageGateway
739
742
  # is archived directly into the S3 storage class (S3 Glacier or S3
740
743
  # Glacier Deep Archive) that corresponds to the pool.
741
744
  #
742
- # Valid values: "GLACIER", "DEEP\_ARCHIVE"
745
+ # Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
743
746
  #
744
747
  # @option params [required, String] :tape_arn
745
748
  # The unique Amazon Resource Name (ARN) of the virtual tape that you
@@ -752,7 +755,7 @@ module Aws::StorageGateway
752
755
  # eject the tape, the tape is archived directly into the storage class
753
756
  # (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
754
757
  #
755
- # Valid values: "GLACIER", "DEEP\_ARCHIVE"
758
+ # Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
756
759
  #
757
760
  # @return [Types::AssignTapePoolOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
758
761
  #
@@ -983,7 +986,7 @@ module Aws::StorageGateway
983
986
  # @option params [String] :snapshot_id
984
987
  # The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as
985
988
  # 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
989
+ # iSCSI storage volume from a snapshot; otherwise, do not include this
987
990
  # field. To list snapshots for your account use [DescribeSnapshots][1]
988
991
  # in the *Amazon Elastic Compute Cloud API Reference*.
989
992
  #
@@ -1021,13 +1024,16 @@ module Aws::StorageGateway
1021
1024
  # request.
1022
1025
  #
1023
1026
  # @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.
1027
+ # Set to `true` to use Amazon S3 server-side encryption with your own
1028
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1029
+ #
1030
+ # Valid Values: `true` \| `false`
1026
1031
  #
1027
1032
  # @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.
1033
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
1034
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
1035
+ # not support asymmetric CMKs. This value can only be set when
1036
+ # `KMSEncrypted` is `true`. Optional.
1031
1037
  #
1032
1038
  # @option params [Array<Types::Tag>] :tags
1033
1039
  # A list of up to 50 tags that you can assign to a cached volume. Each
@@ -1110,13 +1116,17 @@ module Aws::StorageGateway
1110
1116
  # activated to enable you to create a file share. Make sure AWS STS is
1111
1117
  # activated in the AWS Region you are creating your file gateway in. If
1112
1118
  # 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.
1119
+ # information about how to activate AWS STS, see [Activating and
1120
+ # deactivating AWS STS in an AWS Region][1] in the *AWS Identity and
1121
+ # Access Management User Guide*.
1116
1122
  #
1117
1123
  # File gateway does not support creating hard or symbolic links on a
1118
1124
  # file share.
1119
1125
  #
1126
+ #
1127
+ #
1128
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html
1129
+ #
1120
1130
  # @option params [required, String] :client_token
1121
1131
  # A unique string value that you supply that is used by file gateway to
1122
1132
  # ensure idempotent file share creation.
@@ -1129,13 +1139,16 @@ module Aws::StorageGateway
1129
1139
  # to create a file share.
1130
1140
  #
1131
1141
  # @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.
1142
+ # Set to `true` to use Amazon S3 server-side encryption with your own
1143
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1144
+ #
1145
+ # Valid Values: `true` \| `false`
1134
1146
  #
1135
1147
  # @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.
1148
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
1149
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
1150
+ # not support asymmetric CMKs. This value can only be set when
1151
+ # `KMSEncrypted` is `true`. Optional.
1139
1152
  #
1140
1153
  # @option params [required, String] :role
1141
1154
  # The ARN of the AWS Identity and Access Management (IAM) role that a
@@ -1146,44 +1159,51 @@ module Aws::StorageGateway
1146
1159
  #
1147
1160
  # @option params [String] :default_storage_class
1148
1161
  # 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.
1162
+ # the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
1163
+ # Optional.
1164
+ #
1165
+ # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
1166
+ # `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
1152
1167
  #
1153
1168
  # @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".
1169
+ # A value that sets the access control list (ACL) permission for objects
1170
+ # in the S3 bucket that a file gateway puts objects into. The default
1171
+ # value is `private`.
1157
1172
  #
1158
1173
  # @option params [Array<String>] :client_list
1159
1174
  # The list of clients that are allowed to access the file gateway. The
1160
1175
  # list must contain either valid IP addresses or valid CIDR blocks.
1161
1176
  #
1162
1177
  # @option params [String] :squash
1163
- # A value that maps a user to anonymous user. Valid options are the
1164
- # following:
1178
+ # A value that maps a user to anonymous user.
1179
+ #
1180
+ # Valid values are the following:
1165
1181
  #
1166
- # * `RootSquash` - Only root is mapped to anonymous user.
1182
+ # * `RootSquash`\: Only root is mapped to anonymous user.
1167
1183
  #
1168
- # * `NoSquash` - No one is mapped to anonymous user
1184
+ # * `NoSquash`\: No one is mapped to anonymous user.
1169
1185
  #
1170
- # * `AllSquash` - Everyone is mapped to anonymous user.
1186
+ # * `AllSquash`\: Everyone is mapped to anonymous user.
1171
1187
  #
1172
1188
  # @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.
1189
+ # A value that sets the write status of a file share. Set this value to
1190
+ # `true` to set the write status to read-only, otherwise set to `false`.
1191
+ #
1192
+ # Valid Values: `true` \| `false`
1175
1193
  #
1176
1194
  # @option params [Boolean] :guess_mime_type_enabled
1177
1195
  # 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.
1196
+ # based on file extensions. Set this value to `true` to enable MIME type
1197
+ # guessing, otherwise set to `false`. The default value is `true`.
1198
+ #
1199
+ # Valid Values: `true` \| `false`
1180
1200
  #
1181
1201
  # @option params [Boolean] :requester_pays
1182
1202
  # A value that sets who pays the cost of the request and the cost
1183
1203
  # 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.
1204
+ # to `true`, the requester pays the costs; otherwise, the S3 bucket
1205
+ # owner pays. However, the S3 bucket owner always pays the cost of
1206
+ # storing data.
1187
1207
  #
1188
1208
  # <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
1189
1209
  # file share, so make sure that the configuration on the file share is
@@ -1191,6 +1211,8 @@ module Aws::StorageGateway
1191
1211
  #
1192
1212
  # </note>
1193
1213
  #
1214
+ # Valid Values: `true` \| `false`
1215
+ #
1194
1216
  # @option params [Array<Types::Tag>] :tags
1195
1217
  # A list of up to 50 tags that can be assigned to the NFS file share.
1196
1218
  # Each tag is a key-value pair.
@@ -1260,8 +1282,8 @@ module Aws::StorageGateway
1260
1282
  # is activated in the AWS Region you are creating your file gateway in.
1261
1283
  # If AWS STS is not activated in this AWS Region, activate it. For
1262
1284
  # 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.*
1285
+ # deactivating AWS STS in an AWS Region][1] in the *AWS Identity and
1286
+ # Access Management User Guide*.
1265
1287
  #
1266
1288
  # File gateways don't support creating hard or symbolic links on a
1267
1289
  # file
@@ -1279,13 +1301,16 @@ module Aws::StorageGateway
1279
1301
  # The ARN of the file gateway on which you want to create a file share.
1280
1302
  #
1281
1303
  # @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.
1304
+ # Set to `true` to use Amazon S3 server-side encryption with your own
1305
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1306
+ #
1307
+ # Valid Values: `true` \| `false`
1284
1308
  #
1285
1309
  # @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.
1310
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
1311
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
1312
+ # not support asymmetric CMKs. This value can only be set when
1313
+ # `KMSEncrypted` is `true`. Optional.
1289
1314
  #
1290
1315
  # @option params [required, String] :role
1291
1316
  # The ARN of the AWS Identity and Access Management (IAM) role that a
@@ -1296,30 +1321,36 @@ module Aws::StorageGateway
1296
1321
  #
1297
1322
  # @option params [String] :default_storage_class
1298
1323
  # 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.
1324
+ # the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
1325
+ # Optional.
1326
+ #
1327
+ # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
1328
+ # `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
1302
1329
  #
1303
1330
  # @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".
1331
+ # A value that sets the access control list (ACL) permission for objects
1332
+ # in the S3 bucket that a file gateway puts objects into. The default
1333
+ # value is `private`.
1307
1334
  #
1308
1335
  # @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.
1336
+ # A value that sets the write status of a file share. Set this value to
1337
+ # `true` to set the write status to read-only, otherwise set to `false`.
1338
+ #
1339
+ # Valid Values: `true` \| `false`
1311
1340
  #
1312
1341
  # @option params [Boolean] :guess_mime_type_enabled
1313
1342
  # 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.
1343
+ # based on file extensions. Set this value to `true` to enable MIME type
1344
+ # guessing, otherwise set to `false`. The default value is `true`.
1345
+ #
1346
+ # Valid Values: `true` \| `false`
1316
1347
  #
1317
1348
  # @option params [Boolean] :requester_pays
1318
1349
  # A value that sets who pays the cost of the request and the cost
1319
1350
  # 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.
1351
+ # to `true`, the requester pays the costs; otherwise, the S3 bucket
1352
+ # owner pays. However, the S3 bucket owner always pays the cost of
1353
+ # storing data.
1323
1354
  #
1324
1355
  # <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
1325
1356
  # file share, so make sure that the configuration on the file share is
@@ -1327,14 +1358,22 @@ module Aws::StorageGateway
1327
1358
  #
1328
1359
  # </note>
1329
1360
  #
1361
+ # Valid Values: `true` \| `false`
1362
+ #
1330
1363
  # @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
1364
+ # Set this value to `true` to enable access control list (ACL) on the
1365
+ # SMB file share. Set it to `false` to map file and directory
1333
1366
  # permissions to the POSIX permissions.
1334
1367
  #
1335
- # For more information, see
1336
- # https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
1337
- # in the Storage Gateway User Guide.
1368
+ # For more information, see [Using Microsoft Windows ACLs to control
1369
+ # access to an SMB file share][1] in the *AWS Storage Gateway User
1370
+ # Guide*.
1371
+ #
1372
+ # Valid Values: `true` \| `false`
1373
+ #
1374
+ #
1375
+ #
1376
+ # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
1338
1377
  #
1339
1378
  # @option params [Array<String>] :admin_user_list
1340
1379
  # A list of users in the Active Directory that will be granted
@@ -1347,7 +1386,7 @@ module Aws::StorageGateway
1347
1386
  # @option params [Array<String>] :valid_user_list
1348
1387
  # A list of users or groups in the Active Directory that are allowed to
1349
1388
  # 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
1389
+ # For example, `@group1`. Can only be set if Authentication is set to
1351
1390
  # `ActiveDirectory`.
1352
1391
  #
1353
1392
  # @option params [Array<String>] :invalid_user_list
@@ -1360,10 +1399,10 @@ module Aws::StorageGateway
1360
1399
  # The Amazon Resource Name (ARN) of the storage used for the audit logs.
1361
1400
  #
1362
1401
  # @option params [String] :authentication
1363
- # The authentication method that users use to access the file share.
1402
+ # The authentication method that users use to access the file share. The
1403
+ # default is `ActiveDirectory`.
1364
1404
  #
1365
- # Valid values are `ActiveDirectory` or `GuestAccess`. The default is
1366
- # `ActiveDirectory`.
1405
+ # Valid Values: `ActiveDirectory` \| `GuestAccess`
1367
1406
  #
1368
1407
  # @option params [Array<Types::Tag>] :tags
1369
1408
  # A list of up to 50 tags that can be assigned to the NFS file share.
@@ -1424,12 +1463,12 @@ module Aws::StorageGateway
1424
1463
  # Initiates a snapshot of a volume.
1425
1464
  #
1426
1465
  # 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
1466
+ # snapshots of your data to Amazon Simple Storage (Amazon S3) for
1467
+ # durable off-site recovery, as well as import the data to an Amazon
1429
1468
  # Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud
1430
1469
  # (EC2). You can take snapshots of your gateway volume on a scheduled or
1431
- # ad hoc basis. This API enables you to take an ad hoc snapshot. For
1432
- # more information, see [Editing a Snapshot Schedule][1].
1470
+ # ad hoc basis. This API enables you to take ad-hoc snapshot. For more
1471
+ # information, see [Editing a snapshot schedule][1].
1433
1472
  #
1434
1473
  # In the CreateSnapshot request you identify the volume by providing its
1435
1474
  # Amazon Resource Name (ARN). You must also provide description for the
@@ -1442,19 +1481,20 @@ module Aws::StorageGateway
1442
1481
  # gateway type.
1443
1482
  #
1444
1483
  # <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].
1484
+ # more information, see [DescribeSnapshots][2] or [DeleteSnapshot][3] in
1485
+ # the *Amazon Elastic Compute Cloud API Reference*.
1447
1486
  #
1448
1487
  # </note>
1449
1488
  #
1450
1489
  # 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.
1490
+ # more information, see the important note on the [Welcome][4] page.
1452
1491
  #
1453
1492
  #
1454
1493
  #
1455
1494
  # [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
1495
+ # [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html
1496
+ # [3]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html
1497
+ # [4]: https://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html
1458
1498
  #
1459
1499
  # @option params [required, String] :volume_arn
1460
1500
  # The Amazon Resource Name (ARN) of the volume. Use the ListVolumes
@@ -1464,7 +1504,7 @@ module Aws::StorageGateway
1464
1504
  # Textual description of the snapshot that appears in the Amazon EC2
1465
1505
  # console, Elastic Block Store snapshots panel in the **Description**
1466
1506
  # field, and in the AWS Storage Gateway snapshot **Details** pane,
1467
- # **Description** field
1507
+ # **Description** field.
1468
1508
  #
1469
1509
  # @option params [Array<Types::Tag>] :tags
1470
1510
  # A list of up to 50 tags that can be assigned to a snapshot. Each tag
@@ -1543,10 +1583,16 @@ module Aws::StorageGateway
1543
1583
  # from a snapshot.
1544
1584
  #
1545
1585
  # <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*.
1586
+ # more information, see [DescribeSnapshots][1] or [DeleteSnapshot][2] in
1587
+ # the *Amazon Elastic Compute Cloud API Reference*.
1547
1588
  #
1548
1589
  # </note>
1549
1590
  #
1591
+ #
1592
+ #
1593
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html
1594
+ # [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html
1595
+ #
1550
1596
  # @option params [required, String] :volume_arn
1551
1597
  # The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
1552
1598
  # DescribeStorediSCSIVolumes operation to return to retrieve the
@@ -1556,7 +1602,7 @@ module Aws::StorageGateway
1556
1602
  # Textual description of the snapshot that appears in the Amazon EC2
1557
1603
  # console, Elastic Block Store snapshots panel in the **Description**
1558
1604
  # field, and in the AWS Storage Gateway snapshot **Details** pane,
1559
- # **Description** field
1605
+ # **Description** field.
1560
1606
  #
1561
1607
  # @option params [Array<Types::Tag>] :tags
1562
1608
  # A list of up to 50 tags that can be assigned to a snapshot. Each tag
@@ -1652,7 +1698,7 @@ module Aws::StorageGateway
1652
1698
  # @option params [String] :snapshot_id
1653
1699
  # The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as
1654
1700
  # 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
1701
+ # iSCSI storage volume from a snapshot; otherwise, do not include this
1656
1702
  # field. To list snapshots for your account use [DescribeSnapshots][1]
1657
1703
  # in the *Amazon Elastic Compute Cloud API Reference*.
1658
1704
  #
@@ -1661,11 +1707,10 @@ module Aws::StorageGateway
1661
1707
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html
1662
1708
  #
1663
1709
  # @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.
1710
+ # Set to true `true` if you want to preserve the data on the local disk.
1711
+ # Otherwise, set to `false` to create an empty volume.
1667
1712
  #
1668
- # Valid Values: true, false
1713
+ # Valid Values: `true` \| `false`
1669
1714
  #
1670
1715
  # @option params [required, String] :target_name
1671
1716
  # The name of the iSCSI target used by an initiator to connect to a
@@ -1686,13 +1731,16 @@ module Aws::StorageGateway
1686
1731
  # Valid Values: A valid IP address.
1687
1732
  #
1688
1733
  # @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.
1734
+ # Set to `true` to use Amazon S3 server-side encryption with your own
1735
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1736
+ #
1737
+ # Valid Values: `true` \| `false`
1691
1738
  #
1692
1739
  # @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.
1740
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
1741
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
1742
+ # not support asymmetric CMKs. This value can only be set when
1743
+ # `KMSEncrypted` is `true`. Optional.
1696
1744
  #
1697
1745
  # @option params [Array<Types::Tag>] :tags
1698
1746
  # A list of up to 50 tags that can be assigned to a stored volume. Each
@@ -1768,7 +1816,7 @@ module Aws::StorageGateway
1768
1816
 
1769
1817
  # Creates a virtual tape by using your own barcode. You write data to
1770
1818
  # the virtual tape and then archive the tape. A barcode is unique and
1771
- # cannot be reused if it has already been used on a tape. This applies
1819
+ # can not be reused if it has already been used on a tape. This applies
1772
1820
  # to barcodes used on deleted tapes. This operation is only supported in
1773
1821
  # the tape gateway type.
1774
1822
  #
@@ -1799,22 +1847,25 @@ module Aws::StorageGateway
1799
1847
  # </note>
1800
1848
  #
1801
1849
  # @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.
1850
+ # Set to `true` to use Amazon S3 server-side encryption with your own
1851
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1852
+ #
1853
+ # Valid Values: `true` \| `false`
1804
1854
  #
1805
1855
  # @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.
1856
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
1857
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
1858
+ # not support asymmetric CMKs. This value can only be set when
1859
+ # `KMSEncrypted` is `true`. Optional.
1809
1860
  #
1810
1861
  # @option params [String] :pool_id
1811
1862
  # The ID of the pool that you want to add your tape to for archiving.
1812
1863
  # The tape in this pool is archived in the S3 storage class that is
1813
1864
  # associated with the pool. When you use your backup application to
1814
1865
  # 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.
1866
+ # (S3 Glacier or S3 Deep Archive) that corresponds to the pool.
1816
1867
  #
1817
- # Valid values: "GLACIER", "DEEP\_ARCHIVE"
1868
+ # Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
1818
1869
  #
1819
1870
  # @option params [Array<Types::Tag>] :tags
1820
1871
  # A list of up to 50 tags that can be assigned to a virtual tape that
@@ -1922,13 +1973,16 @@ module Aws::StorageGateway
1922
1973
  # </note>
1923
1974
  #
1924
1975
  # @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.
1976
+ # Set to `true` to use Amazon S3 server-side encryption with your own
1977
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1978
+ #
1979
+ # Valid Values: `true` \| `false`
1927
1980
  #
1928
1981
  # @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.
1982
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
1983
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
1984
+ # not support asymmetric CMKs. This value can only be set when
1985
+ # `KMSEncrypted` is `true`. Optional.
1932
1986
  #
1933
1987
  # @option params [String] :pool_id
1934
1988
  # The ID of the pool that you want to add your tape to for archiving.
@@ -1937,7 +1991,7 @@ module Aws::StorageGateway
1937
1991
  # eject the tape, the tape is archived directly into the storage class
1938
1992
  # (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
1939
1993
  #
1940
- # Valid values: "GLACIER", "DEEP\_ARCHIVE"
1994
+ # Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
1941
1995
  #
1942
1996
  # @option params [Array<Types::Tag>] :tags
1943
1997
  # A list of up to 50 tags that can be assigned to a virtual tape. Each
@@ -2058,7 +2112,7 @@ module Aws::StorageGateway
2058
2112
  # One of the BandwidthType values that indicates the gateway bandwidth
2059
2113
  # rate limit to delete.
2060
2114
  #
2061
- # Valid Values: `Upload`, `Download`, `All`.
2115
+ # Valid Values: `Upload` \| `Download` \| `All`
2062
2116
  #
2063
2117
  # @return [Types::DeleteBandwidthRateLimitOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2064
2118
  #
@@ -2160,11 +2214,13 @@ module Aws::StorageGateway
2160
2214
  # The Amazon Resource Name (ARN) of the file share to be deleted.
2161
2215
  #
2162
2216
  # @option params [Boolean] :force_delete
2163
- # If this value is set to true, the operation deletes a file share
2217
+ # If this value is set to `true`, the operation deletes a file share
2164
2218
  # immediately and aborts all data uploads to AWS. Otherwise, the file
2165
2219
  # share is not deleted until all data is uploaded to AWS. This process
2166
2220
  # aborts the data upload process, and the file share enters the
2167
- # FORCE\_DELETING status.
2221
+ # `FORCE_DELETING` status.
2222
+ #
2223
+ # Valid Values: `true` \| `false`
2168
2224
  #
2169
2225
  # @return [Types::DeleteFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2170
2226
  #
@@ -2207,8 +2263,8 @@ module Aws::StorageGateway
2207
2263
  # all remaining Amazon EBS snapshots by canceling your Amazon EC2
2208
2264
  # subscription.  If you prefer not to cancel your Amazon EC2
2209
2265
  # subscription, you can delete your snapshots using the Amazon EC2
2210
- # console. For more information, see the [ AWS Storage Gateway Detail
2211
- # Page][1].
2266
+ # console. For more information, see the [AWS Storage Gateway detail
2267
+ # page][1].
2212
2268
  #
2213
2269
  #
2214
2270
  #
@@ -2260,7 +2316,7 @@ module Aws::StorageGateway
2260
2316
  #
2261
2317
  # You can take snapshots of your gateway volumes on a scheduled or ad
2262
2318
  # hoc basis. This API action enables you to delete a snapshot schedule
2263
- # for a volume. For more information, see [Working with Snapshots][1].
2319
+ # for a volume. For more information, see [Backing up your volumes][1].
2264
2320
  # In the `DeleteSnapshotSchedule` request, you identify the volume by
2265
2321
  # providing its Amazon Resource Name (ARN). This operation is only
2266
2322
  # supported in stored and cached volume gateway types.
@@ -2273,7 +2329,7 @@ module Aws::StorageGateway
2273
2329
  #
2274
2330
  #
2275
2331
  #
2276
- # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/WorkingWithSnapshots.html
2332
+ # [1]: https://docs.aws.amazon.com/storagegatewaylatest/userguide/backing-up-volumes.html
2277
2333
  # [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html
2278
2334
  #
2279
2335
  # @option params [required, String] :volume_arn
@@ -2513,7 +2569,7 @@ module Aws::StorageGateway
2513
2569
  # Returns the bandwidth rate limits of a gateway. By default, these
2514
2570
  # limits are not set, which means no bandwidth rate limiting is in
2515
2571
  # effect. This operation is supported for the stored volume, cached
2516
- # volume and tape gateway types.'
2572
+ # volume and tape gateway types.
2517
2573
  #
2518
2574
  # This operation only returns a value for a bandwidth rate limit only if
2519
2575
  # the limit is set. If no limits are set for the gateway, then this
@@ -2809,6 +2865,7 @@ module Aws::StorageGateway
2809
2865
  # * {Types::DescribeGatewayInformationOutput#vpc_endpoint #vpc_endpoint} => String
2810
2866
  # * {Types::DescribeGatewayInformationOutput#cloud_watch_log_group_arn #cloud_watch_log_group_arn} => String
2811
2867
  # * {Types::DescribeGatewayInformationOutput#host_environment #host_environment} => String
2868
+ # * {Types::DescribeGatewayInformationOutput#endpoint_type #endpoint_type} => String
2812
2869
  #
2813
2870
  #
2814
2871
  # @example Example: To describe metadata about the gateway
@@ -2865,6 +2922,7 @@ module Aws::StorageGateway
2865
2922
  # resp.vpc_endpoint #=> String
2866
2923
  # resp.cloud_watch_log_group_arn #=> String
2867
2924
  # resp.host_environment #=> String, one of "VMWARE", "HYPER-V", "EC2", "KVM", "OTHER"
2925
+ # resp.endpoint_type #=> String
2868
2926
  #
2869
2927
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeGatewayInformation AWS API Documentation
2870
2928
  #
@@ -3152,7 +3210,7 @@ module Aws::StorageGateway
3152
3210
 
3153
3211
  # Returns the description of the gateway volumes specified in the
3154
3212
  # request. The list of gateway volumes in the request must be from one
3155
- # gateway. In the response AWS Storage Gateway returns volume
3213
+ # gateway. In the response, AWS Storage Gateway returns volume
3156
3214
  # information sorted by volume ARNs. This operation is only supported in
3157
3215
  # stored volume gateway type.
3158
3216
  #
@@ -3519,7 +3577,7 @@ module Aws::StorageGateway
3519
3577
  end
3520
3578
 
3521
3579
  # Returns information about the upload buffer of a gateway. This
3522
- # operation is supported for the stored volume, cached volume and tape
3580
+ # operation is supported for the stored volume, cached volume, and tape
3523
3581
  # gateway types.
3524
3582
  #
3525
3583
  # The response includes disk IDs that are configured as upload buffer
@@ -3816,6 +3874,8 @@ module Aws::StorageGateway
3816
3874
  # set to `false`, you must manually disconnect the iSCSI connection from
3817
3875
  # the target volume.
3818
3876
  #
3877
+ # Valid Values: `true` \| `false`
3878
+ #
3819
3879
  # @return [Types::DetachVolumeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3820
3880
  #
3821
3881
  # * {Types::DetachVolumeOutput#volume_arn #volume_arn} => String
@@ -4565,9 +4625,12 @@ module Aws::StorageGateway
4565
4625
  # as Amazon SNS or AWS Lambda function. This operation is only supported
4566
4626
  # for file gateways.
4567
4627
  #
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).
4628
+ # For more information, see [Getting file upload notification][1] in the
4629
+ # *AWS Storage Gateway User Guide*.
4630
+ #
4631
+ #
4632
+ #
4633
+ # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification
4571
4634
  #
4572
4635
  # @option params [required, String] :file_share_arn
4573
4636
  # The Amazon Resource Name (ARN) of the file share.
@@ -4603,7 +4666,8 @@ module Aws::StorageGateway
4603
4666
  # results. This operation is only supported in the file gateway type.
4604
4667
  # You can subscribe to be notified through an Amazon CloudWatch event
4605
4668
  # when your RefreshCache operation completes. For more information, see
4606
- # [Getting Notified About File Operations][1].
4669
+ # [Getting notified about file operations][1] in the *AWS Storage
4670
+ # Gateway User Guide*.
4607
4671
  #
4608
4672
  # When this API is called, it only initiates the refresh operation. When
4609
4673
  # the API call completes and returns a success code, it doesn't
@@ -4616,16 +4680,16 @@ module Aws::StorageGateway
4616
4680
  # Throttle limit: This API is asynchronous so the gateway will accept no
4617
4681
  # more than two refreshes at any time. We recommend using the
4618
4682
  # refresh-complete CloudWatch event notification before issuing
4619
- # additional requests. For more information, see [Getting Notified About
4620
- # File Operations][1].
4683
+ # additional requests. For more information, see [Getting notified about
4684
+ # file operations][1] in the *AWS Storage Gateway User Guide*.
4621
4685
  #
4622
4686
  # If you invoke the RefreshCache API when two requests are already being
4623
4687
  # processed, any new request will cause an
4624
4688
  # `InvalidGatewayRequestException` error because too many requests were
4625
4689
  # sent to the server.
4626
4690
  #
4627
- # For more information, see
4628
- # "https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification".
4691
+ # For more information, see [Getting notified about file operations][1]
4692
+ # in the *AWS Storage Gateway User Guide*.
4629
4693
  #
4630
4694
  #
4631
4695
  #
@@ -4638,18 +4702,19 @@ module Aws::StorageGateway
4638
4702
  # A comma-separated list of the paths of folders to refresh in the
4639
4703
  # cache. The default is \[`"/"`\]. The default refreshes objects and
4640
4704
  # 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
4705
+ # `true`, the entire S3 bucket that the file share has access to is
4642
4706
  # refreshed.
4643
4707
  #
4644
4708
  # @option params [Boolean] :recursive
4645
4709
  # A value that specifies whether to recursively refresh folders in the
4646
4710
  # cache. The refresh includes folders that were in the cache the last
4647
4711
  # time the gateway listed the folder's contents. If this value set to
4648
- # "true", each folder that is listed in `FolderList` is recursively
4712
+ # `true`, each folder that is listed in `FolderList` is recursively
4649
4713
  # updated. Otherwise, subfolders listed in `FolderList` are not
4650
4714
  # refreshed. Only objects that are in folders listed directly under
4651
- # `FolderList` are found and used for the update. The default is
4652
- # "true".
4715
+ # `FolderList` are found and used for the update. The default is `true`.
4716
+ #
4717
+ # Valid Values: `true` \| `false`
4653
4718
  #
4654
4719
  # @return [Types::RefreshCacheOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4655
4720
  #
@@ -4975,7 +5040,7 @@ module Aws::StorageGateway
4975
5040
  # is associated with.
4976
5041
  #
4977
5042
  # @option params [required, String] :password
4978
- # The password that you want to set for your SMB Server.
5043
+ # The password that you want to set for your SMB server.
4979
5044
  #
4980
5045
  # @return [Types::SetSMBGuestPasswordOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4981
5046
  #
@@ -5014,7 +5079,7 @@ module Aws::StorageGateway
5014
5079
  # </note>
5015
5080
  #
5016
5081
  # After the gateway is shutdown, you cannot call any other API except
5017
- # StartGateway, DescribeGatewayInformation and ListGateways. For more
5082
+ # StartGateway, DescribeGatewayInformation, and ListGateways. For more
5018
5083
  # information, see ActivateGateway. Your applications cannot read from
5019
5084
  # or write to the gateway's storage volumes, and there are no snapshots
5020
5085
  # taken.
@@ -5226,7 +5291,7 @@ module Aws::StorageGateway
5226
5291
  # the upload and download bandwidth rate limit or specify only one of
5227
5292
  # the two. If you don't set a bandwidth rate limit, the existing rate
5228
5293
  # limit remains. This operation is supported for the stored volume,
5229
- # cached volume and tape gateway types.'
5294
+ # cached volume, and tape gateway types.
5230
5295
  #
5231
5296
  # By default, a gateway's bandwidth rate limits are not set. If you
5232
5297
  # don't set any limit, the gateway does not have any limitations on its
@@ -5395,7 +5460,7 @@ module Aws::StorageGateway
5395
5460
  # The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that
5396
5461
  # you want to use to monitor and log events in the gateway.
5397
5462
  #
5398
- # For more information, see [What Is Amazon CloudWatch Logs?][1].
5463
+ # For more information, see [What is Amazon CloudWatch logs?][1].
5399
5464
  #
5400
5465
  #
5401
5466
  #
@@ -5460,8 +5525,8 @@ module Aws::StorageGateway
5460
5525
  # minimize the chance of any disruption to your applications by
5461
5526
  # increasing your iSCSI Initiators' timeouts. For more information
5462
5527
  # 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.
5528
+ # [Customizing your Windows iSCSI settings][1] and [Customizing your
5529
+ # Linux iSCSI settings][2], respectively.
5465
5530
  #
5466
5531
  #
5467
5532
  #
@@ -5539,10 +5604,6 @@ module Aws::StorageGateway
5539
5604
  # represented as an ordinal number from 1 to 28, where 1 represents the
5540
5605
  # first day of the month and 28 represents the last day of the month.
5541
5606
  #
5542
- # <note markdown="1"> This value is only available for tape and volume gateways.
5543
- #
5544
- # </note>
5545
- #
5546
5607
  # @return [Types::UpdateMaintenanceStartTimeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5547
5608
  #
5548
5609
  # * {Types::UpdateMaintenanceStartTimeOutput#gateway_arn #gateway_arn} => String
@@ -5617,56 +5678,67 @@ module Aws::StorageGateway
5617
5678
  # The Amazon Resource Name (ARN) of the file share to be updated.
5618
5679
  #
5619
5680
  # @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.
5681
+ # Set to `true` to use Amazon S3 server-side encryption with your own
5682
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
5683
+ #
5684
+ # Valid Values: `true` \| `false`
5622
5685
  #
5623
5686
  # @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.
5687
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
5688
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
5689
+ # not support asymmetric CMKs. This value can only be set when
5690
+ # `KMSEncrypted` is `true`. Optional.
5627
5691
  #
5628
5692
  # @option params [Types::NFSFileShareDefaults] :nfs_file_share_defaults
5629
5693
  # The default values for the file share. Optional.
5630
5694
  #
5631
5695
  # @option params [String] :default_storage_class
5632
5696
  # 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.
5697
+ # the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
5698
+ # Optional.
5699
+ #
5700
+ # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
5701
+ # `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
5636
5702
  #
5637
5703
  # @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".
5704
+ # A value that sets the access control list (ACL) permission for objects
5705
+ # in the S3 bucket that a file gateway puts objects into. The default
5706
+ # value is `private`.
5641
5707
  #
5642
5708
  # @option params [Array<String>] :client_list
5643
5709
  # The list of clients that are allowed to access the file gateway. The
5644
5710
  # list must contain either valid IP addresses or valid CIDR blocks.
5645
5711
  #
5646
5712
  # @option params [String] :squash
5647
- # The user mapped to anonymous user. Valid options are the following:
5713
+ # The user mapped to anonymous user.
5714
+ #
5715
+ # Valid values are the following:
5648
5716
  #
5649
- # * `RootSquash` - Only root is mapped to anonymous user.
5717
+ # * `RootSquash`\: Only root is mapped to anonymous user.
5650
5718
  #
5651
- # * `NoSquash` - No one is mapped to anonymous user
5719
+ # * `NoSquash`\: No one is mapped to anonymous user.
5652
5720
  #
5653
- # * `AllSquash` - Everyone is mapped to anonymous user.
5721
+ # * `AllSquash`\: Everyone is mapped to anonymous user.
5654
5722
  #
5655
5723
  # @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.
5724
+ # A value that sets the write status of a file share. Set this value to
5725
+ # `true` to set the write status to read-only, otherwise set to `false`.
5726
+ #
5727
+ # Valid Values: `true` \| `false`
5658
5728
  #
5659
5729
  # @option params [Boolean] :guess_mime_type_enabled
5660
5730
  # 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.
5731
+ # based on file extensions. Set this value to `true` to enable MIME type
5732
+ # guessing, otherwise set to `false`. The default value is `true`.
5733
+ #
5734
+ # Valid Values: `true` \| `false`
5663
5735
  #
5664
5736
  # @option params [Boolean] :requester_pays
5665
5737
  # A value that sets who pays the cost of the request and the cost
5666
5738
  # 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.
5739
+ # to `true`, the requester pays the costs; otherwise, the S3 bucket
5740
+ # owner pays. However, the S3 bucket owner always pays the cost of
5741
+ # storing data.
5670
5742
  #
5671
5743
  # <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
5672
5744
  # file share, so make sure that the configuration on the file share is
@@ -5674,6 +5746,8 @@ module Aws::StorageGateway
5674
5746
  #
5675
5747
  # </note>
5676
5748
  #
5749
+ # Valid Values: `true` \| `false`
5750
+ #
5677
5751
  # @return [Types::UpdateNFSFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5678
5752
  #
5679
5753
  # * {Types::UpdateNFSFileShareOutput#file_share_arn #file_share_arn} => String
@@ -5724,8 +5798,8 @@ module Aws::StorageGateway
5724
5798
  # is activated in the AWS Region you are creating your file gateway in.
5725
5799
  # If AWS STS is not activated in this AWS Region, activate it. For
5726
5800
  # 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.*
5801
+ # deactivating AWS STS in an AWS Region][1] in the *AWS Identity and
5802
+ # Access Management User Guide*.
5729
5803
  #
5730
5804
  # File gateways don't support creating hard or symbolic links on a
5731
5805
  # file
@@ -5740,40 +5814,49 @@ module Aws::StorageGateway
5740
5814
  # update.
5741
5815
  #
5742
5816
  # @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.
5817
+ # Set to `true` to use Amazon S3 server-side encryption with your own
5818
+ # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
5819
+ #
5820
+ # Valid Values: `true` \| `false`
5745
5821
  #
5746
5822
  # @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.
5823
+ # The Amazon Resource Name (ARN) of a symmetric customer master key
5824
+ # (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
5825
+ # not support asymmetric CMKs. This value can only be set when
5826
+ # `KMSEncrypted` is `true`. Optional.
5750
5827
  #
5751
5828
  # @option params [String] :default_storage_class
5752
5829
  # 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.
5830
+ # the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
5831
+ # Optional.
5832
+ #
5833
+ # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
5834
+ # `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
5756
5835
  #
5757
5836
  # @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".
5837
+ # A value that sets the access control list (ACL) permission for objects
5838
+ # in the S3 bucket that a file gateway puts objects into. The default
5839
+ # value is `private`.
5761
5840
  #
5762
5841
  # @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.
5842
+ # A value that sets the write status of a file share. Set this value to
5843
+ # `true` to set write status to read-only, otherwise set to `false`.
5844
+ #
5845
+ # Valid Values: `true` \| `false`
5765
5846
  #
5766
5847
  # @option params [Boolean] :guess_mime_type_enabled
5767
5848
  # 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.
5849
+ # based on file extensions. Set this value to `true` to enable MIME type
5850
+ # guessing, otherwise set to `false`. The default value is `true`.
5851
+ #
5852
+ # Valid Values: `true` \| `false`
5770
5853
  #
5771
5854
  # @option params [Boolean] :requester_pays
5772
5855
  # A value that sets who pays the cost of the request and the cost
5773
5856
  # 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.
5857
+ # to `true`, the requester pays the costs; otherwise, the S3 bucket
5858
+ # owner pays. However, the S3 bucket owner always pays the cost of
5859
+ # storing data.
5777
5860
  #
5778
5861
  # <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
5779
5862
  # file share, so make sure that the configuration on the file share is
@@ -5781,25 +5864,33 @@ module Aws::StorageGateway
5781
5864
  #
5782
5865
  # </note>
5783
5866
  #
5867
+ # Valid Values: `true` \| `false`
5868
+ #
5784
5869
  # @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
5870
+ # Set this value to `true` to enable access control list (ACL) on the
5871
+ # SMB file share. Set it to `false` to map file and directory
5787
5872
  # permissions to the POSIX permissions.
5788
5873
  #
5789
- # For more information, see
5790
- # https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.htmlin
5791
- # the Storage Gateway User Guide.
5874
+ # For more information, see [Using Microsoft Windows ACLs to control
5875
+ # access to an SMB file share][1] in the *AWS Storage Gateway User
5876
+ # Guide*.
5877
+ #
5878
+ # Valid Values: `true` \| `false`
5879
+ #
5880
+ #
5881
+ #
5882
+ # [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
5792
5883
  #
5793
5884
  # @option params [Array<String>] :admin_user_list
5794
5885
  # A list of users in the Active Directory that have administrator rights
5795
5886
  # 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
5887
+ # example, `@group1`. Can only be set if Authentication is set to
5797
5888
  # `ActiveDirectory`.
5798
5889
  #
5799
5890
  # @option params [Array<String>] :valid_user_list
5800
5891
  # A list of users or groups in the Active Directory that are allowed to
5801
5892
  # 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
5893
+ # For example, `@group1`. Can only be set if Authentication is set to
5803
5894
  # `ActiveDirectory`.
5804
5895
  #
5805
5896
  # @option params [Array<String>] :invalid_user_list
@@ -6005,7 +6096,7 @@ module Aws::StorageGateway
6005
6096
  # @option params [required, String] :device_type
6006
6097
  # The type of medium changer you want to select.
6007
6098
  #
6008
- # Valid Values: "STK-L700", "AWS-Gateway-VTL"
6099
+ # Valid Values: `STK-L700` \| `AWS-Gateway-VTL`
6009
6100
  #
6010
6101
  # @return [Types::UpdateVTLDeviceTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6011
6102
  #
@@ -6059,7 +6150,7 @@ module Aws::StorageGateway
6059
6150
  params: params,
6060
6151
  config: config)
6061
6152
  context[:gem_name] = 'aws-sdk-storagegateway'
6062
- context[:gem_version] = '1.42.1'
6153
+ context[:gem_version] = '1.43.0'
6063
6154
  Seahorse::Client::Request.new(handlers, context)
6064
6155
  end
6065
6156