aws-sdk-secretsmanager 1.49.0 → 1.53.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -22,27 +22,8 @@ module Aws::SecretsManager
22
22
  # either the Amazon Resource Name (ARN) or the friendly name of the
23
23
  # secret.
24
24
  #
25
- # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
26
- # complete ARN. You can specify a partial ARN too—for example, if you
27
- # don’t include the final hyphen and six random characters that
28
- # Secrets Manager adds at the end of the ARN when you created the
29
- # secret. A partial ARN match can work as long as it uniquely matches
30
- # only one secret. However, if your secret has a name that ends in a
31
- # hyphen followed by six characters (before Secrets Manager adds the
32
- # hyphen and six characters to the ARN) and you try to use that as a
33
- # partial ARN, then those characters cause Secrets Manager to assume
34
- # that you’re specifying a complete ARN. This confusion can cause
35
- # unexpected results. To avoid this situation, we recommend that you
36
- # don’t create secret names ending with a hyphen followed by six
37
- # characters.
38
- #
39
- # If you specify an incomplete ARN without the random suffix, and
40
- # instead provide the 'friendly name', you *must* not include the
41
- # random suffix. If you do include the random suffix added by Secrets
42
- # Manager, you receive either a *ResourceNotFoundException* or an
43
- # *AccessDeniedException* error, depending on your permissions.
44
- #
45
- # </note>
25
+ # For an ARN, we recommend that you specify a complete ARN rather than
26
+ # a partial ARN.
46
27
  # @return [String]
47
28
  #
48
29
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/CancelRotateSecretRequest AWS API Documentation
@@ -221,20 +202,13 @@ module Aws::SecretsManager
221
202
  # rotation function knows how to parse.
222
203
  #
223
204
  # For storing multiple values, we recommend that you use a JSON text
224
- # string argument and specify key/value pairs. For information on how
225
- # to format a JSON parameter for the various command line tool
226
- # environments, see [Using JSON for Parameters][1] in the *CLI User
227
- # Guide*. For example:
228
- #
229
- # `\{"username":"bob","password":"abc123xyz456"\}`
230
- #
231
- # If your command-line tool or SDK requires quotation marks around the
232
- # parameter, you should use single quotes to avoid confusion with the
233
- # double quotes required in the JSON text.
205
+ # string argument and specify key/value pairs. For more information,
206
+ # see [Specifying parameter values for the Amazon Web Services CLI][1]
207
+ # in the Amazon Web Services CLI User Guide.
234
208
  #
235
209
  #
236
210
  #
237
- # [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json
211
+ # [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html
238
212
  # @return [String]
239
213
  #
240
214
  # @!attribute [rw] tags
@@ -381,27 +355,8 @@ module Aws::SecretsManager
381
355
  # resource-based policy for. You can specify either the Amazon
382
356
  # Resource Name (ARN) or the friendly name of the secret.
383
357
  #
384
- # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
385
- # complete ARN. You can specify a partial ARN too—for example, if you
386
- # don’t include the final hyphen and six random characters that
387
- # Secrets Manager adds at the end of the ARN when you created the
388
- # secret. A partial ARN match can work as long as it uniquely matches
389
- # only one secret. However, if your secret has a name that ends in a
390
- # hyphen followed by six characters (before Secrets Manager adds the
391
- # hyphen and six characters to the ARN) and you try to use that as a
392
- # partial ARN, then those characters cause Secrets Manager to assume
393
- # that you’re specifying a complete ARN. This confusion can cause
394
- # unexpected results. To avoid this situation, we recommend that you
395
- # don’t create secret names ending with a hyphen followed by six
396
- # characters.
397
- #
398
- # If you specify an incomplete ARN without the random suffix, and
399
- # instead provide the 'friendly name', you *must* not include the
400
- # random suffix. If you do include the random suffix added by Secrets
401
- # Manager, you receive either a *ResourceNotFoundException* or an
402
- # *AccessDeniedException* error, depending on your permissions.
403
- #
404
- # </note>
358
+ # For an ARN, we recommend that you specify a complete ARN rather than
359
+ # a partial ARN.
405
360
  # @return [String]
406
361
  #
407
362
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/DeleteResourcePolicyRequest AWS API Documentation
@@ -444,27 +399,8 @@ module Aws::SecretsManager
444
399
  # Specifies the secret to delete. You can specify either the Amazon
445
400
  # Resource Name (ARN) or the friendly name of the secret.
446
401
  #
447
- # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
448
- # complete ARN. You can specify a partial ARN too—for example, if you
449
- # don’t include the final hyphen and six random characters that
450
- # Secrets Manager adds at the end of the ARN when you created the
451
- # secret. A partial ARN match can work as long as it uniquely matches
452
- # only one secret. However, if your secret has a name that ends in a
453
- # hyphen followed by six characters (before Secrets Manager adds the
454
- # hyphen and six characters to the ARN) and you try to use that as a
455
- # partial ARN, then those characters cause Secrets Manager to assume
456
- # that you’re specifying a complete ARN. This confusion can cause
457
- # unexpected results. To avoid this situation, we recommend that you
458
- # don’t create secret names ending with a hyphen followed by six
459
- # characters.
460
- #
461
- # If you specify an incomplete ARN without the random suffix, and
462
- # instead provide the 'friendly name', you *must* not include the
463
- # random suffix. If you do include the random suffix added by Secrets
464
- # Manager, you receive either a *ResourceNotFoundException* or an
465
- # *AccessDeniedException* error, depending on your permissions.
466
- #
467
- # </note>
402
+ # For an ARN, we recommend that you specify a complete ARN rather than
403
+ # a partial ARN.
468
404
  # @return [String]
469
405
  #
470
406
  # @!attribute [rw] recovery_window_in_days
@@ -546,27 +482,8 @@ module Aws::SecretsManager
546
482
  # can specify either the Amazon Resource Name (ARN) or the friendly
547
483
  # name of the secret.
548
484
  #
549
- # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
550
- # complete ARN. You can specify a partial ARN too—for example, if you
551
- # don’t include the final hyphen and six random characters that
552
- # Secrets Manager adds at the end of the ARN when you created the
553
- # secret. A partial ARN match can work as long as it uniquely matches
554
- # only one secret. However, if your secret has a name that ends in a
555
- # hyphen followed by six characters (before Secrets Manager adds the
556
- # hyphen and six characters to the ARN) and you try to use that as a
557
- # partial ARN, then those characters cause Secrets Manager to assume
558
- # that you’re specifying a complete ARN. This confusion can cause
559
- # unexpected results. To avoid this situation, we recommend that you
560
- # don’t create secret names ending with a hyphen followed by six
561
- # characters.
562
- #
563
- # If you specify an incomplete ARN without the random suffix, and
564
- # instead provide the 'friendly name', you *must* not include the
565
- # random suffix. If you do include the random suffix added by Secrets
566
- # Manager, you receive either a *ResourceNotFoundException* or an
567
- # *AccessDeniedException* error, depending on your permissions.
568
- #
569
- # </note>
485
+ # For an ARN, we recommend that you specify a complete ARN rather than
486
+ # a partial ARN.
570
487
  # @return [String]
571
488
  #
572
489
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/DescribeSecretRequest AWS API Documentation
@@ -613,7 +530,8 @@ module Aws::SecretsManager
613
530
  # @return [String]
614
531
  #
615
532
  # @!attribute [rw] rotation_rules
616
- # A structure with the rotation configuration for this secret.
533
+ # A structure with the rotation configuration for this secret. This
534
+ # field is only populated if rotation is configured.
617
535
  # @return [Types::RotationRulesType]
618
536
  #
619
537
  # @!attribute [rw] last_rotated_date
@@ -864,27 +782,8 @@ module Aws::SecretsManager
864
782
  # resource-based policy for. You can specify either the Amazon
865
783
  # Resource Name (ARN) or the friendly name of the secret.
866
784
  #
867
- # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
868
- # complete ARN. You can specify a partial ARN too—for example, if you
869
- # don’t include the final hyphen and six random characters that
870
- # Secrets Manager adds at the end of the ARN when you created the
871
- # secret. A partial ARN match can work as long as it uniquely matches
872
- # only one secret. However, if your secret has a name that ends in a
873
- # hyphen followed by six characters (before Secrets Manager adds the
874
- # hyphen and six characters to the ARN) and you try to use that as a
875
- # partial ARN, then those characters cause Secrets Manager to assume
876
- # that you’re specifying a complete ARN. This confusion can cause
877
- # unexpected results. To avoid this situation, we recommend that you
878
- # don’t create secret names ending with a hyphen followed by six
879
- # characters.
880
- #
881
- # If you specify an incomplete ARN without the random suffix, and
882
- # instead provide the 'friendly name', you *must* not include the
883
- # random suffix. If you do include the random suffix added by Secrets
884
- # Manager, you receive either a *ResourceNotFoundException* or an
885
- # *AccessDeniedException* error, depending on your permissions.
886
- #
887
- # </note>
785
+ # For an ARN, we recommend that you specify a complete ARN rather than
786
+ # a partial ARN.
888
787
  # @return [String]
889
788
  #
890
789
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/GetResourcePolicyRequest AWS API Documentation
@@ -944,27 +843,8 @@ module Aws::SecretsManager
944
843
  # retrieve. You can specify either the Amazon Resource Name (ARN) or
945
844
  # the friendly name of the secret.
946
845
  #
947
- # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
948
- # complete ARN. You can specify a partial ARN too—for example, if you
949
- # don’t include the final hyphen and six random characters that
950
- # Secrets Manager adds at the end of the ARN when you created the
951
- # secret. A partial ARN match can work as long as it uniquely matches
952
- # only one secret. However, if your secret has a name that ends in a
953
- # hyphen followed by six characters (before Secrets Manager adds the
954
- # hyphen and six characters to the ARN) and you try to use that as a
955
- # partial ARN, then those characters cause Secrets Manager to assume
956
- # that you’re specifying a complete ARN. This confusion can cause
957
- # unexpected results. To avoid this situation, we recommend that you
958
- # don’t create secret names ending with a hyphen followed by six
959
- # characters.
960
- #
961
- # If you specify an incomplete ARN without the random suffix, and
962
- # instead provide the 'friendly name', you *must* not include the
963
- # random suffix. If you do include the random suffix added by Secrets
964
- # Manager, you receive either a *ResourceNotFoundException* or an
965
- # *AccessDeniedException* error, depending on your permissions.
966
- #
967
- # </note>
846
+ # For an ARN, we recommend that you specify a complete ARN rather than
847
+ # a partial ARN.
968
848
  # @return [String]
969
849
  #
970
850
  # @!attribute [rw] version_id
@@ -1165,27 +1045,8 @@ module Aws::SecretsManager
1165
1045
  # list. You can specify either the Amazon Resource Name (ARN) or the
1166
1046
  # friendly name of the secret.
1167
1047
  #
1168
- # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
1169
- # complete ARN. You can specify a partial ARN too—for example, if you
1170
- # don’t include the final hyphen and six random characters that
1171
- # Secrets Manager adds at the end of the ARN when you created the
1172
- # secret. A partial ARN match can work as long as it uniquely matches
1173
- # only one secret. However, if your secret has a name that ends in a
1174
- # hyphen followed by six characters (before Secrets Manager adds the
1175
- # hyphen and six characters to the ARN) and you try to use that as a
1176
- # partial ARN, then those characters cause Secrets Manager to assume
1177
- # that you’re specifying a complete ARN. This confusion can cause
1178
- # unexpected results. To avoid this situation, we recommend that you
1179
- # don’t create secret names ending with a hyphen followed by six
1180
- # characters.
1181
- #
1182
- # If you specify an incomplete ARN without the random suffix, and
1183
- # instead provide the 'friendly name', you *must* not include the
1184
- # random suffix. If you do include the random suffix added by Secrets
1185
- # Manager, you receive either a *ResourceNotFoundException* or an
1186
- # *AccessDeniedException* error, depending on your permissions.
1187
- #
1188
- # </note>
1048
+ # For an ARN, we recommend that you specify a complete ARN rather than
1049
+ # a partial ARN.
1189
1050
  # @return [String]
1190
1051
  #
1191
1052
  # @!attribute [rw] max_results
@@ -1406,27 +1267,8 @@ module Aws::SecretsManager
1406
1267
  # policy. You can specify either the ARN or the friendly name of the
1407
1268
  # secret.
1408
1269
  #
1409
- # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
1410
- # complete ARN. You can specify a partial ARN too—for example, if you
1411
- # don’t include the final hyphen and six random characters that
1412
- # Secrets Manager adds at the end of the ARN when you created the
1413
- # secret. A partial ARN match can work as long as it uniquely matches
1414
- # only one secret. However, if your secret has a name that ends in a
1415
- # hyphen followed by six characters (before Secrets Manager adds the
1416
- # hyphen and six characters to the ARN) and you try to use that as a
1417
- # partial ARN, then those characters cause Secrets Manager to assume
1418
- # that you’re specifying a complete ARN. This confusion can cause
1419
- # unexpected results. To avoid this situation, we recommend that you
1420
- # don’t create secret names ending with a hyphen followed by six
1421
- # characters.
1422
- #
1423
- # If you specify an incomplete ARN without the random suffix, and
1424
- # instead provide the 'friendly name', you *must* not include the
1425
- # random suffix. If you do include the random suffix added by Secrets
1426
- # Manager, you receive either a *ResourceNotFoundException* or an
1427
- # *AccessDeniedException* error, depending on your permissions.
1428
- #
1429
- # </note>
1270
+ # For an ARN, we recommend that you specify a complete ARN rather than
1271
+ # a partial ARN.
1430
1272
  # @return [String]
1431
1273
  #
1432
1274
  # @!attribute [rw] resource_policy
@@ -1492,27 +1334,8 @@ module Aws::SecretsManager
1492
1334
  # specify either the Amazon Resource Name (ARN) or the friendly name
1493
1335
  # of the secret. The secret must already exist.
1494
1336
  #
1495
- # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
1496
- # complete ARN. You can specify a partial ARN too—for example, if you
1497
- # don’t include the final hyphen and six random characters that
1498
- # Secrets Manager adds at the end of the ARN when you created the
1499
- # secret. A partial ARN match can work as long as it uniquely matches
1500
- # only one secret. However, if your secret has a name that ends in a
1501
- # hyphen followed by six characters (before Secrets Manager adds the
1502
- # hyphen and six characters to the ARN) and you try to use that as a
1503
- # partial ARN, then those characters cause Secrets Manager to assume
1504
- # that you’re specifying a complete ARN. This confusion can cause
1505
- # unexpected results. To avoid this situation, we recommend that you
1506
- # don’t create secret names ending with a hyphen followed by six
1507
- # characters.
1508
- #
1509
- # If you specify an incomplete ARN without the random suffix, and
1510
- # instead provide the 'friendly name', you *must* not include the
1511
- # random suffix. If you do include the random suffix added by Secrets
1512
- # Manager, you receive either a *ResourceNotFoundException* or an
1513
- # *AccessDeniedException* error, depending on your permissions.
1514
- #
1515
- # </note>
1337
+ # For an ARN, we recommend that you specify a complete ARN rather than
1338
+ # a partial ARN.
1516
1339
  # @return [String]
1517
1340
  #
1518
1341
  # @!attribute [rw] client_request_token
@@ -1585,22 +1408,13 @@ module Aws::SecretsManager
1585
1408
  # Lambda rotation function knows how to parse.
1586
1409
  #
1587
1410
  # For storing multiple values, we recommend that you use a JSON text
1588
- # string argument and specify key/value pairs. For information on how
1589
- # to format a JSON parameter for the various command line tool
1590
- # environments, see [Using JSON for Parameters][1] in the *CLI User
1591
- # Guide*.
1592
- #
1593
- # For example:
1594
- #
1595
- # `[\{"username":"bob"\},\{"password":"abc123xyz456"\}]`
1596
- #
1597
- # If your command-line tool or SDK requires quotation marks around the
1598
- # parameter, you should use single quotes to avoid confusion with the
1599
- # double quotes required in the JSON text.
1411
+ # string argument and specify key/value pairs. For more information,
1412
+ # see [Specifying parameter values for the Amazon Web Services CLI][1]
1413
+ # in the Amazon Web Services CLI User Guide.
1600
1414
  #
1601
1415
  #
1602
1416
  #
1603
- # [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json
1417
+ # [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html
1604
1418
  # @return [String]
1605
1419
  #
1606
1420
  # @!attribute [rw] version_stages
@@ -1866,27 +1680,8 @@ module Aws::SecretsManager
1866
1680
  # scheduled deletion. You can specify either the Amazon Resource Name
1867
1681
  # (ARN) or the friendly name of the secret.
1868
1682
  #
1869
- # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
1870
- # complete ARN. You can specify a partial ARN too—for example, if you
1871
- # don’t include the final hyphen and six random characters that
1872
- # Secrets Manager adds at the end of the ARN when you created the
1873
- # secret. A partial ARN match can work as long as it uniquely matches
1874
- # only one secret. However, if your secret has a name that ends in a
1875
- # hyphen followed by six characters (before Secrets Manager adds the
1876
- # hyphen and six characters to the ARN) and you try to use that as a
1877
- # partial ARN, then those characters cause Secrets Manager to assume
1878
- # that you’re specifying a complete ARN. This confusion can cause
1879
- # unexpected results. To avoid this situation, we recommend that you
1880
- # don’t create secret names ending with a hyphen followed by six
1881
- # characters.
1882
- #
1883
- # If you specify an incomplete ARN without the random suffix, and
1884
- # instead provide the 'friendly name', you *must* not include the
1885
- # random suffix. If you do include the random suffix added by Secrets
1886
- # Manager, you receive either a *ResourceNotFoundException* or an
1887
- # *AccessDeniedException* error, depending on your permissions.
1888
- #
1889
- # </note>
1683
+ # For an ARN, we recommend that you specify a complete ARN rather than
1684
+ # a partial ARN.
1890
1685
  # @return [String]
1891
1686
  #
1892
1687
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/RestoreSecretRequest AWS API Documentation
@@ -1930,27 +1725,8 @@ module Aws::SecretsManager
1930
1725
  # Specifies the secret that you want to rotate. You can specify either
1931
1726
  # the Amazon Resource Name (ARN) or the friendly name of the secret.
1932
1727
  #
1933
- # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
1934
- # complete ARN. You can specify a partial ARN too—for example, if you
1935
- # don’t include the final hyphen and six random characters that
1936
- # Secrets Manager adds at the end of the ARN when you created the
1937
- # secret. A partial ARN match can work as long as it uniquely matches
1938
- # only one secret. However, if your secret has a name that ends in a
1939
- # hyphen followed by six characters (before Secrets Manager adds the
1940
- # hyphen and six characters to the ARN) and you try to use that as a
1941
- # partial ARN, then those characters cause Secrets Manager to assume
1942
- # that you’re specifying a complete ARN. This confusion can cause
1943
- # unexpected results. To avoid this situation, we recommend that you
1944
- # don’t create secret names ending with a hyphen followed by six
1945
- # characters.
1946
- #
1947
- # If you specify an incomplete ARN without the random suffix, and
1948
- # instead provide the 'friendly name', you *must* not include the
1949
- # random suffix. If you do include the random suffix added by Secrets
1950
- # Manager, you receive either a *ResourceNotFoundException* or an
1951
- # *AccessDeniedException* error, depending on your permissions.
1952
- #
1953
- # </note>
1728
+ # For an ARN, we recommend that you specify a complete ARN rather than
1729
+ # a partial ARN.
1954
1730
  # @return [String]
1955
1731
  #
1956
1732
  # @!attribute [rw] client_request_token
@@ -2300,42 +2076,24 @@ module Aws::SecretsManager
2300
2076
  # can specify either the Amazon Resource Name (ARN) or the friendly
2301
2077
  # name of the secret.
2302
2078
  #
2303
- # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
2304
- # complete ARN. You can specify a partial ARN too—for example, if you
2305
- # don’t include the final hyphen and six random characters that
2306
- # Secrets Manager adds at the end of the ARN when you created the
2307
- # secret. A partial ARN match can work as long as it uniquely matches
2308
- # only one secret. However, if your secret has a name that ends in a
2309
- # hyphen followed by six characters (before Secrets Manager adds the
2310
- # hyphen and six characters to the ARN) and you try to use that as a
2311
- # partial ARN, then those characters cause Secrets Manager to assume
2312
- # that you’re specifying a complete ARN. This confusion can cause
2313
- # unexpected results. To avoid this situation, we recommend that you
2314
- # don’t create secret names ending with a hyphen followed by six
2315
- # characters.
2316
- #
2317
- # If you specify an incomplete ARN without the random suffix, and
2318
- # instead provide the 'friendly name', you *must* not include the
2319
- # random suffix. If you do include the random suffix added by Secrets
2320
- # Manager, you receive either a *ResourceNotFoundException* or an
2321
- # *AccessDeniedException* error, depending on your permissions.
2322
- #
2323
- # </note>
2079
+ # For an ARN, we recommend that you specify a complete ARN rather than
2080
+ # a partial ARN.
2324
2081
  # @return [String]
2325
2082
  #
2326
2083
  # @!attribute [rw] tags
2327
2084
  # The tags to attach to the secret. Each element in the list consists
2328
2085
  # of a `Key` and a `Value`.
2329
2086
  #
2330
- # This parameter to the API requires a JSON text string argument. For
2331
- # information on how to format a JSON parameter for the various
2332
- # command line tool environments, see [Using JSON for Parameters][1]
2333
- # in the *CLI User Guide*. For the CLI, you can also use the syntax:
2334
- # `--Tags Key="Key1",Value="Value1" Key="Key2",Value="Value2"[,…]`
2087
+ # This parameter to the API requires a JSON text string argument.
2335
2088
  #
2089
+ # For storing multiple values, we recommend that you use a JSON text
2090
+ # string argument and specify key/value pairs. For more information,
2091
+ # see [Specifying parameter values for the Amazon Web Services CLI][1]
2092
+ # in the Amazon Web Services CLI User Guide.
2336
2093
  #
2337
2094
  #
2338
- # [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json
2095
+ #
2096
+ # [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html
2339
2097
  # @return [Array<Types::Tag>]
2340
2098
  #
2341
2099
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/TagResourceRequest AWS API Documentation
@@ -2360,27 +2118,8 @@ module Aws::SecretsManager
2360
2118
  # can specify either the Amazon Resource Name (ARN) or the friendly
2361
2119
  # name of the secret.
2362
2120
  #
2363
- # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
2364
- # complete ARN. You can specify a partial ARN too—for example, if you
2365
- # don’t include the final hyphen and six random characters that
2366
- # Secrets Manager adds at the end of the ARN when you created the
2367
- # secret. A partial ARN match can work as long as it uniquely matches
2368
- # only one secret. However, if your secret has a name that ends in a
2369
- # hyphen followed by six characters (before Secrets Manager adds the
2370
- # hyphen and six characters to the ARN) and you try to use that as a
2371
- # partial ARN, then those characters cause Secrets Manager to assume
2372
- # that you’re specifying a complete ARN. This confusion can cause
2373
- # unexpected results. To avoid this situation, we recommend that you
2374
- # don’t create secret names ending with a hyphen followed by six
2375
- # characters.
2376
- #
2377
- # If you specify an incomplete ARN without the random suffix, and
2378
- # instead provide the 'friendly name', you *must* not include the
2379
- # random suffix. If you do include the random suffix added by Secrets
2380
- # Manager, you receive either a *ResourceNotFoundException* or an
2381
- # *AccessDeniedException* error, depending on your permissions.
2382
- #
2383
- # </note>
2121
+ # For an ARN, we recommend that you specify a complete ARN rather than
2122
+ # a partial ARN.
2384
2123
  # @return [String]
2385
2124
  #
2386
2125
  # @!attribute [rw] tag_keys
@@ -2388,14 +2127,16 @@ module Aws::SecretsManager
2388
2127
  # specify the value. Both the key and its associated value are
2389
2128
  # removed.
2390
2129
  #
2391
- # This parameter to the API requires a JSON text string argument. For
2392
- # information on how to format a JSON parameter for the various
2393
- # command line tool environments, see [Using JSON for Parameters][1]
2394
- # in the *CLI User Guide*.
2130
+ # This parameter to the API requires a JSON text string argument.
2131
+ #
2132
+ # For storing multiple values, we recommend that you use a JSON text
2133
+ # string argument and specify key/value pairs. For more information,
2134
+ # see [Specifying parameter values for the Amazon Web Services CLI][1]
2135
+ # in the Amazon Web Services CLI User Guide.
2395
2136
  #
2396
2137
  #
2397
2138
  #
2398
- # [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json
2139
+ # [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html
2399
2140
  # @return [Array<String>]
2400
2141
  #
2401
2142
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/UntagResourceRequest AWS API Documentation
@@ -2424,27 +2165,8 @@ module Aws::SecretsManager
2424
2165
  # add a new version. You can specify either the Amazon Resource Name
2425
2166
  # (ARN) or the friendly name of the secret.
2426
2167
  #
2427
- # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
2428
- # complete ARN. You can specify a partial ARN too—for example, if you
2429
- # don’t include the final hyphen and six random characters that
2430
- # Secrets Manager adds at the end of the ARN when you created the
2431
- # secret. A partial ARN match can work as long as it uniquely matches
2432
- # only one secret. However, if your secret has a name that ends in a
2433
- # hyphen followed by six characters (before Secrets Manager adds the
2434
- # hyphen and six characters to the ARN) and you try to use that as a
2435
- # partial ARN, then those characters cause Secrets Manager to assume
2436
- # that you’re specifying a complete ARN. This confusion can cause
2437
- # unexpected results. To avoid this situation, we recommend that you
2438
- # don’t create secret names ending with a hyphen followed by six
2439
- # characters.
2440
- #
2441
- # If you specify an incomplete ARN without the random suffix, and
2442
- # instead provide the 'friendly name', you *must* not include the
2443
- # random suffix. If you do include the random suffix added by Secrets
2444
- # Manager, you receive either a *ResourceNotFoundException* or an
2445
- # *AccessDeniedException* error, depending on your permissions.
2446
- #
2447
- # </note>
2168
+ # For an ARN, we recommend that you specify a complete ARN rather than
2169
+ # a partial ARN.
2448
2170
  # @return [String]
2449
2171
  #
2450
2172
  # @!attribute [rw] client_request_token
@@ -2499,8 +2221,12 @@ module Aws::SecretsManager
2499
2221
  #
2500
2222
  # @!attribute [rw] kms_key_id
2501
2223
  # (Optional) Specifies an updated ARN or alias of the Amazon Web
2502
- # Services KMS customer master key (CMK) to be used to encrypt the
2503
- # protected text in new versions of this secret.
2224
+ # Services KMS customer master key (CMK) that Secrets Manager uses to
2225
+ # encrypt the protected text in new versions of this secret as well as
2226
+ # any existing versions of this secret that have the staging labels
2227
+ # AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about
2228
+ # staging labels, see [Staging Labels][1] in the *Amazon Web Services
2229
+ # Secrets Manager User Guide*.
2504
2230
  #
2505
2231
  # You can only use the account's default CMK to encrypt and decrypt
2506
2232
  # if you call this operation using credentials from the same account
@@ -2508,6 +2234,10 @@ module Aws::SecretsManager
2508
2234
  # you must create a custom CMK and provide the ARN of that CMK in this
2509
2235
  # field. The user making the call must have permissions to both the
2510
2236
  # secret and the CMK in their respective accounts.
2237
+ #
2238
+ #
2239
+ #
2240
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/terms-concepts.html#term_staging-label
2511
2241
  # @return [String]
2512
2242
  #
2513
2243
  # @!attribute [rw] secret_binary
@@ -2535,25 +2265,13 @@ module Aws::SecretsManager
2535
2265
  # Lambda rotation function knows how to parse.
2536
2266
  #
2537
2267
  # For storing multiple values, we recommend that you use a JSON text
2538
- # string argument and specify key/value pairs. For information on how
2539
- # to format a JSON parameter for the various command line tool
2540
- # environments, see [Using JSON for Parameters][1] in the *CLI User
2541
- # Guide*. For example:
2542
- #
2543
- # `[\{"username":"bob"\},\{"password":"abc123xyz456"\}]`
2544
- #
2545
- # If your command-line tool or SDK requires quotation marks around the
2546
- # parameter, you should use single quotes to avoid confusion with the
2547
- # double quotes required in the JSON text. You can also 'escape' the
2548
- # double quote character in the embedded JSON text by prefacing each
2549
- # with a backslash. For example, the following string is surrounded by
2550
- # double-quotes. All of the embedded double quotes are escaped:
2268
+ # string argument and specify key/value pairs. For more information,
2269
+ # see [Specifying parameter values for the Amazon Web Services CLI][1]
2270
+ # in the Amazon Web Services CLI User Guide.
2551
2271
  #
2552
- # `"[\{"username":"bob"\},\{"password":"abc123xyz456"\}]"`
2553
2272
  #
2554
2273
  #
2555
- #
2556
- # [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json
2274
+ # [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html
2557
2275
  # @return [String]
2558
2276
  #
2559
2277
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/UpdateSecretRequest AWS API Documentation
@@ -2617,27 +2335,8 @@ module Aws::SecretsManager
2617
2335
  # labels you want to modify. You can specify either the Amazon
2618
2336
  # Resource Name (ARN) or the friendly name of the secret.
2619
2337
  #
2620
- # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
2621
- # complete ARN. You can specify a partial ARN too—for example, if you
2622
- # don’t include the final hyphen and six random characters that
2623
- # Secrets Manager adds at the end of the ARN when you created the
2624
- # secret. A partial ARN match can work as long as it uniquely matches
2625
- # only one secret. However, if your secret has a name that ends in a
2626
- # hyphen followed by six characters (before Secrets Manager adds the
2627
- # hyphen and six characters to the ARN) and you try to use that as a
2628
- # partial ARN, then those characters cause Secrets Manager to assume
2629
- # that you’re specifying a complete ARN. This confusion can cause
2630
- # unexpected results. To avoid this situation, we recommend that you
2631
- # don’t create secret names ending with a hyphen followed by six
2632
- # characters.
2633
- #
2634
- # If you specify an incomplete ARN without the random suffix, and
2635
- # instead provide the 'friendly name', you *must* not include the
2636
- # random suffix. If you do include the random suffix added by Secrets
2637
- # Manager, you receive either a *ResourceNotFoundException* or an
2638
- # *AccessDeniedException* error, depending on your permissions.
2639
- #
2640
- # </note>
2338
+ # For an ARN, we recommend that you specify a complete ARN rather than
2339
+ # a partial ARN.
2641
2340
  # @return [String]
2642
2341
  #
2643
2342
  # @!attribute [rw] version_stage
@@ -2705,27 +2404,8 @@ module Aws::SecretsManager
2705
2404
  # policy you want to validate. You can specify either the Amazon
2706
2405
  # Resource Name (ARN) or the friendly name of the secret.
2707
2406
  #
2708
- # <note markdown="1"> If you specify an ARN, we generally recommend that you specify a
2709
- # complete ARN. You can specify a partial ARN too—for example, if you
2710
- # don’t include the final hyphen and six random characters that
2711
- # Secrets Manager adds at the end of the ARN when you created the
2712
- # secret. A partial ARN match can work as long as it uniquely matches
2713
- # only one secret. However, if your secret has a name that ends in a
2714
- # hyphen followed by six characters (before Secrets Manager adds the
2715
- # hyphen and six characters to the ARN) and you try to use that as a
2716
- # partial ARN, then those characters cause Secrets Manager to assume
2717
- # that you’re specifying a complete ARN. This confusion can cause
2718
- # unexpected results. To avoid this situation, we recommend that you
2719
- # don’t create secret names ending with a hyphen followed by six
2720
- # characters.
2721
- #
2722
- # If you specify an incomplete ARN without the random suffix, and
2723
- # instead provide the 'friendly name', you *must* not include the
2724
- # random suffix. If you do include the random suffix added by Secrets
2725
- # Manager, you receive either a *ResourceNotFoundException* or an
2726
- # *AccessDeniedException* error, depending on your permissions.
2727
- #
2728
- # </note>
2407
+ # For an ARN, we recommend that you specify a complete ARN rather than
2408
+ # a partial ARN.
2729
2409
  # @return [String]
2730
2410
  #
2731
2411
  # @!attribute [rw] resource_policy
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-secretsmanager/customizations'
48
48
  # @!group service
49
49
  module Aws::SecretsManager
50
50
 
51
- GEM_VERSION = '1.49.0'
51
+ GEM_VERSION = '1.53.0'
52
52
 
53
53
  end