aws-sdk-secretsmanager 1.59.0 → 1.60.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 53d7a097bb8f0559cb4af375370fb495ca859b2fb472392419f6bd8991e238bf
4
- data.tar.gz: 52c9f84d3cc5ddacd48cbc6856d7b2757e5644046a7c0366de3ddda6d42e6753
3
+ metadata.gz: 8df4daf2d651916a1c2064939bcf1dc18cc30ef5ceef9fdda071f67f3d365632
4
+ data.tar.gz: 8913f355a291887628e8f3537e3f700dab0fd90c0cc5430c216d0310e7005421
5
5
  SHA512:
6
- metadata.gz: 6921e16b817f9831d27d7b53dbc3fb79e1d8e8242758e3ab6e38245f5ea9e33e7b66a87de5822b73d62b8581c544bdddd9ce70373fefd8c75976c5e6b6e3b17d
7
- data.tar.gz: 133798d6d44dd7262efb23bb94e9807499183057344ba2dfc0aaf304c08225a27f93f7272d8fd66ee128e55d68094cbf63aee77a6e226ea9a8b644c4f16c03ad
6
+ metadata.gz: 8068795275cfe892637f5e9635f01566a237fdca18b9388cd3372609d24fe011e011c8a2e59d4c75b0aac0c08078be335028539d6b363e09d0fd3a079fca116d
7
+ data.tar.gz: c68a142de2be5b6d86b0205d663a4fb289e94d8e6bef6f0d30a0744a7f0815339637662c4ed482ff29ee151ae6c6ef530f7bf9c998bbd2b51d1443e4286a6de3
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.60.0 (2022-04-21)
5
+ ------------------
6
+
7
+ * Feature - Documentation updates for Secrets Manager
8
+
4
9
  1.59.0 (2022-03-11)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.59.0
1
+ 1.60.0
@@ -382,14 +382,18 @@ module Aws::SecretsManager
382
382
  #
383
383
  #
384
384
  #
385
- # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
385
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
386
386
  # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
387
387
  #
388
388
  # @option params [required, String] :secret_id
389
389
  # The ARN or name of the secret.
390
390
  #
391
391
  # For an ARN, we recommend that you specify a complete ARN rather than a
392
- # partial ARN.
392
+ # partial ARN. See [Finding a secret from a partial ARN][1].
393
+ #
394
+ #
395
+ #
396
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
393
397
  #
394
398
  # @return [Types::CancelRotateSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
395
399
  #
@@ -435,8 +439,9 @@ module Aws::SecretsManager
435
439
  req.send_request(options)
436
440
  end
437
441
 
438
- # Creates a new secret. A *secret* is a set of credentials, such as a
439
- # user name and password, that you store in an encrypted form in Secrets
442
+ # Creates a new secret. A *secret* can be a password, a set of
443
+ # credentials such as a user name and password, an OAuth token, or other
444
+ # secret information that you store in an encrypted form in Secrets
440
445
  # Manager. The secret also includes the connection information to access
441
446
  # a database or other service, which Secrets Manager doesn't encrypt. A
442
447
  # secret in Secrets Manager consists of both the protected secret data
@@ -451,6 +456,11 @@ module Aws::SecretsManager
451
456
  # `SecretBinary` then Secrets Manager creates an initial secret version
452
457
  # and automatically attaches the staging label `AWSCURRENT` to it.
453
458
  #
459
+ # For database credentials you want to rotate, for Secrets Manager to be
460
+ # able to rotate the secret, you must make sure the JSON you store in
461
+ # the `SecretString` matches the [JSON structure of a database
462
+ # secret][2].
463
+ #
454
464
  # If you don't specify an KMS encryption key, Secrets Manager uses the
455
465
  # Amazon Web Services managed key `aws/secretsmanager`. If this key
456
466
  # doesn't already exist in your account, then Secrets Manager creates
@@ -464,15 +474,22 @@ module Aws::SecretsManager
464
474
  # to encrypt the secret, and you must create and use a customer managed
465
475
  # KMS key.
466
476
  #
467
- # <b>Required permissions: </b> `secretsmanager:CreateSecret`. For more
468
- # information, see [ IAM policy actions for Secrets Manager][2] and
469
- # [Authentication and access control in Secrets Manager][3].
477
+ # <b>Required permissions: </b> `secretsmanager:CreateSecret`. If you
478
+ # include tags in the secret, you also need
479
+ # `secretsmanager:TagResource`. For more information, see [ IAM policy
480
+ # actions for Secrets Manager][3] and [Authentication and access control
481
+ # in Secrets Manager][4].
482
+ #
483
+ # To encrypt the secret with a KMS key other than `aws/secretsmanager`,
484
+ # you need `kms:GenerateDataKey` and `kms:Decrypt` permission to the
485
+ # key.
470
486
  #
471
487
  #
472
488
  #
473
489
  # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html
474
- # [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
475
- # [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
490
+ # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html
491
+ # [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
492
+ # [4]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
476
493
  #
477
494
  # @option params [required, String] :name
478
495
  # The name of the new secret.
@@ -712,7 +729,7 @@ module Aws::SecretsManager
712
729
  #
713
730
  #
714
731
  #
715
- # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
732
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
716
733
  # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
717
734
  #
718
735
  # @option params [required, String] :secret_id
@@ -720,7 +737,11 @@ module Aws::SecretsManager
720
737
  # policy for.
721
738
  #
722
739
  # For an ARN, we recommend that you specify a complete ARN rather than a
723
- # partial ARN.
740
+ # partial ARN. See [Finding a secret from a partial ARN][1].
741
+ #
742
+ #
743
+ #
744
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
724
745
  #
725
746
  # @return [Types::DeleteResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
726
747
  #
@@ -791,14 +812,18 @@ module Aws::SecretsManager
791
812
  #
792
813
  #
793
814
  # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html
794
- # [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
815
+ # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
795
816
  # [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
796
817
  #
797
818
  # @option params [required, String] :secret_id
798
819
  # The ARN or name of the secret to delete.
799
820
  #
800
821
  # For an ARN, we recommend that you specify a complete ARN rather than a
801
- # partial ARN.
822
+ # partial ARN. See [Finding a secret from a partial ARN][1].
823
+ #
824
+ #
825
+ #
826
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
802
827
  #
803
828
  # @option params [Integer] :recovery_window_in_days
804
829
  # The number of days from 7 to 30 that Secrets Manager waits before
@@ -883,14 +908,18 @@ module Aws::SecretsManager
883
908
  #
884
909
  #
885
910
  #
886
- # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
911
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
887
912
  # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
888
913
  #
889
914
  # @option params [required, String] :secret_id
890
915
  # The ARN or name of the secret.
891
916
  #
892
917
  # For an ARN, we recommend that you specify a complete ARN rather than a
893
- # partial ARN.
918
+ # partial ARN. See [Finding a secret from a partial ARN][1].
919
+ #
920
+ #
921
+ #
922
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
894
923
  #
895
924
  # @return [Types::DescribeSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
896
925
  #
@@ -1013,7 +1042,7 @@ module Aws::SecretsManager
1013
1042
  #
1014
1043
  #
1015
1044
  #
1016
- # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
1045
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
1017
1046
  # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
1018
1047
  #
1019
1048
  # @option params [Integer] :password_length
@@ -1111,7 +1140,7 @@ module Aws::SecretsManager
1111
1140
  #
1112
1141
  #
1113
1142
  # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-policies.html
1114
- # [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
1143
+ # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
1115
1144
  # [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
1116
1145
  #
1117
1146
  # @option params [required, String] :secret_id
@@ -1119,7 +1148,11 @@ module Aws::SecretsManager
1119
1148
  # policy for.
1120
1149
  #
1121
1150
  # For an ARN, we recommend that you specify a complete ARN rather than a
1122
- # partial ARN.
1151
+ # partial ARN. See [Finding a secret from a partial ARN][1].
1152
+ #
1153
+ #
1154
+ #
1155
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
1123
1156
  #
1124
1157
  # @return [Types::GetResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1125
1158
  #
@@ -1182,14 +1215,18 @@ module Aws::SecretsManager
1182
1215
  #
1183
1216
  #
1184
1217
  # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html
1185
- # [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
1218
+ # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
1186
1219
  # [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
1187
1220
  #
1188
1221
  # @option params [required, String] :secret_id
1189
1222
  # The ARN or name of the secret to retrieve.
1190
1223
  #
1191
1224
  # For an ARN, we recommend that you specify a complete ARN rather than a
1192
- # partial ARN.
1225
+ # partial ARN. See [Finding a secret from a partial ARN][1].
1226
+ #
1227
+ #
1228
+ #
1229
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
1193
1230
  #
1194
1231
  # @option params [String] :version_id
1195
1232
  # The unique identifier of the version of the secret to retrieve. If you
@@ -1286,14 +1323,18 @@ module Aws::SecretsManager
1286
1323
  #
1287
1324
  #
1288
1325
  #
1289
- # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
1326
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
1290
1327
  # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
1291
1328
  #
1292
1329
  # @option params [required, String] :secret_id
1293
1330
  # The ARN or name of the secret whose versions you want to list.
1294
1331
  #
1295
1332
  # For an ARN, we recommend that you specify a complete ARN rather than a
1296
- # partial ARN.
1333
+ # partial ARN. See [Finding a secret from a partial ARN][1].
1334
+ #
1335
+ #
1336
+ #
1337
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
1297
1338
  #
1298
1339
  # @option params [Integer] :max_results
1299
1340
  # The number of results to include in the response.
@@ -1409,7 +1450,7 @@ module Aws::SecretsManager
1409
1450
  #
1410
1451
  #
1411
1452
  # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html
1412
- # [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
1453
+ # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
1413
1454
  # [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
1414
1455
  #
1415
1456
  # @option params [Integer] :max_results
@@ -1538,13 +1579,17 @@ module Aws::SecretsManager
1538
1579
  #
1539
1580
  # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
1540
1581
  # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html
1541
- # [3]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
1582
+ # [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
1542
1583
  #
1543
1584
  # @option params [required, String] :secret_id
1544
1585
  # The ARN or name of the secret to attach the resource-based policy.
1545
1586
  #
1546
1587
  # For an ARN, we recommend that you specify a complete ARN rather than a
1547
- # partial ARN.
1588
+ # partial ARN. See [Finding a secret from a partial ARN][1].
1589
+ #
1590
+ #
1591
+ #
1592
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
1548
1593
  #
1549
1594
  # @option params [required, String] :resource_policy
1550
1595
  # A JSON-formatted string for an Amazon Web Services resource-based
@@ -1641,17 +1686,21 @@ module Aws::SecretsManager
1641
1686
  #
1642
1687
  #
1643
1688
  #
1644
- # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
1689
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
1645
1690
  # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
1646
1691
  #
1647
1692
  # @option params [required, String] :secret_id
1648
1693
  # The ARN or name of the secret to add a new version to.
1649
1694
  #
1650
1695
  # For an ARN, we recommend that you specify a complete ARN rather than a
1651
- # partial ARN.
1696
+ # partial ARN. See [Finding a secret from a partial ARN][1].
1652
1697
  #
1653
1698
  # If the secret doesn't already exist, use `CreateSecret` instead.
1654
1699
  #
1700
+ #
1701
+ #
1702
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
1703
+ #
1655
1704
  # @option params [String] :client_request_token
1656
1705
  # A unique identifier for the new version of the secret.
1657
1706
  #
@@ -1792,7 +1841,7 @@ module Aws::SecretsManager
1792
1841
  #
1793
1842
  #
1794
1843
  #
1795
- # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
1844
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
1796
1845
  # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
1797
1846
  #
1798
1847
  # @option params [required, String] :secret_id
@@ -1842,7 +1891,7 @@ module Aws::SecretsManager
1842
1891
  #
1843
1892
  #
1844
1893
  # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create-manage-multi-region-secrets.html
1845
- # [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
1894
+ # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
1846
1895
  # [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
1847
1896
  #
1848
1897
  # @option params [required, String] :secret_id
@@ -1902,14 +1951,18 @@ module Aws::SecretsManager
1902
1951
  #
1903
1952
  #
1904
1953
  #
1905
- # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
1954
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
1906
1955
  # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
1907
1956
  #
1908
1957
  # @option params [required, String] :secret_id
1909
1958
  # The ARN or name of the secret to restore.
1910
1959
  #
1911
1960
  # For an ARN, we recommend that you specify a complete ARN rather than a
1912
- # partial ARN.
1961
+ # partial ARN. See [Finding a secret from a partial ARN][1].
1962
+ #
1963
+ #
1964
+ #
1965
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
1913
1966
  #
1914
1967
  # @return [Types::RestoreSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1915
1968
  #
@@ -1952,49 +2005,65 @@ module Aws::SecretsManager
1952
2005
  end
1953
2006
 
1954
2007
  # Configures and starts the asynchronous process of rotating the secret.
2008
+ # For more information about rotation, see [Rotate secrets][1].
1955
2009
  #
1956
2010
  # If you include the configuration parameters, the operation sets the
1957
2011
  # values for the secret and then immediately starts a rotation. If you
1958
2012
  # don't include the configuration parameters, the operation starts a
1959
- # rotation with the values already stored in the secret. For more
1960
- # information about rotation, see [Rotate secrets][1].
2013
+ # rotation with the values already stored in the secret.
1961
2014
  #
1962
- # To configure rotation, you include the ARN of an Amazon Web Services
2015
+ # For database credentials you want to rotate, for Secrets Manager to be
2016
+ # able to rotate the secret, you must make sure the secret value is in
2017
+ # the [ JSON structure of a database secret][2]. In particular, if you
2018
+ # want to use the [ alternating users strategy][3], your secret must
2019
+ # contain the ARN of a superuser secret.
2020
+ #
2021
+ # To configure rotation, you also need the ARN of an Amazon Web Services
1963
2022
  # Lambda function and the schedule for the rotation. The Lambda rotation
1964
2023
  # function creates a new version of the secret and creates or updates
1965
2024
  # the credentials on the database or service to match. After testing the
1966
2025
  # new credentials, the function marks the new secret version with the
1967
2026
  # staging label `AWSCURRENT`. Then anyone who retrieves the secret gets
1968
- # the new version. For more information, see [How rotation works][2].
2027
+ # the new version. For more information, see [How rotation works][4].
2028
+ #
2029
+ # You can create the Lambda rotation function based on the [rotation
2030
+ # function templates][5] that Secrets Manager provides. Choose a
2031
+ # template that matches your [Rotation strategy][6].
1969
2032
  #
1970
2033
  # When rotation is successful, the `AWSPENDING` staging label might be
1971
2034
  # attached to the same version as the `AWSCURRENT` version, or it might
1972
- # not be attached to any version.
1973
- #
1974
- # If the `AWSPENDING` staging label is present but not attached to the
1975
- # same version as `AWSCURRENT`, then any later invocation of
1976
- # `RotateSecret` assumes that a previous rotation request is still in
1977
- # progress and returns an error.
2035
+ # not be attached to any version. If the `AWSPENDING` staging label is
2036
+ # present but not attached to the same version as `AWSCURRENT`, then any
2037
+ # later invocation of `RotateSecret` assumes that a previous rotation
2038
+ # request is still in progress and returns an error.
1978
2039
  #
1979
2040
  # <b>Required permissions: </b> `secretsmanager:RotateSecret`. For more
1980
- # information, see [ IAM policy actions for Secrets Manager][3] and
1981
- # [Authentication and access control in Secrets Manager][4]. You also
2041
+ # information, see [ IAM policy actions for Secrets Manager][7] and
2042
+ # [Authentication and access control in Secrets Manager][8]. You also
1982
2043
  # need `lambda:InvokeFunction` permissions on the rotation function. For
1983
- # more information, see [ Permissions for rotation][5].
2044
+ # more information, see [ Permissions for rotation][9].
1984
2045
  #
1985
2046
  #
1986
2047
  #
1987
2048
  # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html
1988
- # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html
1989
- # [3]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
1990
- # [4]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
1991
- # [5]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets-required-permissions-function.html
2049
+ # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html
2050
+ # [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html#rotating-secrets-two-users
2051
+ # [4]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html
2052
+ # [5]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html
2053
+ # [6]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html
2054
+ # [7]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
2055
+ # [8]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
2056
+ # [9]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets-required-permissions-function.html
1992
2057
  #
1993
2058
  # @option params [required, String] :secret_id
1994
2059
  # The ARN or name of the secret to rotate.
1995
2060
  #
1996
2061
  # For an ARN, we recommend that you specify a complete ARN rather than a
1997
- # partial ARN.
2062
+ # partial ARN. See [Finding a secret from a partial ARN][1].
2063
+ #
2064
+ #
2065
+ #
2066
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
1998
2067
  #
1999
2068
  # @option params [String] :client_request_token
2000
2069
  # A unique identifier for the new version of the secret that helps
@@ -2094,7 +2163,7 @@ module Aws::SecretsManager
2094
2163
  #
2095
2164
  #
2096
2165
  #
2097
- # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
2166
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
2098
2167
  # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
2099
2168
  #
2100
2169
  # @option params [required, String] :secret_id
@@ -2160,7 +2229,7 @@ module Aws::SecretsManager
2160
2229
  #
2161
2230
  #
2162
2231
  #
2163
- # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
2232
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
2164
2233
  # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
2165
2234
  #
2166
2235
  # @option params [required, String] :secret_id
@@ -2169,7 +2238,11 @@ module Aws::SecretsManager
2169
2238
  # secret.
2170
2239
  #
2171
2240
  # For an ARN, we recommend that you specify a complete ARN rather than a
2172
- # partial ARN.
2241
+ # partial ARN. See [Finding a secret from a partial ARN][1].
2242
+ #
2243
+ #
2244
+ #
2245
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
2173
2246
  #
2174
2247
  # @option params [required, Array<Types::Tag>] :tags
2175
2248
  # The tags to attach to the secret as a JSON text string argument. Each
@@ -2243,14 +2316,18 @@ module Aws::SecretsManager
2243
2316
  #
2244
2317
  #
2245
2318
  #
2246
- # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
2319
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
2247
2320
  # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
2248
2321
  #
2249
2322
  # @option params [required, String] :secret_id
2250
2323
  # The ARN or name of the secret.
2251
2324
  #
2252
2325
  # For an ARN, we recommend that you specify a complete ARN rather than a
2253
- # partial ARN.
2326
+ # partial ARN. See [Finding a secret from a partial ARN][1].
2327
+ #
2328
+ #
2329
+ #
2330
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
2254
2331
  #
2255
2332
  # @option params [required, Array<String>] :tag_keys
2256
2333
  # A list of tag key names to remove from the secret. You don't specify
@@ -2346,7 +2423,7 @@ module Aws::SecretsManager
2346
2423
  #
2347
2424
  #
2348
2425
  #
2349
- # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
2426
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
2350
2427
  # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
2351
2428
  # [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/security-encryption.html
2352
2429
  #
@@ -2354,7 +2431,11 @@ module Aws::SecretsManager
2354
2431
  # The ARN or name of the secret.
2355
2432
  #
2356
2433
  # For an ARN, we recommend that you specify a complete ARN rather than a
2357
- # partial ARN.
2434
+ # partial ARN. See [Finding a secret from a partial ARN][1].
2435
+ #
2436
+ #
2437
+ #
2438
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
2358
2439
  #
2359
2440
  # @option params [String] :client_request_token
2360
2441
  # If you include `SecretString` or `SecretBinary`, then Secrets Manager
@@ -2532,7 +2613,7 @@ module Aws::SecretsManager
2532
2613
  #
2533
2614
  #
2534
2615
  # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version
2535
- # [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
2616
+ # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
2536
2617
  # [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
2537
2618
  #
2538
2619
  # @option params [required, String] :secret_id
@@ -2540,7 +2621,11 @@ module Aws::SecretsManager
2540
2621
  # labelsto modify.
2541
2622
  #
2542
2623
  # For an ARN, we recommend that you specify a complete ARN rather than a
2543
- # partial ARN.
2624
+ # partial ARN. See [Finding a secret from a partial ARN][1].
2625
+ #
2626
+ #
2627
+ #
2628
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
2544
2629
  #
2545
2630
  # @option params [required, String] :version_stage
2546
2631
  # The staging label to add to this version.
@@ -2665,7 +2750,7 @@ module Aws::SecretsManager
2665
2750
  #
2666
2751
  #
2667
2752
  # [1]: https://aws.amazon.com/blogs/security/protect-sensitive-data-in-the-cloud-with-automated-reasoning-zelkova/
2668
- # [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions
2753
+ # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
2669
2754
  # [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
2670
2755
  #
2671
2756
  # @option params [String] :secret_id
@@ -2739,7 +2824,7 @@ module Aws::SecretsManager
2739
2824
  params: params,
2740
2825
  config: config)
2741
2826
  context[:gem_name] = 'aws-sdk-secretsmanager'
2742
- context[:gem_version] = '1.59.0'
2827
+ context[:gem_version] = '1.60.0'
2743
2828
  Seahorse::Client::Request.new(handlers, context)
2744
2829
  end
2745
2830
 
@@ -21,7 +21,11 @@ module Aws::SecretsManager
21
21
  # The ARN or name of the secret.
22
22
  #
23
23
  # For an ARN, we recommend that you specify a complete ARN rather than
24
- # a partial ARN.
24
+ # a partial ARN. See [Finding a secret from a partial ARN][1].
25
+ #
26
+ #
27
+ #
28
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
25
29
  # @return [String]
26
30
  #
27
31
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/CancelRotateSecretRequest AWS API Documentation
@@ -330,7 +334,11 @@ module Aws::SecretsManager
330
334
  # policy for.
331
335
  #
332
336
  # For an ARN, we recommend that you specify a complete ARN rather than
333
- # a partial ARN.
337
+ # a partial ARN. See [Finding a secret from a partial ARN][1].
338
+ #
339
+ #
340
+ #
341
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
334
342
  # @return [String]
335
343
  #
336
344
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/DeleteResourcePolicyRequest AWS API Documentation
@@ -373,7 +381,11 @@ module Aws::SecretsManager
373
381
  # The ARN or name of the secret to delete.
374
382
  #
375
383
  # For an ARN, we recommend that you specify a complete ARN rather than
376
- # a partial ARN.
384
+ # a partial ARN. See [Finding a secret from a partial ARN][1].
385
+ #
386
+ #
387
+ #
388
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
377
389
  # @return [String]
378
390
  #
379
391
  # @!attribute [rw] recovery_window_in_days
@@ -449,7 +461,11 @@ module Aws::SecretsManager
449
461
  # The ARN or name of the secret.
450
462
  #
451
463
  # For an ARN, we recommend that you specify a complete ARN rather than
452
- # a partial ARN.
464
+ # a partial ARN. See [Finding a secret from a partial ARN][1].
465
+ #
466
+ #
467
+ #
468
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
453
469
  # @return [String]
454
470
  #
455
471
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/DescribeSecretRequest AWS API Documentation
@@ -775,7 +791,11 @@ module Aws::SecretsManager
775
791
  # resource-based policy for.
776
792
  #
777
793
  # For an ARN, we recommend that you specify a complete ARN rather than
778
- # a partial ARN.
794
+ # a partial ARN. See [Finding a secret from a partial ARN][1].
795
+ #
796
+ #
797
+ #
798
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
779
799
  # @return [String]
780
800
  #
781
801
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/GetResourcePolicyRequest AWS API Documentation
@@ -830,7 +850,11 @@ module Aws::SecretsManager
830
850
  # The ARN or name of the secret to retrieve.
831
851
  #
832
852
  # For an ARN, we recommend that you specify a complete ARN rather than
833
- # a partial ARN.
853
+ # a partial ARN. See [Finding a secret from a partial ARN][1].
854
+ #
855
+ #
856
+ #
857
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
834
858
  # @return [String]
835
859
  #
836
860
  # @!attribute [rw] version_id
@@ -1018,7 +1042,11 @@ module Aws::SecretsManager
1018
1042
  # The ARN or name of the secret whose versions you want to list.
1019
1043
  #
1020
1044
  # For an ARN, we recommend that you specify a complete ARN rather than
1021
- # a partial ARN.
1045
+ # a partial ARN. See [Finding a secret from a partial ARN][1].
1046
+ #
1047
+ #
1048
+ #
1049
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
1022
1050
  # @return [String]
1023
1051
  #
1024
1052
  # @!attribute [rw] max_results
@@ -1207,7 +1235,11 @@ module Aws::SecretsManager
1207
1235
  # The ARN or name of the secret to attach the resource-based policy.
1208
1236
  #
1209
1237
  # For an ARN, we recommend that you specify a complete ARN rather than
1210
- # a partial ARN.
1238
+ # a partial ARN. See [Finding a secret from a partial ARN][1].
1239
+ #
1240
+ #
1241
+ #
1242
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
1211
1243
  # @return [String]
1212
1244
  #
1213
1245
  # @!attribute [rw] resource_policy
@@ -1268,9 +1300,13 @@ module Aws::SecretsManager
1268
1300
  # The ARN or name of the secret to add a new version to.
1269
1301
  #
1270
1302
  # For an ARN, we recommend that you specify a complete ARN rather than
1271
- # a partial ARN.
1303
+ # a partial ARN. See [Finding a secret from a partial ARN][1].
1272
1304
  #
1273
1305
  # If the secret doesn't already exist, use `CreateSecret` instead.
1306
+ #
1307
+ #
1308
+ #
1309
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
1274
1310
  # @return [String]
1275
1311
  #
1276
1312
  # @!attribute [rw] client_request_token
@@ -1597,7 +1633,11 @@ module Aws::SecretsManager
1597
1633
  # The ARN or name of the secret to restore.
1598
1634
  #
1599
1635
  # For an ARN, we recommend that you specify a complete ARN rather than
1600
- # a partial ARN.
1636
+ # a partial ARN. See [Finding a secret from a partial ARN][1].
1637
+ #
1638
+ #
1639
+ #
1640
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
1601
1641
  # @return [String]
1602
1642
  #
1603
1643
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/RestoreSecretRequest AWS API Documentation
@@ -1644,7 +1684,11 @@ module Aws::SecretsManager
1644
1684
  # The ARN or name of the secret to rotate.
1645
1685
  #
1646
1686
  # For an ARN, we recommend that you specify a complete ARN rather than
1647
- # a partial ARN.
1687
+ # a partial ARN. See [Finding a secret from a partial ARN][1].
1688
+ #
1689
+ #
1690
+ #
1691
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
1648
1692
  # @return [String]
1649
1693
  #
1650
1694
  # @!attribute [rw] client_request_token
@@ -2060,7 +2104,11 @@ module Aws::SecretsManager
2060
2104
  # secret.
2061
2105
  #
2062
2106
  # For an ARN, we recommend that you specify a complete ARN rather than
2063
- # a partial ARN.
2107
+ # a partial ARN. See [Finding a secret from a partial ARN][1].
2108
+ #
2109
+ #
2110
+ #
2111
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
2064
2112
  # @return [String]
2065
2113
  #
2066
2114
  # @!attribute [rw] tags
@@ -2098,7 +2146,11 @@ module Aws::SecretsManager
2098
2146
  # The ARN or name of the secret.
2099
2147
  #
2100
2148
  # For an ARN, we recommend that you specify a complete ARN rather than
2101
- # a partial ARN.
2149
+ # a partial ARN. See [Finding a secret from a partial ARN][1].
2150
+ #
2151
+ #
2152
+ #
2153
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
2102
2154
  # @return [String]
2103
2155
  #
2104
2156
  # @!attribute [rw] tag_keys
@@ -2143,7 +2195,11 @@ module Aws::SecretsManager
2143
2195
  # The ARN or name of the secret.
2144
2196
  #
2145
2197
  # For an ARN, we recommend that you specify a complete ARN rather than
2146
- # a partial ARN.
2198
+ # a partial ARN. See [Finding a secret from a partial ARN][1].
2199
+ #
2200
+ #
2201
+ #
2202
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
2147
2203
  # @return [String]
2148
2204
  #
2149
2205
  # @!attribute [rw] client_request_token
@@ -2264,7 +2320,11 @@ module Aws::SecretsManager
2264
2320
  # labelsto modify.
2265
2321
  #
2266
2322
  # For an ARN, we recommend that you specify a complete ARN rather than
2267
- # a partial ARN.
2323
+ # a partial ARN. See [Finding a secret from a partial ARN][1].
2324
+ #
2325
+ #
2326
+ #
2327
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
2268
2328
  # @return [String]
2269
2329
  #
2270
2330
  # @!attribute [rw] version_stage
@@ -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.59.0'
51
+ GEM_VERSION = '1.60.0'
52
52
 
53
53
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-secretsmanager
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.59.0
4
+ version: 1.60.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-03-11 00:00:00.000000000 Z
11
+ date: 2022-04-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core