aws-sdk-secretsmanager 1.85.0 → 1.86.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-secretsmanager/client.rb +104 -2
- data/lib/aws-sdk-secretsmanager/client_api.rb +60 -0
- data/lib/aws-sdk-secretsmanager/endpoints.rb +14 -0
- data/lib/aws-sdk-secretsmanager/plugins/endpoints.rb +2 -0
- data/lib/aws-sdk-secretsmanager/types.rb +145 -4
- data/lib/aws-sdk-secretsmanager.rb +2 -2
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4b36142cce8d1fb43724739b354bd54ab8bd688c78bb97ddaa3df5d23acd9cb9
|
4
|
+
data.tar.gz: fa257f122096e02ef34edcb94b38aa8d87415e376faae8628c8ef7bb2fd3385c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d361c617702184565b9d0fbae46e3d3a402dcdb9199abc1051517b5ff21301164841d0a78b519dd4fe9fc1f90df7a2b1538b01d00255d077b8d190d1314c0c4a
|
7
|
+
data.tar.gz: c4a641d3cb30a79231c9d3b126ceb46bc64ba3aec1d59234bfab0c04376fb8e88117143f5cef732ae16b838fca5283645c5aafd0ad1b9e0ebf6480e14c4f3305
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.86.0 (2023-11-27)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - AWS Secrets Manager has released the BatchGetSecretValue API, which allows customers to fetch up to 20 Secrets with a single request using a list of secret names or filters.
|
8
|
+
|
4
9
|
1.85.0 (2023-11-22)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.86.0
|
@@ -398,6 +398,105 @@ module Aws::SecretsManager
|
|
398
398
|
|
399
399
|
# @!group API Operations
|
400
400
|
|
401
|
+
# Retrieves the contents of the encrypted fields `SecretString` or
|
402
|
+
# `SecretBinary` for up to 20 secrets. To retrieve a single secret, call
|
403
|
+
# GetSecretValue.
|
404
|
+
#
|
405
|
+
# To choose which secrets to retrieve, you can specify a list of secrets
|
406
|
+
# by name or ARN, or you can use filters. If Secrets Manager encounters
|
407
|
+
# errors such as `AccessDeniedException` while attempting to retrieve
|
408
|
+
# any of the secrets, you can see the errors in `Errors` in the
|
409
|
+
# response.
|
410
|
+
#
|
411
|
+
# Secrets Manager generates CloudTrail `GetSecretValue` log entries for
|
412
|
+
# each secret you request when you call this action. Do not include
|
413
|
+
# sensitive information in request parameters because it might be
|
414
|
+
# logged. For more information, see [Logging Secrets Manager events with
|
415
|
+
# CloudTrail][1].
|
416
|
+
#
|
417
|
+
# <b>Required permissions: </b> `secretsmanager:BatchGetSecretValue`,
|
418
|
+
# and you must have `secretsmanager:GetSecretValue` for each secret. If
|
419
|
+
# you use filters, you must also have `secretsmanager:ListSecrets`. If
|
420
|
+
# the secrets are encrypted using customer-managed keys instead of the
|
421
|
+
# Amazon Web Services managed key `aws/secretsmanager`, then you also
|
422
|
+
# need `kms:Decrypt` permissions for the keys. For more information, see
|
423
|
+
# [ IAM policy actions for Secrets Manager][2] and [Authentication and
|
424
|
+
# access control in Secrets Manager][3].
|
425
|
+
#
|
426
|
+
#
|
427
|
+
#
|
428
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html
|
429
|
+
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions
|
430
|
+
# [3]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
|
431
|
+
#
|
432
|
+
# @option params [Array<String>] :secret_id_list
|
433
|
+
# The ARN or names of the secrets to retrieve. You must include
|
434
|
+
# `Filters` or `SecretIdList`, but not both.
|
435
|
+
#
|
436
|
+
# @option params [Array<Types::Filter>] :filters
|
437
|
+
# The filters to choose which secrets to retrieve. You must include
|
438
|
+
# `Filters` or `SecretIdList`, but not both.
|
439
|
+
#
|
440
|
+
# @option params [Integer] :max_results
|
441
|
+
# The number of results to include in the response.
|
442
|
+
#
|
443
|
+
# If there are more results available, in the response, Secrets Manager
|
444
|
+
# includes `NextToken`. To get the next results, call
|
445
|
+
# `BatchGetSecretValue` again with the value from `NextToken`.
|
446
|
+
#
|
447
|
+
# @option params [String] :next_token
|
448
|
+
# A token that indicates where the output should continue from, if a
|
449
|
+
# previous call did not show all results. To get the next results, call
|
450
|
+
# `BatchGetSecretValue` again with this value.
|
451
|
+
#
|
452
|
+
# @return [Types::BatchGetSecretValueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
453
|
+
#
|
454
|
+
# * {Types::BatchGetSecretValueResponse#secret_values #secret_values} => Array<Types::SecretValueEntry>
|
455
|
+
# * {Types::BatchGetSecretValueResponse#next_token #next_token} => String
|
456
|
+
# * {Types::BatchGetSecretValueResponse#errors #errors} => Array<Types::APIErrorType>
|
457
|
+
#
|
458
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
459
|
+
#
|
460
|
+
# @example Request syntax with placeholder values
|
461
|
+
#
|
462
|
+
# resp = client.batch_get_secret_value({
|
463
|
+
# secret_id_list: ["SecretIdType"],
|
464
|
+
# filters: [
|
465
|
+
# {
|
466
|
+
# key: "description", # accepts description, name, tag-key, tag-value, primary-region, owning-service, all
|
467
|
+
# values: ["FilterValueStringType"],
|
468
|
+
# },
|
469
|
+
# ],
|
470
|
+
# max_results: 1,
|
471
|
+
# next_token: "NextTokenType",
|
472
|
+
# })
|
473
|
+
#
|
474
|
+
# @example Response structure
|
475
|
+
#
|
476
|
+
# resp.secret_values #=> Array
|
477
|
+
# resp.secret_values[0].arn #=> String
|
478
|
+
# resp.secret_values[0].name #=> String
|
479
|
+
# resp.secret_values[0].version_id #=> String
|
480
|
+
# resp.secret_values[0].secret_binary #=> String
|
481
|
+
# resp.secret_values[0].secret_string #=> String
|
482
|
+
# resp.secret_values[0].version_stages #=> Array
|
483
|
+
# resp.secret_values[0].version_stages[0] #=> String
|
484
|
+
# resp.secret_values[0].created_date #=> Time
|
485
|
+
# resp.next_token #=> String
|
486
|
+
# resp.errors #=> Array
|
487
|
+
# resp.errors[0].secret_id #=> String
|
488
|
+
# resp.errors[0].error_code #=> String
|
489
|
+
# resp.errors[0].message #=> String
|
490
|
+
#
|
491
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/BatchGetSecretValue AWS API Documentation
|
492
|
+
#
|
493
|
+
# @overload batch_get_secret_value(params = {})
|
494
|
+
# @param [Hash] params ({})
|
495
|
+
def batch_get_secret_value(params = {}, options = {})
|
496
|
+
req = build_request(:batch_get_secret_value, params)
|
497
|
+
req.send_request(options)
|
498
|
+
end
|
499
|
+
|
401
500
|
# Turns off automatic rotation, and if a rotation is currently in
|
402
501
|
# progress, cancels the rotation.
|
403
502
|
#
|
@@ -1294,6 +1393,9 @@ module Aws::SecretsManager
|
|
1294
1393
|
# `SecretBinary` from the specified version of a secret, whichever
|
1295
1394
|
# contains content.
|
1296
1395
|
#
|
1396
|
+
# To retrieve the values for a group of secrets, call
|
1397
|
+
# BatchGetSecretValue.
|
1398
|
+
#
|
1297
1399
|
# We recommend that you cache your secret values by using client-side
|
1298
1400
|
# caching. Caching secrets improves speed and reduces your costs. For
|
1299
1401
|
# more information, see [Cache secrets for your applications][1].
|
@@ -1552,7 +1654,7 @@ module Aws::SecretsManager
|
|
1552
1654
|
#
|
1553
1655
|
# To list the versions of a secret, use ListSecretVersionIds.
|
1554
1656
|
#
|
1555
|
-
# To
|
1657
|
+
# To retrieve the values for the secrets, call BatchGetSecretValue or
|
1556
1658
|
# GetSecretValue.
|
1557
1659
|
#
|
1558
1660
|
# For information about finding secrets in the console, see [Find
|
@@ -3086,7 +3188,7 @@ module Aws::SecretsManager
|
|
3086
3188
|
params: params,
|
3087
3189
|
config: config)
|
3088
3190
|
context[:gem_name] = 'aws-sdk-secretsmanager'
|
3089
|
-
context[:gem_version] = '1.
|
3191
|
+
context[:gem_version] = '1.86.0'
|
3090
3192
|
Seahorse::Client::Request.new(handlers, context)
|
3091
3193
|
end
|
3092
3194
|
|
@@ -13,8 +13,12 @@ module Aws::SecretsManager
|
|
13
13
|
|
14
14
|
include Seahorse::Model
|
15
15
|
|
16
|
+
APIErrorListType = Shapes::ListShape.new(name: 'APIErrorListType')
|
17
|
+
APIErrorType = Shapes::StructureShape.new(name: 'APIErrorType')
|
16
18
|
AddReplicaRegionListType = Shapes::ListShape.new(name: 'AddReplicaRegionListType')
|
17
19
|
AutomaticallyRotateAfterDaysType = Shapes::IntegerShape.new(name: 'AutomaticallyRotateAfterDaysType')
|
20
|
+
BatchGetSecretValueRequest = Shapes::StructureShape.new(name: 'BatchGetSecretValueRequest')
|
21
|
+
BatchGetSecretValueResponse = Shapes::StructureShape.new(name: 'BatchGetSecretValueResponse')
|
18
22
|
BooleanType = Shapes::BooleanShape.new(name: 'BooleanType')
|
19
23
|
CancelRotateSecretRequest = Shapes::StructureShape.new(name: 'CancelRotateSecretRequest')
|
20
24
|
CancelRotateSecretResponse = Shapes::StructureShape.new(name: 'CancelRotateSecretResponse')
|
@@ -34,6 +38,7 @@ module Aws::SecretsManager
|
|
34
38
|
DescriptionType = Shapes::StringShape.new(name: 'DescriptionType')
|
35
39
|
DurationType = Shapes::StringShape.new(name: 'DurationType')
|
36
40
|
EncryptionFailure = Shapes::StructureShape.new(name: 'EncryptionFailure')
|
41
|
+
ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
|
37
42
|
ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
|
38
43
|
ExcludeCharactersType = Shapes::StringShape.new(name: 'ExcludeCharactersType')
|
39
44
|
ExcludeLowercaseType = Shapes::BooleanShape.new(name: 'ExcludeLowercaseType')
|
@@ -67,6 +72,7 @@ module Aws::SecretsManager
|
|
67
72
|
ListSecretsRequest = Shapes::StructureShape.new(name: 'ListSecretsRequest')
|
68
73
|
ListSecretsResponse = Shapes::StructureShape.new(name: 'ListSecretsResponse')
|
69
74
|
MalformedPolicyDocumentException = Shapes::StructureShape.new(name: 'MalformedPolicyDocumentException')
|
75
|
+
MaxResultsBatchType = Shapes::IntegerShape.new(name: 'MaxResultsBatchType')
|
70
76
|
MaxResultsType = Shapes::IntegerShape.new(name: 'MaxResultsType')
|
71
77
|
NameType = Shapes::StringShape.new(name: 'NameType')
|
72
78
|
NextRotationDateType = Shapes::TimestampShape.new(name: 'NextRotationDateType')
|
@@ -104,11 +110,14 @@ module Aws::SecretsManager
|
|
104
110
|
ScheduleExpressionType = Shapes::StringShape.new(name: 'ScheduleExpressionType')
|
105
111
|
SecretARNType = Shapes::StringShape.new(name: 'SecretARNType')
|
106
112
|
SecretBinaryType = Shapes::BlobShape.new(name: 'SecretBinaryType')
|
113
|
+
SecretIdListType = Shapes::ListShape.new(name: 'SecretIdListType')
|
107
114
|
SecretIdType = Shapes::StringShape.new(name: 'SecretIdType')
|
108
115
|
SecretListEntry = Shapes::StructureShape.new(name: 'SecretListEntry')
|
109
116
|
SecretListType = Shapes::ListShape.new(name: 'SecretListType')
|
110
117
|
SecretNameType = Shapes::StringShape.new(name: 'SecretNameType')
|
111
118
|
SecretStringType = Shapes::StringShape.new(name: 'SecretStringType')
|
119
|
+
SecretValueEntry = Shapes::StructureShape.new(name: 'SecretValueEntry')
|
120
|
+
SecretValuesType = Shapes::ListShape.new(name: 'SecretValuesType')
|
112
121
|
SecretVersionIdType = Shapes::StringShape.new(name: 'SecretVersionIdType')
|
113
122
|
SecretVersionStageType = Shapes::StringShape.new(name: 'SecretVersionStageType')
|
114
123
|
SecretVersionStagesType = Shapes::ListShape.new(name: 'SecretVersionStagesType')
|
@@ -137,8 +146,26 @@ module Aws::SecretsManager
|
|
137
146
|
ValidationErrorsEntry = Shapes::StructureShape.new(name: 'ValidationErrorsEntry')
|
138
147
|
ValidationErrorsType = Shapes::ListShape.new(name: 'ValidationErrorsType')
|
139
148
|
|
149
|
+
APIErrorListType.member = Shapes::ShapeRef.new(shape: APIErrorType)
|
150
|
+
|
151
|
+
APIErrorType.add_member(:secret_id, Shapes::ShapeRef.new(shape: SecretIdType, location_name: "SecretId"))
|
152
|
+
APIErrorType.add_member(:error_code, Shapes::ShapeRef.new(shape: ErrorCode, location_name: "ErrorCode"))
|
153
|
+
APIErrorType.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
154
|
+
APIErrorType.struct_class = Types::APIErrorType
|
155
|
+
|
140
156
|
AddReplicaRegionListType.member = Shapes::ShapeRef.new(shape: ReplicaRegionType)
|
141
157
|
|
158
|
+
BatchGetSecretValueRequest.add_member(:secret_id_list, Shapes::ShapeRef.new(shape: SecretIdListType, location_name: "SecretIdList"))
|
159
|
+
BatchGetSecretValueRequest.add_member(:filters, Shapes::ShapeRef.new(shape: FiltersListType, location_name: "Filters"))
|
160
|
+
BatchGetSecretValueRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsBatchType, location_name: "MaxResults", metadata: {"box"=>true}))
|
161
|
+
BatchGetSecretValueRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextTokenType, location_name: "NextToken"))
|
162
|
+
BatchGetSecretValueRequest.struct_class = Types::BatchGetSecretValueRequest
|
163
|
+
|
164
|
+
BatchGetSecretValueResponse.add_member(:secret_values, Shapes::ShapeRef.new(shape: SecretValuesType, location_name: "SecretValues"))
|
165
|
+
BatchGetSecretValueResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextTokenType, location_name: "NextToken"))
|
166
|
+
BatchGetSecretValueResponse.add_member(:errors, Shapes::ShapeRef.new(shape: APIErrorListType, location_name: "Errors"))
|
167
|
+
BatchGetSecretValueResponse.struct_class = Types::BatchGetSecretValueResponse
|
168
|
+
|
142
169
|
CancelRotateSecretRequest.add_member(:secret_id, Shapes::ShapeRef.new(shape: SecretIdType, required: true, location_name: "SecretId"))
|
143
170
|
CancelRotateSecretRequest.struct_class = Types::CancelRotateSecretRequest
|
144
171
|
|
@@ -386,6 +413,8 @@ module Aws::SecretsManager
|
|
386
413
|
RotationRulesType.add_member(:schedule_expression, Shapes::ShapeRef.new(shape: ScheduleExpressionType, location_name: "ScheduleExpression"))
|
387
414
|
RotationRulesType.struct_class = Types::RotationRulesType
|
388
415
|
|
416
|
+
SecretIdListType.member = Shapes::ShapeRef.new(shape: SecretIdType)
|
417
|
+
|
389
418
|
SecretListEntry.add_member(:arn, Shapes::ShapeRef.new(shape: SecretARNType, location_name: "ARN"))
|
390
419
|
SecretListEntry.add_member(:name, Shapes::ShapeRef.new(shape: SecretNameType, location_name: "Name"))
|
391
420
|
SecretListEntry.add_member(:description, Shapes::ShapeRef.new(shape: DescriptionType, location_name: "Description"))
|
@@ -407,6 +436,17 @@ module Aws::SecretsManager
|
|
407
436
|
|
408
437
|
SecretListType.member = Shapes::ShapeRef.new(shape: SecretListEntry)
|
409
438
|
|
439
|
+
SecretValueEntry.add_member(:arn, Shapes::ShapeRef.new(shape: SecretARNType, location_name: "ARN"))
|
440
|
+
SecretValueEntry.add_member(:name, Shapes::ShapeRef.new(shape: SecretNameType, location_name: "Name"))
|
441
|
+
SecretValueEntry.add_member(:version_id, Shapes::ShapeRef.new(shape: SecretVersionIdType, location_name: "VersionId"))
|
442
|
+
SecretValueEntry.add_member(:secret_binary, Shapes::ShapeRef.new(shape: SecretBinaryType, location_name: "SecretBinary"))
|
443
|
+
SecretValueEntry.add_member(:secret_string, Shapes::ShapeRef.new(shape: SecretStringType, location_name: "SecretString"))
|
444
|
+
SecretValueEntry.add_member(:version_stages, Shapes::ShapeRef.new(shape: SecretVersionStagesType, location_name: "VersionStages"))
|
445
|
+
SecretValueEntry.add_member(:created_date, Shapes::ShapeRef.new(shape: CreatedDateType, location_name: "CreatedDate", metadata: {"box"=>true}))
|
446
|
+
SecretValueEntry.struct_class = Types::SecretValueEntry
|
447
|
+
|
448
|
+
SecretValuesType.member = Shapes::ShapeRef.new(shape: SecretValueEntry)
|
449
|
+
|
410
450
|
SecretVersionStagesType.member = Shapes::ShapeRef.new(shape: SecretVersionStageType)
|
411
451
|
|
412
452
|
SecretVersionsListEntry.add_member(:version_id, Shapes::ShapeRef.new(shape: SecretVersionIdType, location_name: "VersionId"))
|
@@ -499,6 +539,26 @@ module Aws::SecretsManager
|
|
499
539
|
"uid" => "secretsmanager-2017-10-17",
|
500
540
|
}
|
501
541
|
|
542
|
+
api.add_operation(:batch_get_secret_value, Seahorse::Model::Operation.new.tap do |o|
|
543
|
+
o.name = "BatchGetSecretValue"
|
544
|
+
o.http_method = "POST"
|
545
|
+
o.http_request_uri = "/"
|
546
|
+
o.input = Shapes::ShapeRef.new(shape: BatchGetSecretValueRequest)
|
547
|
+
o.output = Shapes::ShapeRef.new(shape: BatchGetSecretValueResponse)
|
548
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
549
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
550
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
551
|
+
o.errors << Shapes::ShapeRef.new(shape: DecryptionFailure)
|
552
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
|
553
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
|
554
|
+
o[:pager] = Aws::Pager.new(
|
555
|
+
limit_key: "max_results",
|
556
|
+
tokens: {
|
557
|
+
"next_token" => "next_token"
|
558
|
+
}
|
559
|
+
)
|
560
|
+
end)
|
561
|
+
|
502
562
|
api.add_operation(:cancel_rotate_secret, Seahorse::Model::Operation.new.tap do |o|
|
503
563
|
o.name = "CancelRotateSecret"
|
504
564
|
o.http_method = "POST"
|
@@ -12,6 +12,20 @@ module Aws::SecretsManager
|
|
12
12
|
# @api private
|
13
13
|
module Endpoints
|
14
14
|
|
15
|
+
class BatchGetSecretValue
|
16
|
+
def self.build(context)
|
17
|
+
unless context.config.regional_endpoint
|
18
|
+
endpoint = context.config.endpoint.to_s
|
19
|
+
end
|
20
|
+
Aws::SecretsManager::EndpointParameters.new(
|
21
|
+
region: context.config.region,
|
22
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
23
|
+
use_fips: context.config.use_fips_endpoint,
|
24
|
+
endpoint: endpoint,
|
25
|
+
)
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
15
29
|
class CancelRotateSecret
|
16
30
|
def self.build(context)
|
17
31
|
unless context.config.regional_endpoint
|
@@ -56,6 +56,8 @@ module Aws::SecretsManager
|
|
56
56
|
|
57
57
|
def parameters_for_operation(context)
|
58
58
|
case context.operation_name
|
59
|
+
when :batch_get_secret_value
|
60
|
+
Aws::SecretsManager::Endpoints::BatchGetSecretValue.build(context)
|
59
61
|
when :cancel_rotate_secret
|
60
62
|
Aws::SecretsManager::Endpoints::CancelRotateSecret.build(context)
|
61
63
|
when :create_secret
|
@@ -10,6 +10,97 @@
|
|
10
10
|
module Aws::SecretsManager
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# The error Secrets Manager encountered while retrieving an individual
|
14
|
+
# secret as part of BatchGetSecretValue.
|
15
|
+
#
|
16
|
+
# @!attribute [rw] secret_id
|
17
|
+
# The ARN or name of the secret.
|
18
|
+
# @return [String]
|
19
|
+
#
|
20
|
+
# @!attribute [rw] error_code
|
21
|
+
# The error Secrets Manager encountered while retrieving an individual
|
22
|
+
# secret as part of BatchGetSecretValue, for example
|
23
|
+
# `ResourceNotFoundException`,`InvalidParameterException`,
|
24
|
+
# `InvalidRequestException`, `DecryptionFailure`, or
|
25
|
+
# `AccessDeniedException`.
|
26
|
+
# @return [String]
|
27
|
+
#
|
28
|
+
# @!attribute [rw] message
|
29
|
+
# A message describing the error.
|
30
|
+
# @return [String]
|
31
|
+
#
|
32
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/APIErrorType AWS API Documentation
|
33
|
+
#
|
34
|
+
class APIErrorType < Struct.new(
|
35
|
+
:secret_id,
|
36
|
+
:error_code,
|
37
|
+
:message)
|
38
|
+
SENSITIVE = []
|
39
|
+
include Aws::Structure
|
40
|
+
end
|
41
|
+
|
42
|
+
# @!attribute [rw] secret_id_list
|
43
|
+
# The ARN or names of the secrets to retrieve. You must include
|
44
|
+
# `Filters` or `SecretIdList`, but not both.
|
45
|
+
# @return [Array<String>]
|
46
|
+
#
|
47
|
+
# @!attribute [rw] filters
|
48
|
+
# The filters to choose which secrets to retrieve. You must include
|
49
|
+
# `Filters` or `SecretIdList`, but not both.
|
50
|
+
# @return [Array<Types::Filter>]
|
51
|
+
#
|
52
|
+
# @!attribute [rw] max_results
|
53
|
+
# The number of results to include in the response.
|
54
|
+
#
|
55
|
+
# If there are more results available, in the response, Secrets
|
56
|
+
# Manager includes `NextToken`. To get the next results, call
|
57
|
+
# `BatchGetSecretValue` again with the value from `NextToken`.
|
58
|
+
# @return [Integer]
|
59
|
+
#
|
60
|
+
# @!attribute [rw] next_token
|
61
|
+
# A token that indicates where the output should continue from, if a
|
62
|
+
# previous call did not show all results. To get the next results,
|
63
|
+
# call `BatchGetSecretValue` again with this value.
|
64
|
+
# @return [String]
|
65
|
+
#
|
66
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/BatchGetSecretValueRequest AWS API Documentation
|
67
|
+
#
|
68
|
+
class BatchGetSecretValueRequest < Struct.new(
|
69
|
+
:secret_id_list,
|
70
|
+
:filters,
|
71
|
+
:max_results,
|
72
|
+
:next_token)
|
73
|
+
SENSITIVE = []
|
74
|
+
include Aws::Structure
|
75
|
+
end
|
76
|
+
|
77
|
+
# @!attribute [rw] secret_values
|
78
|
+
# A list of secret values.
|
79
|
+
# @return [Array<Types::SecretValueEntry>]
|
80
|
+
#
|
81
|
+
# @!attribute [rw] next_token
|
82
|
+
# Secrets Manager includes this value if there's more output
|
83
|
+
# available than what is included in the current response. This can
|
84
|
+
# occur even when the response includes no values at all, such as when
|
85
|
+
# you ask for a filtered view of a long list. To get the next results,
|
86
|
+
# call `BatchGetSecretValue` again with this value.
|
87
|
+
# @return [String]
|
88
|
+
#
|
89
|
+
# @!attribute [rw] errors
|
90
|
+
# A list of errors Secrets Manager encountered while attempting to
|
91
|
+
# retrieve individual secrets.
|
92
|
+
# @return [Array<Types::APIErrorType>]
|
93
|
+
#
|
94
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/BatchGetSecretValueResponse AWS API Documentation
|
95
|
+
#
|
96
|
+
class BatchGetSecretValueResponse < Struct.new(
|
97
|
+
:secret_values,
|
98
|
+
:next_token,
|
99
|
+
:errors)
|
100
|
+
SENSITIVE = []
|
101
|
+
include Aws::Structure
|
102
|
+
end
|
103
|
+
|
13
104
|
# @!attribute [rw] secret_id
|
14
105
|
# The ARN or name of the secret.
|
15
106
|
#
|
@@ -1715,10 +1806,7 @@ module Aws::SecretsManager
|
|
1715
1806
|
# @return [String]
|
1716
1807
|
#
|
1717
1808
|
# @!attribute [rw] name
|
1718
|
-
# The friendly name of the secret.
|
1719
|
-
# name to represent a path hierarchy. For example,
|
1720
|
-
# `/prod/databases/dbserver1` could represent the secret for a server
|
1721
|
-
# named `dbserver1` in the folder `databases` in the folder `prod`.
|
1809
|
+
# The friendly name of the secret.
|
1722
1810
|
# @return [String]
|
1723
1811
|
#
|
1724
1812
|
# @!attribute [rw] description
|
@@ -1843,6 +1931,59 @@ module Aws::SecretsManager
|
|
1843
1931
|
include Aws::Structure
|
1844
1932
|
end
|
1845
1933
|
|
1934
|
+
# A structure that contains the secret value and other details for a
|
1935
|
+
# secret.
|
1936
|
+
#
|
1937
|
+
# @!attribute [rw] arn
|
1938
|
+
# The Amazon Resource Name (ARN) of the secret.
|
1939
|
+
# @return [String]
|
1940
|
+
#
|
1941
|
+
# @!attribute [rw] name
|
1942
|
+
# The friendly name of the secret.
|
1943
|
+
# @return [String]
|
1944
|
+
#
|
1945
|
+
# @!attribute [rw] version_id
|
1946
|
+
# The unique version identifier of this version of the secret.
|
1947
|
+
# @return [String]
|
1948
|
+
#
|
1949
|
+
# @!attribute [rw] secret_binary
|
1950
|
+
# The decrypted secret value, if the secret value was originally
|
1951
|
+
# provided as binary data in the form of a byte array. The parameter
|
1952
|
+
# represents the binary data as a [base64-encoded][1] string.
|
1953
|
+
#
|
1954
|
+
#
|
1955
|
+
#
|
1956
|
+
# [1]: https://tools.ietf.org/html/rfc4648#section-4
|
1957
|
+
# @return [String]
|
1958
|
+
#
|
1959
|
+
# @!attribute [rw] secret_string
|
1960
|
+
# The decrypted secret value, if the secret value was originally
|
1961
|
+
# provided as a string or through the Secrets Manager console.
|
1962
|
+
# @return [String]
|
1963
|
+
#
|
1964
|
+
# @!attribute [rw] version_stages
|
1965
|
+
# A list of all of the staging labels currently attached to this
|
1966
|
+
# version of the secret.
|
1967
|
+
# @return [Array<String>]
|
1968
|
+
#
|
1969
|
+
# @!attribute [rw] created_date
|
1970
|
+
# The date the secret was created.
|
1971
|
+
# @return [Time]
|
1972
|
+
#
|
1973
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/SecretValueEntry AWS API Documentation
|
1974
|
+
#
|
1975
|
+
class SecretValueEntry < Struct.new(
|
1976
|
+
:arn,
|
1977
|
+
:name,
|
1978
|
+
:version_id,
|
1979
|
+
:secret_binary,
|
1980
|
+
:secret_string,
|
1981
|
+
:version_stages,
|
1982
|
+
:created_date)
|
1983
|
+
SENSITIVE = [:secret_binary, :secret_string]
|
1984
|
+
include Aws::Structure
|
1985
|
+
end
|
1986
|
+
|
1846
1987
|
# A structure that contains information about one version of a secret.
|
1847
1988
|
#
|
1848
1989
|
# @!attribute [rw] version_id
|
@@ -32,7 +32,7 @@ require_relative 'aws-sdk-secretsmanager/customizations'
|
|
32
32
|
# structure.
|
33
33
|
#
|
34
34
|
# secrets_manager = Aws::SecretsManager::Client.new
|
35
|
-
# resp = secrets_manager.
|
35
|
+
# resp = secrets_manager.batch_get_secret_value(params)
|
36
36
|
#
|
37
37
|
# See {Client} for more information.
|
38
38
|
#
|
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-secretsmanager/customizations'
|
|
52
52
|
# @!group service
|
53
53
|
module Aws::SecretsManager
|
54
54
|
|
55
|
-
GEM_VERSION = '1.
|
55
|
+
GEM_VERSION = '1.86.0'
|
56
56
|
|
57
57
|
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.
|
4
|
+
version: 1.86.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: 2023-11-
|
11
|
+
date: 2023-11-27 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|