@depup/aws-sdk__client-secrets-manager 3.1010.0-depup.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.
Files changed (159) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +39 -0
  3. package/changes.json +42 -0
  4. package/dist-cjs/auth/httpAuthSchemeProvider.js +46 -0
  5. package/dist-cjs/endpoint/endpointResolver.js +18 -0
  6. package/dist-cjs/endpoint/ruleset.js +7 -0
  7. package/dist-cjs/index.js +511 -0
  8. package/dist-cjs/models/SecretsManagerServiceException.js +12 -0
  9. package/dist-cjs/models/errors.js +184 -0
  10. package/dist-cjs/runtimeConfig.browser.js +38 -0
  11. package/dist-cjs/runtimeConfig.js +53 -0
  12. package/dist-cjs/runtimeConfig.native.js +15 -0
  13. package/dist-cjs/runtimeConfig.shared.js +43 -0
  14. package/dist-cjs/schemas/schemas_0.js +665 -0
  15. package/dist-es/SecretsManager.js +61 -0
  16. package/dist-es/SecretsManagerClient.js +50 -0
  17. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  18. package/dist-es/auth/httpAuthSchemeProvider.js +40 -0
  19. package/dist-es/commands/BatchGetSecretValueCommand.js +16 -0
  20. package/dist-es/commands/CancelRotateSecretCommand.js +16 -0
  21. package/dist-es/commands/CreateSecretCommand.js +16 -0
  22. package/dist-es/commands/DeleteResourcePolicyCommand.js +16 -0
  23. package/dist-es/commands/DeleteSecretCommand.js +16 -0
  24. package/dist-es/commands/DescribeSecretCommand.js +16 -0
  25. package/dist-es/commands/GetRandomPasswordCommand.js +16 -0
  26. package/dist-es/commands/GetResourcePolicyCommand.js +16 -0
  27. package/dist-es/commands/GetSecretValueCommand.js +16 -0
  28. package/dist-es/commands/ListSecretVersionIdsCommand.js +16 -0
  29. package/dist-es/commands/ListSecretsCommand.js +16 -0
  30. package/dist-es/commands/PutResourcePolicyCommand.js +16 -0
  31. package/dist-es/commands/PutSecretValueCommand.js +16 -0
  32. package/dist-es/commands/RemoveRegionsFromReplicationCommand.js +16 -0
  33. package/dist-es/commands/ReplicateSecretToRegionsCommand.js +16 -0
  34. package/dist-es/commands/RestoreSecretCommand.js +16 -0
  35. package/dist-es/commands/RotateSecretCommand.js +16 -0
  36. package/dist-es/commands/StopReplicationToReplicaCommand.js +16 -0
  37. package/dist-es/commands/TagResourceCommand.js +16 -0
  38. package/dist-es/commands/UntagResourceCommand.js +16 -0
  39. package/dist-es/commands/UpdateSecretCommand.js +16 -0
  40. package/dist-es/commands/UpdateSecretVersionStageCommand.js +16 -0
  41. package/dist-es/commands/ValidateResourcePolicyCommand.js +16 -0
  42. package/dist-es/commands/index.js +23 -0
  43. package/dist-es/endpoint/EndpointParameters.js +13 -0
  44. package/dist-es/endpoint/endpointResolver.js +14 -0
  45. package/dist-es/endpoint/ruleset.js +4 -0
  46. package/dist-es/extensionConfiguration.js +1 -0
  47. package/dist-es/index.js +9 -0
  48. package/dist-es/models/SecretsManagerServiceException.js +8 -0
  49. package/dist-es/models/enums.js +24 -0
  50. package/dist-es/models/errors.js +169 -0
  51. package/dist-es/models/models_0.js +1 -0
  52. package/dist-es/pagination/BatchGetSecretValuePaginator.js +4 -0
  53. package/dist-es/pagination/Interfaces.js +1 -0
  54. package/dist-es/pagination/ListSecretVersionIdsPaginator.js +4 -0
  55. package/dist-es/pagination/ListSecretsPaginator.js +4 -0
  56. package/dist-es/pagination/index.js +4 -0
  57. package/dist-es/runtimeConfig.browser.js +33 -0
  58. package/dist-es/runtimeConfig.js +48 -0
  59. package/dist-es/runtimeConfig.native.js +11 -0
  60. package/dist-es/runtimeConfig.shared.js +39 -0
  61. package/dist-es/runtimeExtensions.js +9 -0
  62. package/dist-es/schemas/schemas_0.js +661 -0
  63. package/dist-types/SecretsManager.d.ts +220 -0
  64. package/dist-types/SecretsManagerClient.d.ts +235 -0
  65. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  66. package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
  67. package/dist-types/commands/BatchGetSecretValueCommand.d.ts +210 -0
  68. package/dist-types/commands/CancelRotateSecretCommand.d.ts +135 -0
  69. package/dist-types/commands/CreateSecretCommand.d.ts +218 -0
  70. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +126 -0
  71. package/dist-types/commands/DeleteSecretCommand.d.ts +135 -0
  72. package/dist-types/commands/DescribeSecretCommand.d.ts +137 -0
  73. package/dist-types/commands/GetRandomPasswordCommand.d.ts +135 -0
  74. package/dist-types/commands/GetResourcePolicyCommand.d.ts +138 -0
  75. package/dist-types/commands/GetSecretValueCommand.d.ts +157 -0
  76. package/dist-types/commands/ListSecretVersionIdsCommand.d.ts +151 -0
  77. package/dist-types/commands/ListSecretsCommand.d.ts +208 -0
  78. package/dist-types/commands/PutResourcePolicyCommand.d.ts +147 -0
  79. package/dist-types/commands/PutSecretValueCommand.d.ts +183 -0
  80. package/dist-types/commands/RemoveRegionsFromReplicationCommand.d.ts +122 -0
  81. package/dist-types/commands/ReplicateSecretToRegionsCommand.d.ts +157 -0
  82. package/dist-types/commands/RestoreSecretCommand.d.ts +126 -0
  83. package/dist-types/commands/RotateSecretCommand.d.ts +180 -0
  84. package/dist-types/commands/StopReplicationToReplicaCommand.d.ts +111 -0
  85. package/dist-types/commands/TagResourceCommand.d.ts +145 -0
  86. package/dist-types/commands/UntagResourceCommand.d.ts +134 -0
  87. package/dist-types/commands/UpdateSecretCommand.d.ts +221 -0
  88. package/dist-types/commands/UpdateSecretVersionStageCommand.d.ts +187 -0
  89. package/dist-types/commands/ValidateResourcePolicyCommand.d.ts +161 -0
  90. package/dist-types/commands/index.d.ts +23 -0
  91. package/dist-types/endpoint/EndpointParameters.d.ts +50 -0
  92. package/dist-types/endpoint/endpointResolver.d.ts +8 -0
  93. package/dist-types/endpoint/ruleset.d.ts +2 -0
  94. package/dist-types/extensionConfiguration.d.ts +9 -0
  95. package/dist-types/index.d.ts +42 -0
  96. package/dist-types/models/SecretsManagerServiceException.d.ts +14 -0
  97. package/dist-types/models/enums.d.ts +56 -0
  98. package/dist-types/models/errors.d.ts +175 -0
  99. package/dist-types/models/models_0.d.ts +1957 -0
  100. package/dist-types/pagination/BatchGetSecretValuePaginator.d.ts +7 -0
  101. package/dist-types/pagination/Interfaces.d.ts +8 -0
  102. package/dist-types/pagination/ListSecretVersionIdsPaginator.d.ts +7 -0
  103. package/dist-types/pagination/ListSecretsPaginator.d.ts +7 -0
  104. package/dist-types/pagination/index.d.ts +4 -0
  105. package/dist-types/runtimeConfig.browser.d.ts +55 -0
  106. package/dist-types/runtimeConfig.d.ts +55 -0
  107. package/dist-types/runtimeConfig.native.d.ts +54 -0
  108. package/dist-types/runtimeConfig.shared.d.ts +27 -0
  109. package/dist-types/runtimeExtensions.d.ts +17 -0
  110. package/dist-types/schemas/schemas_0.d.ts +99 -0
  111. package/dist-types/ts3.4/SecretsManager.d.ts +426 -0
  112. package/dist-types/ts3.4/SecretsManagerClient.d.ts +258 -0
  113. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  114. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +47 -0
  115. package/dist-types/ts3.4/commands/BatchGetSecretValueCommand.d.ts +51 -0
  116. package/dist-types/ts3.4/commands/CancelRotateSecretCommand.d.ts +51 -0
  117. package/dist-types/ts3.4/commands/CreateSecretCommand.d.ts +47 -0
  118. package/dist-types/ts3.4/commands/DeleteResourcePolicyCommand.d.ts +51 -0
  119. package/dist-types/ts3.4/commands/DeleteSecretCommand.d.ts +47 -0
  120. package/dist-types/ts3.4/commands/DescribeSecretCommand.d.ts +50 -0
  121. package/dist-types/ts3.4/commands/GetRandomPasswordCommand.d.ts +51 -0
  122. package/dist-types/ts3.4/commands/GetResourcePolicyCommand.d.ts +51 -0
  123. package/dist-types/ts3.4/commands/GetSecretValueCommand.d.ts +50 -0
  124. package/dist-types/ts3.4/commands/ListSecretVersionIdsCommand.d.ts +51 -0
  125. package/dist-types/ts3.4/commands/ListSecretsCommand.d.ts +47 -0
  126. package/dist-types/ts3.4/commands/PutResourcePolicyCommand.d.ts +51 -0
  127. package/dist-types/ts3.4/commands/PutSecretValueCommand.d.ts +50 -0
  128. package/dist-types/ts3.4/commands/RemoveRegionsFromReplicationCommand.d.ts +51 -0
  129. package/dist-types/ts3.4/commands/ReplicateSecretToRegionsCommand.d.ts +51 -0
  130. package/dist-types/ts3.4/commands/RestoreSecretCommand.d.ts +50 -0
  131. package/dist-types/ts3.4/commands/RotateSecretCommand.d.ts +47 -0
  132. package/dist-types/ts3.4/commands/StopReplicationToReplicaCommand.d.ts +51 -0
  133. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +45 -0
  134. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +45 -0
  135. package/dist-types/ts3.4/commands/UpdateSecretCommand.d.ts +47 -0
  136. package/dist-types/ts3.4/commands/UpdateSecretVersionStageCommand.d.ts +51 -0
  137. package/dist-types/ts3.4/commands/ValidateResourcePolicyCommand.d.ts +51 -0
  138. package/dist-types/ts3.4/commands/index.d.ts +23 -0
  139. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +51 -0
  140. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  141. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  142. package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
  143. package/dist-types/ts3.4/index.d.ts +12 -0
  144. package/dist-types/ts3.4/models/SecretsManagerServiceException.d.ts +9 -0
  145. package/dist-types/ts3.4/models/enums.d.ts +29 -0
  146. package/dist-types/ts3.4/models/errors.d.ts +97 -0
  147. package/dist-types/ts3.4/models/models_0.d.ts +333 -0
  148. package/dist-types/ts3.4/pagination/BatchGetSecretValuePaginator.d.ts +11 -0
  149. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  150. package/dist-types/ts3.4/pagination/ListSecretVersionIdsPaginator.d.ts +11 -0
  151. package/dist-types/ts3.4/pagination/ListSecretsPaginator.d.ts +11 -0
  152. package/dist-types/ts3.4/pagination/index.d.ts +4 -0
  153. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +100 -0
  154. package/dist-types/ts3.4/runtimeConfig.d.ts +95 -0
  155. package/dist-types/ts3.4/runtimeConfig.native.d.ts +104 -0
  156. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +30 -0
  157. package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
  158. package/dist-types/ts3.4/schemas/schemas_0.d.ts +98 -0
  159. package/package.json +159 -0
@@ -0,0 +1,1957 @@
1
+ import { FilterNameStringType, SortByType, SortOrderType, StatusType } from "./enums";
2
+ /**
3
+ * <p>A custom type that specifies a <code>Region</code> and the <code>KmsKeyId</code> for a
4
+ * replica secret.</p>
5
+ * @public
6
+ */
7
+ export interface ReplicaRegionType {
8
+ /**
9
+ * <p>A Region code. For a list of Region codes, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints">Name and code of
10
+ * Regions</a>.</p>
11
+ * @public
12
+ */
13
+ Region?: string | undefined;
14
+ /**
15
+ * <p>The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include
16
+ * this field, Secrets Manager uses <code>aws/secretsmanager</code>.</p>
17
+ * @public
18
+ */
19
+ KmsKeyId?: string | undefined;
20
+ }
21
+ /**
22
+ * <p>The error Secrets Manager encountered while retrieving an individual secret as part of <a>BatchGetSecretValue</a>.</p>
23
+ * @public
24
+ */
25
+ export interface APIErrorType {
26
+ /**
27
+ * <p>The ARN or name of the secret.</p>
28
+ * @public
29
+ */
30
+ SecretId?: string | undefined;
31
+ /**
32
+ * <p>The error Secrets Manager encountered while retrieving an individual secret as part of <a>BatchGetSecretValue</a>, for example
33
+ * <code>ResourceNotFoundException</code>,<code>InvalidParameterException</code>,
34
+ * <code>InvalidRequestException</code>, <code>DecryptionFailure</code>, or
35
+ * <code>AccessDeniedException</code>.</p>
36
+ * @public
37
+ */
38
+ ErrorCode?: string | undefined;
39
+ /**
40
+ * <p>A message describing the error.</p>
41
+ * @public
42
+ */
43
+ Message?: string | undefined;
44
+ }
45
+ /**
46
+ * <p>Allows you to add filters when you use the search function in Secrets Manager. For more
47
+ * information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html">Find secrets in
48
+ * Secrets Manager</a>.</p>
49
+ * @public
50
+ */
51
+ export interface Filter {
52
+ /**
53
+ * <p>The following are keys you can use:</p>
54
+ * <ul>
55
+ * <li>
56
+ * <p>
57
+ * <b>description</b>: Prefix match, not
58
+ * case-sensitive.</p>
59
+ * </li>
60
+ * <li>
61
+ * <p>
62
+ * <b>name</b>: Prefix match, case-sensitive.</p>
63
+ * </li>
64
+ * <li>
65
+ * <p>
66
+ * <b>tag-key</b>: Prefix match, case-sensitive.</p>
67
+ * </li>
68
+ * <li>
69
+ * <p>
70
+ * <b>tag-value</b>: Prefix match,
71
+ * case-sensitive.</p>
72
+ * </li>
73
+ * <li>
74
+ * <p>
75
+ * <b>primary-region</b>: Prefix match,
76
+ * case-sensitive.</p>
77
+ * </li>
78
+ * <li>
79
+ * <p>
80
+ * <b>owning-service</b>: Prefix match,
81
+ * case-sensitive.</p>
82
+ * </li>
83
+ * <li>
84
+ * <p>
85
+ * <b>all</b>: Breaks the filter value string into
86
+ * words and then searches all attributes for matches. Not case-sensitive.</p>
87
+ * </li>
88
+ * </ul>
89
+ * @public
90
+ */
91
+ Key?: FilterNameStringType | undefined;
92
+ /**
93
+ * <p>The keyword to filter for.</p>
94
+ * <p>You can prefix your search value with an exclamation mark (<code>!</code>) in order to
95
+ * perform negation filters. </p>
96
+ * @public
97
+ */
98
+ Values?: string[] | undefined;
99
+ }
100
+ /**
101
+ * @public
102
+ */
103
+ export interface BatchGetSecretValueRequest {
104
+ /**
105
+ * <p>The ARN or names of the secrets to retrieve. You must include <code>Filters</code> or
106
+ * <code>SecretIdList</code>, but not both.</p>
107
+ * @public
108
+ */
109
+ SecretIdList?: string[] | undefined;
110
+ /**
111
+ * <p>The filters to choose which secrets to retrieve. You must include <code>Filters</code>
112
+ * or <code>SecretIdList</code>, but not both.</p>
113
+ * @public
114
+ */
115
+ Filters?: Filter[] | undefined;
116
+ /**
117
+ * <p>The number of results to include in the response.</p>
118
+ * <p>If there are more results available, in the response, Secrets Manager includes
119
+ * <code>NextToken</code>. To get the next results, call
120
+ * <code>BatchGetSecretValue</code> again with the value from <code>NextToken</code>.
121
+ * To use this parameter, you must also use the <code>Filters</code> parameter.</p>
122
+ * @public
123
+ */
124
+ MaxResults?: number | undefined;
125
+ /**
126
+ * <p>A token that indicates where the output should continue from, if a previous call did
127
+ * not show all results. To get the next results, call <code>BatchGetSecretValue</code>
128
+ * again with this value.</p>
129
+ * @public
130
+ */
131
+ NextToken?: string | undefined;
132
+ }
133
+ /**
134
+ * <p>A structure that contains the secret value and other details for a secret.</p>
135
+ * @public
136
+ */
137
+ export interface SecretValueEntry {
138
+ /**
139
+ * <p>The Amazon Resource Name (ARN) of the secret.</p>
140
+ * @public
141
+ */
142
+ ARN?: string | undefined;
143
+ /**
144
+ * <p>The friendly name of the secret. </p>
145
+ * @public
146
+ */
147
+ Name?: string | undefined;
148
+ /**
149
+ * <p>The unique version identifier of this version of the secret.</p>
150
+ * @public
151
+ */
152
+ VersionId?: string | undefined;
153
+ /**
154
+ * <p>The decrypted secret value, if the secret value was originally provided as binary data
155
+ * in the form of a byte array. The parameter represents the binary data as a <a href="https://tools.ietf.org/html/rfc4648#section-4">base64-encoded</a>
156
+ * string.</p>
157
+ * @public
158
+ */
159
+ SecretBinary?: Uint8Array | undefined;
160
+ /**
161
+ * <p>The decrypted secret value, if the secret value was originally provided as a string or
162
+ * through the Secrets Manager console.</p>
163
+ * @public
164
+ */
165
+ SecretString?: string | undefined;
166
+ /**
167
+ * <p>A list of all of the staging labels currently attached to this version of the
168
+ * secret.</p>
169
+ * @public
170
+ */
171
+ VersionStages?: string[] | undefined;
172
+ /**
173
+ * <p>The date the secret was created.</p>
174
+ * @public
175
+ */
176
+ CreatedDate?: Date | undefined;
177
+ }
178
+ /**
179
+ * @public
180
+ */
181
+ export interface BatchGetSecretValueResponse {
182
+ /**
183
+ * <p>A list of secret values.</p>
184
+ * @public
185
+ */
186
+ SecretValues?: SecretValueEntry[] | undefined;
187
+ /**
188
+ * <p>Secrets Manager includes this value if there's more output available than what is included in
189
+ * the current response. This can occur even when the response includes no values at all,
190
+ * such as when you ask for a filtered view of a long list. To get the next results, call
191
+ * <code>BatchGetSecretValue</code> again with this value.</p>
192
+ * @public
193
+ */
194
+ NextToken?: string | undefined;
195
+ /**
196
+ * <p>A list of errors Secrets Manager encountered while attempting to retrieve individual
197
+ * secrets.</p>
198
+ * @public
199
+ */
200
+ Errors?: APIErrorType[] | undefined;
201
+ }
202
+ /**
203
+ * @public
204
+ */
205
+ export interface CancelRotateSecretRequest {
206
+ /**
207
+ * <p>The ARN or name of the secret.</p>
208
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
209
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
210
+ * @public
211
+ */
212
+ SecretId: string | undefined;
213
+ }
214
+ /**
215
+ * @public
216
+ */
217
+ export interface CancelRotateSecretResponse {
218
+ /**
219
+ * <p>The ARN of the secret.</p>
220
+ * @public
221
+ */
222
+ ARN?: string | undefined;
223
+ /**
224
+ * <p>The name of the secret.</p>
225
+ * @public
226
+ */
227
+ Name?: string | undefined;
228
+ /**
229
+ * <p>The unique identifier of the version of the secret created during the rotation. This
230
+ * version might not be complete, and should be evaluated for possible deletion. We
231
+ * recommend that you remove the <code>VersionStage</code> value <code>AWSPENDING</code>
232
+ * from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation
233
+ * can block you from starting future rotations.</p>
234
+ * @public
235
+ */
236
+ VersionId?: string | undefined;
237
+ }
238
+ /**
239
+ * <p>A structure that contains information about a tag.</p>
240
+ * @public
241
+ */
242
+ export interface Tag {
243
+ /**
244
+ * <p>The key identifier, or name, of the tag.</p>
245
+ * @public
246
+ */
247
+ Key?: string | undefined;
248
+ /**
249
+ * <p>The string value associated with the key of the tag.</p>
250
+ * @public
251
+ */
252
+ Value?: string | undefined;
253
+ }
254
+ /**
255
+ * @public
256
+ */
257
+ export interface CreateSecretRequest {
258
+ /**
259
+ * <p>The name of the new secret.</p>
260
+ * <p>The secret name can contain ASCII letters, numbers, and the following characters:
261
+ * /_+=.@-</p>
262
+ * <p>Do not end your secret name with a hyphen followed by six characters. If you do so,
263
+ * you risk confusion and unexpected results when searching for a secret by partial ARN.
264
+ * Secrets Manager automatically adds a hyphen and six random characters after the secret name at the
265
+ * end of the ARN.</p>
266
+ * @public
267
+ */
268
+ Name: string | undefined;
269
+ /**
270
+ * <p>If you include <code>SecretString</code> or <code>SecretBinary</code>, then Secrets Manager
271
+ * creates an initial version for the secret, and this parameter specifies the unique
272
+ * identifier for the new version. </p>
273
+ * <note>
274
+ * <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. </p>
275
+ * </note>
276
+ * <p>If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> and include it in the request.</p>
277
+ * <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value to ensure uniqueness of your versions within the specified secret. </p>
278
+ * <ul>
279
+ * <li>
280
+ * <p>If the <code>ClientRequestToken</code> value isn't already associated with a
281
+ * version of the secret then a new version of the secret is created. </p>
282
+ * </li>
283
+ * <li>
284
+ * <p>If a version with this value already exists and the version
285
+ * <code>SecretString</code> and <code>SecretBinary</code> values are the same
286
+ * as those in the request, then the request is ignored.</p>
287
+ * </li>
288
+ * <li>
289
+ * <p>If a version with this value already exists and that version's
290
+ * <code>SecretString</code> and <code>SecretBinary</code> values are different
291
+ * from those in the request, then the request fails because you cannot modify an
292
+ * existing version. Instead, use <a>PutSecretValue</a> to create a new
293
+ * version.</p>
294
+ * </li>
295
+ * </ul>
296
+ * <p>This value becomes the <code>VersionId</code> of the new version.</p>
297
+ * @public
298
+ */
299
+ ClientRequestToken?: string | undefined;
300
+ /**
301
+ * <p>The description of the secret.</p>
302
+ * @public
303
+ */
304
+ Description?: string | undefined;
305
+ /**
306
+ * <p>The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value
307
+ * in the secret. An alias is always prefixed by <code>alias/</code>, for example
308
+ * <code>alias/aws/secretsmanager</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html">About
309
+ * aliases</a>.</p>
310
+ * <p>To use a KMS key in a different account, use the key ARN or the alias ARN.</p>
311
+ * <p>If you don't specify this value, then Secrets Manager uses the key
312
+ * <code>aws/secretsmanager</code>. If that key doesn't yet exist, then Secrets Manager creates
313
+ * it for you automatically the first time it encrypts the secret value.</p>
314
+ * <p>If the secret is in a different Amazon Web Services account from the credentials calling the API,
315
+ * then you can't use <code>aws/secretsmanager</code> to encrypt the secret, and you must
316
+ * create and use a customer managed KMS key. </p>
317
+ * @public
318
+ */
319
+ KmsKeyId?: string | undefined;
320
+ /**
321
+ * <p>The binary data to encrypt and store in the new version of the secret. We recommend
322
+ * that you store your binary data in a file and then pass the contents of the file as a
323
+ * parameter.</p>
324
+ * <p>Either <code>SecretString</code> or <code>SecretBinary</code> must have a value, but
325
+ * not both.</p>
326
+ * <p>This parameter is not available in the Secrets Manager console.</p>
327
+ * <p>Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.</p>
328
+ * @public
329
+ */
330
+ SecretBinary?: Uint8Array | undefined;
331
+ /**
332
+ * <p>The text data to encrypt and store in this new version of the secret. We recommend you
333
+ * use a JSON structure of key/value pairs for your secret value.</p>
334
+ * <p>Either <code>SecretString</code> or <code>SecretBinary</code> must have a value, but
335
+ * not both.</p>
336
+ * <p>If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret
337
+ * text in only the <code>SecretString</code> parameter. The Secrets Manager console stores the
338
+ * information as a JSON structure of key/value pairs that a Lambda rotation function can
339
+ * parse.</p>
340
+ * <p>Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.</p>
341
+ * @public
342
+ */
343
+ SecretString?: string | undefined;
344
+ /**
345
+ * <p>A list of tags to attach to the secret. Each tag is a key and value pair of strings in
346
+ * a JSON text string, for example:</p>
347
+ * <p>
348
+ * <code>[\{"Key":"CostCenter","Value":"12345"\},\{"Key":"environment","Value":"production"\}]</code>
349
+ * </p>
350
+ * <p>Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag
351
+ * from one with key "abc".</p>
352
+ * <p>If you check tags in permissions policies as part of your security strategy, then
353
+ * adding or removing a tag can change permissions. If the completion of this operation
354
+ * would result in you losing your permissions for this secret, then Secrets Manager blocks the
355
+ * operation and returns an <code>Access Denied</code> error. For more information, see
356
+ * <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac">Control access to secrets using tags</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2">Limit access to identities with tags that match secrets' tags</a>.</p>
357
+ * <p>For information about how to format a JSON parameter for the various command line tool
358
+ * environments, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json">Using JSON for
359
+ * Parameters</a>. If your command-line tool or SDK requires quotation marks around
360
+ * the parameter, you should use single quotes to avoid confusion with the double quotes
361
+ * required in the JSON text.</p>
362
+ * <p>For tag quotas and naming restrictions, see <a href="https://docs.aws.amazon.com/general/latest/gr/arg.html#taged-reference-quotas">Service quotas for
363
+ * Tagging</a> in the <i>Amazon Web Services General Reference guide</i>.</p>
364
+ * @public
365
+ */
366
+ Tags?: Tag[] | undefined;
367
+ /**
368
+ * <p>A list of Regions and KMS keys to replicate secrets.</p>
369
+ * @public
370
+ */
371
+ AddReplicaRegions?: ReplicaRegionType[] | undefined;
372
+ /**
373
+ * <p>Specifies whether to overwrite a secret with the same name in the destination Region.
374
+ * By default, secrets aren't overwritten.</p>
375
+ * @public
376
+ */
377
+ ForceOverwriteReplicaSecret?: boolean | undefined;
378
+ /**
379
+ * <p>The exact string that identifies the partner that holds the external secret. For more
380
+ * information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/managed-external-secrets.html">Using Secrets Manager managed external secrets</a>.</p>
381
+ * @public
382
+ */
383
+ Type?: string | undefined;
384
+ }
385
+ /**
386
+ * <p>A replication object consisting of a <code>RegionReplicationStatus</code> object and
387
+ * includes a Region, KMSKeyId, status, and status message.</p>
388
+ * @public
389
+ */
390
+ export interface ReplicationStatusType {
391
+ /**
392
+ * <p>The Region where replication occurs.</p>
393
+ * @public
394
+ */
395
+ Region?: string | undefined;
396
+ /**
397
+ * <p>Can be an <code>ARN</code>, <code>Key ID</code>, or <code>Alias</code>. </p>
398
+ * @public
399
+ */
400
+ KmsKeyId?: string | undefined;
401
+ /**
402
+ * <p>The status can be <code>InProgress</code>, <code>Failed</code>, or
403
+ * <code>InSync</code>.</p>
404
+ * @public
405
+ */
406
+ Status?: StatusType | undefined;
407
+ /**
408
+ * <p>Status message such as "<i>Secret with this name already exists in this
409
+ * region</i>".</p>
410
+ * @public
411
+ */
412
+ StatusMessage?: string | undefined;
413
+ /**
414
+ * <p>The date that the secret was last accessed in the Region. This field is omitted if the
415
+ * secret has never been retrieved in the Region.</p>
416
+ * @public
417
+ */
418
+ LastAccessedDate?: Date | undefined;
419
+ }
420
+ /**
421
+ * @public
422
+ */
423
+ export interface CreateSecretResponse {
424
+ /**
425
+ * <p>The ARN of the new secret. The ARN includes the name of the secret followed by six
426
+ * random characters. This ensures that if you create a new secret with the same name as a
427
+ * deleted secret, then users with access to the old secret don't get access to the new
428
+ * secret because the ARNs are different.</p>
429
+ * @public
430
+ */
431
+ ARN?: string | undefined;
432
+ /**
433
+ * <p>The name of the new secret.</p>
434
+ * @public
435
+ */
436
+ Name?: string | undefined;
437
+ /**
438
+ * <p>The unique identifier associated with the version of the new secret.</p>
439
+ * @public
440
+ */
441
+ VersionId?: string | undefined;
442
+ /**
443
+ * <p>A list of the replicas of this secret and their status:</p>
444
+ * <ul>
445
+ * <li>
446
+ * <p>
447
+ * <code>Failed</code>, which indicates that the replica was not created.</p>
448
+ * </li>
449
+ * <li>
450
+ * <p>
451
+ * <code>InProgress</code>, which indicates that Secrets Manager is in the
452
+ * process of creating the replica.</p>
453
+ * </li>
454
+ * <li>
455
+ * <p>
456
+ * <code>InSync</code>, which indicates that the replica was created.</p>
457
+ * </li>
458
+ * </ul>
459
+ * @public
460
+ */
461
+ ReplicationStatus?: ReplicationStatusType[] | undefined;
462
+ }
463
+ /**
464
+ * @public
465
+ */
466
+ export interface DeleteResourcePolicyRequest {
467
+ /**
468
+ * <p>The ARN or name of the secret to delete the attached resource-based policy for.</p>
469
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
470
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
471
+ * @public
472
+ */
473
+ SecretId: string | undefined;
474
+ }
475
+ /**
476
+ * @public
477
+ */
478
+ export interface DeleteResourcePolicyResponse {
479
+ /**
480
+ * <p>The ARN of the secret that the resource-based policy was deleted for.</p>
481
+ * @public
482
+ */
483
+ ARN?: string | undefined;
484
+ /**
485
+ * <p>The name of the secret that the resource-based policy was deleted for.</p>
486
+ * @public
487
+ */
488
+ Name?: string | undefined;
489
+ }
490
+ /**
491
+ * @public
492
+ */
493
+ export interface DeleteSecretRequest {
494
+ /**
495
+ * <p>The ARN or name of the secret to delete.</p>
496
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
497
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
498
+ * @public
499
+ */
500
+ SecretId: string | undefined;
501
+ /**
502
+ * <p>The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the
503
+ * secret. You can't use both this parameter and <code>ForceDeleteWithoutRecovery</code> in
504
+ * the same call. If you don't use either, then by default Secrets Manager uses a 30 day recovery
505
+ * window.</p>
506
+ * @public
507
+ */
508
+ RecoveryWindowInDays?: number | undefined;
509
+ /**
510
+ * <p>Specifies whether to delete the secret without any recovery window. You can't use both
511
+ * this parameter and <code>RecoveryWindowInDays</code> in the same call. If you don't use
512
+ * either, then by default Secrets Manager uses a 30 day recovery window.</p>
513
+ * <p>Secrets Manager performs the actual deletion with an asynchronous background process, so there
514
+ * might be a short delay before the secret is permanently deleted. If you delete a secret
515
+ * and then immediately create a secret with the same name, use appropriate back off and
516
+ * retry logic.</p>
517
+ * <p>If you forcibly delete an already deleted or nonexistent secret, the operation does
518
+ * not return <code>ResourceNotFoundException</code>.</p>
519
+ * <important>
520
+ * <p>Use this parameter with caution. This parameter causes the operation to skip the
521
+ * normal recovery window before the permanent deletion that Secrets Manager would normally
522
+ * impose with the <code>RecoveryWindowInDays</code> parameter. If you delete a secret
523
+ * with the <code>ForceDeleteWithoutRecovery</code> parameter, then you have no
524
+ * opportunity to recover the secret. You lose the secret permanently.</p>
525
+ * </important>
526
+ * @public
527
+ */
528
+ ForceDeleteWithoutRecovery?: boolean | undefined;
529
+ }
530
+ /**
531
+ * @public
532
+ */
533
+ export interface DeleteSecretResponse {
534
+ /**
535
+ * <p>The ARN of the secret.</p>
536
+ * @public
537
+ */
538
+ ARN?: string | undefined;
539
+ /**
540
+ * <p>The name of the secret.</p>
541
+ * @public
542
+ */
543
+ Name?: string | undefined;
544
+ /**
545
+ * <p>The date and time after which this secret Secrets Manager can permanently delete this secret,
546
+ * and it can no longer be restored. This value is the date and time of the delete request
547
+ * plus the number of days in <code>RecoveryWindowInDays</code>.</p>
548
+ * @public
549
+ */
550
+ DeletionDate?: Date | undefined;
551
+ }
552
+ /**
553
+ * @public
554
+ */
555
+ export interface DescribeSecretRequest {
556
+ /**
557
+ * <p>The ARN or name of the secret. </p>
558
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
559
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
560
+ * @public
561
+ */
562
+ SecretId: string | undefined;
563
+ }
564
+ /**
565
+ * <p>The metadata needed to successfully rotate a managed external secret. A list of key
566
+ * value pairs in JSON format specified by the partner. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/mes-partners.html">Managed
567
+ * external secret partners</a>.</p>
568
+ * @public
569
+ */
570
+ export interface ExternalSecretRotationMetadataItem {
571
+ /**
572
+ * <p>The key that identifies the item.</p>
573
+ * @public
574
+ */
575
+ Key?: string | undefined;
576
+ /**
577
+ * <p>The value of the specified item.</p>
578
+ * @public
579
+ */
580
+ Value?: string | undefined;
581
+ }
582
+ /**
583
+ * <p>A structure that defines the rotation configuration for the secret.</p>
584
+ * @public
585
+ */
586
+ export interface RotationRulesType {
587
+ /**
588
+ * <p>The number of days between rotations of the secret. You can use this value to check
589
+ * that your secret meets your compliance guidelines for how often secrets must be rotated.
590
+ * If you use this field to set the rotation schedule, Secrets Manager calculates the next rotation
591
+ * date based on the previous rotation. Manually updating the secret value by calling
592
+ * <code>PutSecretValue</code> or <code>UpdateSecret</code> is considered a valid
593
+ * rotation.</p>
594
+ * <p>In <code>DescribeSecret</code> and <code>ListSecrets</code>, this value is calculated
595
+ * from the rotation schedule after every successful rotation. In
596
+ * <code>RotateSecret</code>, you can set the rotation schedule in
597
+ * <code>RotationRules</code> with <code>AutomaticallyAfterDays</code> or
598
+ * <code>ScheduleExpression</code>, but not both. To set a rotation schedule in hours,
599
+ * use <code>ScheduleExpression</code>.</p>
600
+ * @public
601
+ */
602
+ AutomaticallyAfterDays?: number | undefined;
603
+ /**
604
+ * <p>The length of the rotation window in hours, for example <code>3h</code> for a three
605
+ * hour window. Secrets Manager rotates your secret at any time during this window. The window must
606
+ * not extend into the next rotation window or the next UTC day. The window starts
607
+ * according to the <code>ScheduleExpression</code>. If you don't specify a
608
+ * <code>Duration</code>, for a <code>ScheduleExpression</code> in hours, the window
609
+ * automatically closes after one hour. For a <code>ScheduleExpression</code> in days, the
610
+ * window automatically closes at the end of the UTC day. For more information, including
611
+ * examples, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html">Schedule
612
+ * expressions in Secrets Manager rotation</a> in the <i>Secrets Manager Users
613
+ * Guide</i>.</p>
614
+ * @public
615
+ */
616
+ Duration?: string | undefined;
617
+ /**
618
+ * <p>A <code>cron()</code> or <code>rate()</code> expression that defines the schedule for
619
+ * rotating your secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager rotates your
620
+ * secret any time during a rotation window.</p>
621
+ * <p>Secrets Manager <code>rate()</code> expressions represent the interval in hours or days that you
622
+ * want to rotate your secret, for example <code>rate(12 hours)</code> or <code>rate(10
623
+ * days)</code>. You can rotate a secret as often as every four hours. If you use a
624
+ * <code>rate()</code> expression, the rotation window starts at midnight. For a rate
625
+ * in hours, the default rotation window closes after one hour. For a rate in days, the
626
+ * default rotation window closes at the end of the day. You can set the
627
+ * <code>Duration</code> to change the rotation window. The rotation window must not
628
+ * extend into the next UTC day or into the next rotation window.</p>
629
+ * <p>You can use a <code>cron()</code> expression to create a rotation schedule that is
630
+ * more detailed than a rotation interval. For more information, including examples, see
631
+ * <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html">Schedule
632
+ * expressions in Secrets Manager rotation</a> in the <i>Secrets Manager Users Guide</i>.
633
+ * For a cron expression that represents a schedule in hours, the default rotation window
634
+ * closes after one hour. For a cron expression that represents a schedule in days, the
635
+ * default rotation window closes at the end of the day. You can set the
636
+ * <code>Duration</code> to change the rotation window. The rotation window must not
637
+ * extend into the next UTC day or into the next rotation window.</p>
638
+ * @public
639
+ */
640
+ ScheduleExpression?: string | undefined;
641
+ }
642
+ /**
643
+ * @public
644
+ */
645
+ export interface DescribeSecretResponse {
646
+ /**
647
+ * <p>The ARN of the secret.</p>
648
+ * @public
649
+ */
650
+ ARN?: string | undefined;
651
+ /**
652
+ * <p>The name of the secret.</p>
653
+ * @public
654
+ */
655
+ Name?: string | undefined;
656
+ /**
657
+ * <p>The exact string that identifies the partner that holds the external secret. For more
658
+ * information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/managed-external-secrets.html">Using Secrets Manager managed external secrets</a>.</p>
659
+ * @public
660
+ */
661
+ Type?: string | undefined;
662
+ /**
663
+ * <p>The description of the secret.</p>
664
+ * @public
665
+ */
666
+ Description?: string | undefined;
667
+ /**
668
+ * <p>The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the secret value.
669
+ * If the secret is encrypted with the Amazon Web Services managed key
670
+ * <code>aws/secretsmanager</code>, this field is omitted. Secrets created using the
671
+ * console use an KMS key ID.</p>
672
+ * @public
673
+ */
674
+ KmsKeyId?: string | undefined;
675
+ /**
676
+ * <p>Specifies whether automatic rotation is turned on for this secret. If the secret has
677
+ * never been configured for rotation, Secrets Manager returns null.</p>
678
+ * <p>To turn on rotation, use <a>RotateSecret</a>. To turn off rotation, use
679
+ * <a>CancelRotateSecret</a>.</p>
680
+ * @public
681
+ */
682
+ RotationEnabled?: boolean | undefined;
683
+ /**
684
+ * <p>The ARN of the Lambda function that Secrets Manager invokes to rotate the secret. </p>
685
+ * @public
686
+ */
687
+ RotationLambdaARN?: string | undefined;
688
+ /**
689
+ * <p>The rotation schedule and Lambda function for this secret. If the secret previously had
690
+ * rotation turned on, but it is now turned off, this field shows the previous rotation
691
+ * schedule and rotation function. If the secret never had rotation turned on, this field
692
+ * is omitted.</p>
693
+ * @public
694
+ */
695
+ RotationRules?: RotationRulesType | undefined;
696
+ /**
697
+ * <p>The metadata needed to successfully rotate a managed external secret. A list of key
698
+ * value pairs in JSON format specified by the partner. For more information about the
699
+ * required information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/mes-partners.html">Managed external secrets partners</a>.</p>
700
+ * @public
701
+ */
702
+ ExternalSecretRotationMetadata?: ExternalSecretRotationMetadataItem[] | undefined;
703
+ /**
704
+ * <p>The Amazon Resource Name (ARN) of the role that allows Secrets Manager to rotate a secret held
705
+ * by a third-party partner. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/mes-security.html">Security and
706
+ * permissions</a>.</p>
707
+ * @public
708
+ */
709
+ ExternalSecretRotationRoleArn?: string | undefined;
710
+ /**
711
+ * <p>The last date and time that Secrets Manager rotated the secret. If the secret isn't configured
712
+ * for rotation or rotation has been disabled, Secrets Manager returns null.</p>
713
+ * @public
714
+ */
715
+ LastRotatedDate?: Date | undefined;
716
+ /**
717
+ * <p>The last date and time that this secret was modified in any way.</p>
718
+ * @public
719
+ */
720
+ LastChangedDate?: Date | undefined;
721
+ /**
722
+ * <p>The date that the secret was last accessed in the Region. This field is omitted if the
723
+ * secret has never been retrieved in the Region.</p>
724
+ * @public
725
+ */
726
+ LastAccessedDate?: Date | undefined;
727
+ /**
728
+ * <p>The date the secret is scheduled for deletion. If it is not scheduled for deletion,
729
+ * this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at
730
+ * least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes
731
+ * the secret, including all of its versions.</p>
732
+ * <p>If a secret is scheduled for deletion, then its details, including the encrypted
733
+ * secret value, is not accessible. To cancel a scheduled deletion and restore access to
734
+ * the secret, use <a>RestoreSecret</a>.</p>
735
+ * @public
736
+ */
737
+ DeletedDate?: Date | undefined;
738
+ /**
739
+ * <p>The next rotation is scheduled to occur on or before this date. If the secret isn't
740
+ * configured for rotation or rotation has been disabled, Secrets Manager returns null. If rotation
741
+ * fails, Secrets Manager retries the entire rotation process multiple times. If rotation
742
+ * is unsuccessful, this date may be in the past.</p>
743
+ * <p>This date represents the latest date that rotation will occur, but it is not an
744
+ * approximate rotation date. In some cases, for example if you turn off automatic rotation
745
+ * and then turn it back on, the next rotation may occur much sooner than this date.</p>
746
+ * @public
747
+ */
748
+ NextRotationDate?: Date | undefined;
749
+ /**
750
+ * <p>The list of tags attached to the secret. To add tags to a secret, use <a>TagResource</a>. To remove tags, use <a>UntagResource</a>.</p>
751
+ * @public
752
+ */
753
+ Tags?: Tag[] | undefined;
754
+ /**
755
+ * <p>A list of the versions of the secret that have staging labels attached. Versions that
756
+ * don't have staging labels are considered deprecated and Secrets Manager can delete them.</p>
757
+ * <p>Secrets Manager uses staging labels to indicate the status of a secret version during rotation.
758
+ * The three staging labels for rotation are: </p>
759
+ * <ul>
760
+ * <li>
761
+ * <p>
762
+ * <code>AWSCURRENT</code>, which indicates the current version of the
763
+ * secret.</p>
764
+ * </li>
765
+ * <li>
766
+ * <p>
767
+ * <code>AWSPENDING</code>, which indicates the version of the secret that
768
+ * contains new secret information that will become the next current version when
769
+ * rotation finishes.</p>
770
+ * <p>During rotation, Secrets Manager creates an <code>AWSPENDING</code> version ID before
771
+ * creating the new secret version. To check if a secret version exists, call <a>GetSecretValue</a>.</p>
772
+ * </li>
773
+ * <li>
774
+ * <p>
775
+ * <code>AWSPREVIOUS</code>, which indicates the previous current version of the
776
+ * secret. You can use this as the <i>last known good</i>
777
+ * version.</p>
778
+ * </li>
779
+ * </ul>
780
+ * <p>For more information about rotation and staging labels, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">How rotation works</a>.</p>
781
+ * @public
782
+ */
783
+ VersionIdsToStages?: Record<string, string[]> | undefined;
784
+ /**
785
+ * <p>The ID of the service that created this secret. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by
786
+ * other Amazon Web Services services</a>.</p>
787
+ * @public
788
+ */
789
+ OwningService?: string | undefined;
790
+ /**
791
+ * <p>The date the secret was created.</p>
792
+ * @public
793
+ */
794
+ CreatedDate?: Date | undefined;
795
+ /**
796
+ * <p>The Region the secret is in. If a secret is replicated to other Regions, the replicas
797
+ * are listed in <code>ReplicationStatus</code>. </p>
798
+ * @public
799
+ */
800
+ PrimaryRegion?: string | undefined;
801
+ /**
802
+ * <p>A list of the replicas of this secret and their status: </p>
803
+ * <ul>
804
+ * <li>
805
+ * <p>
806
+ * <code>Failed</code>, which indicates that the replica was not created.</p>
807
+ * </li>
808
+ * <li>
809
+ * <p>
810
+ * <code>InProgress</code>, which indicates that Secrets Manager is in the process of
811
+ * creating the replica.</p>
812
+ * </li>
813
+ * <li>
814
+ * <p>
815
+ * <code>InSync</code>, which indicates that the replica was created.</p>
816
+ * </li>
817
+ * </ul>
818
+ * @public
819
+ */
820
+ ReplicationStatus?: ReplicationStatusType[] | undefined;
821
+ }
822
+ /**
823
+ * @public
824
+ */
825
+ export interface GetRandomPasswordRequest {
826
+ /**
827
+ * <p>The length of the password. If you don't include this parameter, the default length is
828
+ * 32 characters.</p>
829
+ * @public
830
+ */
831
+ PasswordLength?: number | undefined;
832
+ /**
833
+ * <p>A string of the characters that you don't want in the password.</p>
834
+ * @public
835
+ */
836
+ ExcludeCharacters?: string | undefined;
837
+ /**
838
+ * <p>Specifies whether to exclude numbers from the password. If you don't include this
839
+ * switch, the password can contain numbers.</p>
840
+ * @public
841
+ */
842
+ ExcludeNumbers?: boolean | undefined;
843
+ /**
844
+ * <p>Specifies whether to exclude the following punctuation characters from the password:
845
+ * <code>! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` \{ | \}
846
+ * ~</code>. If you don't include this switch, the password can contain
847
+ * punctuation.</p>
848
+ * @public
849
+ */
850
+ ExcludePunctuation?: boolean | undefined;
851
+ /**
852
+ * <p>Specifies whether to exclude uppercase letters from the password. If you don't include
853
+ * this switch, the password can contain uppercase letters.</p>
854
+ * @public
855
+ */
856
+ ExcludeUppercase?: boolean | undefined;
857
+ /**
858
+ * <p>Specifies whether to exclude lowercase letters from the password. If you don't include
859
+ * this switch, the password can contain lowercase letters.</p>
860
+ * @public
861
+ */
862
+ ExcludeLowercase?: boolean | undefined;
863
+ /**
864
+ * <p>Specifies whether to include the space character. If you include this switch, the
865
+ * password can contain space characters.</p>
866
+ * @public
867
+ */
868
+ IncludeSpace?: boolean | undefined;
869
+ /**
870
+ * <p>Specifies whether to include at least one upper and lowercase letter, one number, and
871
+ * one punctuation. If you don't include this switch, the password contains at least one of
872
+ * every character type.</p>
873
+ * @public
874
+ */
875
+ RequireEachIncludedType?: boolean | undefined;
876
+ }
877
+ /**
878
+ * @public
879
+ */
880
+ export interface GetRandomPasswordResponse {
881
+ /**
882
+ * <p>A string with the password.</p>
883
+ * @public
884
+ */
885
+ RandomPassword?: string | undefined;
886
+ }
887
+ /**
888
+ * @public
889
+ */
890
+ export interface GetResourcePolicyRequest {
891
+ /**
892
+ * <p>The ARN or name of the secret to retrieve the attached resource-based policy
893
+ * for.</p>
894
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
895
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
896
+ * @public
897
+ */
898
+ SecretId: string | undefined;
899
+ }
900
+ /**
901
+ * @public
902
+ */
903
+ export interface GetResourcePolicyResponse {
904
+ /**
905
+ * <p>The ARN of the secret that the resource-based policy was retrieved for.</p>
906
+ * @public
907
+ */
908
+ ARN?: string | undefined;
909
+ /**
910
+ * <p>The name of the secret that the resource-based policy was retrieved for.</p>
911
+ * @public
912
+ */
913
+ Name?: string | undefined;
914
+ /**
915
+ * <p>A JSON-formatted string that contains the permissions policy attached to the secret.
916
+ * For more information about permissions policies, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication and access
917
+ * control for Secrets Manager</a>.</p>
918
+ * @public
919
+ */
920
+ ResourcePolicy?: string | undefined;
921
+ }
922
+ /**
923
+ * @public
924
+ */
925
+ export interface GetSecretValueRequest {
926
+ /**
927
+ * <p>The ARN or name of the secret to retrieve. To retrieve a secret from another account,
928
+ * you must use an ARN.</p>
929
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
930
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
931
+ * @public
932
+ */
933
+ SecretId: string | undefined;
934
+ /**
935
+ * <p>The unique identifier of the version of the secret to retrieve. If you include both
936
+ * this parameter and <code>VersionStage</code>, the two parameters must refer to the same
937
+ * secret version. If you don't specify either a <code>VersionStage</code> or
938
+ * <code>VersionId</code>, then Secrets Manager returns the <code>AWSCURRENT</code>
939
+ * version.</p>
940
+ * <p>This value is typically a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a>
941
+ * value with 32 hexadecimal digits.</p>
942
+ * @public
943
+ */
944
+ VersionId?: string | undefined;
945
+ /**
946
+ * <p>The staging label of the version of the secret to retrieve. </p>
947
+ * <p>Secrets Manager uses staging labels to keep track of different versions during the rotation
948
+ * process. If you include both this parameter and <code>VersionId</code>, the two
949
+ * parameters must refer to the same secret version. If you don't specify either a
950
+ * <code>VersionStage</code> or <code>VersionId</code>, Secrets Manager returns the
951
+ * <code>AWSCURRENT</code> version.</p>
952
+ * @public
953
+ */
954
+ VersionStage?: string | undefined;
955
+ }
956
+ /**
957
+ * @public
958
+ */
959
+ export interface GetSecretValueResponse {
960
+ /**
961
+ * <p>The ARN of the secret.</p>
962
+ * @public
963
+ */
964
+ ARN?: string | undefined;
965
+ /**
966
+ * <p>The friendly name of the secret.</p>
967
+ * @public
968
+ */
969
+ Name?: string | undefined;
970
+ /**
971
+ * <p>The unique identifier of this version of the secret.</p>
972
+ * @public
973
+ */
974
+ VersionId?: string | undefined;
975
+ /**
976
+ * <p>The decrypted secret value, if the secret value was originally provided as binary data
977
+ * in the form of a byte array. When you retrieve a <code>SecretBinary</code> using the
978
+ * HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it
979
+ * is not encoded.</p>
980
+ * <p>If the secret was created by using the Secrets Manager console, or if the secret value was
981
+ * originally provided as a string, then this field is omitted. The secret value appears in
982
+ * <code>SecretString</code> instead.</p>
983
+ * <p>Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.</p>
984
+ * @public
985
+ */
986
+ SecretBinary?: Uint8Array | undefined;
987
+ /**
988
+ * <p>The decrypted secret value, if the secret value was originally provided as a string or
989
+ * through the Secrets Manager console.</p>
990
+ * <p>If this secret was created by using the console, then Secrets Manager stores the information as
991
+ * a JSON structure of key/value pairs. </p>
992
+ * <p>Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.</p>
993
+ * @public
994
+ */
995
+ SecretString?: string | undefined;
996
+ /**
997
+ * <p>A list of all of the staging labels currently attached to this version of the
998
+ * secret.</p>
999
+ * @public
1000
+ */
1001
+ VersionStages?: string[] | undefined;
1002
+ /**
1003
+ * <p>The date and time that this version of the secret was created. If you don't specify
1004
+ * which version in <code>VersionId</code> or <code>VersionStage</code>, then Secrets Manager uses
1005
+ * the <code>AWSCURRENT</code> version.</p>
1006
+ * @public
1007
+ */
1008
+ CreatedDate?: Date | undefined;
1009
+ }
1010
+ /**
1011
+ * @public
1012
+ */
1013
+ export interface ListSecretsRequest {
1014
+ /**
1015
+ * <p>Specifies whether to include secrets scheduled for deletion. By default, secrets
1016
+ * scheduled for deletion aren't included.</p>
1017
+ * @public
1018
+ */
1019
+ IncludePlannedDeletion?: boolean | undefined;
1020
+ /**
1021
+ * <p>The number of results to include in the response.</p>
1022
+ * <p>If there are more results available, in the response, Secrets Manager includes
1023
+ * <code>NextToken</code>. To get the next results, call <code>ListSecrets</code> again
1024
+ * with the value from <code>NextToken</code>.</p>
1025
+ * @public
1026
+ */
1027
+ MaxResults?: number | undefined;
1028
+ /**
1029
+ * <p>A token that indicates where the output should continue from, if a previous call did
1030
+ * not show all results. To get the next results, call <code>ListSecrets</code> again with
1031
+ * this value.</p>
1032
+ * @public
1033
+ */
1034
+ NextToken?: string | undefined;
1035
+ /**
1036
+ * <p>The filters to apply to the list of secrets.</p>
1037
+ * @public
1038
+ */
1039
+ Filters?: Filter[] | undefined;
1040
+ /**
1041
+ * <p>Secrets are listed by <code>CreatedDate</code>. </p>
1042
+ * @public
1043
+ */
1044
+ SortOrder?: SortOrderType | undefined;
1045
+ /**
1046
+ * <p>If not specified, secrets are listed by <code>CreatedDate</code>.</p>
1047
+ * @public
1048
+ */
1049
+ SortBy?: SortByType | undefined;
1050
+ }
1051
+ /**
1052
+ * <p>A structure that contains the details about a secret. It does not include the
1053
+ * encrypted <code>SecretString</code> and <code>SecretBinary</code> values. To get those
1054
+ * values, use <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetSecretValue.html">GetSecretValue</a> .</p>
1055
+ * @public
1056
+ */
1057
+ export interface SecretListEntry {
1058
+ /**
1059
+ * <p>The Amazon Resource Name (ARN) of the secret.</p>
1060
+ * @public
1061
+ */
1062
+ ARN?: string | undefined;
1063
+ /**
1064
+ * <p>The friendly name of the secret. </p>
1065
+ * @public
1066
+ */
1067
+ Name?: string | undefined;
1068
+ /**
1069
+ * <p>The exact string that identifies the third-party partner that holds the external
1070
+ * secret. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/mes-partners.html">Managed external secret
1071
+ * partners</a>.</p>
1072
+ * @public
1073
+ */
1074
+ Type?: string | undefined;
1075
+ /**
1076
+ * <p>The user-provided description of the secret.</p>
1077
+ * @public
1078
+ */
1079
+ Description?: string | undefined;
1080
+ /**
1081
+ * <p>The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is
1082
+ * encrypted with the Amazon Web Services managed key <code>aws/secretsmanager</code>, this
1083
+ * field is omitted.</p>
1084
+ * @public
1085
+ */
1086
+ KmsKeyId?: string | undefined;
1087
+ /**
1088
+ * <p>Indicates whether automatic, scheduled rotation is enabled for this secret.</p>
1089
+ * @public
1090
+ */
1091
+ RotationEnabled?: boolean | undefined;
1092
+ /**
1093
+ * <p>The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret
1094
+ * either automatically per the schedule or manually by a call to <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_RotateSecret.html">
1095
+ * <code>RotateSecret</code>
1096
+ * </a>.</p>
1097
+ * @public
1098
+ */
1099
+ RotationLambdaARN?: string | undefined;
1100
+ /**
1101
+ * <p>A structure that defines the rotation configuration for the secret.</p>
1102
+ * @public
1103
+ */
1104
+ RotationRules?: RotationRulesType | undefined;
1105
+ /**
1106
+ * <p>The metadata needed to successfully rotate a managed external secret. A list of key
1107
+ * value pairs in JSON format specified by the partner. For more information about the
1108
+ * required information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/mes-partners.html">Managed external secrets partners</a>.</p>
1109
+ * @public
1110
+ */
1111
+ ExternalSecretRotationMetadata?: ExternalSecretRotationMetadataItem[] | undefined;
1112
+ /**
1113
+ * <p>The role that Secrets Manager assumes to call APIs required to perform the rotation. For more
1114
+ * information about the required information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/mes-partners.html">Managed
1115
+ * external secrets partners</a>.</p>
1116
+ * @public
1117
+ */
1118
+ ExternalSecretRotationRoleArn?: string | undefined;
1119
+ /**
1120
+ * <p>The most recent date and time that the Secrets Manager rotation process was
1121
+ * successfully completed. This value is null if the secret hasn't ever rotated.</p>
1122
+ * @public
1123
+ */
1124
+ LastRotatedDate?: Date | undefined;
1125
+ /**
1126
+ * <p>The last date and time that this secret was modified in any way.</p>
1127
+ * @public
1128
+ */
1129
+ LastChangedDate?: Date | undefined;
1130
+ /**
1131
+ * <p>The date that the secret was last accessed in the Region. This field is omitted if the
1132
+ * secret has never been retrieved in the Region.</p>
1133
+ * @public
1134
+ */
1135
+ LastAccessedDate?: Date | undefined;
1136
+ /**
1137
+ * <p>The date and time the deletion of the secret occurred. Not present on active secrets.
1138
+ * The secret can be recovered until the number of days in the recovery window has passed,
1139
+ * as specified in the <code>RecoveryWindowInDays</code> parameter of the <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html">
1140
+ * <code>DeleteSecret</code>
1141
+ * </a> operation.</p>
1142
+ * @public
1143
+ */
1144
+ DeletedDate?: Date | undefined;
1145
+ /**
1146
+ * <p>The next rotation is scheduled to occur on or before this date. If the secret isn't
1147
+ * configured for rotation or rotation has been disabled, Secrets Manager returns null.</p>
1148
+ * @public
1149
+ */
1150
+ NextRotationDate?: Date | undefined;
1151
+ /**
1152
+ * <p>The list of user-defined tags associated with the secret. To add tags to a secret, use
1153
+ * <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_TagResource.html">
1154
+ * <code>TagResource</code>
1155
+ * </a>. To remove tags, use <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_UntagResource.html">
1156
+ * <code>UntagResource</code>
1157
+ * </a>.</p>
1158
+ * @public
1159
+ */
1160
+ Tags?: Tag[] | undefined;
1161
+ /**
1162
+ * <p>A list of all of the currently assigned <code>SecretVersionStage</code> staging labels
1163
+ * and the <code>SecretVersionId</code> attached to each one. Staging labels are used to
1164
+ * keep track of the different versions during the rotation process.</p>
1165
+ * <note>
1166
+ * <p>A version that does not have any <code>SecretVersionStage</code> is considered
1167
+ * deprecated and subject to deletion. Such versions are not included in this
1168
+ * list.</p>
1169
+ * </note>
1170
+ * @public
1171
+ */
1172
+ SecretVersionsToStages?: Record<string, string[]> | undefined;
1173
+ /**
1174
+ * <p>Returns the name of the service that created the secret.</p>
1175
+ * @public
1176
+ */
1177
+ OwningService?: string | undefined;
1178
+ /**
1179
+ * <p>The date and time when a secret was created.</p>
1180
+ * @public
1181
+ */
1182
+ CreatedDate?: Date | undefined;
1183
+ /**
1184
+ * <p>The Region where Secrets Manager originated the secret.</p>
1185
+ * @public
1186
+ */
1187
+ PrimaryRegion?: string | undefined;
1188
+ }
1189
+ /**
1190
+ * @public
1191
+ */
1192
+ export interface ListSecretsResponse {
1193
+ /**
1194
+ * <p>A list of the secrets in the account.</p>
1195
+ * @public
1196
+ */
1197
+ SecretList?: SecretListEntry[] | undefined;
1198
+ /**
1199
+ * <p>Secrets Manager includes this value if there's more output available than what is included in
1200
+ * the current response. This can occur even when the response includes no values at all,
1201
+ * such as when you ask for a filtered view of a long list. To get the next results, call
1202
+ * <code>ListSecrets</code> again with this value.</p>
1203
+ * @public
1204
+ */
1205
+ NextToken?: string | undefined;
1206
+ }
1207
+ /**
1208
+ * @public
1209
+ */
1210
+ export interface ListSecretVersionIdsRequest {
1211
+ /**
1212
+ * <p>The ARN or name of the secret whose versions you want to list.</p>
1213
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
1214
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
1215
+ * @public
1216
+ */
1217
+ SecretId: string | undefined;
1218
+ /**
1219
+ * <p>The number of results to include in the response.</p>
1220
+ * <p>If there are more results available, in the response, Secrets Manager includes
1221
+ * <code>NextToken</code>. To get the next results, call
1222
+ * <code>ListSecretVersionIds</code> again with the value from <code>NextToken</code>.
1223
+ * </p>
1224
+ * @public
1225
+ */
1226
+ MaxResults?: number | undefined;
1227
+ /**
1228
+ * <p>A token that indicates where the output should continue from, if a previous call did
1229
+ * not show all results. To get the next results, call <code>ListSecretVersionIds</code>
1230
+ * again with this value.</p>
1231
+ * @public
1232
+ */
1233
+ NextToken?: string | undefined;
1234
+ /**
1235
+ * <p>Specifies whether to include versions of secrets that don't have any staging labels
1236
+ * attached to them. Versions without staging labels are considered deprecated and are
1237
+ * subject to deletion by Secrets Manager. By default, versions without staging labels aren't
1238
+ * included.</p>
1239
+ * @public
1240
+ */
1241
+ IncludeDeprecated?: boolean | undefined;
1242
+ }
1243
+ /**
1244
+ * <p>A structure that contains information about one version of a secret.</p>
1245
+ * @public
1246
+ */
1247
+ export interface SecretVersionsListEntry {
1248
+ /**
1249
+ * <p>The unique version identifier of this version of the secret.</p>
1250
+ * @public
1251
+ */
1252
+ VersionId?: string | undefined;
1253
+ /**
1254
+ * <p>An array of staging labels that are currently associated with this version of the
1255
+ * secret.</p>
1256
+ * @public
1257
+ */
1258
+ VersionStages?: string[] | undefined;
1259
+ /**
1260
+ * <p>The date that this version of the secret was last accessed. Note that the resolution
1261
+ * of this field is at the date level and does not include the time.</p>
1262
+ * @public
1263
+ */
1264
+ LastAccessedDate?: Date | undefined;
1265
+ /**
1266
+ * <p>The date and time this version of the secret was created.</p>
1267
+ * @public
1268
+ */
1269
+ CreatedDate?: Date | undefined;
1270
+ /**
1271
+ * <p>The KMS keys used to encrypt the secret version.</p>
1272
+ * @public
1273
+ */
1274
+ KmsKeyIds?: string[] | undefined;
1275
+ }
1276
+ /**
1277
+ * @public
1278
+ */
1279
+ export interface ListSecretVersionIdsResponse {
1280
+ /**
1281
+ * <p>A list of the versions of the secret.</p>
1282
+ * @public
1283
+ */
1284
+ Versions?: SecretVersionsListEntry[] | undefined;
1285
+ /**
1286
+ * <p>Secrets Manager includes this value if there's more output available than what is included in
1287
+ * the current response. This can occur even when the response includes no values at all,
1288
+ * such as when you ask for a filtered view of a long list. To get the next results, call
1289
+ * <code>ListSecretVersionIds</code> again with this value. </p>
1290
+ * @public
1291
+ */
1292
+ NextToken?: string | undefined;
1293
+ /**
1294
+ * <p>The ARN of the secret.</p>
1295
+ * @public
1296
+ */
1297
+ ARN?: string | undefined;
1298
+ /**
1299
+ * <p>The name of the secret.</p>
1300
+ * @public
1301
+ */
1302
+ Name?: string | undefined;
1303
+ }
1304
+ /**
1305
+ * @public
1306
+ */
1307
+ export interface PutResourcePolicyRequest {
1308
+ /**
1309
+ * <p>The ARN or name of the secret to attach the resource-based policy.</p>
1310
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
1311
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
1312
+ * @public
1313
+ */
1314
+ SecretId: string | undefined;
1315
+ /**
1316
+ * <p>A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see
1317
+ * <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html">Permissions policy examples</a>.</p>
1318
+ * @public
1319
+ */
1320
+ ResourcePolicy: string | undefined;
1321
+ /**
1322
+ * <p>Specifies whether to block resource-based policies that allow broad access to the
1323
+ * secret, for example those that use a wildcard for the principal. By default, public
1324
+ * policies aren't blocked.</p>
1325
+ * <important>
1326
+ * <p>Resource policy validation and the BlockPublicPolicy parameter help protect your
1327
+ * resources by preventing public access from being granted through the resource
1328
+ * policies that are directly attached to your secrets. In addition to using these
1329
+ * features, carefully inspect the following policies to confirm that they do not grant
1330
+ * public access:</p>
1331
+ * <ul>
1332
+ * <li>
1333
+ * <p>Identity-based policies attached to associated Amazon Web Services
1334
+ * principals (for example, IAM roles)</p>
1335
+ * </li>
1336
+ * <li>
1337
+ * <p>Resource-based policies attached to associated Amazon Web Services
1338
+ * resources (for example, Key Management Service (KMS)
1339
+ * keys)</p>
1340
+ * </li>
1341
+ * </ul>
1342
+ * <p>To review permissions to your secrets, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/determine-acccess_examine-iam-policies.html">Determine who has permissions to your secrets</a>.</p>
1343
+ * </important>
1344
+ * @public
1345
+ */
1346
+ BlockPublicPolicy?: boolean | undefined;
1347
+ }
1348
+ /**
1349
+ * @public
1350
+ */
1351
+ export interface PutResourcePolicyResponse {
1352
+ /**
1353
+ * <p>The ARN of the secret.</p>
1354
+ * @public
1355
+ */
1356
+ ARN?: string | undefined;
1357
+ /**
1358
+ * <p>The name of the secret.</p>
1359
+ * @public
1360
+ */
1361
+ Name?: string | undefined;
1362
+ }
1363
+ /**
1364
+ * @public
1365
+ */
1366
+ export interface PutSecretValueRequest {
1367
+ /**
1368
+ * <p>The ARN or name of the secret to add a new version to.</p>
1369
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
1370
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
1371
+ * <p>If the secret doesn't already exist, use <code>CreateSecret</code> instead.</p>
1372
+ * @public
1373
+ */
1374
+ SecretId: string | undefined;
1375
+ /**
1376
+ * <p>A unique identifier for the new version of the secret. </p>
1377
+ * <note>
1378
+ * <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. </p>
1379
+ * </note>
1380
+ * <p>If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> and include it in the request.</p>
1381
+ * <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value to ensure uniqueness of your versions within the specified secret. </p>
1382
+ * <ul>
1383
+ * <li>
1384
+ * <p>If the <code>ClientRequestToken</code> value isn't already associated with a
1385
+ * version of the secret then a new version of the secret is created. </p>
1386
+ * </li>
1387
+ * <li>
1388
+ * <p>If a version with this value already exists and that version's
1389
+ * <code>SecretString</code> or <code>SecretBinary</code> values are the same
1390
+ * as those in the request then the request is ignored. The operation is
1391
+ * idempotent. </p>
1392
+ * </li>
1393
+ * <li>
1394
+ * <p>If a version with this value already exists and the version of the
1395
+ * <code>SecretString</code> and <code>SecretBinary</code> values are different
1396
+ * from those in the request, then the request fails because you can't modify a
1397
+ * secret version. You can only create new versions to store new secret
1398
+ * values.</p>
1399
+ * </li>
1400
+ * </ul>
1401
+ * <p>This value becomes the <code>VersionId</code> of the new version.</p>
1402
+ * @public
1403
+ */
1404
+ ClientRequestToken?: string | undefined;
1405
+ /**
1406
+ * <p>The binary data to encrypt and store in the new version of the secret. To use this
1407
+ * parameter in the command-line tools, we recommend that you store your binary data in a
1408
+ * file and then pass the contents of the file as a parameter. </p>
1409
+ * <p>You must include <code>SecretBinary</code> or <code>SecretString</code>, but not
1410
+ * both.</p>
1411
+ * <p>You can't access this value from the Secrets Manager console.</p>
1412
+ * <p>Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.</p>
1413
+ * @public
1414
+ */
1415
+ SecretBinary?: Uint8Array | undefined;
1416
+ /**
1417
+ * <p>The text to encrypt and store in the new version of the secret. </p>
1418
+ * <p>You must include <code>SecretBinary</code> or <code>SecretString</code>, but not
1419
+ * both.</p>
1420
+ * <p>We recommend you create the secret string as JSON key/value pairs, as shown in the
1421
+ * example.</p>
1422
+ * <p>Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.</p>
1423
+ * @public
1424
+ */
1425
+ SecretString?: string | undefined;
1426
+ /**
1427
+ * <p>A list of staging labels to attach to this version of the secret. Secrets Manager uses staging
1428
+ * labels to track versions of a secret through the rotation process.</p>
1429
+ * <p>If you specify a staging label that's already associated with a different version of
1430
+ * the same secret, then Secrets Manager removes the label from the other version and attaches it to
1431
+ * this version. If you specify <code>AWSCURRENT</code>, and it is already attached to
1432
+ * another version, then Secrets Manager also moves the staging label <code>AWSPREVIOUS</code> to the
1433
+ * version that <code>AWSCURRENT</code> was removed from.</p>
1434
+ * <p>If you don't include <code>VersionStages</code>, then Secrets Manager automatically moves the
1435
+ * staging label <code>AWSCURRENT</code> to this version.</p>
1436
+ * @public
1437
+ */
1438
+ VersionStages?: string[] | undefined;
1439
+ /**
1440
+ * <p>A unique identifier that indicates the source of the request. Required for secret
1441
+ * rotations using an IAM assumed role or cross-account rotation, in which you rotate a
1442
+ * secret in one account by using a Lambda rotation function in another account. In both
1443
+ * cases, the rotation function assumes an IAM role to call Secrets Manager, and then Secrets Manager validates
1444
+ * the identity using the token. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">How rotation
1445
+ * works</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_lambda">Rotation by Lambda
1446
+ * functions</a>.</p>
1447
+ * <p>Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.</p>
1448
+ * @public
1449
+ */
1450
+ RotationToken?: string | undefined;
1451
+ }
1452
+ /**
1453
+ * @public
1454
+ */
1455
+ export interface PutSecretValueResponse {
1456
+ /**
1457
+ * <p>The ARN of the secret.</p>
1458
+ * @public
1459
+ */
1460
+ ARN?: string | undefined;
1461
+ /**
1462
+ * <p>The name of the secret.</p>
1463
+ * @public
1464
+ */
1465
+ Name?: string | undefined;
1466
+ /**
1467
+ * <p>The unique identifier of the version of the secret.</p>
1468
+ * @public
1469
+ */
1470
+ VersionId?: string | undefined;
1471
+ /**
1472
+ * <p>The list of staging labels that are currently attached to this version of the secret.
1473
+ * Secrets Manager uses staging labels to track a version as it progresses through the secret
1474
+ * rotation process.</p>
1475
+ * @public
1476
+ */
1477
+ VersionStages?: string[] | undefined;
1478
+ }
1479
+ /**
1480
+ * @public
1481
+ */
1482
+ export interface RemoveRegionsFromReplicationRequest {
1483
+ /**
1484
+ * <p>The ARN or name of the secret.</p>
1485
+ * @public
1486
+ */
1487
+ SecretId: string | undefined;
1488
+ /**
1489
+ * <p>The Regions of the replicas to remove.</p>
1490
+ * @public
1491
+ */
1492
+ RemoveReplicaRegions: string[] | undefined;
1493
+ }
1494
+ /**
1495
+ * @public
1496
+ */
1497
+ export interface RemoveRegionsFromReplicationResponse {
1498
+ /**
1499
+ * <p>The ARN of the primary secret.</p>
1500
+ * @public
1501
+ */
1502
+ ARN?: string | undefined;
1503
+ /**
1504
+ * <p>The status of replicas for this secret after you remove Regions.</p>
1505
+ * @public
1506
+ */
1507
+ ReplicationStatus?: ReplicationStatusType[] | undefined;
1508
+ }
1509
+ /**
1510
+ * @public
1511
+ */
1512
+ export interface ReplicateSecretToRegionsRequest {
1513
+ /**
1514
+ * <p>The ARN or name of the secret to replicate.</p>
1515
+ * @public
1516
+ */
1517
+ SecretId: string | undefined;
1518
+ /**
1519
+ * <p>A list of Regions in which to replicate the secret.</p>
1520
+ * @public
1521
+ */
1522
+ AddReplicaRegions: ReplicaRegionType[] | undefined;
1523
+ /**
1524
+ * <p>Specifies whether to overwrite a secret with the same name in the destination Region.
1525
+ * By default, secrets aren't overwritten.</p>
1526
+ * @public
1527
+ */
1528
+ ForceOverwriteReplicaSecret?: boolean | undefined;
1529
+ }
1530
+ /**
1531
+ * @public
1532
+ */
1533
+ export interface ReplicateSecretToRegionsResponse {
1534
+ /**
1535
+ * <p>The ARN of the primary secret.</p>
1536
+ * @public
1537
+ */
1538
+ ARN?: string | undefined;
1539
+ /**
1540
+ * <p>The status of replication.</p>
1541
+ * @public
1542
+ */
1543
+ ReplicationStatus?: ReplicationStatusType[] | undefined;
1544
+ }
1545
+ /**
1546
+ * @public
1547
+ */
1548
+ export interface RestoreSecretRequest {
1549
+ /**
1550
+ * <p>The ARN or name of the secret to restore.</p>
1551
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
1552
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
1553
+ * @public
1554
+ */
1555
+ SecretId: string | undefined;
1556
+ }
1557
+ /**
1558
+ * @public
1559
+ */
1560
+ export interface RestoreSecretResponse {
1561
+ /**
1562
+ * <p>The ARN of the secret that was restored.</p>
1563
+ * @public
1564
+ */
1565
+ ARN?: string | undefined;
1566
+ /**
1567
+ * <p>The name of the secret that was restored.</p>
1568
+ * @public
1569
+ */
1570
+ Name?: string | undefined;
1571
+ }
1572
+ /**
1573
+ * @public
1574
+ */
1575
+ export interface RotateSecretRequest {
1576
+ /**
1577
+ * <p>The ARN or name of the secret to rotate.</p>
1578
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
1579
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
1580
+ * @public
1581
+ */
1582
+ SecretId: string | undefined;
1583
+ /**
1584
+ * <p>A unique identifier for the new version of the secret. You only need to specify this
1585
+ * value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't
1586
+ * attempt to create a secret version twice.</p>
1587
+ * <note>
1588
+ * <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. </p>
1589
+ * </note>
1590
+ * <p>If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> and include it in the request.</p>
1591
+ * <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value to ensure uniqueness of your versions within the specified secret. </p>
1592
+ * @public
1593
+ */
1594
+ ClientRequestToken?: string | undefined;
1595
+ /**
1596
+ * <p>For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda
1597
+ * rotation function. </p>
1598
+ * <p>For secrets that use <i>managed rotation</i>, omit this field. For more
1599
+ * information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_managed.html">Managed
1600
+ * rotation</a> in the <i>Secrets Manager User Guide</i>.</p>
1601
+ * @public
1602
+ */
1603
+ RotationLambdaARN?: string | undefined;
1604
+ /**
1605
+ * <p>A structure that defines the rotation configuration for this secret.</p>
1606
+ * <important>
1607
+ * <p>When changing an existing rotation schedule and setting
1608
+ * <code>RotateImmediately</code> to <code>false</code>:</p>
1609
+ * <ul>
1610
+ * <li>
1611
+ * <p>If using <code>AutomaticallyAfterDays</code> or a
1612
+ * <code>ScheduleExpression</code> with <code>rate()</code>, the previously
1613
+ * scheduled rotation might still occur.</p>
1614
+ * </li>
1615
+ * <li>
1616
+ * <p>To prevent unintended rotations, use a <code>ScheduleExpression</code>
1617
+ * with <code>cron()</code> for granular control over rotation windows.</p>
1618
+ * </li>
1619
+ * </ul>
1620
+ * </important>
1621
+ * @public
1622
+ */
1623
+ RotationRules?: RotationRulesType | undefined;
1624
+ /**
1625
+ * <p>The metadata needed to successfully rotate a managed external secret. A list of key
1626
+ * value pairs in JSON format specified by the partner. For more information about the
1627
+ * required information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/managed-external-secrets.html">Using Secrets Manager managed external secrets</a>
1628
+ * </p>
1629
+ * @public
1630
+ */
1631
+ ExternalSecretRotationMetadata?: ExternalSecretRotationMetadataItem[] | undefined;
1632
+ /**
1633
+ * <p>The Amazon Resource Name (ARN) of the role that allows Secrets Manager to rotate a secret held
1634
+ * by a third-party partner. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/mes-security.html">Security and
1635
+ * permissions</a>.</p>
1636
+ * @public
1637
+ */
1638
+ ExternalSecretRotationRoleArn?: string | undefined;
1639
+ /**
1640
+ * <p>Specifies whether to rotate the secret immediately or wait until the next scheduled
1641
+ * rotation window. The rotation schedule is defined in <a>RotateSecretRequest$RotationRules</a>.</p>
1642
+ * <p>The default for <code>RotateImmediately</code> is <code>true</code>. If you don't
1643
+ * specify this value, Secrets Manager rotates the secret immediately.</p>
1644
+ * <p>If you set <code>RotateImmediately</code> to <code>false</code>, Secrets Manager tests
1645
+ * the rotation configuration by running the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">
1646
+ * <code>testSecret</code> step</a> of the Lambda rotation function. This test
1647
+ * creates an <code>AWSPENDING</code> version of the secret and then removes it.</p>
1648
+ * <p>When changing an existing rotation schedule and setting <code>RotateImmediately</code>
1649
+ * to <code>false</code>:</p>
1650
+ * <ul>
1651
+ * <li>
1652
+ * <p>If using <code>AutomaticallyAfterDays</code> or a
1653
+ * <code>ScheduleExpression</code> with <code>rate()</code>, the previously
1654
+ * scheduled rotation might still occur.</p>
1655
+ * </li>
1656
+ * <li>
1657
+ * <p>To prevent unintended rotations, use a <code>ScheduleExpression</code> with
1658
+ * <code>cron()</code> for granular control over rotation windows.</p>
1659
+ * </li>
1660
+ * </ul>
1661
+ * <p>Rotation is an asynchronous process. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">How rotation works</a>.</p>
1662
+ * @public
1663
+ */
1664
+ RotateImmediately?: boolean | undefined;
1665
+ }
1666
+ /**
1667
+ * @public
1668
+ */
1669
+ export interface RotateSecretResponse {
1670
+ /**
1671
+ * <p>The ARN of the secret.</p>
1672
+ * @public
1673
+ */
1674
+ ARN?: string | undefined;
1675
+ /**
1676
+ * <p>The name of the secret.</p>
1677
+ * @public
1678
+ */
1679
+ Name?: string | undefined;
1680
+ /**
1681
+ * <p>The ID of the new version of the secret.</p>
1682
+ * @public
1683
+ */
1684
+ VersionId?: string | undefined;
1685
+ }
1686
+ /**
1687
+ * @public
1688
+ */
1689
+ export interface StopReplicationToReplicaRequest {
1690
+ /**
1691
+ * <p>The name of the secret or the replica ARN. The replica ARN is the same as the original
1692
+ * primary secret ARN expect the Region is changed to the replica Region. </p>
1693
+ * @public
1694
+ */
1695
+ SecretId: string | undefined;
1696
+ }
1697
+ /**
1698
+ * @public
1699
+ */
1700
+ export interface StopReplicationToReplicaResponse {
1701
+ /**
1702
+ * <p>The ARN of the promoted secret. The ARN is the same as the original primary secret
1703
+ * except the Region is changed.</p>
1704
+ * @public
1705
+ */
1706
+ ARN?: string | undefined;
1707
+ }
1708
+ /**
1709
+ * @public
1710
+ */
1711
+ export interface TagResourceRequest {
1712
+ /**
1713
+ * <p>The identifier for the secret to attach tags to. You can specify either the Amazon
1714
+ * Resource Name (ARN) or the friendly name of the secret.</p>
1715
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
1716
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
1717
+ * @public
1718
+ */
1719
+ SecretId: string | undefined;
1720
+ /**
1721
+ * <p>The tags to attach to the secret as a JSON text string argument. Each element in the
1722
+ * list consists of a <code>Key</code> and a <code>Value</code>.</p>
1723
+ * <p>For storing multiple values, we recommend that you use a JSON text
1724
+ * string argument and specify key/value pairs. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html">Specifying parameter values for the Amazon Web Services CLI</a>
1725
+ * in the Amazon Web Services CLI User Guide.</p>
1726
+ * @public
1727
+ */
1728
+ Tags: Tag[] | undefined;
1729
+ }
1730
+ /**
1731
+ * @public
1732
+ */
1733
+ export interface UntagResourceRequest {
1734
+ /**
1735
+ * <p>The ARN or name of the secret.</p>
1736
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
1737
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
1738
+ * @public
1739
+ */
1740
+ SecretId: string | undefined;
1741
+ /**
1742
+ * <p>A list of tag key names to remove from the secret. You don't specify the value. Both
1743
+ * the key and its associated value are removed.</p>
1744
+ * <p>This parameter requires a JSON text string argument.</p>
1745
+ * <p>For storing multiple values, we recommend that you use a JSON text
1746
+ * string argument and specify key/value pairs. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html">Specifying parameter values for the Amazon Web Services CLI</a>
1747
+ * in the Amazon Web Services CLI User Guide.</p>
1748
+ * @public
1749
+ */
1750
+ TagKeys: string[] | undefined;
1751
+ }
1752
+ /**
1753
+ * @public
1754
+ */
1755
+ export interface UpdateSecretRequest {
1756
+ /**
1757
+ * <p>The ARN or name of the secret.</p>
1758
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
1759
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
1760
+ * @public
1761
+ */
1762
+ SecretId: string | undefined;
1763
+ /**
1764
+ * <p>If you include <code>SecretString</code> or <code>SecretBinary</code>, then Secrets Manager
1765
+ * creates a new version for the secret, and this parameter specifies the unique identifier
1766
+ * for the new version.</p>
1767
+ * <note>
1768
+ * <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. </p>
1769
+ * </note>
1770
+ * <p>If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> and include it in the request.</p>
1771
+ * <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value to ensure uniqueness of your versions within the specified secret. </p>
1772
+ * @public
1773
+ */
1774
+ ClientRequestToken?: string | undefined;
1775
+ /**
1776
+ * <p>The description of the secret.</p>
1777
+ * @public
1778
+ */
1779
+ Description?: string | undefined;
1780
+ /**
1781
+ * <p>The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new
1782
+ * secret versions as well as any existing versions with the staging labels
1783
+ * <code>AWSCURRENT</code>, <code>AWSPENDING</code>, or <code>AWSPREVIOUS</code>. If
1784
+ * you don't have <code>kms:Encrypt</code> permission to the new key, Secrets Manager does not
1785
+ * re-encrypt existing secret versions with the new key. For more information about
1786
+ * versions and staging labels, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version">Concepts:
1787
+ * Version</a>.</p>
1788
+ * <p>A key alias is always prefixed by <code>alias/</code>, for example
1789
+ * <code>alias/aws/secretsmanager</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html">About
1790
+ * aliases</a>.</p>
1791
+ * <p>If you set this to an empty string, Secrets Manager uses the Amazon Web Services managed key
1792
+ * <code>aws/secretsmanager</code>. If this key doesn't already exist in your account,
1793
+ * then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account
1794
+ * automatically have access to use <code>aws/secretsmanager</code>. Creating
1795
+ * <code>aws/secretsmanager</code> can result in a one-time significant delay in
1796
+ * returning the result. </p>
1797
+ * <important>
1798
+ * <p>You can only use the Amazon Web Services managed key
1799
+ * <code>aws/secretsmanager</code> if you call this operation using credentials from
1800
+ * the same Amazon Web Services account that owns the secret. If the secret is in a different
1801
+ * account, then you must use a customer managed key and provide the ARN of that
1802
+ * KMS key in this field. The user making the call must have
1803
+ * permissions to both the secret and the KMS key in their respective
1804
+ * accounts.</p>
1805
+ * </important>
1806
+ * @public
1807
+ */
1808
+ KmsKeyId?: string | undefined;
1809
+ /**
1810
+ * <p>The binary data to encrypt and store in the new version of the secret. We recommend
1811
+ * that you store your binary data in a file and then pass the contents of the file as a
1812
+ * parameter. </p>
1813
+ * <p>Either <code>SecretBinary</code> or <code>SecretString</code> must have a value, but
1814
+ * not both.</p>
1815
+ * <p>You can't access this parameter in the Secrets Manager console.</p>
1816
+ * <p>Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.</p>
1817
+ * @public
1818
+ */
1819
+ SecretBinary?: Uint8Array | undefined;
1820
+ /**
1821
+ * <p>The text data to encrypt and store in the new version of the secret. We recommend you
1822
+ * use a JSON structure of key/value pairs for your secret value. </p>
1823
+ * <p>Either <code>SecretBinary</code> or <code>SecretString</code> must have a value, but
1824
+ * not both. </p>
1825
+ * <p>Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.</p>
1826
+ * @public
1827
+ */
1828
+ SecretString?: string | undefined;
1829
+ /**
1830
+ * <p>The exact string that identifies the third-party partner that holds the external
1831
+ * secret. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/mes-partners.html">Managed external secret
1832
+ * partners</a>.</p>
1833
+ * @public
1834
+ */
1835
+ Type?: string | undefined;
1836
+ }
1837
+ /**
1838
+ * @public
1839
+ */
1840
+ export interface UpdateSecretResponse {
1841
+ /**
1842
+ * <p>The ARN of the secret that was updated.</p>
1843
+ * @public
1844
+ */
1845
+ ARN?: string | undefined;
1846
+ /**
1847
+ * <p>The name of the secret that was updated.</p>
1848
+ * @public
1849
+ */
1850
+ Name?: string | undefined;
1851
+ /**
1852
+ * <p>If Secrets Manager created a new version of the secret during this operation, then
1853
+ * <code>VersionId</code> contains the unique identifier of the new version.</p>
1854
+ * @public
1855
+ */
1856
+ VersionId?: string | undefined;
1857
+ }
1858
+ /**
1859
+ * @public
1860
+ */
1861
+ export interface UpdateSecretVersionStageRequest {
1862
+ /**
1863
+ * <p>The ARN or the name of the secret with the version and staging labelsto modify.</p>
1864
+ * <p>For an ARN, we recommend that you specify a complete ARN rather
1865
+ * than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
1866
+ * @public
1867
+ */
1868
+ SecretId: string | undefined;
1869
+ /**
1870
+ * <p>The staging label to add to this version.</p>
1871
+ * @public
1872
+ */
1873
+ VersionStage: string | undefined;
1874
+ /**
1875
+ * <p>The ID of the version that the staging label is to be removed from. If the staging
1876
+ * label you are trying to attach to one version is already attached to a different
1877
+ * version, then you must include this parameter and specify the version that the label is
1878
+ * to be removed from. If the label is attached and you either do not specify this
1879
+ * parameter, or the version ID does not match, then the operation fails.</p>
1880
+ * @public
1881
+ */
1882
+ RemoveFromVersionId?: string | undefined;
1883
+ /**
1884
+ * <p>The ID of the version to add the staging label to. To remove a label from a version,
1885
+ * then do not specify this parameter.</p>
1886
+ * <p>If the staging label is already attached to a different version of the secret, then
1887
+ * you must also specify the <code>RemoveFromVersionId</code> parameter. </p>
1888
+ * @public
1889
+ */
1890
+ MoveToVersionId?: string | undefined;
1891
+ }
1892
+ /**
1893
+ * @public
1894
+ */
1895
+ export interface UpdateSecretVersionStageResponse {
1896
+ /**
1897
+ * <p>The ARN of the secret that was updated.</p>
1898
+ * @public
1899
+ */
1900
+ ARN?: string | undefined;
1901
+ /**
1902
+ * <p>The name of the secret that was updated.</p>
1903
+ * @public
1904
+ */
1905
+ Name?: string | undefined;
1906
+ }
1907
+ /**
1908
+ * @public
1909
+ */
1910
+ export interface ValidateResourcePolicyRequest {
1911
+ /**
1912
+ * <p>The ARN or name of the secret with the resource-based policy you want to
1913
+ * validate.</p>
1914
+ * @public
1915
+ */
1916
+ SecretId?: string | undefined;
1917
+ /**
1918
+ * <p>A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in
1919
+ * the string identifies who can access or manage this secret and its versions. For example
1920
+ * policies, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html">Permissions
1921
+ * policy examples</a>.</p>
1922
+ * @public
1923
+ */
1924
+ ResourcePolicy: string | undefined;
1925
+ }
1926
+ /**
1927
+ * <p>Displays errors that occurred during validation of the resource policy.</p>
1928
+ * @public
1929
+ */
1930
+ export interface ValidationErrorsEntry {
1931
+ /**
1932
+ * <p>Checks the name of the policy.</p>
1933
+ * @public
1934
+ */
1935
+ CheckName?: string | undefined;
1936
+ /**
1937
+ * <p>Displays error messages if validation encounters problems during validation of the
1938
+ * resource policy.</p>
1939
+ * @public
1940
+ */
1941
+ ErrorMessage?: string | undefined;
1942
+ }
1943
+ /**
1944
+ * @public
1945
+ */
1946
+ export interface ValidateResourcePolicyResponse {
1947
+ /**
1948
+ * <p>True if your policy passes validation, otherwise false.</p>
1949
+ * @public
1950
+ */
1951
+ PolicyValidationPassed?: boolean | undefined;
1952
+ /**
1953
+ * <p>Validation errors if your policy didn't pass validation.</p>
1954
+ * @public
1955
+ */
1956
+ ValidationErrors?: ValidationErrorsEntry[] | undefined;
1957
+ }