@aws-sdk/client-secrets-manager 3.35.0 → 3.38.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.
- package/CHANGELOG.md +47 -0
- package/dist-cjs/SecretsManager.js +0 -66
- package/dist-cjs/SecretsManagerClient.js +0 -71
- package/dist-cjs/commands/CancelRotateSecretCommand.js +0 -77
- package/dist-cjs/commands/CreateSecretCommand.js +0 -112
- package/dist-cjs/commands/DeleteResourcePolicyCommand.js +0 -48
- package/dist-cjs/commands/DeleteSecretCommand.js +0 -70
- package/dist-cjs/commands/DescribeSecretCommand.js +0 -52
- package/dist-cjs/commands/GetRandomPasswordCommand.js +0 -37
- package/dist-cjs/commands/GetResourcePolicyCommand.js +0 -51
- package/dist-cjs/commands/GetSecretValueCommand.js +0 -52
- package/dist-cjs/commands/ListSecretVersionIdsCommand.js +0 -53
- package/dist-cjs/commands/ListSecretsCommand.js +0 -54
- package/dist-cjs/commands/PutResourcePolicyCommand.js +0 -56
- package/dist-cjs/commands/PutSecretValueCommand.js +0 -112
- package/dist-cjs/commands/RemoveRegionsFromReplicationCommand.js +0 -25
- package/dist-cjs/commands/ReplicateSecretToRegionsCommand.js +0 -26
- package/dist-cjs/commands/RestoreSecretCommand.js +0 -43
- package/dist-cjs/commands/RotateSecretCommand.js +0 -86
- package/dist-cjs/commands/StopReplicationToReplicaCommand.js +0 -25
- package/dist-cjs/commands/TagResourceCommand.js +0 -80
- package/dist-cjs/commands/UntagResourceCommand.js +0 -53
- package/dist-cjs/commands/UpdateSecretCommand.js +0 -109
- package/dist-cjs/commands/UpdateSecretVersionStageCommand.js +0 -61
- package/dist-cjs/commands/ValidateResourcePolicyCommand.js +0 -59
- package/dist-cjs/commands/index.js +25 -0
- package/dist-cjs/endpoints.js +1 -2
- package/dist-cjs/index.js +4 -28
- package/dist-cjs/models/index.js +0 -1
- package/dist-cjs/models/models_0.js +0 -187
- package/dist-cjs/pagination/Interfaces.js +0 -1
- package/dist-cjs/pagination/ListSecretVersionIdsPaginator.js +0 -11
- package/dist-cjs/pagination/ListSecretsPaginator.js +0 -11
- package/dist-cjs/pagination/index.js +6 -0
- package/dist-cjs/protocols/Aws_json1_1.js +0 -6
- package/dist-cjs/runtimeConfig.browser.js +1 -6
- package/dist-cjs/runtimeConfig.js +2 -7
- package/dist-cjs/runtimeConfig.native.js +0 -4
- package/dist-cjs/runtimeConfig.shared.js +0 -4
- package/dist-es/SecretsManager.js +0 -1
- package/dist-es/SecretsManagerClient.js +0 -1
- package/dist-es/commands/CancelRotateSecretCommand.js +0 -1
- package/dist-es/commands/CreateSecretCommand.js +0 -1
- package/dist-es/commands/DeleteResourcePolicyCommand.js +0 -1
- package/dist-es/commands/DeleteSecretCommand.js +0 -1
- package/dist-es/commands/DescribeSecretCommand.js +0 -1
- package/dist-es/commands/GetRandomPasswordCommand.js +0 -1
- package/dist-es/commands/GetResourcePolicyCommand.js +0 -1
- package/dist-es/commands/GetSecretValueCommand.js +0 -1
- package/dist-es/commands/ListSecretVersionIdsCommand.js +0 -1
- package/dist-es/commands/ListSecretsCommand.js +0 -1
- package/dist-es/commands/PutResourcePolicyCommand.js +0 -1
- package/dist-es/commands/PutSecretValueCommand.js +0 -1
- package/dist-es/commands/RemoveRegionsFromReplicationCommand.js +0 -1
- package/dist-es/commands/ReplicateSecretToRegionsCommand.js +0 -1
- package/dist-es/commands/RestoreSecretCommand.js +0 -1
- package/dist-es/commands/RotateSecretCommand.js +0 -1
- package/dist-es/commands/StopReplicationToReplicaCommand.js +0 -1
- package/dist-es/commands/TagResourceCommand.js +0 -1
- package/dist-es/commands/UntagResourceCommand.js +0 -1
- package/dist-es/commands/UpdateSecretCommand.js +0 -1
- package/dist-es/commands/UpdateSecretVersionStageCommand.js +0 -1
- package/dist-es/commands/ValidateResourcePolicyCommand.js +0 -1
- package/dist-es/commands/index.js +22 -0
- package/dist-es/endpoints.js +1 -2
- package/dist-es/index.js +4 -28
- package/dist-es/models/index.js +0 -1
- package/dist-es/models/models_0.js +0 -1
- package/dist-es/pagination/Interfaces.js +0 -1
- package/dist-es/pagination/ListSecretVersionIdsPaginator.js +0 -1
- package/dist-es/pagination/ListSecretsPaginator.js +0 -1
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_json1_1.js +0 -1
- package/dist-es/runtimeConfig.browser.js +1 -2
- package/dist-es/runtimeConfig.js +2 -3
- package/dist-es/runtimeConfig.native.js +0 -1
- package/dist-es/runtimeConfig.shared.js +0 -1
- package/dist-types/SecretsManager.d.ts +16 -10
- package/dist-types/commands/PutSecretValueCommand.d.ts +6 -5
- package/dist-types/commands/UpdateSecretCommand.d.ts +10 -5
- package/dist-types/commands/index.d.ts +22 -0
- package/dist-types/index.d.ts +4 -27
- package/dist-types/models/models_0.d.ts +54 -268
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/SecretsManager.d.ts +23 -922
- package/dist-types/ts3.4/SecretsManagerClient.d.ts +24 -151
- package/dist-types/ts3.4/commands/CancelRotateSecretCommand.d.ts +2 -72
- package/dist-types/ts3.4/commands/CreateSecretCommand.d.ts +2 -107
- package/dist-types/ts3.4/commands/DeleteResourcePolicyCommand.d.ts +2 -43
- package/dist-types/ts3.4/commands/DeleteSecretCommand.d.ts +2 -65
- package/dist-types/ts3.4/commands/DescribeSecretCommand.d.ts +2 -47
- package/dist-types/ts3.4/commands/GetRandomPasswordCommand.d.ts +2 -32
- package/dist-types/ts3.4/commands/GetResourcePolicyCommand.d.ts +2 -46
- package/dist-types/ts3.4/commands/GetSecretValueCommand.d.ts +2 -47
- package/dist-types/ts3.4/commands/ListSecretVersionIdsCommand.d.ts +2 -48
- package/dist-types/ts3.4/commands/ListSecretsCommand.d.ts +2 -49
- package/dist-types/ts3.4/commands/PutResourcePolicyCommand.d.ts +2 -51
- package/dist-types/ts3.4/commands/PutSecretValueCommand.d.ts +2 -107
- package/dist-types/ts3.4/commands/RemoveRegionsFromReplicationCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/ReplicateSecretToRegionsCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/RestoreSecretCommand.d.ts +2 -38
- package/dist-types/ts3.4/commands/RotateSecretCommand.d.ts +2 -81
- package/dist-types/ts3.4/commands/StopReplicationToReplicaCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -75
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -48
- package/dist-types/ts3.4/commands/UpdateSecretCommand.d.ts +2 -104
- package/dist-types/ts3.4/commands/UpdateSecretVersionStageCommand.d.ts +2 -56
- package/dist-types/ts3.4/commands/ValidateResourcePolicyCommand.d.ts +2 -54
- package/dist-types/ts3.4/commands/index.d.ts +22 -0
- package/dist-types/ts3.4/index.d.ts +4 -27
- package/dist-types/ts3.4/models/models_0.d.ts +256 -1506
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
- package/package.json +33 -30
- package/dist-cjs/SecretsManager.js.map +0 -1
- package/dist-cjs/SecretsManagerClient.js.map +0 -1
- package/dist-cjs/commands/CancelRotateSecretCommand.js.map +0 -1
- package/dist-cjs/commands/CreateSecretCommand.js.map +0 -1
- package/dist-cjs/commands/DeleteResourcePolicyCommand.js.map +0 -1
- package/dist-cjs/commands/DeleteSecretCommand.js.map +0 -1
- package/dist-cjs/commands/DescribeSecretCommand.js.map +0 -1
- package/dist-cjs/commands/GetRandomPasswordCommand.js.map +0 -1
- package/dist-cjs/commands/GetResourcePolicyCommand.js.map +0 -1
- package/dist-cjs/commands/GetSecretValueCommand.js.map +0 -1
- package/dist-cjs/commands/ListSecretVersionIdsCommand.js.map +0 -1
- package/dist-cjs/commands/ListSecretsCommand.js.map +0 -1
- package/dist-cjs/commands/PutResourcePolicyCommand.js.map +0 -1
- package/dist-cjs/commands/PutSecretValueCommand.js.map +0 -1
- package/dist-cjs/commands/RemoveRegionsFromReplicationCommand.js.map +0 -1
- package/dist-cjs/commands/ReplicateSecretToRegionsCommand.js.map +0 -1
- package/dist-cjs/commands/RestoreSecretCommand.js.map +0 -1
- package/dist-cjs/commands/RotateSecretCommand.js.map +0 -1
- package/dist-cjs/commands/StopReplicationToReplicaCommand.js.map +0 -1
- package/dist-cjs/commands/TagResourceCommand.js.map +0 -1
- package/dist-cjs/commands/UntagResourceCommand.js.map +0 -1
- package/dist-cjs/commands/UpdateSecretCommand.js.map +0 -1
- package/dist-cjs/commands/UpdateSecretVersionStageCommand.js.map +0 -1
- package/dist-cjs/commands/ValidateResourcePolicyCommand.js.map +0 -1
- package/dist-cjs/endpoints.js.map +0 -1
- package/dist-cjs/index.js.map +0 -1
- package/dist-cjs/models/index.js.map +0 -1
- package/dist-cjs/models/models_0.js.map +0 -1
- package/dist-cjs/pagination/Interfaces.js.map +0 -1
- package/dist-cjs/pagination/ListSecretVersionIdsPaginator.js.map +0 -1
- package/dist-cjs/pagination/ListSecretsPaginator.js.map +0 -1
- package/dist-cjs/protocols/Aws_json1_1.js.map +0 -1
- package/dist-cjs/runtimeConfig.browser.js.map +0 -1
- package/dist-cjs/runtimeConfig.js.map +0 -1
- package/dist-cjs/runtimeConfig.native.js.map +0 -1
- package/dist-cjs/runtimeConfig.shared.js.map +0 -1
- package/dist-es/SecretsManager.js.map +0 -1
- package/dist-es/SecretsManagerClient.js.map +0 -1
- package/dist-es/commands/CancelRotateSecretCommand.js.map +0 -1
- package/dist-es/commands/CreateSecretCommand.js.map +0 -1
- package/dist-es/commands/DeleteResourcePolicyCommand.js.map +0 -1
- package/dist-es/commands/DeleteSecretCommand.js.map +0 -1
- package/dist-es/commands/DescribeSecretCommand.js.map +0 -1
- package/dist-es/commands/GetRandomPasswordCommand.js.map +0 -1
- package/dist-es/commands/GetResourcePolicyCommand.js.map +0 -1
- package/dist-es/commands/GetSecretValueCommand.js.map +0 -1
- package/dist-es/commands/ListSecretVersionIdsCommand.js.map +0 -1
- package/dist-es/commands/ListSecretsCommand.js.map +0 -1
- package/dist-es/commands/PutResourcePolicyCommand.js.map +0 -1
- package/dist-es/commands/PutSecretValueCommand.js.map +0 -1
- package/dist-es/commands/RemoveRegionsFromReplicationCommand.js.map +0 -1
- package/dist-es/commands/ReplicateSecretToRegionsCommand.js.map +0 -1
- package/dist-es/commands/RestoreSecretCommand.js.map +0 -1
- package/dist-es/commands/RotateSecretCommand.js.map +0 -1
- package/dist-es/commands/StopReplicationToReplicaCommand.js.map +0 -1
- package/dist-es/commands/TagResourceCommand.js.map +0 -1
- package/dist-es/commands/UntagResourceCommand.js.map +0 -1
- package/dist-es/commands/UpdateSecretCommand.js.map +0 -1
- package/dist-es/commands/UpdateSecretVersionStageCommand.js.map +0 -1
- package/dist-es/commands/ValidateResourcePolicyCommand.js.map +0 -1
- package/dist-es/endpoints.js.map +0 -1
- package/dist-es/index.js.map +0 -1
- package/dist-es/models/index.js.map +0 -1
- package/dist-es/models/models_0.js.map +0 -1
- package/dist-es/pagination/Interfaces.js.map +0 -1
- package/dist-es/pagination/ListSecretVersionIdsPaginator.js.map +0 -1
- package/dist-es/pagination/ListSecretsPaginator.js.map +0 -1
- package/dist-es/protocols/Aws_json1_1.js.map +0 -1
- package/dist-es/runtimeConfig.browser.js.map +0 -1
- package/dist-es/runtimeConfig.js.map +0 -1
- package/dist-es/runtimeConfig.native.js.map +0 -1
- package/dist-es/runtimeConfig.shared.js.map +0 -1
- package/jest.config.js +0 -4
- package/src/SecretsManager.ts +0 -1643
- package/src/SecretsManagerClient.ts +0 -385
- package/src/commands/CancelRotateSecretCommand.ts +0 -147
- package/src/commands/CreateSecretCommand.ts +0 -182
- package/src/commands/DeleteResourcePolicyCommand.ts +0 -118
- package/src/commands/DeleteSecretCommand.ts +0 -140
- package/src/commands/DescribeSecretCommand.ts +0 -122
- package/src/commands/GetRandomPasswordCommand.ts +0 -107
- package/src/commands/GetResourcePolicyCommand.ts +0 -121
- package/src/commands/GetSecretValueCommand.ts +0 -122
- package/src/commands/ListSecretVersionIdsCommand.ts +0 -123
- package/src/commands/ListSecretsCommand.ts +0 -124
- package/src/commands/PutResourcePolicyCommand.ts +0 -126
- package/src/commands/PutSecretValueCommand.ts +0 -182
- package/src/commands/RemoveRegionsFromReplicationCommand.ts +0 -100
- package/src/commands/ReplicateSecretToRegionsCommand.ts +0 -96
- package/src/commands/RestoreSecretCommand.ts +0 -113
- package/src/commands/RotateSecretCommand.ts +0 -156
- package/src/commands/StopReplicationToReplicaCommand.ts +0 -95
- package/src/commands/TagResourceCommand.ts +0 -150
- package/src/commands/UntagResourceCommand.ts +0 -123
- package/src/commands/UpdateSecretCommand.ts +0 -179
- package/src/commands/UpdateSecretVersionStageCommand.ts +0 -131
- package/src/commands/ValidateResourcePolicyCommand.ts +0 -129
- package/src/endpoints.ts +0 -86
- package/src/index.ts +0 -28
- package/src/models/index.ts +0 -1
- package/src/models/models_0.ts +0 -2422
- package/src/pagination/Interfaces.ts +0 -8
- package/src/pagination/ListSecretVersionIdsPaginator.ts +0 -59
- package/src/pagination/ListSecretsPaginator.ts +0 -55
- package/src/protocols/Aws_json1_1.ts +0 -3422
- package/src/runtimeConfig.browser.ts +0 -41
- package/src/runtimeConfig.native.ts +0 -17
- package/src/runtimeConfig.shared.ts +0 -17
- package/src/runtimeConfig.ts +0 -46
- package/tsconfig.es.json +0 -10
- package/tsconfig.json +0 -33
- package/tsconfig.types.json +0 -9
|
@@ -6,55 +6,11 @@ export interface GetResourcePolicyCommandInput extends GetResourcePolicyRequest
|
|
|
6
6
|
}
|
|
7
7
|
export interface GetResourcePolicyCommandOutput extends GetResourcePolicyResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Retrieves the JSON text of the resource-based policy document attached to the specified
|
|
11
|
-
* secret. The JSON request string input and response output displays formatted code
|
|
12
|
-
* with white space and line breaks for better readability. Submit your input as a single line
|
|
13
|
-
* JSON string.</p>
|
|
14
|
-
* <p>
|
|
15
|
-
* <b>Minimum permissions</b>
|
|
16
|
-
* </p>
|
|
17
|
-
* <p>To run this command, you must have the following permissions:</p>
|
|
18
|
-
* <ul>
|
|
19
|
-
* <li>
|
|
20
|
-
* <p>secretsmanager:GetResourcePolicy</p>
|
|
21
|
-
* </li>
|
|
22
|
-
* </ul>
|
|
23
|
-
* <p>
|
|
24
|
-
* <b>Related operations</b>
|
|
25
|
-
* </p>
|
|
26
|
-
* <ul>
|
|
27
|
-
* <li>
|
|
28
|
-
* <p>To attach a resource policy to a secret, use <a>PutResourcePolicy</a>.</p>
|
|
29
|
-
* </li>
|
|
30
|
-
* <li>
|
|
31
|
-
* <p>To delete the resource-based policy attached to a secret, use <a>DeleteResourcePolicy</a>.</p>
|
|
32
|
-
* </li>
|
|
33
|
-
* <li>
|
|
34
|
-
* <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p>
|
|
35
|
-
* </li>
|
|
36
|
-
* </ul>
|
|
37
|
-
* @example
|
|
38
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
39
|
-
* ```javascript
|
|
40
|
-
* import { SecretsManagerClient, GetResourcePolicyCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import
|
|
41
|
-
* // const { SecretsManagerClient, GetResourcePolicyCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import
|
|
42
|
-
* const client = new SecretsManagerClient(config);
|
|
43
|
-
* const command = new GetResourcePolicyCommand(input);
|
|
44
|
-
* const response = await client.send(command);
|
|
45
|
-
* ```
|
|
46
|
-
*
|
|
47
|
-
* @see {@link GetResourcePolicyCommandInput} for command's `input` shape.
|
|
48
|
-
* @see {@link GetResourcePolicyCommandOutput} for command's `response` shape.
|
|
49
|
-
* @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
|
|
50
|
-
*
|
|
51
|
-
*/
|
|
9
|
+
|
|
52
10
|
export declare class GetResourcePolicyCommand extends $Command<GetResourcePolicyCommandInput, GetResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
53
11
|
readonly input: GetResourcePolicyCommandInput;
|
|
54
12
|
constructor(input: GetResourcePolicyCommandInput);
|
|
55
|
-
|
|
56
|
-
* @internal
|
|
57
|
-
*/
|
|
13
|
+
|
|
58
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetResourcePolicyCommandInput, GetResourcePolicyCommandOutput>;
|
|
59
15
|
private serialize;
|
|
60
16
|
private deserialize;
|
|
@@ -6,56 +6,11 @@ export interface GetSecretValueCommandInput extends GetSecretValueRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface GetSecretValueCommandOutput extends GetSecretValueResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Retrieves the contents of the encrypted fields <code>SecretString</code> or
|
|
11
|
-
* <code>SecretBinary</code> from the specified version of a secret, whichever contains
|
|
12
|
-
* content.</p>
|
|
13
|
-
* <p>
|
|
14
|
-
* <b>Minimum permissions</b>
|
|
15
|
-
* </p>
|
|
16
|
-
* <p>To run this command, you must have the following permissions:</p>
|
|
17
|
-
* <ul>
|
|
18
|
-
* <li>
|
|
19
|
-
* <p>secretsmanager:GetSecretValue</p>
|
|
20
|
-
* </li>
|
|
21
|
-
* <li>
|
|
22
|
-
* <p>kms:Decrypt - required only if you use a customer-managed Amazon Web Services KMS key to encrypt the
|
|
23
|
-
* secret. You do not need this permission to use the account's default Amazon Web Services managed CMK for
|
|
24
|
-
* Secrets Manager.</p>
|
|
25
|
-
* </li>
|
|
26
|
-
* </ul>
|
|
27
|
-
* <p>
|
|
28
|
-
* <b>Related operations</b>
|
|
29
|
-
* </p>
|
|
30
|
-
* <ul>
|
|
31
|
-
* <li>
|
|
32
|
-
* <p>To create a new version of the secret with different encrypted information, use <a>PutSecretValue</a>.</p>
|
|
33
|
-
* </li>
|
|
34
|
-
* <li>
|
|
35
|
-
* <p>To retrieve the non-encrypted details for the secret, use <a>DescribeSecret</a>.</p>
|
|
36
|
-
* </li>
|
|
37
|
-
* </ul>
|
|
38
|
-
* @example
|
|
39
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
40
|
-
* ```javascript
|
|
41
|
-
* import { SecretsManagerClient, GetSecretValueCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import
|
|
42
|
-
* // const { SecretsManagerClient, GetSecretValueCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import
|
|
43
|
-
* const client = new SecretsManagerClient(config);
|
|
44
|
-
* const command = new GetSecretValueCommand(input);
|
|
45
|
-
* const response = await client.send(command);
|
|
46
|
-
* ```
|
|
47
|
-
*
|
|
48
|
-
* @see {@link GetSecretValueCommandInput} for command's `input` shape.
|
|
49
|
-
* @see {@link GetSecretValueCommandOutput} for command's `response` shape.
|
|
50
|
-
* @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
|
|
51
|
-
*
|
|
52
|
-
*/
|
|
9
|
+
|
|
53
10
|
export declare class GetSecretValueCommand extends $Command<GetSecretValueCommandInput, GetSecretValueCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
54
11
|
readonly input: GetSecretValueCommandInput;
|
|
55
12
|
constructor(input: GetSecretValueCommandInput);
|
|
56
|
-
|
|
57
|
-
* @internal
|
|
58
|
-
*/
|
|
13
|
+
|
|
59
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSecretValueCommandInput, GetSecretValueCommandOutput>;
|
|
60
15
|
private serialize;
|
|
61
16
|
private deserialize;
|
|
@@ -6,57 +6,11 @@ export interface ListSecretVersionIdsCommandInput extends ListSecretVersionIdsRe
|
|
|
6
6
|
}
|
|
7
7
|
export interface ListSecretVersionIdsCommandOutput extends ListSecretVersionIdsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Lists all of the versions attached to the specified secret. The output does not include
|
|
11
|
-
* the <code>SecretString</code> or <code>SecretBinary</code> fields. By default, the list
|
|
12
|
-
* includes only versions that have at least one staging label in <code>VersionStage</code>
|
|
13
|
-
* attached.</p>
|
|
14
|
-
* <note>
|
|
15
|
-
* <p>Always check the <code>NextToken</code> response parameter
|
|
16
|
-
* when calling any of the <code>List*</code> operations. These operations can occasionally return
|
|
17
|
-
* an empty or shorter than expected list of results even when there more results become available.
|
|
18
|
-
* When this happens, the <code>NextToken</code> response parameter contains a value to pass to the
|
|
19
|
-
* next call to the same API to request the next part of the list.</p>
|
|
20
|
-
* </note>
|
|
21
|
-
* <p>
|
|
22
|
-
* <b>Minimum
|
|
23
|
-
* permissions</b>
|
|
24
|
-
* </p>
|
|
25
|
-
* <p>To run this command, you must have the following permissions:</p>
|
|
26
|
-
* <ul>
|
|
27
|
-
* <li>
|
|
28
|
-
* <p>secretsmanager:ListSecretVersionIds</p>
|
|
29
|
-
* </li>
|
|
30
|
-
* </ul>
|
|
31
|
-
* <p>
|
|
32
|
-
* <b>Related operations</b>
|
|
33
|
-
* </p>
|
|
34
|
-
* <ul>
|
|
35
|
-
* <li>
|
|
36
|
-
* <p>To list the secrets in an account, use <a>ListSecrets</a>.</p>
|
|
37
|
-
* </li>
|
|
38
|
-
* </ul>
|
|
39
|
-
* @example
|
|
40
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
41
|
-
* ```javascript
|
|
42
|
-
* import { SecretsManagerClient, ListSecretVersionIdsCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import
|
|
43
|
-
* // const { SecretsManagerClient, ListSecretVersionIdsCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import
|
|
44
|
-
* const client = new SecretsManagerClient(config);
|
|
45
|
-
* const command = new ListSecretVersionIdsCommand(input);
|
|
46
|
-
* const response = await client.send(command);
|
|
47
|
-
* ```
|
|
48
|
-
*
|
|
49
|
-
* @see {@link ListSecretVersionIdsCommandInput} for command's `input` shape.
|
|
50
|
-
* @see {@link ListSecretVersionIdsCommandOutput} for command's `response` shape.
|
|
51
|
-
* @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
|
|
52
|
-
*
|
|
53
|
-
*/
|
|
9
|
+
|
|
54
10
|
export declare class ListSecretVersionIdsCommand extends $Command<ListSecretVersionIdsCommandInput, ListSecretVersionIdsCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
55
11
|
readonly input: ListSecretVersionIdsCommandInput;
|
|
56
12
|
constructor(input: ListSecretVersionIdsCommandInput);
|
|
57
|
-
|
|
58
|
-
* @internal
|
|
59
|
-
*/
|
|
13
|
+
|
|
60
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListSecretVersionIdsCommandInput, ListSecretVersionIdsCommandOutput>;
|
|
61
15
|
private serialize;
|
|
62
16
|
private deserialize;
|
|
@@ -6,58 +6,11 @@ export interface ListSecretsCommandInput extends ListSecretsRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface ListSecretsCommandOutput extends ListSecretsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Lists all of the secrets that are stored by Secrets Manager in the Amazon Web Services account. To list the
|
|
11
|
-
* versions currently stored for a specific secret, use <a>ListSecretVersionIds</a>.
|
|
12
|
-
* The encrypted fields <code>SecretString</code> and <code>SecretBinary</code> are not included
|
|
13
|
-
* in the output. To get that information, call the <a>GetSecretValue</a>
|
|
14
|
-
* operation.</p>
|
|
15
|
-
* <note>
|
|
16
|
-
* <p>Always check the <code>NextToken</code> response parameter
|
|
17
|
-
* when calling any of the <code>List*</code> operations. These operations can occasionally return
|
|
18
|
-
* an empty or shorter than expected list of results even when there more results become available.
|
|
19
|
-
* When this happens, the <code>NextToken</code> response parameter contains a value to pass to the
|
|
20
|
-
* next call to the same API to request the next part of the list.</p>
|
|
21
|
-
* </note>
|
|
22
|
-
* <p>
|
|
23
|
-
* <b>Minimum
|
|
24
|
-
* permissions</b>
|
|
25
|
-
* </p>
|
|
26
|
-
* <p>To run this command, you must have the following permissions:</p>
|
|
27
|
-
* <ul>
|
|
28
|
-
* <li>
|
|
29
|
-
* <p>secretsmanager:ListSecrets</p>
|
|
30
|
-
* </li>
|
|
31
|
-
* </ul>
|
|
32
|
-
* <p>
|
|
33
|
-
* <b>Related operations</b>
|
|
34
|
-
* </p>
|
|
35
|
-
* <ul>
|
|
36
|
-
* <li>
|
|
37
|
-
* <p>To list the versions attached to a secret, use <a>ListSecretVersionIds</a>.</p>
|
|
38
|
-
* </li>
|
|
39
|
-
* </ul>
|
|
40
|
-
* @example
|
|
41
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
42
|
-
* ```javascript
|
|
43
|
-
* import { SecretsManagerClient, ListSecretsCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import
|
|
44
|
-
* // const { SecretsManagerClient, ListSecretsCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import
|
|
45
|
-
* const client = new SecretsManagerClient(config);
|
|
46
|
-
* const command = new ListSecretsCommand(input);
|
|
47
|
-
* const response = await client.send(command);
|
|
48
|
-
* ```
|
|
49
|
-
*
|
|
50
|
-
* @see {@link ListSecretsCommandInput} for command's `input` shape.
|
|
51
|
-
* @see {@link ListSecretsCommandOutput} for command's `response` shape.
|
|
52
|
-
* @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
|
|
53
|
-
*
|
|
54
|
-
*/
|
|
9
|
+
|
|
55
10
|
export declare class ListSecretsCommand extends $Command<ListSecretsCommandInput, ListSecretsCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
56
11
|
readonly input: ListSecretsCommandInput;
|
|
57
12
|
constructor(input: ListSecretsCommandInput);
|
|
58
|
-
|
|
59
|
-
* @internal
|
|
60
|
-
*/
|
|
13
|
+
|
|
61
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListSecretsCommandInput, ListSecretsCommandOutput>;
|
|
62
15
|
private serialize;
|
|
63
16
|
private deserialize;
|
|
@@ -6,60 +6,11 @@ export interface PutResourcePolicyCommandInput extends PutResourcePolicyRequest
|
|
|
6
6
|
}
|
|
7
7
|
export interface PutResourcePolicyCommandOutput extends PutResourcePolicyResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Attaches the contents of the specified resource-based permission policy to a secret. A
|
|
11
|
-
* resource-based policy is optional. Alternatively, you can use IAM identity-based policies
|
|
12
|
-
* that specify the secret's Amazon Resource Name (ARN) in the policy statement's
|
|
13
|
-
* <code>Resources</code> element. You can also use a combination of both identity-based and
|
|
14
|
-
* resource-based policies. The affected users and roles receive the permissions that are
|
|
15
|
-
* permitted by all of the relevant policies. For more information, see <a href="http://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html">Using Resource-Based
|
|
16
|
-
* Policies for Amazon Web Services Secrets Manager</a>. For the complete description of the Amazon Web Services policy syntax and
|
|
17
|
-
* grammar, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html">IAM JSON
|
|
18
|
-
* Policy Reference</a> in the <i>IAM User Guide</i>.</p>
|
|
19
|
-
* <p>
|
|
20
|
-
* <b>Minimum permissions</b>
|
|
21
|
-
* </p>
|
|
22
|
-
* <p>To run this command, you must have the following permissions:</p>
|
|
23
|
-
* <ul>
|
|
24
|
-
* <li>
|
|
25
|
-
* <p>secretsmanager:PutResourcePolicy</p>
|
|
26
|
-
* </li>
|
|
27
|
-
* </ul>
|
|
28
|
-
* <p>
|
|
29
|
-
* <b>Related operations</b>
|
|
30
|
-
* </p>
|
|
31
|
-
* <ul>
|
|
32
|
-
* <li>
|
|
33
|
-
* <p>To retrieve the resource policy attached to a secret, use <a>GetResourcePolicy</a>.</p>
|
|
34
|
-
* </li>
|
|
35
|
-
* <li>
|
|
36
|
-
* <p>To delete the resource-based policy attached to a secret, use <a>DeleteResourcePolicy</a>.</p>
|
|
37
|
-
* </li>
|
|
38
|
-
* <li>
|
|
39
|
-
* <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p>
|
|
40
|
-
* </li>
|
|
41
|
-
* </ul>
|
|
42
|
-
* @example
|
|
43
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
44
|
-
* ```javascript
|
|
45
|
-
* import { SecretsManagerClient, PutResourcePolicyCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import
|
|
46
|
-
* // const { SecretsManagerClient, PutResourcePolicyCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import
|
|
47
|
-
* const client = new SecretsManagerClient(config);
|
|
48
|
-
* const command = new PutResourcePolicyCommand(input);
|
|
49
|
-
* const response = await client.send(command);
|
|
50
|
-
* ```
|
|
51
|
-
*
|
|
52
|
-
* @see {@link PutResourcePolicyCommandInput} for command's `input` shape.
|
|
53
|
-
* @see {@link PutResourcePolicyCommandOutput} for command's `response` shape.
|
|
54
|
-
* @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
|
|
55
|
-
*
|
|
56
|
-
*/
|
|
9
|
+
|
|
57
10
|
export declare class PutResourcePolicyCommand extends $Command<PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
58
11
|
readonly input: PutResourcePolicyCommandInput;
|
|
59
12
|
constructor(input: PutResourcePolicyCommandInput);
|
|
60
|
-
|
|
61
|
-
* @internal
|
|
62
|
-
*/
|
|
13
|
+
|
|
63
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput>;
|
|
64
15
|
private serialize;
|
|
65
16
|
private deserialize;
|
|
@@ -6,116 +6,11 @@ export interface PutSecretValueCommandInput extends PutSecretValueRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface PutSecretValueCommandOutput extends PutSecretValueResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Stores a new encrypted secret value in the specified secret. To do this, the operation
|
|
11
|
-
* creates a new version and attaches it to the secret. The version can contain a new
|
|
12
|
-
* <code>SecretString</code> value or a new <code>SecretBinary</code> value. You can also
|
|
13
|
-
* specify the staging labels that are initially attached to the new version.</p>
|
|
14
|
-
* <note>
|
|
15
|
-
* <p>The Secrets Manager console uses only the <code>SecretString</code> field. To add binary data to a
|
|
16
|
-
* secret with the <code>SecretBinary</code> field you must use the Amazon Web Services CLI or one of the
|
|
17
|
-
* Amazon Web Services SDKs.</p>
|
|
18
|
-
* </note>
|
|
19
|
-
* <ul>
|
|
20
|
-
* <li>
|
|
21
|
-
* <p>If this operation creates the first version for the secret then Secrets Manager
|
|
22
|
-
* automatically attaches the staging label <code>AWSCURRENT</code> to the new version.</p>
|
|
23
|
-
* </li>
|
|
24
|
-
* <li>
|
|
25
|
-
* <p>If you do not specify a value for VersionStages then Secrets Manager automatically
|
|
26
|
-
* moves the staging label <code>AWSCURRENT</code> to this new version.</p>
|
|
27
|
-
* </li>
|
|
28
|
-
* <li>
|
|
29
|
-
* <p>If this operation moves the staging label <code>AWSCURRENT</code> from another version to this
|
|
30
|
-
* version, then Secrets Manager also automatically moves the staging label <code>AWSPREVIOUS</code> to
|
|
31
|
-
* the version that <code>AWSCURRENT</code> was removed from.</p>
|
|
32
|
-
* </li>
|
|
33
|
-
* <li>
|
|
34
|
-
* <p>This operation is idempotent. If a version with a <code>VersionId</code> with the same
|
|
35
|
-
* value as the <code>ClientRequestToken</code> parameter already exists and you specify the
|
|
36
|
-
* same secret data, the operation succeeds but does nothing. However, if the secret data is
|
|
37
|
-
* different, then the operation fails because you cannot modify an existing version; you can
|
|
38
|
-
* only create new ones.</p>
|
|
39
|
-
* </li>
|
|
40
|
-
* </ul>
|
|
41
|
-
* <note>
|
|
42
|
-
* <ul>
|
|
43
|
-
* <li>
|
|
44
|
-
* <p>If you call an operation to encrypt or decrypt the <code>SecretString</code>
|
|
45
|
-
* or <code>SecretBinary</code> for a secret in the same account as the calling user and that
|
|
46
|
-
* secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the account's default
|
|
47
|
-
* Amazon Web Services managed customer master key (CMK) with the alias <code>aws/secretsmanager</code>. If this key
|
|
48
|
-
* doesn't already exist in your account then Secrets Manager creates it for you automatically. All
|
|
49
|
-
* users and roles in the same Amazon Web Services account automatically have access to use the default CMK.
|
|
50
|
-
* Note that if an Secrets Manager API call results in Amazon Web Services creating the account's
|
|
51
|
-
* Amazon Web Services-managed CMK, it can result in a one-time significant delay in returning the
|
|
52
|
-
* result.</p>
|
|
53
|
-
* </li>
|
|
54
|
-
* <li>
|
|
55
|
-
* <p>If the secret resides in a different Amazon Web Services account from the credentials calling an API that
|
|
56
|
-
* requires encryption or decryption of the secret value then you must create and use a custom
|
|
57
|
-
* Amazon Web Services KMS CMK because you can't access the default CMK for the account using credentials
|
|
58
|
-
* from a different Amazon Web Services account. Store the ARN of the CMK in the secret when you create the
|
|
59
|
-
* secret or when you update it by including it in the <code>KMSKeyId</code>. If you call an
|
|
60
|
-
* API that must encrypt or decrypt <code>SecretString</code> or <code>SecretBinary</code>
|
|
61
|
-
* using credentials from a different account then the Amazon Web Services KMS key policy must grant cross-account
|
|
62
|
-
* access to that other account's user or role for both the kms:GenerateDataKey and
|
|
63
|
-
* kms:Decrypt operations.</p>
|
|
64
|
-
* </li>
|
|
65
|
-
* </ul>
|
|
66
|
-
* </note>
|
|
67
|
-
* <p>
|
|
68
|
-
* <b>Minimum permissions</b>
|
|
69
|
-
* </p>
|
|
70
|
-
* <p>To run this command, you must have the following permissions:</p>
|
|
71
|
-
* <ul>
|
|
72
|
-
* <li>
|
|
73
|
-
* <p>secretsmanager:PutSecretValue</p>
|
|
74
|
-
* </li>
|
|
75
|
-
* <li>
|
|
76
|
-
* <p>kms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt
|
|
77
|
-
* the secret. You do not need this permission to use the account's default Amazon Web Services managed CMK
|
|
78
|
-
* for Secrets Manager.</p>
|
|
79
|
-
* </li>
|
|
80
|
-
* </ul>
|
|
81
|
-
* <p>
|
|
82
|
-
* <b>Related operations</b>
|
|
83
|
-
* </p>
|
|
84
|
-
* <ul>
|
|
85
|
-
* <li>
|
|
86
|
-
* <p>To retrieve the encrypted value you store in the version of a secret, use <a>GetSecretValue</a>.</p>
|
|
87
|
-
* </li>
|
|
88
|
-
* <li>
|
|
89
|
-
* <p>To create a secret, use <a>CreateSecret</a>.</p>
|
|
90
|
-
* </li>
|
|
91
|
-
* <li>
|
|
92
|
-
* <p>To get the details for a secret, use <a>DescribeSecret</a>.</p>
|
|
93
|
-
* </li>
|
|
94
|
-
* <li>
|
|
95
|
-
* <p>To list the versions attached to a secret, use <a>ListSecretVersionIds</a>.</p>
|
|
96
|
-
* </li>
|
|
97
|
-
* </ul>
|
|
98
|
-
* @example
|
|
99
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
100
|
-
* ```javascript
|
|
101
|
-
* import { SecretsManagerClient, PutSecretValueCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import
|
|
102
|
-
* // const { SecretsManagerClient, PutSecretValueCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import
|
|
103
|
-
* const client = new SecretsManagerClient(config);
|
|
104
|
-
* const command = new PutSecretValueCommand(input);
|
|
105
|
-
* const response = await client.send(command);
|
|
106
|
-
* ```
|
|
107
|
-
*
|
|
108
|
-
* @see {@link PutSecretValueCommandInput} for command's `input` shape.
|
|
109
|
-
* @see {@link PutSecretValueCommandOutput} for command's `response` shape.
|
|
110
|
-
* @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
|
|
111
|
-
*
|
|
112
|
-
*/
|
|
9
|
+
|
|
113
10
|
export declare class PutSecretValueCommand extends $Command<PutSecretValueCommandInput, PutSecretValueCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
114
11
|
readonly input: PutSecretValueCommandInput;
|
|
115
12
|
constructor(input: PutSecretValueCommandInput);
|
|
116
|
-
|
|
117
|
-
* @internal
|
|
118
|
-
*/
|
|
13
|
+
|
|
119
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutSecretValueCommandInput, PutSecretValueCommandOutput>;
|
|
120
15
|
private serialize;
|
|
121
16
|
private deserialize;
|
|
@@ -6,29 +6,11 @@ export interface RemoveRegionsFromReplicationCommandInput extends RemoveRegionsF
|
|
|
6
6
|
}
|
|
7
7
|
export interface RemoveRegionsFromReplicationCommandOutput extends RemoveRegionsFromReplicationResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Remove regions from replication.</p>
|
|
11
|
-
* @example
|
|
12
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
-
* ```javascript
|
|
14
|
-
* import { SecretsManagerClient, RemoveRegionsFromReplicationCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import
|
|
15
|
-
* // const { SecretsManagerClient, RemoveRegionsFromReplicationCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import
|
|
16
|
-
* const client = new SecretsManagerClient(config);
|
|
17
|
-
* const command = new RemoveRegionsFromReplicationCommand(input);
|
|
18
|
-
* const response = await client.send(command);
|
|
19
|
-
* ```
|
|
20
|
-
*
|
|
21
|
-
* @see {@link RemoveRegionsFromReplicationCommandInput} for command's `input` shape.
|
|
22
|
-
* @see {@link RemoveRegionsFromReplicationCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
|
|
24
|
-
*
|
|
25
|
-
*/
|
|
9
|
+
|
|
26
10
|
export declare class RemoveRegionsFromReplicationCommand extends $Command<RemoveRegionsFromReplicationCommandInput, RemoveRegionsFromReplicationCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
27
11
|
readonly input: RemoveRegionsFromReplicationCommandInput;
|
|
28
12
|
constructor(input: RemoveRegionsFromReplicationCommandInput);
|
|
29
|
-
|
|
30
|
-
* @internal
|
|
31
|
-
*/
|
|
13
|
+
|
|
32
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RemoveRegionsFromReplicationCommandInput, RemoveRegionsFromReplicationCommandOutput>;
|
|
33
15
|
private serialize;
|
|
34
16
|
private deserialize;
|
|
@@ -6,30 +6,11 @@ export interface ReplicateSecretToRegionsCommandInput extends ReplicateSecretToR
|
|
|
6
6
|
}
|
|
7
7
|
export interface ReplicateSecretToRegionsCommandOutput extends ReplicateSecretToRegionsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Converts an existing secret to a multi-Region secret and begins replication the secret to a
|
|
11
|
-
* list of new regions. </p>
|
|
12
|
-
* @example
|
|
13
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
14
|
-
* ```javascript
|
|
15
|
-
* import { SecretsManagerClient, ReplicateSecretToRegionsCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import
|
|
16
|
-
* // const { SecretsManagerClient, ReplicateSecretToRegionsCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import
|
|
17
|
-
* const client = new SecretsManagerClient(config);
|
|
18
|
-
* const command = new ReplicateSecretToRegionsCommand(input);
|
|
19
|
-
* const response = await client.send(command);
|
|
20
|
-
* ```
|
|
21
|
-
*
|
|
22
|
-
* @see {@link ReplicateSecretToRegionsCommandInput} for command's `input` shape.
|
|
23
|
-
* @see {@link ReplicateSecretToRegionsCommandOutput} for command's `response` shape.
|
|
24
|
-
* @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
|
|
25
|
-
*
|
|
26
|
-
*/
|
|
9
|
+
|
|
27
10
|
export declare class ReplicateSecretToRegionsCommand extends $Command<ReplicateSecretToRegionsCommandInput, ReplicateSecretToRegionsCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
28
11
|
readonly input: ReplicateSecretToRegionsCommandInput;
|
|
29
12
|
constructor(input: ReplicateSecretToRegionsCommandInput);
|
|
30
|
-
|
|
31
|
-
* @internal
|
|
32
|
-
*/
|
|
13
|
+
|
|
33
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ReplicateSecretToRegionsCommandInput, ReplicateSecretToRegionsCommandOutput>;
|
|
34
15
|
private serialize;
|
|
35
16
|
private deserialize;
|
|
@@ -6,47 +6,11 @@ export interface RestoreSecretCommandInput extends RestoreSecretRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface RestoreSecretCommandOutput extends RestoreSecretResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Cancels the scheduled deletion of a secret by removing the <code>DeletedDate</code> time
|
|
11
|
-
* stamp. This makes the secret accessible to query once again.</p>
|
|
12
|
-
* <p>
|
|
13
|
-
* <b>Minimum permissions</b>
|
|
14
|
-
* </p>
|
|
15
|
-
* <p>To run this command, you must have the following permissions:</p>
|
|
16
|
-
* <ul>
|
|
17
|
-
* <li>
|
|
18
|
-
* <p>secretsmanager:RestoreSecret</p>
|
|
19
|
-
* </li>
|
|
20
|
-
* </ul>
|
|
21
|
-
* <p>
|
|
22
|
-
* <b>Related operations</b>
|
|
23
|
-
* </p>
|
|
24
|
-
* <ul>
|
|
25
|
-
* <li>
|
|
26
|
-
* <p>To delete a secret, use <a>DeleteSecret</a>.</p>
|
|
27
|
-
* </li>
|
|
28
|
-
* </ul>
|
|
29
|
-
* @example
|
|
30
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
31
|
-
* ```javascript
|
|
32
|
-
* import { SecretsManagerClient, RestoreSecretCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import
|
|
33
|
-
* // const { SecretsManagerClient, RestoreSecretCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import
|
|
34
|
-
* const client = new SecretsManagerClient(config);
|
|
35
|
-
* const command = new RestoreSecretCommand(input);
|
|
36
|
-
* const response = await client.send(command);
|
|
37
|
-
* ```
|
|
38
|
-
*
|
|
39
|
-
* @see {@link RestoreSecretCommandInput} for command's `input` shape.
|
|
40
|
-
* @see {@link RestoreSecretCommandOutput} for command's `response` shape.
|
|
41
|
-
* @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
|
|
42
|
-
*
|
|
43
|
-
*/
|
|
9
|
+
|
|
44
10
|
export declare class RestoreSecretCommand extends $Command<RestoreSecretCommandInput, RestoreSecretCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
45
11
|
readonly input: RestoreSecretCommandInput;
|
|
46
12
|
constructor(input: RestoreSecretCommandInput);
|
|
47
|
-
|
|
48
|
-
* @internal
|
|
49
|
-
*/
|
|
13
|
+
|
|
50
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RestoreSecretCommandInput, RestoreSecretCommandOutput>;
|
|
51
15
|
private serialize;
|
|
52
16
|
private deserialize;
|
|
@@ -6,90 +6,11 @@ export interface RotateSecretCommandInput extends RotateSecretRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface RotateSecretCommandOutput extends RotateSecretResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Configures and starts the asynchronous process of rotating this secret. If you include the
|
|
11
|
-
* configuration parameters, the operation sets those values for the secret and then immediately
|
|
12
|
-
* starts a rotation. If you do not include the configuration parameters, the operation starts a
|
|
13
|
-
* rotation with the values already stored in the secret. After the rotation completes, the
|
|
14
|
-
* protected service and its clients all use the new version of the secret. </p>
|
|
15
|
-
* <p>This required configuration information includes the ARN of an Amazon Web Services Lambda function and
|
|
16
|
-
* optionally, the time between scheduled rotations. The Lambda rotation function creates a new
|
|
17
|
-
* version of the secret and creates or updates the credentials on the protected service to
|
|
18
|
-
* match. After testing the new credentials, the function marks the new secret with the staging
|
|
19
|
-
* label <code>AWSCURRENT</code> so that your clients all immediately begin to use the new version. For more
|
|
20
|
-
* information about rotating secrets and how to configure a Lambda function to rotate the
|
|
21
|
-
* secrets for your protected service, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotating Secrets in Amazon Web Services Secrets Manager</a> in the
|
|
22
|
-
* <i>Amazon Web Services Secrets Manager User Guide</i>.</p>
|
|
23
|
-
* <p>Secrets Manager schedules the next rotation when the previous
|
|
24
|
-
* one completes. Secrets Manager schedules the date by adding the rotation interval (number of days) to the
|
|
25
|
-
* actual date of the last rotation. The service chooses the hour within that 24-hour date window
|
|
26
|
-
* randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour
|
|
27
|
-
* and influenced by a variety of factors that help distribute load.</p>
|
|
28
|
-
* <p>The
|
|
29
|
-
* rotation function must end with the versions of the secret in one of two states:</p>
|
|
30
|
-
* <ul>
|
|
31
|
-
* <li>
|
|
32
|
-
* <p>The <code>AWSPENDING</code> and <code>AWSCURRENT</code> staging labels are attached to the same version of
|
|
33
|
-
* the secret, or</p>
|
|
34
|
-
* </li>
|
|
35
|
-
* <li>
|
|
36
|
-
* <p>The <code>AWSPENDING</code> staging label is not attached to any version of the secret.</p>
|
|
37
|
-
* </li>
|
|
38
|
-
* </ul>
|
|
39
|
-
* <p>If the <code>AWSPENDING</code> staging label is present but not attached to the same version as
|
|
40
|
-
* <code>AWSCURRENT</code> then any later invocation of <code>RotateSecret</code> assumes that a previous
|
|
41
|
-
* rotation request is still in progress and returns an error.</p>
|
|
42
|
-
* <p>
|
|
43
|
-
* <b>Minimum permissions</b>
|
|
44
|
-
* </p>
|
|
45
|
-
* <p>To run this command, you must have the following permissions:</p>
|
|
46
|
-
* <ul>
|
|
47
|
-
* <li>
|
|
48
|
-
* <p>secretsmanager:RotateSecret</p>
|
|
49
|
-
* </li>
|
|
50
|
-
* <li>
|
|
51
|
-
* <p>lambda:InvokeFunction (on the function specified in the secret's metadata)</p>
|
|
52
|
-
* </li>
|
|
53
|
-
* </ul>
|
|
54
|
-
* <p>
|
|
55
|
-
* <b>Related operations</b>
|
|
56
|
-
* </p>
|
|
57
|
-
* <ul>
|
|
58
|
-
* <li>
|
|
59
|
-
* <p>To list the secrets in your account, use <a>ListSecrets</a>.</p>
|
|
60
|
-
* </li>
|
|
61
|
-
* <li>
|
|
62
|
-
* <p>To get the details for a version of a secret, use <a>DescribeSecret</a>.</p>
|
|
63
|
-
* </li>
|
|
64
|
-
* <li>
|
|
65
|
-
* <p>To create a new version of a secret, use <a>CreateSecret</a>.</p>
|
|
66
|
-
* </li>
|
|
67
|
-
* <li>
|
|
68
|
-
* <p>To attach staging labels to or remove staging labels from a version of a secret, use
|
|
69
|
-
* <a>UpdateSecretVersionStage</a>.</p>
|
|
70
|
-
* </li>
|
|
71
|
-
* </ul>
|
|
72
|
-
* @example
|
|
73
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
74
|
-
* ```javascript
|
|
75
|
-
* import { SecretsManagerClient, RotateSecretCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import
|
|
76
|
-
* // const { SecretsManagerClient, RotateSecretCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import
|
|
77
|
-
* const client = new SecretsManagerClient(config);
|
|
78
|
-
* const command = new RotateSecretCommand(input);
|
|
79
|
-
* const response = await client.send(command);
|
|
80
|
-
* ```
|
|
81
|
-
*
|
|
82
|
-
* @see {@link RotateSecretCommandInput} for command's `input` shape.
|
|
83
|
-
* @see {@link RotateSecretCommandOutput} for command's `response` shape.
|
|
84
|
-
* @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape.
|
|
85
|
-
*
|
|
86
|
-
*/
|
|
9
|
+
|
|
87
10
|
export declare class RotateSecretCommand extends $Command<RotateSecretCommandInput, RotateSecretCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
88
11
|
readonly input: RotateSecretCommandInput;
|
|
89
12
|
constructor(input: RotateSecretCommandInput);
|
|
90
|
-
|
|
91
|
-
* @internal
|
|
92
|
-
*/
|
|
13
|
+
|
|
93
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecretsManagerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RotateSecretCommandInput, RotateSecretCommandOutput>;
|
|
94
15
|
private serialize;
|
|
95
16
|
private deserialize;
|