@aws-sdk/client-secrets-manager 3.289.0 → 3.290.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/commands/CancelRotateSecretCommand.d.ts +28 -0
- package/dist-types/commands/CreateSecretCommand.d.ts +48 -0
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +28 -0
- package/dist-types/commands/DeleteSecretCommand.d.ts +28 -0
- package/dist-types/commands/DescribeSecretCommand.d.ts +10 -0
- package/dist-types/commands/GetRandomPasswordCommand.d.ts +25 -0
- package/dist-types/commands/GetResourcePolicyCommand.d.ts +28 -0
- package/dist-types/commands/GetSecretValueCommand.d.ts +31 -0
- package/dist-types/commands/ListSecretVersionIdsCommand.d.ts +13 -0
- package/dist-types/commands/ListSecretsCommand.d.ts +10 -0
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +34 -0
- package/dist-types/commands/PutSecretValueCommand.d.ts +42 -0
- package/dist-types/commands/RemoveRegionsFromReplicationCommand.d.ts +28 -0
- package/dist-types/commands/ReplicateSecretToRegionsCommand.d.ts +28 -0
- package/dist-types/commands/RestoreSecretCommand.d.ts +28 -0
- package/dist-types/commands/RotateSecretCommand.d.ts +28 -0
- package/dist-types/commands/StopReplicationToReplicaCommand.d.ts +28 -0
- package/dist-types/commands/TagResourceCommand.d.ts +28 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +28 -0
- package/dist-types/commands/UpdateSecretCommand.d.ts +48 -0
- package/dist-types/commands/UpdateSecretVersionStageCommand.d.ts +31 -0
- package/dist-types/commands/ValidateResourcePolicyCommand.d.ts +31 -0
- package/package.json +29 -29
|
@@ -47,6 +47,34 @@ export interface CancelRotateSecretCommandOutput extends CancelRotateSecretRespo
|
|
|
47
47
|
* @see {@link CancelRotateSecretCommandOutput} for command's `response` shape.
|
|
48
48
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
49
49
|
*
|
|
50
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
51
|
+
* <p>An error occurred on the server side.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
54
|
+
* <p>The parameter name or value is invalid.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
57
|
+
* <p>A parameter value is not valid for the current state of the
|
|
58
|
+
* resource.</p>
|
|
59
|
+
* <p>Possible causes:</p>
|
|
60
|
+
* <ul>
|
|
61
|
+
* <li>
|
|
62
|
+
* <p>The secret is scheduled for deletion.</p>
|
|
63
|
+
* </li>
|
|
64
|
+
* <li>
|
|
65
|
+
* <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
|
|
66
|
+
* ARN configured and you didn't include such an ARN as a parameter in this call. </p>
|
|
67
|
+
* </li>
|
|
68
|
+
* <li>
|
|
69
|
+
* <p>The secret is managed by another service, and you must use that service to update it.
|
|
70
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
|
|
71
|
+
* </li>
|
|
72
|
+
* </ul>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
75
|
+
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
76
|
+
*
|
|
77
|
+
*
|
|
50
78
|
* @example To cancel scheduled rotation for a secret
|
|
51
79
|
* ```javascript
|
|
52
80
|
* // 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.
|
|
@@ -64,6 +64,54 @@ export interface CreateSecretCommandOutput extends CreateSecretResponse, __Metad
|
|
|
64
64
|
* @see {@link CreateSecretCommandOutput} for command's `response` shape.
|
|
65
65
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
66
66
|
*
|
|
67
|
+
* @throws {@link DecryptionFailure} (client fault)
|
|
68
|
+
* <p>Secrets Manager can't decrypt the protected secret text using the provided KMS key. </p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link EncryptionFailure} (client fault)
|
|
71
|
+
* <p>Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the
|
|
72
|
+
* KMS key is available, enabled, and not in an invalid state. For more
|
|
73
|
+
* information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a>.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
76
|
+
* <p>An error occurred on the server side.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
79
|
+
* <p>The parameter name or value is invalid.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
82
|
+
* <p>A parameter value is not valid for the current state of the
|
|
83
|
+
* resource.</p>
|
|
84
|
+
* <p>Possible causes:</p>
|
|
85
|
+
* <ul>
|
|
86
|
+
* <li>
|
|
87
|
+
* <p>The secret is scheduled for deletion.</p>
|
|
88
|
+
* </li>
|
|
89
|
+
* <li>
|
|
90
|
+
* <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
|
|
91
|
+
* ARN configured and you didn't include such an ARN as a parameter in this call. </p>
|
|
92
|
+
* </li>
|
|
93
|
+
* <li>
|
|
94
|
+
* <p>The secret is managed by another service, and you must use that service to update it.
|
|
95
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
|
|
96
|
+
* </li>
|
|
97
|
+
* </ul>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
100
|
+
* <p>The request failed because it would exceed one of the Secrets Manager quotas.</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link MalformedPolicyDocumentException} (client fault)
|
|
103
|
+
* <p>The resource policy has syntax errors.</p>
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link PreconditionNotMetException} (client fault)
|
|
106
|
+
* <p>The request failed because you did not complete all the prerequisite steps.</p>
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link ResourceExistsException} (client fault)
|
|
109
|
+
* <p>A resource with the ID you requested already exists.</p>
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
112
|
+
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
113
|
+
*
|
|
114
|
+
*
|
|
67
115
|
* @example To create a basic secret
|
|
68
116
|
* ```javascript
|
|
69
117
|
* // 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.
|
|
@@ -37,6 +37,34 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR
|
|
|
37
37
|
* @see {@link DeleteResourcePolicyCommandOutput} for command's `response` shape.
|
|
38
38
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
39
39
|
*
|
|
40
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
41
|
+
* <p>An error occurred on the server side.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
44
|
+
* <p>The parameter name or value is invalid.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
47
|
+
* <p>A parameter value is not valid for the current state of the
|
|
48
|
+
* resource.</p>
|
|
49
|
+
* <p>Possible causes:</p>
|
|
50
|
+
* <ul>
|
|
51
|
+
* <li>
|
|
52
|
+
* <p>The secret is scheduled for deletion.</p>
|
|
53
|
+
* </li>
|
|
54
|
+
* <li>
|
|
55
|
+
* <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
|
|
56
|
+
* ARN configured and you didn't include such an ARN as a parameter in this call. </p>
|
|
57
|
+
* </li>
|
|
58
|
+
* <li>
|
|
59
|
+
* <p>The secret is managed by another service, and you must use that service to update it.
|
|
60
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
|
|
61
|
+
* </li>
|
|
62
|
+
* </ul>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
65
|
+
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
66
|
+
*
|
|
67
|
+
*
|
|
40
68
|
* @example To delete the resource-based policy attached to a secret
|
|
41
69
|
* ```javascript
|
|
42
70
|
* // The following example shows how to delete the resource-based policy that is attached to a secret.
|
|
@@ -57,6 +57,34 @@ export interface DeleteSecretCommandOutput extends DeleteSecretResponse, __Metad
|
|
|
57
57
|
* @see {@link DeleteSecretCommandOutput} for command's `response` shape.
|
|
58
58
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
59
59
|
*
|
|
60
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
61
|
+
* <p>An error occurred on the server side.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
64
|
+
* <p>The parameter name or value is invalid.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
67
|
+
* <p>A parameter value is not valid for the current state of the
|
|
68
|
+
* resource.</p>
|
|
69
|
+
* <p>Possible causes:</p>
|
|
70
|
+
* <ul>
|
|
71
|
+
* <li>
|
|
72
|
+
* <p>The secret is scheduled for deletion.</p>
|
|
73
|
+
* </li>
|
|
74
|
+
* <li>
|
|
75
|
+
* <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
|
|
76
|
+
* ARN configured and you didn't include such an ARN as a parameter in this call. </p>
|
|
77
|
+
* </li>
|
|
78
|
+
* <li>
|
|
79
|
+
* <p>The secret is managed by another service, and you must use that service to update it.
|
|
80
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
|
|
81
|
+
* </li>
|
|
82
|
+
* </ul>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
85
|
+
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
86
|
+
*
|
|
87
|
+
*
|
|
60
88
|
* @example To delete a secret
|
|
61
89
|
* ```javascript
|
|
62
90
|
* // 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.
|
|
@@ -37,6 +37,16 @@ export interface DescribeSecretCommandOutput extends DescribeSecretResponse, __M
|
|
|
37
37
|
* @see {@link DescribeSecretCommandOutput} for command's `response` shape.
|
|
38
38
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
39
39
|
*
|
|
40
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
41
|
+
* <p>An error occurred on the server side.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
44
|
+
* <p>The parameter name or value is invalid.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
47
|
+
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
48
|
+
*
|
|
49
|
+
*
|
|
40
50
|
* @example To retrieve the details of a secret
|
|
41
51
|
* ```javascript
|
|
42
52
|
* // The following example shows how to get the details about a secret.
|
|
@@ -38,6 +38,31 @@ export interface GetRandomPasswordCommandOutput extends GetRandomPasswordRespons
|
|
|
38
38
|
* @see {@link GetRandomPasswordCommandOutput} for command's `response` shape.
|
|
39
39
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
40
40
|
*
|
|
41
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
42
|
+
* <p>An error occurred on the server side.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
45
|
+
* <p>The parameter name or value is invalid.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
48
|
+
* <p>A parameter value is not valid for the current state of the
|
|
49
|
+
* resource.</p>
|
|
50
|
+
* <p>Possible causes:</p>
|
|
51
|
+
* <ul>
|
|
52
|
+
* <li>
|
|
53
|
+
* <p>The secret is scheduled for deletion.</p>
|
|
54
|
+
* </li>
|
|
55
|
+
* <li>
|
|
56
|
+
* <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
|
|
57
|
+
* ARN configured and you didn't include such an ARN as a parameter in this call. </p>
|
|
58
|
+
* </li>
|
|
59
|
+
* <li>
|
|
60
|
+
* <p>The secret is managed by another service, and you must use that service to update it.
|
|
61
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
|
|
62
|
+
* </li>
|
|
63
|
+
* </ul>
|
|
64
|
+
*
|
|
65
|
+
*
|
|
41
66
|
* @example To generate a random password
|
|
42
67
|
* ```javascript
|
|
43
68
|
* // 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.
|
|
@@ -39,6 +39,34 @@ export interface GetResourcePolicyCommandOutput extends GetResourcePolicyRespons
|
|
|
39
39
|
* @see {@link GetResourcePolicyCommandOutput} for command's `response` shape.
|
|
40
40
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
41
41
|
*
|
|
42
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
43
|
+
* <p>An error occurred on the server side.</p>
|
|
44
|
+
*
|
|
45
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
46
|
+
* <p>The parameter name or value is invalid.</p>
|
|
47
|
+
*
|
|
48
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
49
|
+
* <p>A parameter value is not valid for the current state of the
|
|
50
|
+
* resource.</p>
|
|
51
|
+
* <p>Possible causes:</p>
|
|
52
|
+
* <ul>
|
|
53
|
+
* <li>
|
|
54
|
+
* <p>The secret is scheduled for deletion.</p>
|
|
55
|
+
* </li>
|
|
56
|
+
* <li>
|
|
57
|
+
* <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
|
|
58
|
+
* ARN configured and you didn't include such an ARN as a parameter in this call. </p>
|
|
59
|
+
* </li>
|
|
60
|
+
* <li>
|
|
61
|
+
* <p>The secret is managed by another service, and you must use that service to update it.
|
|
62
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
|
|
63
|
+
* </li>
|
|
64
|
+
* </ul>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
67
|
+
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
68
|
+
*
|
|
69
|
+
*
|
|
42
70
|
* @example To retrieve the resource-based policy attached to a secret
|
|
43
71
|
* ```javascript
|
|
44
72
|
* // The following example shows how to retrieve the resource-based policy that is attached to a secret.
|
|
@@ -45,6 +45,37 @@ export interface GetSecretValueCommandOutput extends GetSecretValueResponse, __M
|
|
|
45
45
|
* @see {@link GetSecretValueCommandOutput} for command's `response` shape.
|
|
46
46
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
47
47
|
*
|
|
48
|
+
* @throws {@link DecryptionFailure} (client fault)
|
|
49
|
+
* <p>Secrets Manager can't decrypt the protected secret text using the provided KMS key. </p>
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
52
|
+
* <p>An error occurred on the server side.</p>
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
55
|
+
* <p>The parameter name or value is invalid.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
58
|
+
* <p>A parameter value is not valid for the current state of the
|
|
59
|
+
* resource.</p>
|
|
60
|
+
* <p>Possible causes:</p>
|
|
61
|
+
* <ul>
|
|
62
|
+
* <li>
|
|
63
|
+
* <p>The secret is scheduled for deletion.</p>
|
|
64
|
+
* </li>
|
|
65
|
+
* <li>
|
|
66
|
+
* <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
|
|
67
|
+
* ARN configured and you didn't include such an ARN as a parameter in this call. </p>
|
|
68
|
+
* </li>
|
|
69
|
+
* <li>
|
|
70
|
+
* <p>The secret is managed by another service, and you must use that service to update it.
|
|
71
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
|
|
72
|
+
* </li>
|
|
73
|
+
* </ul>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
76
|
+
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
77
|
+
*
|
|
78
|
+
*
|
|
48
79
|
* @example To retrieve the encrypted secret value of a secret
|
|
49
80
|
* ```javascript
|
|
50
81
|
* // The following example shows how to retrieve a secret string value.
|
|
@@ -39,6 +39,19 @@ export interface ListSecretVersionIdsCommandOutput extends ListSecretVersionIdsR
|
|
|
39
39
|
* @see {@link ListSecretVersionIdsCommandOutput} for command's `response` shape.
|
|
40
40
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
41
41
|
*
|
|
42
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
43
|
+
* <p>An error occurred on the server side.</p>
|
|
44
|
+
*
|
|
45
|
+
* @throws {@link InvalidNextTokenException} (client fault)
|
|
46
|
+
* <p>The <code>NextToken</code> value is invalid.</p>
|
|
47
|
+
*
|
|
48
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
49
|
+
* <p>The parameter name or value is invalid.</p>
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
52
|
+
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
53
|
+
*
|
|
54
|
+
*
|
|
42
55
|
* @example To list all of the secret versions associated with a secret
|
|
43
56
|
* ```javascript
|
|
44
57
|
* // The following example shows how to retrieve a list of all of the versions of a secret, including those without any staging labels.
|
|
@@ -43,6 +43,16 @@ export interface ListSecretsCommandOutput extends ListSecretsResponse, __Metadat
|
|
|
43
43
|
* @see {@link ListSecretsCommandOutput} for command's `response` shape.
|
|
44
44
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
45
45
|
*
|
|
46
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
47
|
+
* <p>An error occurred on the server side.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link InvalidNextTokenException} (client fault)
|
|
50
|
+
* <p>The <code>NextToken</code> value is invalid.</p>
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
53
|
+
* <p>The parameter name or value is invalid.</p>
|
|
54
|
+
*
|
|
55
|
+
*
|
|
46
56
|
* @example To list the secrets in your account
|
|
47
57
|
* ```javascript
|
|
48
58
|
* // The following example shows how to list all of the secrets in your account.
|
|
@@ -40,6 +40,40 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons
|
|
|
40
40
|
* @see {@link PutResourcePolicyCommandOutput} for command's `response` shape.
|
|
41
41
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
42
42
|
*
|
|
43
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
44
|
+
* <p>An error occurred on the server side.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
47
|
+
* <p>The parameter name or value is invalid.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
50
|
+
* <p>A parameter value is not valid for the current state of the
|
|
51
|
+
* resource.</p>
|
|
52
|
+
* <p>Possible causes:</p>
|
|
53
|
+
* <ul>
|
|
54
|
+
* <li>
|
|
55
|
+
* <p>The secret is scheduled for deletion.</p>
|
|
56
|
+
* </li>
|
|
57
|
+
* <li>
|
|
58
|
+
* <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
|
|
59
|
+
* ARN configured and you didn't include such an ARN as a parameter in this call. </p>
|
|
60
|
+
* </li>
|
|
61
|
+
* <li>
|
|
62
|
+
* <p>The secret is managed by another service, and you must use that service to update it.
|
|
63
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
|
|
64
|
+
* </li>
|
|
65
|
+
* </ul>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link MalformedPolicyDocumentException} (client fault)
|
|
68
|
+
* <p>The resource policy has syntax errors.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link PublicPolicyException} (client fault)
|
|
71
|
+
* <p>The <code>BlockPublicPolicy</code> parameter is set to true, and the resource policy did not prevent broad access to the secret.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
74
|
+
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
75
|
+
*
|
|
76
|
+
*
|
|
43
77
|
* @example To add a resource-based policy to a secret
|
|
44
78
|
* ```javascript
|
|
45
79
|
* // The following example shows how to add a resource-based policy to a secret.
|
|
@@ -56,6 +56,48 @@ export interface PutSecretValueCommandOutput extends PutSecretValueResponse, __M
|
|
|
56
56
|
* @see {@link PutSecretValueCommandOutput} for command's `response` shape.
|
|
57
57
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
58
58
|
*
|
|
59
|
+
* @throws {@link DecryptionFailure} (client fault)
|
|
60
|
+
* <p>Secrets Manager can't decrypt the protected secret text using the provided KMS key. </p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link EncryptionFailure} (client fault)
|
|
63
|
+
* <p>Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the
|
|
64
|
+
* KMS key is available, enabled, and not in an invalid state. For more
|
|
65
|
+
* information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a>.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
68
|
+
* <p>An error occurred on the server side.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
71
|
+
* <p>The parameter name or value is invalid.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
74
|
+
* <p>A parameter value is not valid for the current state of the
|
|
75
|
+
* resource.</p>
|
|
76
|
+
* <p>Possible causes:</p>
|
|
77
|
+
* <ul>
|
|
78
|
+
* <li>
|
|
79
|
+
* <p>The secret is scheduled for deletion.</p>
|
|
80
|
+
* </li>
|
|
81
|
+
* <li>
|
|
82
|
+
* <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
|
|
83
|
+
* ARN configured and you didn't include such an ARN as a parameter in this call. </p>
|
|
84
|
+
* </li>
|
|
85
|
+
* <li>
|
|
86
|
+
* <p>The secret is managed by another service, and you must use that service to update it.
|
|
87
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
|
|
88
|
+
* </li>
|
|
89
|
+
* </ul>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
92
|
+
* <p>The request failed because it would exceed one of the Secrets Manager quotas.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link ResourceExistsException} (client fault)
|
|
95
|
+
* <p>A resource with the ID you requested already exists.</p>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
98
|
+
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
99
|
+
*
|
|
100
|
+
*
|
|
59
101
|
* @example To store a secret value in a new version of a secret
|
|
60
102
|
* ```javascript
|
|
61
103
|
* // The following example shows how to create a new version of the secret. Alternatively, you can use the update-secret command.
|
|
@@ -36,6 +36,34 @@ export interface RemoveRegionsFromReplicationCommandOutput extends RemoveRegions
|
|
|
36
36
|
* @see {@link RemoveRegionsFromReplicationCommandOutput} for command's `response` shape.
|
|
37
37
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
38
38
|
*
|
|
39
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
40
|
+
* <p>An error occurred on the server side.</p>
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
43
|
+
* <p>The parameter name or value is invalid.</p>
|
|
44
|
+
*
|
|
45
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
46
|
+
* <p>A parameter value is not valid for the current state of the
|
|
47
|
+
* resource.</p>
|
|
48
|
+
* <p>Possible causes:</p>
|
|
49
|
+
* <ul>
|
|
50
|
+
* <li>
|
|
51
|
+
* <p>The secret is scheduled for deletion.</p>
|
|
52
|
+
* </li>
|
|
53
|
+
* <li>
|
|
54
|
+
* <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
|
|
55
|
+
* ARN configured and you didn't include such an ARN as a parameter in this call. </p>
|
|
56
|
+
* </li>
|
|
57
|
+
* <li>
|
|
58
|
+
* <p>The secret is managed by another service, and you must use that service to update it.
|
|
59
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
|
|
60
|
+
* </li>
|
|
61
|
+
* </ul>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
64
|
+
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
65
|
+
*
|
|
66
|
+
*
|
|
39
67
|
*/
|
|
40
68
|
export declare class RemoveRegionsFromReplicationCommand extends $Command<RemoveRegionsFromReplicationCommandInput, RemoveRegionsFromReplicationCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
41
69
|
readonly input: RemoveRegionsFromReplicationCommandInput;
|
|
@@ -36,6 +36,34 @@ export interface ReplicateSecretToRegionsCommandOutput extends ReplicateSecretTo
|
|
|
36
36
|
* @see {@link ReplicateSecretToRegionsCommandOutput} for command's `response` shape.
|
|
37
37
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
38
38
|
*
|
|
39
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
40
|
+
* <p>An error occurred on the server side.</p>
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
43
|
+
* <p>The parameter name or value is invalid.</p>
|
|
44
|
+
*
|
|
45
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
46
|
+
* <p>A parameter value is not valid for the current state of the
|
|
47
|
+
* resource.</p>
|
|
48
|
+
* <p>Possible causes:</p>
|
|
49
|
+
* <ul>
|
|
50
|
+
* <li>
|
|
51
|
+
* <p>The secret is scheduled for deletion.</p>
|
|
52
|
+
* </li>
|
|
53
|
+
* <li>
|
|
54
|
+
* <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
|
|
55
|
+
* ARN configured and you didn't include such an ARN as a parameter in this call. </p>
|
|
56
|
+
* </li>
|
|
57
|
+
* <li>
|
|
58
|
+
* <p>The secret is managed by another service, and you must use that service to update it.
|
|
59
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
|
|
60
|
+
* </li>
|
|
61
|
+
* </ul>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
64
|
+
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
65
|
+
*
|
|
66
|
+
*
|
|
39
67
|
*/
|
|
40
68
|
export declare class ReplicateSecretToRegionsCommand extends $Command<ReplicateSecretToRegionsCommandInput, ReplicateSecretToRegionsCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
41
69
|
readonly input: ReplicateSecretToRegionsCommandInput;
|
|
@@ -37,6 +37,34 @@ export interface RestoreSecretCommandOutput extends RestoreSecretResponse, __Met
|
|
|
37
37
|
* @see {@link RestoreSecretCommandOutput} for command's `response` shape.
|
|
38
38
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
39
39
|
*
|
|
40
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
41
|
+
* <p>An error occurred on the server side.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
44
|
+
* <p>The parameter name or value is invalid.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
47
|
+
* <p>A parameter value is not valid for the current state of the
|
|
48
|
+
* resource.</p>
|
|
49
|
+
* <p>Possible causes:</p>
|
|
50
|
+
* <ul>
|
|
51
|
+
* <li>
|
|
52
|
+
* <p>The secret is scheduled for deletion.</p>
|
|
53
|
+
* </li>
|
|
54
|
+
* <li>
|
|
55
|
+
* <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
|
|
56
|
+
* ARN configured and you didn't include such an ARN as a parameter in this call. </p>
|
|
57
|
+
* </li>
|
|
58
|
+
* <li>
|
|
59
|
+
* <p>The secret is managed by another service, and you must use that service to update it.
|
|
60
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
|
|
61
|
+
* </li>
|
|
62
|
+
* </ul>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
65
|
+
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
66
|
+
*
|
|
67
|
+
*
|
|
40
68
|
* @example To restore a previously deleted secret
|
|
41
69
|
* ```javascript
|
|
42
70
|
* // The following example shows how to restore a secret that you previously scheduled for deletion.
|
|
@@ -44,6 +44,34 @@ export interface RotateSecretCommandOutput extends RotateSecretResponse, __Metad
|
|
|
44
44
|
* @see {@link RotateSecretCommandOutput} for command's `response` shape.
|
|
45
45
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
46
46
|
*
|
|
47
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
48
|
+
* <p>An error occurred on the server side.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
51
|
+
* <p>The parameter name or value is invalid.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
54
|
+
* <p>A parameter value is not valid for the current state of the
|
|
55
|
+
* resource.</p>
|
|
56
|
+
* <p>Possible causes:</p>
|
|
57
|
+
* <ul>
|
|
58
|
+
* <li>
|
|
59
|
+
* <p>The secret is scheduled for deletion.</p>
|
|
60
|
+
* </li>
|
|
61
|
+
* <li>
|
|
62
|
+
* <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
|
|
63
|
+
* ARN configured and you didn't include such an ARN as a parameter in this call. </p>
|
|
64
|
+
* </li>
|
|
65
|
+
* <li>
|
|
66
|
+
* <p>The secret is managed by another service, and you must use that service to update it.
|
|
67
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
|
|
68
|
+
* </li>
|
|
69
|
+
* </ul>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
72
|
+
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
73
|
+
*
|
|
74
|
+
*
|
|
47
75
|
* @example To configure rotation for a secret
|
|
48
76
|
* ```javascript
|
|
49
77
|
* // 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.
|
|
@@ -37,6 +37,34 @@ export interface StopReplicationToReplicaCommandOutput extends StopReplicationTo
|
|
|
37
37
|
* @see {@link StopReplicationToReplicaCommandOutput} for command's `response` shape.
|
|
38
38
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
39
39
|
*
|
|
40
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
41
|
+
* <p>An error occurred on the server side.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
44
|
+
* <p>The parameter name or value is invalid.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
47
|
+
* <p>A parameter value is not valid for the current state of the
|
|
48
|
+
* resource.</p>
|
|
49
|
+
* <p>Possible causes:</p>
|
|
50
|
+
* <ul>
|
|
51
|
+
* <li>
|
|
52
|
+
* <p>The secret is scheduled for deletion.</p>
|
|
53
|
+
* </li>
|
|
54
|
+
* <li>
|
|
55
|
+
* <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
|
|
56
|
+
* ARN configured and you didn't include such an ARN as a parameter in this call. </p>
|
|
57
|
+
* </li>
|
|
58
|
+
* <li>
|
|
59
|
+
* <p>The secret is managed by another service, and you must use that service to update it.
|
|
60
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
|
|
61
|
+
* </li>
|
|
62
|
+
* </ul>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
65
|
+
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
66
|
+
*
|
|
67
|
+
*
|
|
40
68
|
*/
|
|
41
69
|
export declare class StopReplicationToReplicaCommand extends $Command<StopReplicationToReplicaCommandInput, StopReplicationToReplicaCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
42
70
|
readonly input: StopReplicationToReplicaCommandInput;
|
|
@@ -69,6 +69,34 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
69
69
|
* @see {@link TagResourceCommandOutput} for command's `response` shape.
|
|
70
70
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
71
71
|
*
|
|
72
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
73
|
+
* <p>An error occurred on the server side.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
76
|
+
* <p>The parameter name or value is invalid.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
79
|
+
* <p>A parameter value is not valid for the current state of the
|
|
80
|
+
* resource.</p>
|
|
81
|
+
* <p>Possible causes:</p>
|
|
82
|
+
* <ul>
|
|
83
|
+
* <li>
|
|
84
|
+
* <p>The secret is scheduled for deletion.</p>
|
|
85
|
+
* </li>
|
|
86
|
+
* <li>
|
|
87
|
+
* <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
|
|
88
|
+
* ARN configured and you didn't include such an ARN as a parameter in this call. </p>
|
|
89
|
+
* </li>
|
|
90
|
+
* <li>
|
|
91
|
+
* <p>The secret is managed by another service, and you must use that service to update it.
|
|
92
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
|
|
93
|
+
* </li>
|
|
94
|
+
* </ul>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
97
|
+
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
98
|
+
*
|
|
99
|
+
*
|
|
72
100
|
* @example To add tags to a secret
|
|
73
101
|
* ```javascript
|
|
74
102
|
* // 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.
|
|
@@ -44,6 +44,34 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
|
|
|
44
44
|
* @see {@link UntagResourceCommandOutput} for command's `response` shape.
|
|
45
45
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
46
46
|
*
|
|
47
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
48
|
+
* <p>An error occurred on the server side.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
51
|
+
* <p>The parameter name or value is invalid.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
54
|
+
* <p>A parameter value is not valid for the current state of the
|
|
55
|
+
* resource.</p>
|
|
56
|
+
* <p>Possible causes:</p>
|
|
57
|
+
* <ul>
|
|
58
|
+
* <li>
|
|
59
|
+
* <p>The secret is scheduled for deletion.</p>
|
|
60
|
+
* </li>
|
|
61
|
+
* <li>
|
|
62
|
+
* <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
|
|
63
|
+
* ARN configured and you didn't include such an ARN as a parameter in this call. </p>
|
|
64
|
+
* </li>
|
|
65
|
+
* <li>
|
|
66
|
+
* <p>The secret is managed by another service, and you must use that service to update it.
|
|
67
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
|
|
68
|
+
* </li>
|
|
69
|
+
* </ul>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
72
|
+
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
73
|
+
*
|
|
74
|
+
*
|
|
47
75
|
* @example To remove tags from a secret
|
|
48
76
|
* ```javascript
|
|
49
77
|
* // 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.
|
|
@@ -55,6 +55,54 @@ export interface UpdateSecretCommandOutput extends UpdateSecretResponse, __Metad
|
|
|
55
55
|
* @see {@link UpdateSecretCommandOutput} for command's `response` shape.
|
|
56
56
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
57
57
|
*
|
|
58
|
+
* @throws {@link DecryptionFailure} (client fault)
|
|
59
|
+
* <p>Secrets Manager can't decrypt the protected secret text using the provided KMS key. </p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link EncryptionFailure} (client fault)
|
|
62
|
+
* <p>Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the
|
|
63
|
+
* KMS key is available, enabled, and not in an invalid state. For more
|
|
64
|
+
* information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a>.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
67
|
+
* <p>An error occurred on the server side.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
70
|
+
* <p>The parameter name or value is invalid.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
73
|
+
* <p>A parameter value is not valid for the current state of the
|
|
74
|
+
* resource.</p>
|
|
75
|
+
* <p>Possible causes:</p>
|
|
76
|
+
* <ul>
|
|
77
|
+
* <li>
|
|
78
|
+
* <p>The secret is scheduled for deletion.</p>
|
|
79
|
+
* </li>
|
|
80
|
+
* <li>
|
|
81
|
+
* <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
|
|
82
|
+
* ARN configured and you didn't include such an ARN as a parameter in this call. </p>
|
|
83
|
+
* </li>
|
|
84
|
+
* <li>
|
|
85
|
+
* <p>The secret is managed by another service, and you must use that service to update it.
|
|
86
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
|
|
87
|
+
* </li>
|
|
88
|
+
* </ul>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
91
|
+
* <p>The request failed because it would exceed one of the Secrets Manager quotas.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link MalformedPolicyDocumentException} (client fault)
|
|
94
|
+
* <p>The resource policy has syntax errors.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link PreconditionNotMetException} (client fault)
|
|
97
|
+
* <p>The request failed because you did not complete all the prerequisite steps.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link ResourceExistsException} (client fault)
|
|
100
|
+
* <p>A resource with the ID you requested already exists.</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
103
|
+
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
104
|
+
*
|
|
105
|
+
*
|
|
58
106
|
* @example To update the description of a secret
|
|
59
107
|
* ```javascript
|
|
60
108
|
* // The following example shows how to modify the description of a secret.
|
|
@@ -50,6 +50,37 @@ export interface UpdateSecretVersionStageCommandOutput extends UpdateSecretVersi
|
|
|
50
50
|
* @see {@link UpdateSecretVersionStageCommandOutput} for command's `response` shape.
|
|
51
51
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
52
52
|
*
|
|
53
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
54
|
+
* <p>An error occurred on the server side.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
57
|
+
* <p>The parameter name or value is invalid.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
60
|
+
* <p>A parameter value is not valid for the current state of the
|
|
61
|
+
* resource.</p>
|
|
62
|
+
* <p>Possible causes:</p>
|
|
63
|
+
* <ul>
|
|
64
|
+
* <li>
|
|
65
|
+
* <p>The secret is scheduled for deletion.</p>
|
|
66
|
+
* </li>
|
|
67
|
+
* <li>
|
|
68
|
+
* <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
|
|
69
|
+
* ARN configured and you didn't include such an ARN as a parameter in this call. </p>
|
|
70
|
+
* </li>
|
|
71
|
+
* <li>
|
|
72
|
+
* <p>The secret is managed by another service, and you must use that service to update it.
|
|
73
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
|
|
74
|
+
* </li>
|
|
75
|
+
* </ul>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
78
|
+
* <p>The request failed because it would exceed one of the Secrets Manager quotas.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
81
|
+
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
82
|
+
*
|
|
83
|
+
*
|
|
53
84
|
* @example To add a staging label attached to a version of a secret
|
|
54
85
|
* ```javascript
|
|
55
86
|
* // 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.
|
|
@@ -50,6 +50,37 @@ export interface ValidateResourcePolicyCommandOutput extends ValidateResourcePol
|
|
|
50
50
|
* @see {@link ValidateResourcePolicyCommandOutput} for command's `response` shape.
|
|
51
51
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
52
52
|
*
|
|
53
|
+
* @throws {@link InternalServiceError} (server fault)
|
|
54
|
+
* <p>An error occurred on the server side.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
57
|
+
* <p>The parameter name or value is invalid.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
60
|
+
* <p>A parameter value is not valid for the current state of the
|
|
61
|
+
* resource.</p>
|
|
62
|
+
* <p>Possible causes:</p>
|
|
63
|
+
* <ul>
|
|
64
|
+
* <li>
|
|
65
|
+
* <p>The secret is scheduled for deletion.</p>
|
|
66
|
+
* </li>
|
|
67
|
+
* <li>
|
|
68
|
+
* <p>You tried to enable rotation on a secret that doesn't already have a Lambda function
|
|
69
|
+
* ARN configured and you didn't include such an ARN as a parameter in this call. </p>
|
|
70
|
+
* </li>
|
|
71
|
+
* <li>
|
|
72
|
+
* <p>The secret is managed by another service, and you must use that service to update it.
|
|
73
|
+
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p>
|
|
74
|
+
* </li>
|
|
75
|
+
* </ul>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link MalformedPolicyDocumentException} (client fault)
|
|
78
|
+
* <p>The resource policy has syntax errors.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
81
|
+
* <p>Secrets Manager can't find the resource that you asked for.</p>
|
|
82
|
+
*
|
|
83
|
+
*
|
|
53
84
|
* @example To validate a resource-based policy to a secret
|
|
54
85
|
* ```javascript
|
|
55
86
|
* // The following example shows how to validate a resource-based policy to a secret.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-secrets-manager",
|
|
3
3
|
"description": "AWS SDK for JavaScript Secrets Manager Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.290.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -20,37 +20,37 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
23
|
-
"@aws-sdk/client-sts": "3.
|
|
24
|
-
"@aws-sdk/config-resolver": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
-
"@aws-sdk/fetch-http-handler": "3.
|
|
27
|
-
"@aws-sdk/hash-node": "3.
|
|
28
|
-
"@aws-sdk/invalid-dependency": "3.
|
|
29
|
-
"@aws-sdk/middleware-content-length": "3.
|
|
30
|
-
"@aws-sdk/middleware-endpoint": "3.
|
|
31
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
32
|
-
"@aws-sdk/middleware-logger": "3.
|
|
33
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
34
|
-
"@aws-sdk/middleware-retry": "3.
|
|
35
|
-
"@aws-sdk/middleware-serde": "3.
|
|
36
|
-
"@aws-sdk/middleware-signing": "3.
|
|
37
|
-
"@aws-sdk/middleware-stack": "3.
|
|
38
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
39
|
-
"@aws-sdk/node-config-provider": "3.
|
|
40
|
-
"@aws-sdk/node-http-handler": "3.
|
|
41
|
-
"@aws-sdk/protocol-http": "3.
|
|
42
|
-
"@aws-sdk/smithy-client": "3.
|
|
43
|
-
"@aws-sdk/types": "3.
|
|
44
|
-
"@aws-sdk/url-parser": "3.
|
|
23
|
+
"@aws-sdk/client-sts": "3.290.0",
|
|
24
|
+
"@aws-sdk/config-resolver": "3.290.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.290.0",
|
|
26
|
+
"@aws-sdk/fetch-http-handler": "3.290.0",
|
|
27
|
+
"@aws-sdk/hash-node": "3.290.0",
|
|
28
|
+
"@aws-sdk/invalid-dependency": "3.290.0",
|
|
29
|
+
"@aws-sdk/middleware-content-length": "3.290.0",
|
|
30
|
+
"@aws-sdk/middleware-endpoint": "3.290.0",
|
|
31
|
+
"@aws-sdk/middleware-host-header": "3.290.0",
|
|
32
|
+
"@aws-sdk/middleware-logger": "3.290.0",
|
|
33
|
+
"@aws-sdk/middleware-recursion-detection": "3.290.0",
|
|
34
|
+
"@aws-sdk/middleware-retry": "3.290.0",
|
|
35
|
+
"@aws-sdk/middleware-serde": "3.290.0",
|
|
36
|
+
"@aws-sdk/middleware-signing": "3.290.0",
|
|
37
|
+
"@aws-sdk/middleware-stack": "3.290.0",
|
|
38
|
+
"@aws-sdk/middleware-user-agent": "3.290.0",
|
|
39
|
+
"@aws-sdk/node-config-provider": "3.290.0",
|
|
40
|
+
"@aws-sdk/node-http-handler": "3.290.0",
|
|
41
|
+
"@aws-sdk/protocol-http": "3.290.0",
|
|
42
|
+
"@aws-sdk/smithy-client": "3.290.0",
|
|
43
|
+
"@aws-sdk/types": "3.290.0",
|
|
44
|
+
"@aws-sdk/url-parser": "3.290.0",
|
|
45
45
|
"@aws-sdk/util-base64": "3.208.0",
|
|
46
46
|
"@aws-sdk/util-body-length-browser": "3.188.0",
|
|
47
47
|
"@aws-sdk/util-body-length-node": "3.208.0",
|
|
48
|
-
"@aws-sdk/util-defaults-mode-browser": "3.
|
|
49
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
50
|
-
"@aws-sdk/util-endpoints": "3.
|
|
51
|
-
"@aws-sdk/util-retry": "3.
|
|
52
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
53
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
48
|
+
"@aws-sdk/util-defaults-mode-browser": "3.290.0",
|
|
49
|
+
"@aws-sdk/util-defaults-mode-node": "3.290.0",
|
|
50
|
+
"@aws-sdk/util-endpoints": "3.290.0",
|
|
51
|
+
"@aws-sdk/util-retry": "3.290.0",
|
|
52
|
+
"@aws-sdk/util-user-agent-browser": "3.290.0",
|
|
53
|
+
"@aws-sdk/util-user-agent-node": "3.290.0",
|
|
54
54
|
"@aws-sdk/util-utf8": "3.254.0",
|
|
55
55
|
"tslib": "^2.3.1",
|
|
56
56
|
"uuid": "^8.3.2"
|