aws-sdk-secretsmanager 1.81.0 → 1.95.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.
@@ -22,6 +22,7 @@ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
22
  require 'aws-sdk-core/plugins/response_paging.rb'
23
23
  require 'aws-sdk-core/plugins/stub_responses.rb'
24
24
  require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/invocation_id.rb'
25
26
  require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
27
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
28
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
@@ -72,6 +73,7 @@ module Aws::SecretsManager
72
73
  add_plugin(Aws::Plugins::ResponsePaging)
73
74
  add_plugin(Aws::Plugins::StubResponses)
74
75
  add_plugin(Aws::Plugins::IdempotencyToken)
76
+ add_plugin(Aws::Plugins::InvocationId)
75
77
  add_plugin(Aws::Plugins::JsonvalueConverter)
76
78
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
77
79
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
@@ -196,10 +198,17 @@ module Aws::SecretsManager
196
198
  # When set to 'true' the request body will not be compressed
197
199
  # for supported operations.
198
200
  #
199
- # @option options [String] :endpoint
200
- # The client endpoint is normally constructed from the `:region`
201
- # option. You should only configure an `:endpoint` when connecting
202
- # to test or custom endpoints. This should be a valid HTTP(S) URI.
201
+ # @option options [String, URI::HTTPS, URI::HTTP] :endpoint
202
+ # Normally you should not configure the `:endpoint` option
203
+ # directly. This is normally constructed from the `:region`
204
+ # option. Configuring `:endpoint` is normally reserved for
205
+ # connecting to test or custom endpoints. The endpoint should
206
+ # be a URI formatted like:
207
+ #
208
+ # 'http://example.com'
209
+ # 'https://example.com'
210
+ # 'http://example.com:123'
211
+ #
203
212
  #
204
213
  # @option options [Integer] :endpoint_cache_max_entries (1000)
205
214
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -292,8 +301,9 @@ module Aws::SecretsManager
292
301
  #
293
302
  # @option options [String] :sdk_ua_app_id
294
303
  # A unique and opaque application ID that is appended to the
295
- # User-Agent header as app/<sdk_ua_app_id>. It should have a
296
- # maximum length of 50.
304
+ # User-Agent header as app/sdk_ua_app_id. It should have a
305
+ # maximum length of 50. This variable is sourced from environment
306
+ # variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
297
307
  #
298
308
  # @option options [String] :secret_access_key
299
309
  #
@@ -347,57 +357,223 @@ module Aws::SecretsManager
347
357
  # @option options [Aws::SecretsManager::EndpointProvider] :endpoint_provider
348
358
  # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::SecretsManager::EndpointParameters`
349
359
  #
350
- # @option options [URI::HTTP,String] :http_proxy A proxy to send
351
- # requests through. Formatted like 'http://proxy.com:123'.
360
+ # @option options [Float] :http_continue_timeout (1)
361
+ # The number of seconds to wait for a 100-continue response before sending the
362
+ # request body. This option has no effect unless the request has "Expect"
363
+ # header set to "100-continue". Defaults to `nil` which disables this
364
+ # behaviour. This value can safely be set per request on the session.
365
+ #
366
+ # @option options [Float] :http_idle_timeout (5)
367
+ # The number of seconds a connection is allowed to sit idle before it
368
+ # is considered stale. Stale connections are closed and removed from the
369
+ # pool before making a request.
370
+ #
371
+ # @option options [Float] :http_open_timeout (15)
372
+ # The default number of seconds to wait for response data.
373
+ # This value can safely be set per-request on the session.
374
+ #
375
+ # @option options [URI::HTTP,String] :http_proxy
376
+ # A proxy to send requests through. Formatted like 'http://proxy.com:123'.
377
+ #
378
+ # @option options [Float] :http_read_timeout (60)
379
+ # The default number of seconds to wait for response data.
380
+ # This value can safely be set per-request on the session.
381
+ #
382
+ # @option options [Boolean] :http_wire_trace (false)
383
+ # When `true`, HTTP debug output will be sent to the `:logger`.
384
+ #
385
+ # @option options [Proc] :on_chunk_received
386
+ # When a Proc object is provided, it will be used as callback when each chunk
387
+ # of the response body is received. It provides three arguments: the chunk,
388
+ # the number of bytes received, and the total number of
389
+ # bytes in the response (or nil if the server did not send a `content-length`).
390
+ #
391
+ # @option options [Proc] :on_chunk_sent
392
+ # When a Proc object is provided, it will be used as callback when each chunk
393
+ # of the request body is sent. It provides three arguments: the chunk,
394
+ # the number of bytes read from the body, and the total number of
395
+ # bytes in the body.
396
+ #
397
+ # @option options [Boolean] :raise_response_errors (true)
398
+ # When `true`, response errors are raised.
399
+ #
400
+ # @option options [String] :ssl_ca_bundle
401
+ # Full path to the SSL certificate authority bundle file that should be used when
402
+ # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
403
+ # `:ssl_ca_directory` the the system default will be used if available.
404
+ #
405
+ # @option options [String] :ssl_ca_directory
406
+ # Full path of the directory that contains the unbundled SSL certificate
407
+ # authority files for verifying peer certificates. If you do
408
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
409
+ # default will be used if available.
352
410
  #
353
- # @option options [Float] :http_open_timeout (15) The number of
354
- # seconds to wait when opening a HTTP session before raising a
355
- # `Timeout::Error`.
411
+ # @option options [String] :ssl_ca_store
412
+ # Sets the X509::Store to verify peer certificate.
356
413
  #
357
- # @option options [Float] :http_read_timeout (60) The default
358
- # number of seconds to wait for response data. This value can
359
- # safely be set per-request on the session.
414
+ # @option options [Float] :ssl_timeout
415
+ # Sets the SSL timeout in seconds
360
416
  #
361
- # @option options [Float] :http_idle_timeout (5) The number of
362
- # seconds a connection is allowed to sit idle before it is
363
- # considered stale. Stale connections are closed and removed
364
- # from the pool before making a request.
417
+ # @option options [Boolean] :ssl_verify_peer (true)
418
+ # When `true`, SSL peer certificates are verified when establishing a connection.
365
419
  #
366
- # @option options [Float] :http_continue_timeout (1) The number of
367
- # seconds to wait for a 100-continue response before sending the
368
- # request body. This option has no effect unless the request has
369
- # "Expect" header set to "100-continue". Defaults to `nil` which
370
- # disables this behaviour. This value can safely be set per
371
- # request on the session.
420
+ def initialize(*args)
421
+ super
422
+ end
423
+
424
+ # @!group API Operations
425
+
426
+ # Retrieves the contents of the encrypted fields `SecretString` or
427
+ # `SecretBinary` for up to 20 secrets. To retrieve a single secret, call
428
+ # GetSecretValue.
372
429
  #
373
- # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
374
- # in seconds.
430
+ # To choose which secrets to retrieve, you can specify a list of secrets
431
+ # by name or ARN, or you can use filters. If Secrets Manager encounters
432
+ # errors such as `AccessDeniedException` while attempting to retrieve
433
+ # any of the secrets, you can see the errors in `Errors` in the
434
+ # response.
375
435
  #
376
- # @option options [Boolean] :http_wire_trace (false) When `true`,
377
- # HTTP debug output will be sent to the `:logger`.
436
+ # Secrets Manager generates CloudTrail `GetSecretValue` log entries for
437
+ # each secret you request when you call this action. Do not include
438
+ # sensitive information in request parameters because it might be
439
+ # logged. For more information, see [Logging Secrets Manager events with
440
+ # CloudTrail][1].
378
441
  #
379
- # @option options [Boolean] :ssl_verify_peer (true) When `true`,
380
- # SSL peer certificates are verified when establishing a
381
- # connection.
442
+ # <b>Required permissions: </b> `secretsmanager:BatchGetSecretValue`,
443
+ # and you must have `secretsmanager:GetSecretValue` for each secret. If
444
+ # you use filters, you must also have `secretsmanager:ListSecrets`. If
445
+ # the secrets are encrypted using customer-managed keys instead of the
446
+ # Amazon Web Services managed key `aws/secretsmanager`, then you also
447
+ # need `kms:Decrypt` permissions for the keys. For more information, see
448
+ # [ IAM policy actions for Secrets Manager][2] and [Authentication and
449
+ # access control in Secrets Manager][3].
382
450
  #
383
- # @option options [String] :ssl_ca_bundle Full path to the SSL
384
- # certificate authority bundle file that should be used when
385
- # verifying peer certificates. If you do not pass
386
- # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
387
- # will be used if available.
388
451
  #
389
- # @option options [String] :ssl_ca_directory Full path of the
390
- # directory that contains the unbundled SSL certificate
391
- # authority files for verifying peer certificates. If you do
392
- # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
393
- # system default will be used if available.
394
452
  #
395
- def initialize(*args)
396
- super
453
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html
454
+ # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
455
+ # [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
456
+ #
457
+ # @option params [Array<String>] :secret_id_list
458
+ # The ARN or names of the secrets to retrieve. You must include
459
+ # `Filters` or `SecretIdList`, but not both.
460
+ #
461
+ # @option params [Array<Types::Filter>] :filters
462
+ # The filters to choose which secrets to retrieve. You must include
463
+ # `Filters` or `SecretIdList`, but not both.
464
+ #
465
+ # @option params [Integer] :max_results
466
+ # The number of results to include in the response.
467
+ #
468
+ # If there are more results available, in the response, Secrets Manager
469
+ # includes `NextToken`. To get the next results, call
470
+ # `BatchGetSecretValue` again with the value from `NextToken`. To use
471
+ # this parameter, you must also use the `Filters` parameter.
472
+ #
473
+ # @option params [String] :next_token
474
+ # A token that indicates where the output should continue from, if a
475
+ # previous call did not show all results. To get the next results, call
476
+ # `BatchGetSecretValue` again with this value.
477
+ #
478
+ # @return [Types::BatchGetSecretValueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
479
+ #
480
+ # * {Types::BatchGetSecretValueResponse#secret_values #secret_values} => Array&lt;Types::SecretValueEntry&gt;
481
+ # * {Types::BatchGetSecretValueResponse#next_token #next_token} => String
482
+ # * {Types::BatchGetSecretValueResponse#errors #errors} => Array&lt;Types::APIErrorType&gt;
483
+ #
484
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
485
+ #
486
+ #
487
+ # @example Example: To retrieve the secret values for a group of secrets listed by name
488
+ #
489
+ # # The following example gets the values for three secrets.
490
+ #
491
+ # resp = client.batch_get_secret_value({
492
+ # secret_id_list: [
493
+ # "MySecret1",
494
+ # "MySecret2",
495
+ # "MySecret3",
496
+ # ],
497
+ # })
498
+ #
499
+ # resp.to_h outputs the following:
500
+ # {
501
+ # errors: [
502
+ # ],
503
+ # secret_values: [
504
+ # {
505
+ # arn: "&region-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret1-a1b2c3",
506
+ # created_date: Time.parse(1700591229.801),
507
+ # name: "MySecret1",
508
+ # secret_string: "{\"username\":\"diego_ramirez\",\"password\":\"EXAMPLE-PASSWORD\",\"engine\":\"mysql\",\"host\":\"secretsmanagertutorial.cluster.us-west-2.rds.amazonaws.com\",\"port\":3306,\"dbClusterIdentifier\":\"secretsmanagertutorial\"}",
509
+ # version_id: "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa",
510
+ # version_stages: [
511
+ # "AWSCURRENT",
512
+ # ],
513
+ # },
514
+ # {
515
+ # arn: "&region-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret2-a1b2c3",
516
+ # created_date: Time.parse(1699911394.105),
517
+ # name: "MySecret2",
518
+ # secret_string: "{\"username\":\"akua_mansa\",\"password\":\"EXAMPLE-PASSWORD\"",
519
+ # version_id: "a1b2c3d4-5678-90ab-cdef-EXAMPLEbbbbb",
520
+ # version_stages: [
521
+ # "AWSCURRENT",
522
+ # ],
523
+ # },
524
+ # {
525
+ # arn: "&region-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret3-a1b2c3",
526
+ # created_date: Time.parse(1699911394.105),
527
+ # name: "MySecret3",
528
+ # secret_string: "{\"username\":\"jie_liu\",\"password\":\"EXAMPLE-PASSWORD\"",
529
+ # version_id: "a1b2c3d4-5678-90ab-cdef-EXAMPLEccccc",
530
+ # version_stages: [
531
+ # "AWSCURRENT",
532
+ # ],
533
+ # },
534
+ # ],
535
+ # }
536
+ #
537
+ # @example Request syntax with placeholder values
538
+ #
539
+ # resp = client.batch_get_secret_value({
540
+ # secret_id_list: ["SecretIdType"],
541
+ # filters: [
542
+ # {
543
+ # key: "description", # accepts description, name, tag-key, tag-value, primary-region, owning-service, all
544
+ # values: ["FilterValueStringType"],
545
+ # },
546
+ # ],
547
+ # max_results: 1,
548
+ # next_token: "NextTokenType",
549
+ # })
550
+ #
551
+ # @example Response structure
552
+ #
553
+ # resp.secret_values #=> Array
554
+ # resp.secret_values[0].arn #=> String
555
+ # resp.secret_values[0].name #=> String
556
+ # resp.secret_values[0].version_id #=> String
557
+ # resp.secret_values[0].secret_binary #=> String
558
+ # resp.secret_values[0].secret_string #=> String
559
+ # resp.secret_values[0].version_stages #=> Array
560
+ # resp.secret_values[0].version_stages[0] #=> String
561
+ # resp.secret_values[0].created_date #=> Time
562
+ # resp.next_token #=> String
563
+ # resp.errors #=> Array
564
+ # resp.errors[0].secret_id #=> String
565
+ # resp.errors[0].error_code #=> String
566
+ # resp.errors[0].message #=> String
567
+ #
568
+ # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/BatchGetSecretValue AWS API Documentation
569
+ #
570
+ # @overload batch_get_secret_value(params = {})
571
+ # @param [Hash] params ({})
572
+ def batch_get_secret_value(params = {}, options = {})
573
+ req = build_request(:batch_get_secret_value, params)
574
+ req.send_request(options)
397
575
  end
398
576
 
399
- # @!group API Operations
400
-
401
577
  # Turns off automatic rotation, and if a rotation is currently in
402
578
  # progress, cancels the rotation.
403
579
  #
@@ -567,14 +743,14 @@ module Aws::SecretsManager
567
743
  # <note markdown="1"> If you use the Amazon Web Services CLI or one of the Amazon Web
568
744
  # Services SDKs to call this operation, then you can leave this
569
745
  # parameter empty. The CLI or SDK generates a random UUID for you and
570
- # includes it as the value for this parameter in the request. If you
571
- # don't use the SDK and instead generate a raw HTTP request to the
572
- # Secrets Manager service endpoint, then you must generate a
573
- # `ClientRequestToken` yourself for the new version and include the
574
- # value in the request.
746
+ # includes it as the value for this parameter in the request.
575
747
  #
576
748
  # </note>
577
749
  #
750
+ # If you generate a raw HTTP request to the Secrets Manager service
751
+ # endpoint, then you must generate a `ClientRequestToken` and include it
752
+ # in the request.
753
+ #
578
754
  # This value helps ensure idempotency. Secrets Manager uses this value
579
755
  # to prevent the accidental creation of duplicate versions if there are
580
756
  # failures and retries during a rotation. We recommend that you generate
@@ -676,32 +852,15 @@ module Aws::SecretsManager
676
852
  # parameter, you should use single quotes to avoid confusion with the
677
853
  # double quotes required in the JSON text.
678
854
  #
679
- # The following restrictions apply to tags:
680
- #
681
- # * Maximum number of tags per secret: 50
682
- #
683
- # * Maximum key length: 127 Unicode characters in UTF-8
684
- #
685
- # * Maximum value length: 255 Unicode characters in UTF-8
686
- #
687
- # * Tag keys and values are case sensitive.
688
- #
689
- # * Do not use the `aws:` prefix in your tag names or values because
690
- # Amazon Web Services reserves it for Amazon Web Services use. You
691
- # can't edit or delete tag names or values with this prefix. Tags
692
- # with this prefix do not count against your tags per secret limit.
693
- #
694
- # * If you use your tagging schema across multiple services and
695
- # resources, other services might have restrictions on allowed
696
- # characters. Generally allowed characters: letters, spaces, and
697
- # numbers representable in UTF-8, plus the following special
698
- # characters: + - = . \_ : / @.
855
+ # For tag quotas and naming restrictions, see [Service quotas for
856
+ # Tagging][4] in the *Amazon Web Services General Reference guide*.
699
857
  #
700
858
  #
701
859
  #
702
860
  # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac
703
861
  # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2
704
862
  # [3]: https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json
863
+ # [4]: https://docs.aws.amazon.com/general/latest/gr/arg.html#taged-reference-quotas
705
864
  #
706
865
  # @option params [Array<Types::ReplicaRegionType>] :add_replica_regions
707
866
  # A list of Regions and KMS keys to replicate secrets.
@@ -1132,22 +1291,21 @@ module Aws::SecretsManager
1132
1291
 
1133
1292
  # Generates a random password. We recommend that you specify the maximum
1134
1293
  # length and include every character type that the system you are
1135
- # generating a password for can support.
1294
+ # generating a password for can support. By default, Secrets Manager
1295
+ # uses uppercase and lowercase letters, numbers, and the following
1296
+ # characters in passwords: `` !"#$%&'()*+,-./:;<=>?@[\\]^_`\{|\}~ ``
1136
1297
  #
1137
1298
  # Secrets Manager generates a CloudTrail log entry when you call this
1138
- # action. Do not include sensitive information in request parameters
1139
- # because it might be logged. For more information, see [Logging Secrets
1140
- # Manager events with CloudTrail][1].
1299
+ # action.
1141
1300
  #
1142
1301
  # <b>Required permissions: </b> `secretsmanager:GetRandomPassword`. For
1143
- # more information, see [ IAM policy actions for Secrets Manager][2] and
1144
- # [Authentication and access control in Secrets Manager][3].
1302
+ # more information, see [ IAM policy actions for Secrets Manager][1] and
1303
+ # [Authentication and access control in Secrets Manager][2].
1145
1304
  #
1146
1305
  #
1147
1306
  #
1148
- # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html
1149
- # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
1150
- # [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
1307
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
1308
+ # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
1151
1309
  #
1152
1310
  # @option params [Integer] :password_length
1153
1311
  # The length of the password. If you don't include this parameter, the
@@ -1311,6 +1469,9 @@ module Aws::SecretsManager
1311
1469
  # `SecretBinary` from the specified version of a secret, whichever
1312
1470
  # contains content.
1313
1471
  #
1472
+ # To retrieve the values for a group of secrets, call
1473
+ # BatchGetSecretValue.
1474
+ #
1314
1475
  # We recommend that you cache your secret values by using client-side
1315
1476
  # caching. Caching secrets improves speed and reduces your costs. For
1316
1477
  # more information, see [Cache secrets for your applications][1].
@@ -1563,13 +1724,13 @@ module Aws::SecretsManager
1563
1724
  # Services account, not including secrets that are marked for deletion.
1564
1725
  # To see secrets marked for deletion, use the Secrets Manager console.
1565
1726
  #
1566
- # ListSecrets is eventually consistent, however it might not reflect
1567
- # changes from the last five minutes. To get the latest information for
1568
- # a specific secret, use DescribeSecret.
1727
+ # All Secrets Manager operations are eventually consistent. ListSecrets
1728
+ # might not reflect changes from the last five minutes. You can get more
1729
+ # recent information for a specific secret by calling DescribeSecret.
1569
1730
  #
1570
1731
  # To list the versions of a secret, use ListSecretVersionIds.
1571
1732
  #
1572
- # To get the secret value from `SecretString` or `SecretBinary`, call
1733
+ # To retrieve the values for the secrets, call BatchGetSecretValue or
1573
1734
  # GetSecretValue.
1574
1735
  #
1575
1736
  # For information about finding secrets in the console, see [Find
@@ -1754,6 +1915,25 @@ module Aws::SecretsManager
1754
1915
  # access to the secret, for example those that use a wildcard for the
1755
1916
  # principal. By default, public policies aren't blocked.
1756
1917
  #
1918
+ # Resource policy validation and the BlockPublicPolicy parameter help
1919
+ # protect your resources by preventing public access from being granted
1920
+ # through the resource policies that are directly attached to your
1921
+ # secrets. In addition to using these features, carefully inspect the
1922
+ # following policies to confirm that they do not grant public access:
1923
+ #
1924
+ # * Identity-based policies attached to associated Amazon Web Services
1925
+ # principals (for example, IAM roles)
1926
+ #
1927
+ # * Resource-based policies attached to associated Amazon Web Services
1928
+ # resources (for example, Key Management Service (KMS) keys)
1929
+ #
1930
+ # To review permissions to your secrets, see [Determine who has
1931
+ # permissions to your secrets][1].
1932
+ #
1933
+ #
1934
+ #
1935
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/determine-acccess_examine-iam-policies.html
1936
+ #
1757
1937
  # @return [Types::PutResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1758
1938
  #
1759
1939
  # * {Types::PutResourcePolicyResponse#arn #arn} => String
@@ -1860,19 +2040,20 @@ module Aws::SecretsManager
1860
2040
  #
1861
2041
  # <note markdown="1"> If you use the Amazon Web Services CLI or one of the Amazon Web
1862
2042
  # Services SDKs to call this operation, then you can leave this
1863
- # parameter empty because they generate a random UUID for you. If you
1864
- # don't use the SDK and instead generate a raw HTTP request to the
1865
- # Secrets Manager service endpoint, then you must generate a
1866
- # `ClientRequestToken` yourself for new versions and include that value
1867
- # in the request.
2043
+ # parameter empty. The CLI or SDK generates a random UUID for you and
2044
+ # includes it as the value for this parameter in the request.
1868
2045
  #
1869
2046
  # </note>
1870
2047
  #
2048
+ # If you generate a raw HTTP request to the Secrets Manager service
2049
+ # endpoint, then you must generate a `ClientRequestToken` and include it
2050
+ # in the request.
2051
+ #
1871
2052
  # This value helps ensure idempotency. Secrets Manager uses this value
1872
2053
  # to prevent the accidental creation of duplicate versions if there are
1873
- # failures and retries during the Lambda rotation function processing.
1874
- # We recommend that you generate a [UUID-type][1] value to ensure
1875
- # uniqueness within the specified secret.
2054
+ # failures and retries during a rotation. We recommend that you generate
2055
+ # a [UUID-type][1] value to ensure uniqueness of your versions within
2056
+ # the specified secret.
1876
2057
  #
1877
2058
  # * If the `ClientRequestToken` value isn't already associated with a
1878
2059
  # version of the secret then a new version of the secret is created.
@@ -2049,9 +2230,13 @@ module Aws::SecretsManager
2049
2230
  # Manager events with CloudTrail][2].
2050
2231
  #
2051
2232
  # <b>Required permissions: </b>
2052
- # `secretsmanager:ReplicateSecretToRegions`. For more information, see [
2053
- # IAM policy actions for Secrets Manager][3] and [Authentication and
2054
- # access control in Secrets Manager][4].
2233
+ # `secretsmanager:ReplicateSecretToRegions`. If the primary secret is
2234
+ # encrypted with a KMS key other than `aws/secretsmanager`, you also
2235
+ # need `kms:Decrypt` permission to the key. To encrypt the replicated
2236
+ # secret with a KMS key other than `aws/secretsmanager`, you need
2237
+ # `kms:GenerateDataKey` and `kms:Encrypt` to the key. For more
2238
+ # information, see [ IAM policy actions for Secrets Manager][3] and
2239
+ # [Authentication and access control in Secrets Manager][4].
2055
2240
  #
2056
2241
  #
2057
2242
  #
@@ -2253,24 +2438,27 @@ module Aws::SecretsManager
2253
2438
  # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
2254
2439
  #
2255
2440
  # @option params [String] :client_request_token
2256
- # A unique identifier for the new version of the secret that helps
2257
- # ensure idempotency. Secrets Manager uses this value to prevent the
2258
- # accidental creation of duplicate versions if there are failures and
2259
- # retries during rotation. This value becomes the `VersionId` of the new
2260
- # version.
2261
- #
2262
- # If you use the Amazon Web Services CLI or one of the Amazon Web
2263
- # Services SDK to call this operation, then you can leave this parameter
2264
- # empty. The CLI or SDK generates a random UUID for you and includes
2265
- # that in the request for this parameter. If you don't use the SDK and
2266
- # instead generate a raw HTTP request to the Secrets Manager service
2267
- # endpoint, then you must generate a `ClientRequestToken` yourself for
2268
- # new versions and include that value in the request.
2269
- #
2270
- # You only need to specify this value if you implement your own retry
2271
- # logic and you want to ensure that Secrets Manager doesn't attempt to
2272
- # create a secret version twice. We recommend that you generate a
2273
- # [UUID-type][1] value to ensure uniqueness within the specified secret.
2441
+ # A unique identifier for the new version of the secret. You only need
2442
+ # to specify this value if you implement your own retry logic and you
2443
+ # want to ensure that Secrets Manager doesn't attempt to create a
2444
+ # secret version twice.
2445
+ #
2446
+ # <note markdown="1"> If you use the Amazon Web Services CLI or one of the Amazon Web
2447
+ # Services SDKs to call this operation, then you can leave this
2448
+ # parameter empty. The CLI or SDK generates a random UUID for you and
2449
+ # includes it as the value for this parameter in the request.
2450
+ #
2451
+ # </note>
2452
+ #
2453
+ # If you generate a raw HTTP request to the Secrets Manager service
2454
+ # endpoint, then you must generate a `ClientRequestToken` and include it
2455
+ # in the request.
2456
+ #
2457
+ # This value helps ensure idempotency. Secrets Manager uses this value
2458
+ # to prevent the accidental creation of duplicate versions if there are
2459
+ # failures and retries during a rotation. We recommend that you generate
2460
+ # a [UUID-type][1] value to ensure uniqueness of your versions within
2461
+ # the specified secret.
2274
2462
  #
2275
2463
  # **A suitable default value is auto-generated.** You should normally
2276
2464
  # not need to pass this option.**
@@ -2438,26 +2626,8 @@ module Aws::SecretsManager
2438
2626
  # specific versions of the secret. This operation appends tags to the
2439
2627
  # existing list of tags.
2440
2628
  #
2441
- # The following restrictions apply to tags:
2442
- #
2443
- # * Maximum number of tags per secret: 50
2444
- #
2445
- # * Maximum key length: 127 Unicode characters in UTF-8
2446
- #
2447
- # * Maximum value length: 255 Unicode characters in UTF-8
2448
- #
2449
- # * Tag keys and values are case sensitive.
2450
- #
2451
- # * Do not use the `aws:` prefix in your tag names or values because
2452
- # Amazon Web Services reserves it for Amazon Web Services use. You
2453
- # can't edit or delete tag names or values with this prefix. Tags
2454
- # with this prefix do not count against your tags per secret limit.
2455
- #
2456
- # * If you use your tagging schema across multiple services and
2457
- # resources, other services might have restrictions on allowed
2458
- # characters. Generally allowed characters: letters, spaces, and
2459
- # numbers representable in UTF-8, plus the following special
2460
- # characters: + - = . \_ : / @.
2629
+ # For tag quotas and naming restrictions, see [Service quotas for
2630
+ # Tagging][1] in the *Amazon Web Services General Reference guide*.
2461
2631
  #
2462
2632
  # If you use tags as part of your security strategy, then adding or
2463
2633
  # removing a tag can change permissions. If successfully completing this
@@ -2467,17 +2637,18 @@ module Aws::SecretsManager
2467
2637
  # Secrets Manager generates a CloudTrail log entry when you call this
2468
2638
  # action. Do not include sensitive information in request parameters
2469
2639
  # because it might be logged. For more information, see [Logging Secrets
2470
- # Manager events with CloudTrail][1].
2640
+ # Manager events with CloudTrail][2].
2471
2641
  #
2472
2642
  # <b>Required permissions: </b> `secretsmanager:TagResource`. For more
2473
- # information, see [ IAM policy actions for Secrets Manager][2] and
2474
- # [Authentication and access control in Secrets Manager][3].
2643
+ # information, see [ IAM policy actions for Secrets Manager][3] and
2644
+ # [Authentication and access control in Secrets Manager][4].
2475
2645
  #
2476
2646
  #
2477
2647
  #
2478
- # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html
2479
- # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
2480
- # [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
2648
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/arg.html#taged-reference-quotas
2649
+ # [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html
2650
+ # [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
2651
+ # [4]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
2481
2652
  #
2482
2653
  # @option params [required, String] :secret_id
2483
2654
  # The identifier for the secret to attach tags to. You can specify
@@ -2701,19 +2872,27 @@ module Aws::SecretsManager
2701
2872
  # <note markdown="1"> If you use the Amazon Web Services CLI or one of the Amazon Web
2702
2873
  # Services SDKs to call this operation, then you can leave this
2703
2874
  # parameter empty. The CLI or SDK generates a random UUID for you and
2704
- # includes it as the value for this parameter in the request. If you
2705
- # don't use the SDK and instead generate a raw HTTP request to the
2706
- # Secrets Manager service endpoint, then you must generate a
2707
- # `ClientRequestToken` yourself for the new version and include the
2708
- # value in the request.
2875
+ # includes it as the value for this parameter in the request.
2709
2876
  #
2710
2877
  # </note>
2711
2878
  #
2712
- # This value becomes the `VersionId` of the new version.
2879
+ # If you generate a raw HTTP request to the Secrets Manager service
2880
+ # endpoint, then you must generate a `ClientRequestToken` and include it
2881
+ # in the request.
2882
+ #
2883
+ # This value helps ensure idempotency. Secrets Manager uses this value
2884
+ # to prevent the accidental creation of duplicate versions if there are
2885
+ # failures and retries during a rotation. We recommend that you generate
2886
+ # a [UUID-type][1] value to ensure uniqueness of your versions within
2887
+ # the specified secret.
2713
2888
  #
2714
2889
  # **A suitable default value is auto-generated.** You should normally
2715
2890
  # not need to pass this option.**
2716
2891
  #
2892
+ #
2893
+ #
2894
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
2895
+ #
2717
2896
  # @option params [String] :description
2718
2897
  # The description of the secret.
2719
2898
  #
@@ -3108,7 +3287,7 @@ module Aws::SecretsManager
3108
3287
  params: params,
3109
3288
  config: config)
3110
3289
  context[:gem_name] = 'aws-sdk-secretsmanager'
3111
- context[:gem_version] = '1.81.0'
3290
+ context[:gem_version] = '1.95.0'
3112
3291
  Seahorse::Client::Request.new(handlers, context)
3113
3292
  end
3114
3293