@aws-sdk/client-secrets-manager 3.534.0 → 3.535.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/dist-types/SecretsManager.d.ts +4 -1
- package/dist-types/SecretsManagerClient.d.ts +1 -1
- package/dist-types/commands/BatchGetSecretValueCommand.d.ts +2 -1
- package/dist-types/commands/CancelRotateSecretCommand.d.ts +2 -1
- package/dist-types/commands/CreateSecretCommand.d.ts +2 -1
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +2 -1
- package/dist-types/commands/DeleteSecretCommand.d.ts +2 -1
- package/dist-types/commands/DescribeSecretCommand.d.ts +2 -1
- package/dist-types/commands/GetRandomPasswordCommand.d.ts +2 -1
- package/dist-types/commands/GetResourcePolicyCommand.d.ts +2 -1
- package/dist-types/commands/GetSecretValueCommand.d.ts +2 -1
- package/dist-types/commands/ListSecretVersionIdsCommand.d.ts +2 -1
- package/dist-types/commands/ListSecretsCommand.d.ts +2 -1
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +2 -1
- package/dist-types/commands/PutSecretValueCommand.d.ts +2 -1
- package/dist-types/commands/RemoveRegionsFromReplicationCommand.d.ts +2 -1
- package/dist-types/commands/ReplicateSecretToRegionsCommand.d.ts +2 -1
- package/dist-types/commands/RestoreSecretCommand.d.ts +2 -1
- package/dist-types/commands/RotateSecretCommand.d.ts +2 -1
- package/dist-types/commands/StopReplicationToReplicaCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateSecretCommand.d.ts +2 -1
- package/dist-types/commands/UpdateSecretVersionStageCommand.d.ts +2 -1
- package/dist-types/commands/ValidateResourcePolicyCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +219 -219
- package/dist-types/ts3.4/SecretsManager.d.ts +3 -0
- package/dist-types/ts3.4/commands/BatchGetSecretValueCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CancelRotateSecretCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateSecretCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteResourcePolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteSecretCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeSecretCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetRandomPasswordCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetResourcePolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetSecretValueCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSecretVersionIdsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSecretsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutResourcePolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutSecretValueCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RemoveRegionsFromReplicationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ReplicateSecretToRegionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RestoreSecretCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RotateSecretCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopReplicationToReplicaCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateSecretCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateSecretVersionStageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ValidateResourcePolicyCommand.d.ts +9 -0
- package/package.json +40 -40
|
@@ -27,6 +27,7 @@ export interface SecretsManager {
|
|
|
27
27
|
/**
|
|
28
28
|
* @see {@link BatchGetSecretValueCommand}
|
|
29
29
|
*/
|
|
30
|
+
batchGetSecretValue(): Promise<BatchGetSecretValueCommandOutput>;
|
|
30
31
|
batchGetSecretValue(args: BatchGetSecretValueCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetSecretValueCommandOutput>;
|
|
31
32
|
batchGetSecretValue(args: BatchGetSecretValueCommandInput, cb: (err: any, data?: BatchGetSecretValueCommandOutput) => void): void;
|
|
32
33
|
batchGetSecretValue(args: BatchGetSecretValueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetSecretValueCommandOutput) => void): void;
|
|
@@ -63,6 +64,7 @@ export interface SecretsManager {
|
|
|
63
64
|
/**
|
|
64
65
|
* @see {@link GetRandomPasswordCommand}
|
|
65
66
|
*/
|
|
67
|
+
getRandomPassword(): Promise<GetRandomPasswordCommandOutput>;
|
|
66
68
|
getRandomPassword(args: GetRandomPasswordCommandInput, options?: __HttpHandlerOptions): Promise<GetRandomPasswordCommandOutput>;
|
|
67
69
|
getRandomPassword(args: GetRandomPasswordCommandInput, cb: (err: any, data?: GetRandomPasswordCommandOutput) => void): void;
|
|
68
70
|
getRandomPassword(args: GetRandomPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRandomPasswordCommandOutput) => void): void;
|
|
@@ -81,6 +83,7 @@ export interface SecretsManager {
|
|
|
81
83
|
/**
|
|
82
84
|
* @see {@link ListSecretsCommand}
|
|
83
85
|
*/
|
|
86
|
+
listSecrets(): Promise<ListSecretsCommandOutput>;
|
|
84
87
|
listSecrets(args: ListSecretsCommandInput, options?: __HttpHandlerOptions): Promise<ListSecretsCommandOutput>;
|
|
85
88
|
listSecrets(args: ListSecretsCommandInput, cb: (err: any, data?: ListSecretsCommandOutput) => void): void;
|
|
86
89
|
listSecrets(args: ListSecretsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecretsCommandOutput) => void): void;
|
|
@@ -164,7 +167,6 @@ export interface SecretsManager {
|
|
|
164
167
|
validateResourcePolicy(args: ValidateResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateResourcePolicyCommandOutput) => void): void;
|
|
165
168
|
}
|
|
166
169
|
/**
|
|
167
|
-
* @public
|
|
168
170
|
* <fullname>Amazon Web Services Secrets Manager</fullname>
|
|
169
171
|
* <p>Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.</p>
|
|
170
172
|
* <p>This guide provides descriptions of the Secrets Manager API. For more information about using this
|
|
@@ -191,6 +193,7 @@ export interface SecretsManager {
|
|
|
191
193
|
* CloudTrail, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring.html#monitoring_cloudtrail">Logging
|
|
192
194
|
* Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail</a> in the <i>Amazon Web Services Secrets Manager User Guide</i>.
|
|
193
195
|
* To learn more about CloudTrail, including enabling it and find your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">Amazon Web Services CloudTrail User Guide</a>.</p>
|
|
196
|
+
* @public
|
|
194
197
|
*/
|
|
195
198
|
export declare class SecretsManager extends SecretsManagerClient implements SecretsManager {
|
|
196
199
|
}
|
|
@@ -174,7 +174,6 @@ export type SecretsManagerClientResolvedConfigType = __SmithyResolvedConfigurati
|
|
|
174
174
|
export interface SecretsManagerClientResolvedConfig extends SecretsManagerClientResolvedConfigType {
|
|
175
175
|
}
|
|
176
176
|
/**
|
|
177
|
-
* @public
|
|
178
177
|
* <fullname>Amazon Web Services Secrets Manager</fullname>
|
|
179
178
|
* <p>Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.</p>
|
|
180
179
|
* <p>This guide provides descriptions of the Secrets Manager API. For more information about using this
|
|
@@ -201,6 +200,7 @@ export interface SecretsManagerClientResolvedConfig extends SecretsManagerClient
|
|
|
201
200
|
* CloudTrail, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring.html#monitoring_cloudtrail">Logging
|
|
202
201
|
* Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail</a> in the <i>Amazon Web Services Secrets Manager User Guide</i>.
|
|
203
202
|
* To learn more about CloudTrail, including enabling it and find your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">Amazon Web Services CloudTrail User Guide</a>.</p>
|
|
203
|
+
* @public
|
|
204
204
|
*/
|
|
205
205
|
export declare class SecretsManagerClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, SecretsManagerClientResolvedConfig> {
|
|
206
206
|
/**
|
|
@@ -22,10 +22,10 @@ export interface BatchGetSecretValueCommandOutput extends BatchGetSecretValueRes
|
|
|
22
22
|
}
|
|
23
23
|
declare const BatchGetSecretValueCommand_base: {
|
|
24
24
|
new (input: BatchGetSecretValueCommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetSecretValueCommandInput, BatchGetSecretValueCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (...[input]: [] | [BatchGetSecretValueCommandInput]): import("@smithy/smithy-client").CommandImpl<BatchGetSecretValueCommandInput, BatchGetSecretValueCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Retrieves the contents of the encrypted fields <code>SecretString</code> or <code>SecretBinary</code> for up to 20 secrets. To retrieve a single secret, call <a>GetSecretValue</a>. </p>
|
|
30
30
|
* <p>To choose which secrets to retrieve, you can specify a list of secrets by name or ARN, or you can use filters. If Secrets Manager encounters errors such as <code>AccessDeniedException</code> while attempting to retrieve any of the secrets, you can see the errors in <code>Errors</code> in the response.</p>
|
|
31
31
|
* <p>Secrets Manager generates CloudTrail <code>GetSecretValue</code> log entries for each secret you request when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
@@ -127,6 +127,7 @@ declare const BatchGetSecretValueCommand_base: {
|
|
|
127
127
|
* @throws {@link SecretsManagerServiceException}
|
|
128
128
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
129
129
|
*
|
|
130
|
+
* @public
|
|
130
131
|
* @example To retrieve the secret values for a group of secrets listed by name
|
|
131
132
|
* ```javascript
|
|
132
133
|
* // The following example gets the values for three secrets.
|
|
@@ -22,10 +22,10 @@ export interface CancelRotateSecretCommandOutput extends CancelRotateSecretRespo
|
|
|
22
22
|
}
|
|
23
23
|
declare const CancelRotateSecretCommand_base: {
|
|
24
24
|
new (input: CancelRotateSecretCommandInput): import("@smithy/smithy-client").CommandImpl<CancelRotateSecretCommandInput, CancelRotateSecretCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: CancelRotateSecretCommandInput): import("@smithy/smithy-client").CommandImpl<CancelRotateSecretCommandInput, CancelRotateSecretCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Turns off automatic rotation, and if a rotation is currently in
|
|
30
30
|
* progress, cancels the rotation.</p>
|
|
31
31
|
* <p>If you cancel a rotation in progress, it can leave the <code>VersionStage</code>
|
|
@@ -100,6 +100,7 @@ declare const CancelRotateSecretCommand_base: {
|
|
|
100
100
|
* @throws {@link SecretsManagerServiceException}
|
|
101
101
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
102
102
|
*
|
|
103
|
+
* @public
|
|
103
104
|
* @example To cancel scheduled rotation for a secret
|
|
104
105
|
* ```javascript
|
|
105
106
|
* // The following example shows how to cancel rotation for a secret. The operation sets the RotationEnabled field to false and cancels all scheduled rotations. To resume scheduled rotations, you must re-enable rotation by calling the rotate-secret operation.
|
|
@@ -22,10 +22,10 @@ export interface CreateSecretCommandOutput extends CreateSecretResponse, __Metad
|
|
|
22
22
|
}
|
|
23
23
|
declare const CreateSecretCommand_base: {
|
|
24
24
|
new (input: CreateSecretCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSecretCommandInput, CreateSecretCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: CreateSecretCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSecretCommandInput, CreateSecretCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Creates a new secret. A <i>secret</i> can be a password, a set of
|
|
30
30
|
* credentials such as a user name and password, an OAuth token, or other secret information
|
|
31
31
|
* that you store in an encrypted form in Secrets Manager. The secret also
|
|
@@ -164,6 +164,7 @@ declare const CreateSecretCommand_base: {
|
|
|
164
164
|
* @throws {@link SecretsManagerServiceException}
|
|
165
165
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
166
166
|
*
|
|
167
|
+
* @public
|
|
167
168
|
* @example To create a basic secret
|
|
168
169
|
* ```javascript
|
|
169
170
|
* // The following example shows how to create a secret. The credentials stored in the encrypted secret value are retrieved from a file on disk named mycreds.json.
|
|
@@ -22,10 +22,10 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR
|
|
|
22
22
|
}
|
|
23
23
|
declare const DeleteResourcePolicyCommand_base: {
|
|
24
24
|
new (input: DeleteResourcePolicyCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: DeleteResourcePolicyCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Deletes the resource-based permission policy attached to the secret. To attach a policy to
|
|
30
30
|
* a secret, use <a>PutResourcePolicy</a>.</p>
|
|
31
31
|
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
@@ -89,6 +89,7 @@ declare const DeleteResourcePolicyCommand_base: {
|
|
|
89
89
|
* @throws {@link SecretsManagerServiceException}
|
|
90
90
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
91
91
|
*
|
|
92
|
+
* @public
|
|
92
93
|
* @example To delete the resource-based policy attached to a secret
|
|
93
94
|
* ```javascript
|
|
94
95
|
* // The following example shows how to delete the resource-based policy that is attached to a secret.
|
|
@@ -22,10 +22,10 @@ export interface DeleteSecretCommandOutput extends DeleteSecretResponse, __Metad
|
|
|
22
22
|
}
|
|
23
23
|
declare const DeleteSecretCommand_base: {
|
|
24
24
|
new (input: DeleteSecretCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteSecretCommandInput, DeleteSecretCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: DeleteSecretCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteSecretCommandInput, DeleteSecretCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Deletes a secret and all of its versions. You can specify a recovery
|
|
30
30
|
* window during which you can restore the secret. The minimum recovery window is 7 days.
|
|
31
31
|
* The default recovery window is 30 days. Secrets Manager attaches a <code>DeletionDate</code> stamp to
|
|
@@ -112,6 +112,7 @@ declare const DeleteSecretCommand_base: {
|
|
|
112
112
|
* @throws {@link SecretsManagerServiceException}
|
|
113
113
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
114
114
|
*
|
|
115
|
+
* @public
|
|
115
116
|
* @example To delete a secret
|
|
116
117
|
* ```javascript
|
|
117
118
|
* // The following example shows how to delete a secret. The secret stays in your account in a deprecated and inaccessible state until the recovery window ends. After the date and time in the DeletionDate response field has passed, you can no longer recover this secret with restore-secret.
|
|
@@ -22,10 +22,10 @@ export interface DescribeSecretCommandOutput extends DescribeSecretResponse, __M
|
|
|
22
22
|
}
|
|
23
23
|
declare const DescribeSecretCommand_base: {
|
|
24
24
|
new (input: DescribeSecretCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeSecretCommandInput, DescribeSecretCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: DescribeSecretCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeSecretCommandInput, DescribeSecretCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager
|
|
30
30
|
* only returns fields that have a value in the response. </p>
|
|
31
31
|
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
@@ -108,6 +108,7 @@ declare const DescribeSecretCommand_base: {
|
|
|
108
108
|
* @throws {@link SecretsManagerServiceException}
|
|
109
109
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
110
110
|
*
|
|
111
|
+
* @public
|
|
111
112
|
* @example To retrieve the details of a secret
|
|
112
113
|
* ```javascript
|
|
113
114
|
* // The following example shows how to get the details about a secret.
|
|
@@ -22,10 +22,10 @@ export interface GetRandomPasswordCommandOutput extends GetRandomPasswordRespons
|
|
|
22
22
|
}
|
|
23
23
|
declare const GetRandomPasswordCommand_base: {
|
|
24
24
|
new (input: GetRandomPasswordCommandInput): import("@smithy/smithy-client").CommandImpl<GetRandomPasswordCommandInput, GetRandomPasswordCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (...[input]: [] | [GetRandomPasswordCommandInput]): import("@smithy/smithy-client").CommandImpl<GetRandomPasswordCommandInput, GetRandomPasswordCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Generates a random password. We recommend that you specify the
|
|
30
30
|
* maximum length and include every character type that the system you are generating a password
|
|
31
31
|
* for can support. By default, Secrets Manager uses uppercase and lowercase letters, numbers, and the following characters in passwords: <code>!\"#$%&'()*+,-./:;<=>?@[\\]^_`\{|\}~</code>
|
|
@@ -94,6 +94,7 @@ declare const GetRandomPasswordCommand_base: {
|
|
|
94
94
|
* @throws {@link SecretsManagerServiceException}
|
|
95
95
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
96
96
|
*
|
|
97
|
+
* @public
|
|
97
98
|
* @example To generate a random password
|
|
98
99
|
* ```javascript
|
|
99
100
|
* // The following example shows how to request a randomly generated password. This example includes the optional flags to require spaces and at least one character of each included type. It specifies a length of 20 characters.
|
|
@@ -22,10 +22,10 @@ export interface GetResourcePolicyCommandOutput extends GetResourcePolicyRespons
|
|
|
22
22
|
}
|
|
23
23
|
declare const GetResourcePolicyCommand_base: {
|
|
24
24
|
new (input: GetResourcePolicyCommandInput): import("@smithy/smithy-client").CommandImpl<GetResourcePolicyCommandInput, GetResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: GetResourcePolicyCommandInput): import("@smithy/smithy-client").CommandImpl<GetResourcePolicyCommandInput, GetResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Retrieves the JSON text of the resource-based policy document attached to the
|
|
30
30
|
* secret. For more information about permissions policies attached to a secret, see
|
|
31
31
|
* <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-policies.html">Permissions
|
|
@@ -92,6 +92,7 @@ declare const GetResourcePolicyCommand_base: {
|
|
|
92
92
|
* @throws {@link SecretsManagerServiceException}
|
|
93
93
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
94
94
|
*
|
|
95
|
+
* @public
|
|
95
96
|
* @example To retrieve the resource-based policy attached to a secret
|
|
96
97
|
* ```javascript
|
|
97
98
|
* // The following example shows how to retrieve the resource-based policy that is attached to a secret.
|
|
@@ -22,10 +22,10 @@ export interface GetSecretValueCommandOutput extends GetSecretValueResponse, __M
|
|
|
22
22
|
}
|
|
23
23
|
declare const GetSecretValueCommand_base: {
|
|
24
24
|
new (input: GetSecretValueCommandInput): import("@smithy/smithy-client").CommandImpl<GetSecretValueCommandInput, GetSecretValueCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: GetSecretValueCommandInput): import("@smithy/smithy-client").CommandImpl<GetSecretValueCommandInput, GetSecretValueCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Retrieves the contents of the encrypted fields <code>SecretString</code> or
|
|
30
30
|
* <code>SecretBinary</code> from the specified version of a secret, whichever contains
|
|
31
31
|
* content.</p>
|
|
@@ -110,6 +110,7 @@ declare const GetSecretValueCommand_base: {
|
|
|
110
110
|
* @throws {@link SecretsManagerServiceException}
|
|
111
111
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
112
112
|
*
|
|
113
|
+
* @public
|
|
113
114
|
* @example To retrieve the encrypted secret value of a secret
|
|
114
115
|
* ```javascript
|
|
115
116
|
* // The following example shows how to retrieve a secret string value.
|
|
@@ -22,10 +22,10 @@ export interface ListSecretVersionIdsCommandOutput extends ListSecretVersionIdsR
|
|
|
22
22
|
}
|
|
23
23
|
declare const ListSecretVersionIdsCommand_base: {
|
|
24
24
|
new (input: ListSecretVersionIdsCommandInput): import("@smithy/smithy-client").CommandImpl<ListSecretVersionIdsCommandInput, ListSecretVersionIdsCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: ListSecretVersionIdsCommandInput): import("@smithy/smithy-client").CommandImpl<ListSecretVersionIdsCommandInput, ListSecretVersionIdsCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions
|
|
30
30
|
* of a secret. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version">
|
|
31
31
|
* Secrets Manager concepts: Versions</a>.</p>
|
|
@@ -93,6 +93,7 @@ declare const ListSecretVersionIdsCommand_base: {
|
|
|
93
93
|
* @throws {@link SecretsManagerServiceException}
|
|
94
94
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
95
95
|
*
|
|
96
|
+
* @public
|
|
96
97
|
* @example To list all of the secret versions associated with a secret
|
|
97
98
|
* ```javascript
|
|
98
99
|
* // The following example shows how to retrieve a list of all of the versions of a secret, including those without any staging labels.
|
|
@@ -22,10 +22,10 @@ export interface ListSecretsCommandOutput extends ListSecretsResponse, __Metadat
|
|
|
22
22
|
}
|
|
23
23
|
declare const ListSecretsCommand_base: {
|
|
24
24
|
new (input: ListSecretsCommandInput): import("@smithy/smithy-client").CommandImpl<ListSecretsCommandInput, ListSecretsCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (...[input]: [] | [ListSecretsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListSecretsCommandInput, ListSecretsCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets
|
|
30
30
|
* that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.</p>
|
|
31
31
|
* <p>All Secrets Manager operations are eventually consistent. ListSecrets might not reflect changes from the last five minutes. You can get more recent information for a specific secret by calling <a>DescribeSecret</a>.</p>
|
|
@@ -137,6 +137,7 @@ declare const ListSecretsCommand_base: {
|
|
|
137
137
|
* @throws {@link SecretsManagerServiceException}
|
|
138
138
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
139
139
|
*
|
|
140
|
+
* @public
|
|
140
141
|
* @example To list the secrets in your account
|
|
141
142
|
* ```javascript
|
|
142
143
|
* // The following example shows how to list all of the secrets in your account.
|
|
@@ -22,10 +22,10 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons
|
|
|
22
22
|
}
|
|
23
23
|
declare const PutResourcePolicyCommand_base: {
|
|
24
24
|
new (input: PutResourcePolicyCommandInput): import("@smithy/smithy-client").CommandImpl<PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: PutResourcePolicyCommandInput): import("@smithy/smithy-client").CommandImpl<PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Attaches a resource-based permission policy to a secret. A resource-based policy is
|
|
30
30
|
* optional. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication and access control for Secrets Manager</a>
|
|
31
31
|
* </p>
|
|
@@ -100,6 +100,7 @@ declare const PutResourcePolicyCommand_base: {
|
|
|
100
100
|
* @throws {@link SecretsManagerServiceException}
|
|
101
101
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
102
102
|
*
|
|
103
|
+
* @public
|
|
103
104
|
* @example To add a resource-based policy to a secret
|
|
104
105
|
* ```javascript
|
|
105
106
|
* // The following example shows how to add a resource-based policy to a secret.
|
|
@@ -22,10 +22,10 @@ export interface PutSecretValueCommandOutput extends PutSecretValueResponse, __M
|
|
|
22
22
|
}
|
|
23
23
|
declare const PutSecretValueCommand_base: {
|
|
24
24
|
new (input: PutSecretValueCommandInput): import("@smithy/smithy-client").CommandImpl<PutSecretValueCommandInput, PutSecretValueCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: PutSecretValueCommandInput): import("@smithy/smithy-client").CommandImpl<PutSecretValueCommandInput, PutSecretValueCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Creates a new version with a new encrypted secret value and attaches it to the secret. The
|
|
30
30
|
* version can contain a new <code>SecretString</code> value or a new <code>SecretBinary</code> value. </p>
|
|
31
31
|
* <p>We recommend you avoid calling <code>PutSecretValue</code> at a sustained rate of more than
|
|
@@ -132,6 +132,7 @@ declare const PutSecretValueCommand_base: {
|
|
|
132
132
|
* @throws {@link SecretsManagerServiceException}
|
|
133
133
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
134
134
|
*
|
|
135
|
+
* @public
|
|
135
136
|
* @example To store a secret value in a new version of a secret
|
|
136
137
|
* ```javascript
|
|
137
138
|
* // The following example shows how to create a new version of the secret. Alternatively, you can use the update-secret command.
|
|
@@ -22,10 +22,10 @@ export interface RemoveRegionsFromReplicationCommandOutput extends RemoveRegions
|
|
|
22
22
|
}
|
|
23
23
|
declare const RemoveRegionsFromReplicationCommand_base: {
|
|
24
24
|
new (input: RemoveRegionsFromReplicationCommandInput): import("@smithy/smithy-client").CommandImpl<RemoveRegionsFromReplicationCommandInput, RemoveRegionsFromReplicationCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: RemoveRegionsFromReplicationCommandInput): import("@smithy/smithy-client").CommandImpl<RemoveRegionsFromReplicationCommandInput, RemoveRegionsFromReplicationCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.</p>
|
|
30
30
|
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
31
31
|
* <p>
|
|
@@ -99,6 +99,7 @@ declare const RemoveRegionsFromReplicationCommand_base: {
|
|
|
99
99
|
* @throws {@link SecretsManagerServiceException}
|
|
100
100
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
101
101
|
*
|
|
102
|
+
* @public
|
|
102
103
|
*/
|
|
103
104
|
export declare class RemoveRegionsFromReplicationCommand extends RemoveRegionsFromReplicationCommand_base {
|
|
104
105
|
}
|
|
@@ -22,10 +22,10 @@ export interface ReplicateSecretToRegionsCommandOutput extends ReplicateSecretTo
|
|
|
22
22
|
}
|
|
23
23
|
declare const ReplicateSecretToRegionsCommand_base: {
|
|
24
24
|
new (input: ReplicateSecretToRegionsCommandInput): import("@smithy/smithy-client").CommandImpl<ReplicateSecretToRegionsCommandInput, ReplicateSecretToRegionsCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: ReplicateSecretToRegionsCommandInput): import("@smithy/smithy-client").CommandImpl<ReplicateSecretToRegionsCommandInput, ReplicateSecretToRegionsCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Replicates the secret to a new Regions. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/create-manage-multi-region-secrets.html">Multi-Region secrets</a>.</p>
|
|
30
30
|
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
31
31
|
* <p>
|
|
@@ -103,6 +103,7 @@ declare const ReplicateSecretToRegionsCommand_base: {
|
|
|
103
103
|
* @throws {@link SecretsManagerServiceException}
|
|
104
104
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
105
105
|
*
|
|
106
|
+
* @public
|
|
106
107
|
* @example Example
|
|
107
108
|
* ```javascript
|
|
108
109
|
* // The following example replicates a secret to eu-west-3. The replica is encrypted with the AWS managed key aws/secretsmanager.
|
|
@@ -22,10 +22,10 @@ export interface RestoreSecretCommandOutput extends RestoreSecretResponse, __Met
|
|
|
22
22
|
}
|
|
23
23
|
declare const RestoreSecretCommand_base: {
|
|
24
24
|
new (input: RestoreSecretCommandInput): import("@smithy/smithy-client").CommandImpl<RestoreSecretCommandInput, RestoreSecretCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: RestoreSecretCommandInput): import("@smithy/smithy-client").CommandImpl<RestoreSecretCommandInput, RestoreSecretCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Cancels the scheduled deletion of a secret by removing the <code>DeletedDate</code> time
|
|
30
30
|
* stamp. You can access a secret again after it has been restored.</p>
|
|
31
31
|
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
@@ -89,6 +89,7 @@ declare const RestoreSecretCommand_base: {
|
|
|
89
89
|
* @throws {@link SecretsManagerServiceException}
|
|
90
90
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
91
91
|
*
|
|
92
|
+
* @public
|
|
92
93
|
* @example To restore a previously deleted secret
|
|
93
94
|
* ```javascript
|
|
94
95
|
* // The following example shows how to restore a secret that you previously scheduled for deletion.
|
|
@@ -22,10 +22,10 @@ export interface RotateSecretCommandOutput extends RotateSecretResponse, __Metad
|
|
|
22
22
|
}
|
|
23
23
|
declare const RotateSecretCommand_base: {
|
|
24
24
|
new (input: RotateSecretCommandInput): import("@smithy/smithy-client").CommandImpl<RotateSecretCommandInput, RotateSecretCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: RotateSecretCommandInput): import("@smithy/smithy-client").CommandImpl<RotateSecretCommandInput, RotateSecretCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Configures and starts the asynchronous process of rotating the secret. For information about rotation,
|
|
30
30
|
* see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotate secrets</a> in the <i>Secrets Manager User Guide</i>. If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret. </p>
|
|
31
31
|
* <p>When rotation is successful, the <code>AWSPENDING</code> staging label might be attached
|
|
@@ -105,6 +105,7 @@ declare const RotateSecretCommand_base: {
|
|
|
105
105
|
* @throws {@link SecretsManagerServiceException}
|
|
106
106
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
107
107
|
*
|
|
108
|
+
* @public
|
|
108
109
|
* @example To configure rotation for a secret
|
|
109
110
|
* ```javascript
|
|
110
111
|
* // The following example configures rotation for a secret using a cron expression. The first rotation happens immediately after the changes are stored in the secret. The rotation schedule is the first and 15th day of every month. The rotation window begins at 4:00 PM UTC and ends at 6:00 PM.
|
|
@@ -22,10 +22,10 @@ export interface StopReplicationToReplicaCommandOutput extends StopReplicationTo
|
|
|
22
22
|
}
|
|
23
23
|
declare const StopReplicationToReplicaCommand_base: {
|
|
24
24
|
new (input: StopReplicationToReplicaCommandInput): import("@smithy/smithy-client").CommandImpl<StopReplicationToReplicaCommandInput, StopReplicationToReplicaCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: StopReplicationToReplicaCommandInput): import("@smithy/smithy-client").CommandImpl<StopReplicationToReplicaCommandInput, StopReplicationToReplicaCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.</p>
|
|
30
30
|
* <p>You must call this operation from the Region in which you want to promote the replica to a primary secret.</p>
|
|
31
31
|
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
@@ -88,6 +88,7 @@ declare const StopReplicationToReplicaCommand_base: {
|
|
|
88
88
|
* @throws {@link SecretsManagerServiceException}
|
|
89
89
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
90
90
|
*
|
|
91
|
+
* @public
|
|
91
92
|
*/
|
|
92
93
|
export declare class StopReplicationToReplicaCommand extends StopReplicationToReplicaCommand_base {
|
|
93
94
|
}
|
|
@@ -22,10 +22,10 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
}
|
|
23
23
|
declare const TagResourceCommand_base: {
|
|
24
24
|
new (input: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the
|
|
30
30
|
* secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.</p>
|
|
31
31
|
* <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 Tagging</a> in the <i>Amazon Web Services General
|
|
@@ -100,6 +100,7 @@ declare const TagResourceCommand_base: {
|
|
|
100
100
|
* @throws {@link SecretsManagerServiceException}
|
|
101
101
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
102
102
|
*
|
|
103
|
+
* @public
|
|
103
104
|
* @example To add tags to a secret
|
|
104
105
|
* ```javascript
|
|
105
106
|
* // The following example shows how to attach two tags each with a Key and Value to a secret. There is no output from this API. To see the result, use the DescribeSecret operation.
|
|
@@ -22,10 +22,10 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
}
|
|
23
23
|
declare const UntagResourceCommand_base: {
|
|
24
24
|
new (input: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Removes specific tags from a secret.</p>
|
|
30
30
|
* <p>This operation is idempotent. If a requested tag is not attached to the secret, no error
|
|
31
31
|
* is returned and the secret metadata is unchanged.</p>
|
|
@@ -96,6 +96,7 @@ declare const UntagResourceCommand_base: {
|
|
|
96
96
|
* @throws {@link SecretsManagerServiceException}
|
|
97
97
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
98
98
|
*
|
|
99
|
+
* @public
|
|
99
100
|
* @example To remove tags from a secret
|
|
100
101
|
* ```javascript
|
|
101
102
|
* // The following example shows how to remove two tags from a secret's metadata. For each, both the tag and the associated value are removed. There is no output from this API. To see the result, use the DescribeSecret operation.
|
|
@@ -22,10 +22,10 @@ export interface UpdateSecretCommandOutput extends UpdateSecretResponse, __Metad
|
|
|
22
22
|
}
|
|
23
23
|
declare const UpdateSecretCommand_base: {
|
|
24
24
|
new (input: UpdateSecretCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSecretCommandInput, UpdateSecretCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: UpdateSecretCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSecretCommandInput, UpdateSecretCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use <a>PutSecretValue</a>.</p>
|
|
30
30
|
* <p>To change the rotation configuration of a secret, use <a>RotateSecret</a> instead.</p>
|
|
31
31
|
* <p>To change a secret so that it is managed by another service, you need to recreate the secret in that service. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets Manager secrets managed by other Amazon Web Services services</a>.</p>
|
|
@@ -133,6 +133,7 @@ declare const UpdateSecretCommand_base: {
|
|
|
133
133
|
* @throws {@link SecretsManagerServiceException}
|
|
134
134
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
135
135
|
*
|
|
136
|
+
* @public
|
|
136
137
|
* @example To update the description of a secret
|
|
137
138
|
* ```javascript
|
|
138
139
|
* // The following example shows how to modify the description of a secret.
|
|
@@ -22,10 +22,10 @@ export interface UpdateSecretVersionStageCommandOutput extends UpdateSecretVersi
|
|
|
22
22
|
}
|
|
23
23
|
declare const UpdateSecretVersionStageCommand_base: {
|
|
24
24
|
new (input: UpdateSecretVersionStageCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSecretVersionStageCommandInput, UpdateSecretVersionStageCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: UpdateSecretVersionStageCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSecretVersionStageCommandInput, UpdateSecretVersionStageCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to
|
|
30
30
|
* track a version as it progresses through the secret rotation process. Each staging label can be
|
|
31
31
|
* attached to only one version at a time. To add a staging label to a version when it is already
|
|
@@ -108,6 +108,7 @@ declare const UpdateSecretVersionStageCommand_base: {
|
|
|
108
108
|
* @throws {@link SecretsManagerServiceException}
|
|
109
109
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
110
110
|
*
|
|
111
|
+
* @public
|
|
111
112
|
* @example To add a staging label attached to a version of a secret
|
|
112
113
|
* ```javascript
|
|
113
114
|
* // The following example shows you how to add a staging label to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.
|
|
@@ -22,10 +22,10 @@ export interface ValidateResourcePolicyCommandOutput extends ValidateResourcePol
|
|
|
22
22
|
}
|
|
23
23
|
declare const ValidateResourcePolicyCommand_base: {
|
|
24
24
|
new (input: ValidateResourcePolicyCommandInput): import("@smithy/smithy-client").CommandImpl<ValidateResourcePolicyCommandInput, ValidateResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: ValidateResourcePolicyCommandInput): import("@smithy/smithy-client").CommandImpl<ValidateResourcePolicyCommandInput, ValidateResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Validates that a resource policy does not grant a wide range of principals access to
|
|
30
30
|
* your secret. A resource-based policy is optional for secrets.</p>
|
|
31
31
|
* <p>The API performs three checks when validating the policy:</p>
|
|
@@ -111,6 +111,7 @@ declare const ValidateResourcePolicyCommand_base: {
|
|
|
111
111
|
* @throws {@link SecretsManagerServiceException}
|
|
112
112
|
* <p>Base exception class for all service exceptions from SecretsManager service.</p>
|
|
113
113
|
*
|
|
114
|
+
* @public
|
|
114
115
|
* @example To validate a resource-based policy to a secret
|
|
115
116
|
* ```javascript
|
|
116
117
|
* // The following example shows how to validate a resource-based policy to a secret.
|