aws-sdk-secretsmanager 1.49.0 → 1.50.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-secretsmanager/client.rb +90 -383
- data/lib/aws-sdk-secretsmanager/types.rb +70 -390
- data/lib/aws-sdk-secretsmanager.rb +1 -1
- metadata +2 -2
@@ -392,26 +392,8 @@ module Aws::SecretsManager
|
|
392
392
|
# either the Amazon Resource Name (ARN) or the friendly name of the
|
393
393
|
# secret.
|
394
394
|
#
|
395
|
-
#
|
396
|
-
#
|
397
|
-
# don’t include the final hyphen and six random characters that Secrets
|
398
|
-
# Manager adds at the end of the ARN when you created the secret. A
|
399
|
-
# partial ARN match can work as long as it uniquely matches only one
|
400
|
-
# secret. However, if your secret has a name that ends in a hyphen
|
401
|
-
# followed by six characters (before Secrets Manager adds the hyphen and
|
402
|
-
# six characters to the ARN) and you try to use that as a partial ARN,
|
403
|
-
# then those characters cause Secrets Manager to assume that you’re
|
404
|
-
# specifying a complete ARN. This confusion can cause unexpected
|
405
|
-
# results. To avoid this situation, we recommend that you don’t create
|
406
|
-
# secret names ending with a hyphen followed by six characters.
|
407
|
-
#
|
408
|
-
# If you specify an incomplete ARN without the random suffix, and
|
409
|
-
# instead provide the 'friendly name', you *must* not include the
|
410
|
-
# random suffix. If you do include the random suffix added by Secrets
|
411
|
-
# Manager, you receive either a *ResourceNotFoundException* or an
|
412
|
-
# *AccessDeniedException* error, depending on your permissions.
|
413
|
-
#
|
414
|
-
# </note>
|
395
|
+
# For an ARN, we recommend that you specify a complete ARN rather than a
|
396
|
+
# partial ARN.
|
415
397
|
#
|
416
398
|
# @return [Types::CancelRotateSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
417
399
|
#
|
@@ -654,20 +636,13 @@ module Aws::SecretsManager
|
|
654
636
|
# rotation function knows how to parse.
|
655
637
|
#
|
656
638
|
# For storing multiple values, we recommend that you use a JSON text
|
657
|
-
# string argument and specify key/value pairs. For information
|
658
|
-
#
|
659
|
-
#
|
660
|
-
# Guide*. For example:
|
661
|
-
#
|
662
|
-
# `\{"username":"bob","password":"abc123xyz456"\}`
|
663
|
-
#
|
664
|
-
# If your command-line tool or SDK requires quotation marks around the
|
665
|
-
# parameter, you should use single quotes to avoid confusion with the
|
666
|
-
# double quotes required in the JSON text.
|
639
|
+
# string argument and specify key/value pairs. For more information, see
|
640
|
+
# [Specifying parameter values for the Amazon Web Services CLI][1] in
|
641
|
+
# the Amazon Web Services CLI User Guide.
|
667
642
|
#
|
668
643
|
#
|
669
644
|
#
|
670
|
-
# [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-
|
645
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html
|
671
646
|
#
|
672
647
|
# @option params [Array<Types::Tag>] :tags
|
673
648
|
# (Optional) Specifies a list of user-defined tags that are attached to
|
@@ -825,26 +800,8 @@ module Aws::SecretsManager
|
|
825
800
|
# resource-based policy for. You can specify either the Amazon Resource
|
826
801
|
# Name (ARN) or the friendly name of the secret.
|
827
802
|
#
|
828
|
-
#
|
829
|
-
#
|
830
|
-
# don’t include the final hyphen and six random characters that Secrets
|
831
|
-
# Manager adds at the end of the ARN when you created the secret. A
|
832
|
-
# partial ARN match can work as long as it uniquely matches only one
|
833
|
-
# secret. However, if your secret has a name that ends in a hyphen
|
834
|
-
# followed by six characters (before Secrets Manager adds the hyphen and
|
835
|
-
# six characters to the ARN) and you try to use that as a partial ARN,
|
836
|
-
# then those characters cause Secrets Manager to assume that you’re
|
837
|
-
# specifying a complete ARN. This confusion can cause unexpected
|
838
|
-
# results. To avoid this situation, we recommend that you don’t create
|
839
|
-
# secret names ending with a hyphen followed by six characters.
|
840
|
-
#
|
841
|
-
# If you specify an incomplete ARN without the random suffix, and
|
842
|
-
# instead provide the 'friendly name', you *must* not include the
|
843
|
-
# random suffix. If you do include the random suffix added by Secrets
|
844
|
-
# Manager, you receive either a *ResourceNotFoundException* or an
|
845
|
-
# *AccessDeniedException* error, depending on your permissions.
|
846
|
-
#
|
847
|
-
# </note>
|
803
|
+
# For an ARN, we recommend that you specify a complete ARN rather than a
|
804
|
+
# partial ARN.
|
848
805
|
#
|
849
806
|
# @return [Types::DeleteResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
850
807
|
#
|
@@ -934,26 +891,8 @@ module Aws::SecretsManager
|
|
934
891
|
# Specifies the secret to delete. You can specify either the Amazon
|
935
892
|
# Resource Name (ARN) or the friendly name of the secret.
|
936
893
|
#
|
937
|
-
#
|
938
|
-
#
|
939
|
-
# don’t include the final hyphen and six random characters that Secrets
|
940
|
-
# Manager adds at the end of the ARN when you created the secret. A
|
941
|
-
# partial ARN match can work as long as it uniquely matches only one
|
942
|
-
# secret. However, if your secret has a name that ends in a hyphen
|
943
|
-
# followed by six characters (before Secrets Manager adds the hyphen and
|
944
|
-
# six characters to the ARN) and you try to use that as a partial ARN,
|
945
|
-
# then those characters cause Secrets Manager to assume that you’re
|
946
|
-
# specifying a complete ARN. This confusion can cause unexpected
|
947
|
-
# results. To avoid this situation, we recommend that you don’t create
|
948
|
-
# secret names ending with a hyphen followed by six characters.
|
949
|
-
#
|
950
|
-
# If you specify an incomplete ARN without the random suffix, and
|
951
|
-
# instead provide the 'friendly name', you *must* not include the
|
952
|
-
# random suffix. If you do include the random suffix added by Secrets
|
953
|
-
# Manager, you receive either a *ResourceNotFoundException* or an
|
954
|
-
# *AccessDeniedException* error, depending on your permissions.
|
955
|
-
#
|
956
|
-
# </note>
|
894
|
+
# For an ARN, we recommend that you specify a complete ARN rather than a
|
895
|
+
# partial ARN.
|
957
896
|
#
|
958
897
|
# @option params [Integer] :recovery_window_in_days
|
959
898
|
# (Optional) Specifies the number of days that Secrets Manager waits
|
@@ -1062,26 +1001,8 @@ module Aws::SecretsManager
|
|
1062
1001
|
# can specify either the Amazon Resource Name (ARN) or the friendly name
|
1063
1002
|
# of the secret.
|
1064
1003
|
#
|
1065
|
-
#
|
1066
|
-
#
|
1067
|
-
# don’t include the final hyphen and six random characters that Secrets
|
1068
|
-
# Manager adds at the end of the ARN when you created the secret. A
|
1069
|
-
# partial ARN match can work as long as it uniquely matches only one
|
1070
|
-
# secret. However, if your secret has a name that ends in a hyphen
|
1071
|
-
# followed by six characters (before Secrets Manager adds the hyphen and
|
1072
|
-
# six characters to the ARN) and you try to use that as a partial ARN,
|
1073
|
-
# then those characters cause Secrets Manager to assume that you’re
|
1074
|
-
# specifying a complete ARN. This confusion can cause unexpected
|
1075
|
-
# results. To avoid this situation, we recommend that you don’t create
|
1076
|
-
# secret names ending with a hyphen followed by six characters.
|
1077
|
-
#
|
1078
|
-
# If you specify an incomplete ARN without the random suffix, and
|
1079
|
-
# instead provide the 'friendly name', you *must* not include the
|
1080
|
-
# random suffix. If you do include the random suffix added by Secrets
|
1081
|
-
# Manager, you receive either a *ResourceNotFoundException* or an
|
1082
|
-
# *AccessDeniedException* error, depending on your permissions.
|
1083
|
-
#
|
1084
|
-
# </note>
|
1004
|
+
# For an ARN, we recommend that you specify a complete ARN rather than a
|
1005
|
+
# partial ARN.
|
1085
1006
|
#
|
1086
1007
|
# @return [Types::DescribeSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1087
1008
|
#
|
@@ -1325,26 +1246,8 @@ module Aws::SecretsManager
|
|
1325
1246
|
# resource-based policy for. You can specify either the Amazon Resource
|
1326
1247
|
# Name (ARN) or the friendly name of the secret.
|
1327
1248
|
#
|
1328
|
-
#
|
1329
|
-
#
|
1330
|
-
# don’t include the final hyphen and six random characters that Secrets
|
1331
|
-
# Manager adds at the end of the ARN when you created the secret. A
|
1332
|
-
# partial ARN match can work as long as it uniquely matches only one
|
1333
|
-
# secret. However, if your secret has a name that ends in a hyphen
|
1334
|
-
# followed by six characters (before Secrets Manager adds the hyphen and
|
1335
|
-
# six characters to the ARN) and you try to use that as a partial ARN,
|
1336
|
-
# then those characters cause Secrets Manager to assume that you’re
|
1337
|
-
# specifying a complete ARN. This confusion can cause unexpected
|
1338
|
-
# results. To avoid this situation, we recommend that you don’t create
|
1339
|
-
# secret names ending with a hyphen followed by six characters.
|
1340
|
-
#
|
1341
|
-
# If you specify an incomplete ARN without the random suffix, and
|
1342
|
-
# instead provide the 'friendly name', you *must* not include the
|
1343
|
-
# random suffix. If you do include the random suffix added by Secrets
|
1344
|
-
# Manager, you receive either a *ResourceNotFoundException* or an
|
1345
|
-
# *AccessDeniedException* error, depending on your permissions.
|
1346
|
-
#
|
1347
|
-
# </note>
|
1249
|
+
# For an ARN, we recommend that you specify a complete ARN rather than a
|
1250
|
+
# partial ARN.
|
1348
1251
|
#
|
1349
1252
|
# @return [Types::GetResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1350
1253
|
#
|
@@ -1417,26 +1320,8 @@ module Aws::SecretsManager
|
|
1417
1320
|
# You can specify either the Amazon Resource Name (ARN) or the friendly
|
1418
1321
|
# name of the secret.
|
1419
1322
|
#
|
1420
|
-
#
|
1421
|
-
#
|
1422
|
-
# don’t include the final hyphen and six random characters that Secrets
|
1423
|
-
# Manager adds at the end of the ARN when you created the secret. A
|
1424
|
-
# partial ARN match can work as long as it uniquely matches only one
|
1425
|
-
# secret. However, if your secret has a name that ends in a hyphen
|
1426
|
-
# followed by six characters (before Secrets Manager adds the hyphen and
|
1427
|
-
# six characters to the ARN) and you try to use that as a partial ARN,
|
1428
|
-
# then those characters cause Secrets Manager to assume that you’re
|
1429
|
-
# specifying a complete ARN. This confusion can cause unexpected
|
1430
|
-
# results. To avoid this situation, we recommend that you don’t create
|
1431
|
-
# secret names ending with a hyphen followed by six characters.
|
1432
|
-
#
|
1433
|
-
# If you specify an incomplete ARN without the random suffix, and
|
1434
|
-
# instead provide the 'friendly name', you *must* not include the
|
1435
|
-
# random suffix. If you do include the random suffix added by Secrets
|
1436
|
-
# Manager, you receive either a *ResourceNotFoundException* or an
|
1437
|
-
# *AccessDeniedException* error, depending on your permissions.
|
1438
|
-
#
|
1439
|
-
# </note>
|
1323
|
+
# For an ARN, we recommend that you specify a complete ARN rather than a
|
1324
|
+
# partial ARN.
|
1440
1325
|
#
|
1441
1326
|
# @option params [String] :version_id
|
1442
1327
|
# Specifies the unique identifier of the version of the secret that you
|
@@ -1559,26 +1444,8 @@ module Aws::SecretsManager
|
|
1559
1444
|
# list. You can specify either the Amazon Resource Name (ARN) or the
|
1560
1445
|
# friendly name of the secret.
|
1561
1446
|
#
|
1562
|
-
#
|
1563
|
-
#
|
1564
|
-
# don’t include the final hyphen and six random characters that Secrets
|
1565
|
-
# Manager adds at the end of the ARN when you created the secret. A
|
1566
|
-
# partial ARN match can work as long as it uniquely matches only one
|
1567
|
-
# secret. However, if your secret has a name that ends in a hyphen
|
1568
|
-
# followed by six characters (before Secrets Manager adds the hyphen and
|
1569
|
-
# six characters to the ARN) and you try to use that as a partial ARN,
|
1570
|
-
# then those characters cause Secrets Manager to assume that you’re
|
1571
|
-
# specifying a complete ARN. This confusion can cause unexpected
|
1572
|
-
# results. To avoid this situation, we recommend that you don’t create
|
1573
|
-
# secret names ending with a hyphen followed by six characters.
|
1574
|
-
#
|
1575
|
-
# If you specify an incomplete ARN without the random suffix, and
|
1576
|
-
# instead provide the 'friendly name', you *must* not include the
|
1577
|
-
# random suffix. If you do include the random suffix added by Secrets
|
1578
|
-
# Manager, you receive either a *ResourceNotFoundException* or an
|
1579
|
-
# *AccessDeniedException* error, depending on your permissions.
|
1580
|
-
#
|
1581
|
-
# </note>
|
1447
|
+
# For an ARN, we recommend that you specify a complete ARN rather than a
|
1448
|
+
# partial ARN.
|
1582
1449
|
#
|
1583
1450
|
# @option params [Integer] :max_results
|
1584
1451
|
# (Optional) Limits the number of results you want to include in the
|
@@ -1868,26 +1735,8 @@ module Aws::SecretsManager
|
|
1868
1735
|
# policy. You can specify either the ARN or the friendly name of the
|
1869
1736
|
# secret.
|
1870
1737
|
#
|
1871
|
-
#
|
1872
|
-
#
|
1873
|
-
# don’t include the final hyphen and six random characters that Secrets
|
1874
|
-
# Manager adds at the end of the ARN when you created the secret. A
|
1875
|
-
# partial ARN match can work as long as it uniquely matches only one
|
1876
|
-
# secret. However, if your secret has a name that ends in a hyphen
|
1877
|
-
# followed by six characters (before Secrets Manager adds the hyphen and
|
1878
|
-
# six characters to the ARN) and you try to use that as a partial ARN,
|
1879
|
-
# then those characters cause Secrets Manager to assume that you’re
|
1880
|
-
# specifying a complete ARN. This confusion can cause unexpected
|
1881
|
-
# results. To avoid this situation, we recommend that you don’t create
|
1882
|
-
# secret names ending with a hyphen followed by six characters.
|
1883
|
-
#
|
1884
|
-
# If you specify an incomplete ARN without the random suffix, and
|
1885
|
-
# instead provide the 'friendly name', you *must* not include the
|
1886
|
-
# random suffix. If you do include the random suffix added by Secrets
|
1887
|
-
# Manager, you receive either a *ResourceNotFoundException* or an
|
1888
|
-
# *AccessDeniedException* error, depending on your permissions.
|
1889
|
-
#
|
1890
|
-
# </note>
|
1738
|
+
# For an ARN, we recommend that you specify a complete ARN rather than a
|
1739
|
+
# partial ARN.
|
1891
1740
|
#
|
1892
1741
|
# @option params [required, String] :resource_policy
|
1893
1742
|
# A JSON-formatted string constructed according to the grammar and
|
@@ -1955,11 +1804,14 @@ module Aws::SecretsManager
|
|
1955
1804
|
# `SecretBinary` value. You can also specify the staging labels that are
|
1956
1805
|
# initially attached to the new version.
|
1957
1806
|
#
|
1958
|
-
#
|
1959
|
-
#
|
1960
|
-
#
|
1961
|
-
#
|
1962
|
-
#
|
1807
|
+
# We recommend you avoid calling `PutSecretValue` at a sustained rate of
|
1808
|
+
# more than once every 10 minutes. When you update the secret value,
|
1809
|
+
# Secrets Manager creates a new version of the secret. Secrets Manager
|
1810
|
+
# removes outdated versions when there are more than 100, but it does
|
1811
|
+
# not remove versions created less than 24 hours ago. If you call
|
1812
|
+
# `PutSecretValue` more than once every 10 minutes, you create more
|
1813
|
+
# versions than Secrets Manager removes, and you will reach the quota
|
1814
|
+
# for secret versions.
|
1963
1815
|
#
|
1964
1816
|
# * If this operation creates the first version for the secret then
|
1965
1817
|
# Secrets Manager automatically attaches the staging label
|
@@ -2036,26 +1888,8 @@ module Aws::SecretsManager
|
|
2036
1888
|
# specify either the Amazon Resource Name (ARN) or the friendly name of
|
2037
1889
|
# the secret. The secret must already exist.
|
2038
1890
|
#
|
2039
|
-
#
|
2040
|
-
#
|
2041
|
-
# don’t include the final hyphen and six random characters that Secrets
|
2042
|
-
# Manager adds at the end of the ARN when you created the secret. A
|
2043
|
-
# partial ARN match can work as long as it uniquely matches only one
|
2044
|
-
# secret. However, if your secret has a name that ends in a hyphen
|
2045
|
-
# followed by six characters (before Secrets Manager adds the hyphen and
|
2046
|
-
# six characters to the ARN) and you try to use that as a partial ARN,
|
2047
|
-
# then those characters cause Secrets Manager to assume that you’re
|
2048
|
-
# specifying a complete ARN. This confusion can cause unexpected
|
2049
|
-
# results. To avoid this situation, we recommend that you don’t create
|
2050
|
-
# secret names ending with a hyphen followed by six characters.
|
2051
|
-
#
|
2052
|
-
# If you specify an incomplete ARN without the random suffix, and
|
2053
|
-
# instead provide the 'friendly name', you *must* not include the
|
2054
|
-
# random suffix. If you do include the random suffix added by Secrets
|
2055
|
-
# Manager, you receive either a *ResourceNotFoundException* or an
|
2056
|
-
# *AccessDeniedException* error, depending on your permissions.
|
2057
|
-
#
|
2058
|
-
# </note>
|
1891
|
+
# For an ARN, we recommend that you specify a complete ARN rather than a
|
1892
|
+
# partial ARN.
|
2059
1893
|
#
|
2060
1894
|
# @option params [String] :client_request_token
|
2061
1895
|
# (Optional) Specifies a unique identifier for the new version of the
|
@@ -2124,22 +1958,13 @@ module Aws::SecretsManager
|
|
2124
1958
|
# Lambda rotation function knows how to parse.
|
2125
1959
|
#
|
2126
1960
|
# For storing multiple values, we recommend that you use a JSON text
|
2127
|
-
# string argument and specify key/value pairs. For information
|
2128
|
-
#
|
2129
|
-
#
|
2130
|
-
# Guide*.
|
2131
|
-
#
|
2132
|
-
# For example:
|
2133
|
-
#
|
2134
|
-
# `[\{"username":"bob"\},\{"password":"abc123xyz456"\}]`
|
2135
|
-
#
|
2136
|
-
# If your command-line tool or SDK requires quotation marks around the
|
2137
|
-
# parameter, you should use single quotes to avoid confusion with the
|
2138
|
-
# double quotes required in the JSON text.
|
1961
|
+
# string argument and specify key/value pairs. For more information, see
|
1962
|
+
# [Specifying parameter values for the Amazon Web Services CLI][1] in
|
1963
|
+
# the Amazon Web Services CLI User Guide.
|
2139
1964
|
#
|
2140
1965
|
#
|
2141
1966
|
#
|
2142
|
-
# [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-
|
1967
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html
|
2143
1968
|
#
|
2144
1969
|
# @option params [Array<String>] :version_stages
|
2145
1970
|
# (Optional) Specifies a list of staging labels that are attached to
|
@@ -2324,26 +2149,8 @@ module Aws::SecretsManager
|
|
2324
2149
|
# scheduled deletion. You can specify either the Amazon Resource Name
|
2325
2150
|
# (ARN) or the friendly name of the secret.
|
2326
2151
|
#
|
2327
|
-
#
|
2328
|
-
#
|
2329
|
-
# don’t include the final hyphen and six random characters that Secrets
|
2330
|
-
# Manager adds at the end of the ARN when you created the secret. A
|
2331
|
-
# partial ARN match can work as long as it uniquely matches only one
|
2332
|
-
# secret. However, if your secret has a name that ends in a hyphen
|
2333
|
-
# followed by six characters (before Secrets Manager adds the hyphen and
|
2334
|
-
# six characters to the ARN) and you try to use that as a partial ARN,
|
2335
|
-
# then those characters cause Secrets Manager to assume that you’re
|
2336
|
-
# specifying a complete ARN. This confusion can cause unexpected
|
2337
|
-
# results. To avoid this situation, we recommend that you don’t create
|
2338
|
-
# secret names ending with a hyphen followed by six characters.
|
2339
|
-
#
|
2340
|
-
# If you specify an incomplete ARN without the random suffix, and
|
2341
|
-
# instead provide the 'friendly name', you *must* not include the
|
2342
|
-
# random suffix. If you do include the random suffix added by Secrets
|
2343
|
-
# Manager, you receive either a *ResourceNotFoundException* or an
|
2344
|
-
# *AccessDeniedException* error, depending on your permissions.
|
2345
|
-
#
|
2346
|
-
# </note>
|
2152
|
+
# For an ARN, we recommend that you specify a complete ARN rather than a
|
2153
|
+
# partial ARN.
|
2347
2154
|
#
|
2348
2155
|
# @return [Types::RestoreSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2349
2156
|
#
|
@@ -2455,26 +2262,8 @@ module Aws::SecretsManager
|
|
2455
2262
|
# Specifies the secret that you want to rotate. You can specify either
|
2456
2263
|
# the Amazon Resource Name (ARN) or the friendly name of the secret.
|
2457
2264
|
#
|
2458
|
-
#
|
2459
|
-
#
|
2460
|
-
# don’t include the final hyphen and six random characters that Secrets
|
2461
|
-
# Manager adds at the end of the ARN when you created the secret. A
|
2462
|
-
# partial ARN match can work as long as it uniquely matches only one
|
2463
|
-
# secret. However, if your secret has a name that ends in a hyphen
|
2464
|
-
# followed by six characters (before Secrets Manager adds the hyphen and
|
2465
|
-
# six characters to the ARN) and you try to use that as a partial ARN,
|
2466
|
-
# then those characters cause Secrets Manager to assume that you’re
|
2467
|
-
# specifying a complete ARN. This confusion can cause unexpected
|
2468
|
-
# results. To avoid this situation, we recommend that you don’t create
|
2469
|
-
# secret names ending with a hyphen followed by six characters.
|
2470
|
-
#
|
2471
|
-
# If you specify an incomplete ARN without the random suffix, and
|
2472
|
-
# instead provide the 'friendly name', you *must* not include the
|
2473
|
-
# random suffix. If you do include the random suffix added by Secrets
|
2474
|
-
# Manager, you receive either a *ResourceNotFoundException* or an
|
2475
|
-
# *AccessDeniedException* error, depending on your permissions.
|
2476
|
-
#
|
2477
|
-
# </note>
|
2265
|
+
# For an ARN, we recommend that you specify a complete ARN rather than a
|
2266
|
+
# partial ARN.
|
2478
2267
|
#
|
2479
2268
|
# @option params [String] :client_request_token
|
2480
2269
|
# (Optional) Specifies a unique identifier for the new version of the
|
@@ -2626,40 +2415,23 @@ module Aws::SecretsManager
|
|
2626
2415
|
# specify either the Amazon Resource Name (ARN) or the friendly name of
|
2627
2416
|
# the secret.
|
2628
2417
|
#
|
2629
|
-
#
|
2630
|
-
#
|
2631
|
-
# don’t include the final hyphen and six random characters that Secrets
|
2632
|
-
# Manager adds at the end of the ARN when you created the secret. A
|
2633
|
-
# partial ARN match can work as long as it uniquely matches only one
|
2634
|
-
# secret. However, if your secret has a name that ends in a hyphen
|
2635
|
-
# followed by six characters (before Secrets Manager adds the hyphen and
|
2636
|
-
# six characters to the ARN) and you try to use that as a partial ARN,
|
2637
|
-
# then those characters cause Secrets Manager to assume that you’re
|
2638
|
-
# specifying a complete ARN. This confusion can cause unexpected
|
2639
|
-
# results. To avoid this situation, we recommend that you don’t create
|
2640
|
-
# secret names ending with a hyphen followed by six characters.
|
2641
|
-
#
|
2642
|
-
# If you specify an incomplete ARN without the random suffix, and
|
2643
|
-
# instead provide the 'friendly name', you *must* not include the
|
2644
|
-
# random suffix. If you do include the random suffix added by Secrets
|
2645
|
-
# Manager, you receive either a *ResourceNotFoundException* or an
|
2646
|
-
# *AccessDeniedException* error, depending on your permissions.
|
2647
|
-
#
|
2648
|
-
# </note>
|
2418
|
+
# For an ARN, we recommend that you specify a complete ARN rather than a
|
2419
|
+
# partial ARN.
|
2649
2420
|
#
|
2650
2421
|
# @option params [required, Array<Types::Tag>] :tags
|
2651
2422
|
# The tags to attach to the secret. Each element in the list consists of
|
2652
2423
|
# a `Key` and a `Value`.
|
2653
2424
|
#
|
2654
|
-
# This parameter to the API requires a JSON text string argument.
|
2655
|
-
# information on how to format a JSON parameter for the various command
|
2656
|
-
# line tool environments, see [Using JSON for Parameters][1] in the *CLI
|
2657
|
-
# User Guide*. For the CLI, you can also use the syntax: `--Tags
|
2658
|
-
# Key="Key1",Value="Value1" Key="Key2",Value="Value2"[,…]`
|
2425
|
+
# This parameter to the API requires a JSON text string argument.
|
2659
2426
|
#
|
2427
|
+
# For storing multiple values, we recommend that you use a JSON text
|
2428
|
+
# string argument and specify key/value pairs. For more information, see
|
2429
|
+
# [Specifying parameter values for the Amazon Web Services CLI][1] in
|
2430
|
+
# the Amazon Web Services CLI User Guide.
|
2660
2431
|
#
|
2661
2432
|
#
|
2662
|
-
#
|
2433
|
+
#
|
2434
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html
|
2663
2435
|
#
|
2664
2436
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2665
2437
|
#
|
@@ -2734,39 +2506,23 @@ module Aws::SecretsManager
|
|
2734
2506
|
# can specify either the Amazon Resource Name (ARN) or the friendly name
|
2735
2507
|
# of the secret.
|
2736
2508
|
#
|
2737
|
-
#
|
2738
|
-
#
|
2739
|
-
# don’t include the final hyphen and six random characters that Secrets
|
2740
|
-
# Manager adds at the end of the ARN when you created the secret. A
|
2741
|
-
# partial ARN match can work as long as it uniquely matches only one
|
2742
|
-
# secret. However, if your secret has a name that ends in a hyphen
|
2743
|
-
# followed by six characters (before Secrets Manager adds the hyphen and
|
2744
|
-
# six characters to the ARN) and you try to use that as a partial ARN,
|
2745
|
-
# then those characters cause Secrets Manager to assume that you’re
|
2746
|
-
# specifying a complete ARN. This confusion can cause unexpected
|
2747
|
-
# results. To avoid this situation, we recommend that you don’t create
|
2748
|
-
# secret names ending with a hyphen followed by six characters.
|
2749
|
-
#
|
2750
|
-
# If you specify an incomplete ARN without the random suffix, and
|
2751
|
-
# instead provide the 'friendly name', you *must* not include the
|
2752
|
-
# random suffix. If you do include the random suffix added by Secrets
|
2753
|
-
# Manager, you receive either a *ResourceNotFoundException* or an
|
2754
|
-
# *AccessDeniedException* error, depending on your permissions.
|
2755
|
-
#
|
2756
|
-
# </note>
|
2509
|
+
# For an ARN, we recommend that you specify a complete ARN rather than a
|
2510
|
+
# partial ARN.
|
2757
2511
|
#
|
2758
2512
|
# @option params [required, Array<String>] :tag_keys
|
2759
2513
|
# A list of tag key names to remove from the secret. You don't specify
|
2760
2514
|
# the value. Both the key and its associated value are removed.
|
2761
2515
|
#
|
2762
|
-
# This parameter to the API requires a JSON text string argument.
|
2763
|
-
# information on how to format a JSON parameter for the various command
|
2764
|
-
# line tool environments, see [Using JSON for Parameters][1] in the *CLI
|
2765
|
-
# User Guide*.
|
2516
|
+
# This parameter to the API requires a JSON text string argument.
|
2766
2517
|
#
|
2518
|
+
# For storing multiple values, we recommend that you use a JSON text
|
2519
|
+
# string argument and specify key/value pairs. For more information, see
|
2520
|
+
# [Specifying parameter values for the Amazon Web Services CLI][1] in
|
2521
|
+
# the Amazon Web Services CLI User Guide.
|
2767
2522
|
#
|
2768
2523
|
#
|
2769
|
-
#
|
2524
|
+
#
|
2525
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html
|
2770
2526
|
#
|
2771
2527
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2772
2528
|
#
|
@@ -2800,13 +2556,22 @@ module Aws::SecretsManager
|
|
2800
2556
|
req.send_request(options)
|
2801
2557
|
end
|
2802
2558
|
|
2803
|
-
# Modifies many of the details of the specified secret.
|
2804
|
-
#
|
2805
|
-
#
|
2559
|
+
# Modifies many of the details of the specified secret.
|
2560
|
+
#
|
2561
|
+
# To change the secret value, you can also use PutSecretValue.
|
2806
2562
|
#
|
2807
|
-
# To
|
2563
|
+
# To change the rotation configuration of a secret, use RotateSecret
|
2808
2564
|
# instead.
|
2809
2565
|
#
|
2566
|
+
# We recommend you avoid calling `UpdateSecret` at a sustained rate of
|
2567
|
+
# more than once every 10 minutes. When you call `UpdateSecret` to
|
2568
|
+
# update the secret value, Secrets Manager creates a new version of the
|
2569
|
+
# secret. Secrets Manager removes outdated versions when there are more
|
2570
|
+
# than 100, but it does not remove versions created less than 24 hours
|
2571
|
+
# ago. If you update the secret value more than once every 10 minutes,
|
2572
|
+
# you create more versions than Secrets Manager removes, and you will
|
2573
|
+
# reach the quota for secret versions.
|
2574
|
+
#
|
2810
2575
|
# <note markdown="1"> The Secrets Manager console uses only the `SecretString` parameter and
|
2811
2576
|
# therefore limits you to encrypting and storing only a text string. To
|
2812
2577
|
# encrypt and store binary data as part of the version of a secret, you
|
@@ -2884,26 +2649,8 @@ module Aws::SecretsManager
|
|
2884
2649
|
# add a new version. You can specify either the Amazon Resource Name
|
2885
2650
|
# (ARN) or the friendly name of the secret.
|
2886
2651
|
#
|
2887
|
-
#
|
2888
|
-
#
|
2889
|
-
# don’t include the final hyphen and six random characters that Secrets
|
2890
|
-
# Manager adds at the end of the ARN when you created the secret. A
|
2891
|
-
# partial ARN match can work as long as it uniquely matches only one
|
2892
|
-
# secret. However, if your secret has a name that ends in a hyphen
|
2893
|
-
# followed by six characters (before Secrets Manager adds the hyphen and
|
2894
|
-
# six characters to the ARN) and you try to use that as a partial ARN,
|
2895
|
-
# then those characters cause Secrets Manager to assume that you’re
|
2896
|
-
# specifying a complete ARN. This confusion can cause unexpected
|
2897
|
-
# results. To avoid this situation, we recommend that you don’t create
|
2898
|
-
# secret names ending with a hyphen followed by six characters.
|
2899
|
-
#
|
2900
|
-
# If you specify an incomplete ARN without the random suffix, and
|
2901
|
-
# instead provide the 'friendly name', you *must* not include the
|
2902
|
-
# random suffix. If you do include the random suffix added by Secrets
|
2903
|
-
# Manager, you receive either a *ResourceNotFoundException* or an
|
2904
|
-
# *AccessDeniedException* error, depending on your permissions.
|
2905
|
-
#
|
2906
|
-
# </note>
|
2652
|
+
# For an ARN, we recommend that you specify a complete ARN rather than a
|
2653
|
+
# partial ARN.
|
2907
2654
|
#
|
2908
2655
|
# @option params [String] :client_request_token
|
2909
2656
|
# (Optional) If you want to add a new version to the secret, this
|
@@ -2955,8 +2702,12 @@ module Aws::SecretsManager
|
|
2955
2702
|
#
|
2956
2703
|
# @option params [String] :kms_key_id
|
2957
2704
|
# (Optional) Specifies an updated ARN or alias of the Amazon Web
|
2958
|
-
# Services KMS customer master key (CMK)
|
2959
|
-
# protected text in new versions of this secret
|
2705
|
+
# Services KMS customer master key (CMK) that Secrets Manager uses to
|
2706
|
+
# encrypt the protected text in new versions of this secret as well as
|
2707
|
+
# any existing versions of this secret that have the staging labels
|
2708
|
+
# AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about
|
2709
|
+
# staging labels, see [Staging Labels][1] in the *Amazon Web Services
|
2710
|
+
# Secrets Manager User Guide*.
|
2960
2711
|
#
|
2961
2712
|
# You can only use the account's default CMK to encrypt and decrypt if
|
2962
2713
|
# you call this operation using credentials from the same account that
|
@@ -2965,6 +2716,10 @@ module Aws::SecretsManager
|
|
2965
2716
|
# field. The user making the call must have permissions to both the
|
2966
2717
|
# secret and the CMK in their respective accounts.
|
2967
2718
|
#
|
2719
|
+
#
|
2720
|
+
#
|
2721
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/terms-concepts.html#term_staging-label
|
2722
|
+
#
|
2968
2723
|
# @option params [String, StringIO, File] :secret_binary
|
2969
2724
|
# (Optional) Specifies updated binary data that you want to encrypt and
|
2970
2725
|
# store in the new version of the secret. To use this parameter in the
|
@@ -2989,25 +2744,13 @@ module Aws::SecretsManager
|
|
2989
2744
|
# Lambda rotation function knows how to parse.
|
2990
2745
|
#
|
2991
2746
|
# For storing multiple values, we recommend that you use a JSON text
|
2992
|
-
# string argument and specify key/value pairs. For information
|
2993
|
-
#
|
2994
|
-
#
|
2995
|
-
# Guide*. For example:
|
2747
|
+
# string argument and specify key/value pairs. For more information, see
|
2748
|
+
# [Specifying parameter values for the Amazon Web Services CLI][1] in
|
2749
|
+
# the Amazon Web Services CLI User Guide.
|
2996
2750
|
#
|
2997
|
-
# `[\{"username":"bob"\},\{"password":"abc123xyz456"\}]`
|
2998
2751
|
#
|
2999
|
-
# If your command-line tool or SDK requires quotation marks around the
|
3000
|
-
# parameter, you should use single quotes to avoid confusion with the
|
3001
|
-
# double quotes required in the JSON text. You can also 'escape' the
|
3002
|
-
# double quote character in the embedded JSON text by prefacing each
|
3003
|
-
# with a backslash. For example, the following string is surrounded by
|
3004
|
-
# double-quotes. All of the embedded double quotes are escaped:
|
3005
2752
|
#
|
3006
|
-
#
|
3007
|
-
#
|
3008
|
-
#
|
3009
|
-
#
|
3010
|
-
# [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json
|
2753
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html
|
3011
2754
|
#
|
3012
2755
|
# @return [Types::UpdateSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3013
2756
|
#
|
@@ -3142,26 +2885,8 @@ module Aws::SecretsManager
|
|
3142
2885
|
# you want to modify. You can specify either the Amazon Resource Name
|
3143
2886
|
# (ARN) or the friendly name of the secret.
|
3144
2887
|
#
|
3145
|
-
#
|
3146
|
-
#
|
3147
|
-
# don’t include the final hyphen and six random characters that Secrets
|
3148
|
-
# Manager adds at the end of the ARN when you created the secret. A
|
3149
|
-
# partial ARN match can work as long as it uniquely matches only one
|
3150
|
-
# secret. However, if your secret has a name that ends in a hyphen
|
3151
|
-
# followed by six characters (before Secrets Manager adds the hyphen and
|
3152
|
-
# six characters to the ARN) and you try to use that as a partial ARN,
|
3153
|
-
# then those characters cause Secrets Manager to assume that you’re
|
3154
|
-
# specifying a complete ARN. This confusion can cause unexpected
|
3155
|
-
# results. To avoid this situation, we recommend that you don’t create
|
3156
|
-
# secret names ending with a hyphen followed by six characters.
|
3157
|
-
#
|
3158
|
-
# If you specify an incomplete ARN without the random suffix, and
|
3159
|
-
# instead provide the 'friendly name', you *must* not include the
|
3160
|
-
# random suffix. If you do include the random suffix added by Secrets
|
3161
|
-
# Manager, you receive either a *ResourceNotFoundException* or an
|
3162
|
-
# *AccessDeniedException* error, depending on your permissions.
|
3163
|
-
#
|
3164
|
-
# </note>
|
2888
|
+
# For an ARN, we recommend that you specify a complete ARN rather than a
|
2889
|
+
# partial ARN.
|
3165
2890
|
#
|
3166
2891
|
# @option params [required, String] :version_stage
|
3167
2892
|
# The staging label to add to this version.
|
@@ -3300,26 +3025,8 @@ module Aws::SecretsManager
|
|
3300
3025
|
# you want to validate. You can specify either the Amazon Resource Name
|
3301
3026
|
# (ARN) or the friendly name of the secret.
|
3302
3027
|
#
|
3303
|
-
#
|
3304
|
-
#
|
3305
|
-
# don’t include the final hyphen and six random characters that Secrets
|
3306
|
-
# Manager adds at the end of the ARN when you created the secret. A
|
3307
|
-
# partial ARN match can work as long as it uniquely matches only one
|
3308
|
-
# secret. However, if your secret has a name that ends in a hyphen
|
3309
|
-
# followed by six characters (before Secrets Manager adds the hyphen and
|
3310
|
-
# six characters to the ARN) and you try to use that as a partial ARN,
|
3311
|
-
# then those characters cause Secrets Manager to assume that you’re
|
3312
|
-
# specifying a complete ARN. This confusion can cause unexpected
|
3313
|
-
# results. To avoid this situation, we recommend that you don’t create
|
3314
|
-
# secret names ending with a hyphen followed by six characters.
|
3315
|
-
#
|
3316
|
-
# If you specify an incomplete ARN without the random suffix, and
|
3317
|
-
# instead provide the 'friendly name', you *must* not include the
|
3318
|
-
# random suffix. If you do include the random suffix added by Secrets
|
3319
|
-
# Manager, you receive either a *ResourceNotFoundException* or an
|
3320
|
-
# *AccessDeniedException* error, depending on your permissions.
|
3321
|
-
#
|
3322
|
-
# </note>
|
3028
|
+
# For an ARN, we recommend that you specify a complete ARN rather than a
|
3029
|
+
# partial ARN.
|
3323
3030
|
#
|
3324
3031
|
# @option params [required, String] :resource_policy
|
3325
3032
|
# A JSON-formatted string constructed according to the grammar and
|
@@ -3391,7 +3098,7 @@ module Aws::SecretsManager
|
|
3391
3098
|
params: params,
|
3392
3099
|
config: config)
|
3393
3100
|
context[:gem_name] = 'aws-sdk-secretsmanager'
|
3394
|
-
context[:gem_version] = '1.
|
3101
|
+
context[:gem_version] = '1.50.0'
|
3395
3102
|
Seahorse::Client::Request.new(handlers, context)
|
3396
3103
|
end
|
3397
3104
|
|