Skip to content

Commit 12647db

Browse files
author
awstools
committed
docs(client-secrets-manager): Documentation updates for AWS Secrets Manager
1 parent 9466c82 commit 12647db

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

Diff for: clients/client-secrets-manager/src/models/models_0.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -966,7 +966,7 @@ export interface DescribeSecretResponse {
966966
KmsKeyId?: string;
967967

968968
/**
969-
* <p>Specifies whether automatic rotation is turned on for this secret.</p>
969+
* <p>Specifies whether automatic rotation is turned on for this secret. If the secret has never been configured for rotation, Secrets Manager returns null.</p>
970970
* <p>To turn on rotation, use <a>RotateSecret</a>. To turn off
971971
* rotation, use <a>CancelRotateSecret</a>.</p>
972972
* @public
@@ -1216,7 +1216,7 @@ export interface GetResourcePolicyResponse {
12161216
*/
12171217
export interface GetSecretValueRequest {
12181218
/**
1219-
* <p>The ARN or name of the secret to retrieve.</p>
1219+
* <p>The ARN or name of the secret to retrieve. To retrieve a secret from another account, you must use an ARN.</p>
12201220
* <p>For an ARN, we recommend that you specify a complete ARN rather
12211221
* than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
12221222
* @public
@@ -1946,7 +1946,7 @@ export interface RotateSecretRequest {
19461946
* <p>Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
19471947
* The rotation schedule is defined in <a>RotateSecretRequest$RotationRules</a>.</p>
19481948
* <p>For secrets that use a Lambda rotation function to rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the
1949-
* <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">
1949+
* <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_lambda-functions.html#rotate-secrets_lambda-functions-code">
19501950
* <code>testSecret</code>
19511951
* step</a> of the Lambda rotation function. The test creates an <code>AWSPENDING</code> version of the secret and then removes it.</p>
19521952
* <p>By default, Secrets Manager rotates the secret immediately.</p>
@@ -2207,7 +2207,7 @@ export interface UpdateSecretVersionStageResponse {
22072207
*/
22082208
export interface ValidateResourcePolicyRequest {
22092209
/**
2210-
* <p>This field is reserved for internal use.</p>
2210+
* <p>The ARN or name of the secret with the resource-based policy you want to validate.</p>
22112211
* @public
22122212
*/
22132213
SecretId?: string;

Diff for: codegen/sdk-codegen/aws-models/secrets-manager.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -712,7 +712,7 @@
712712
"target": "com.amazonaws.secretsmanager#RotationEnabledType",
713713
"traits": {
714714
"smithy.api#default": null,
715-
"smithy.api#documentation": "<p>Specifies whether automatic rotation is turned on for this secret.</p>\n <p>To turn on rotation, use <a>RotateSecret</a>. To turn off\n rotation, use <a>CancelRotateSecret</a>.</p>"
715+
"smithy.api#documentation": "<p>Specifies whether automatic rotation is turned on for this secret. If the secret has never been configured for rotation, Secrets Manager returns null.</p>\n <p>To turn on rotation, use <a>RotateSecret</a>. To turn off\n rotation, use <a>CancelRotateSecret</a>.</p>"
716716
}
717717
},
718718
"RotationLambdaARN": {
@@ -1215,7 +1215,7 @@
12151215
"SecretId": {
12161216
"target": "com.amazonaws.secretsmanager#SecretIdType",
12171217
"traits": {
1218-
"smithy.api#documentation": "<p>The ARN or name of the secret to retrieve.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen\">Finding a secret from a partial ARN</a>.</p>",
1218+
"smithy.api#documentation": "<p>The ARN or name of the secret to retrieve. To retrieve a secret from another account, you must use an ARN.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen\">Finding a secret from a partial ARN</a>.</p>",
12191219
"smithy.api#required": {}
12201220
}
12211221
},
@@ -2408,7 +2408,7 @@
24082408
"target": "com.amazonaws.secretsmanager#BooleanType",
24092409
"traits": {
24102410
"smithy.api#default": null,
2411-
"smithy.api#documentation": "<p>Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. \n The rotation schedule is defined in <a>RotateSecretRequest$RotationRules</a>.</p>\n <p>For secrets that use a Lambda rotation function to rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the \n <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html\">\n <code>testSecret</code> \n step</a> of the Lambda rotation function. The test creates an <code>AWSPENDING</code> version of the secret and then removes it.</p>\n <p>By default, Secrets Manager rotates the secret immediately.</p>"
2411+
"smithy.api#documentation": "<p>Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. \n The rotation schedule is defined in <a>RotateSecretRequest$RotationRules</a>.</p>\n <p>For secrets that use a Lambda rotation function to rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the \n <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_lambda-functions.html#rotate-secrets_lambda-functions-code\">\n <code>testSecret</code> \n step</a> of the Lambda rotation function. The test creates an <code>AWSPENDING</code> version of the secret and then removes it.</p>\n <p>By default, Secrets Manager rotates the secret immediately.</p>"
24122412
}
24132413
}
24142414
},
@@ -3420,7 +3420,7 @@
34203420
"SecretId": {
34213421
"target": "com.amazonaws.secretsmanager#SecretIdType",
34223422
"traits": {
3423-
"smithy.api#documentation": "<p>This field is reserved for internal use.</p>"
3423+
"smithy.api#documentation": "<p>The ARN or name of the secret with the resource-based policy you want to validate.</p>"
34243424
}
34253425
},
34263426
"ResourcePolicy": {

0 commit comments

Comments
 (0)