Skip to content

Commit

Permalink
docs(client-secrets-manager): Documentation updates for AWS Secrets M…
Browse files Browse the repository at this point in the history 
…anager
  • Loading branch information
awstools committed May 16, 2024
1 parent 9466c82 commit 12647db
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions clients/client-secrets-manager/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -966,7 +966,7 @@ export interface DescribeSecretResponse {
KmsKeyId?: string;

/**
* <p>Specifies whether automatic rotation is turned on for this secret.</p>
* <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>
* <p>To turn on rotation, use <a>RotateSecret</a>. To turn off
* rotation, use <a>CancelRotateSecret</a>.</p>
* @public
Expand Down Expand Up @@ -1216,7 +1216,7 @@ export interface GetResourcePolicyResponse {
*/
export interface GetSecretValueRequest {
/**
* <p>The ARN or name of the secret to retrieve.</p>
* <p>The ARN or name of the secret to retrieve. To retrieve a secret from another account, you must use an ARN.</p>
* <p>For an ARN, we recommend that you specify a complete ARN rather
* 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>
* @public
Expand Down Expand Up @@ -1946,7 +1946,7 @@ export interface RotateSecretRequest {
* <p>Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
* The rotation schedule is defined in <a>RotateSecretRequest$RotationRules</a>.</p>
* <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
* <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">
* <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_lambda-functions.html#rotate-secrets_lambda-functions-code">
* <code>testSecret</code>
* step</a> of the Lambda rotation function. The test creates an <code>AWSPENDING</code> version of the secret and then removes it.</p>
* <p>By default, Secrets Manager rotates the secret immediately.</p>
Expand Down Expand Up @@ -2207,7 +2207,7 @@ export interface UpdateSecretVersionStageResponse {
*/
export interface ValidateResourcePolicyRequest {
/**
* <p>This field is reserved for internal use.</p>
* <p>The ARN or name of the secret with the resource-based policy you want to validate.</p>
* @public
*/
SecretId?: string;
Expand Down
8 changes: 4 additions & 4 deletions codegen/sdk-codegen/aws-models/secrets-manager.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -712,7 +712,7 @@
"target": "com.amazonaws.secretsmanager#RotationEnabledType",
"traits": {
"smithy.api#default": null,
"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>"
"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>"
}
},
"RotationLambdaARN": {
Expand Down Expand Up @@ -1215,7 +1215,7 @@
"SecretId": {
"target": "com.amazonaws.secretsmanager#SecretIdType",
"traits": {
"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>",
"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>",
"smithy.api#required": {}
}
},
Expand Down Expand Up @@ -2408,7 +2408,7 @@
"target": "com.amazonaws.secretsmanager#BooleanType",
"traits": {
"smithy.api#default": null,
"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>"
"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>"
}
}
},
Expand Down Expand Up @@ -3420,7 +3420,7 @@
"SecretId": {
"target": "com.amazonaws.secretsmanager#SecretIdType",
"traits": {
"smithy.api#documentation": "<p>This field is reserved for internal use.</p>"
"smithy.api#documentation": "<p>The ARN or name of the secret with the resource-based policy you want to validate.</p>"
}
},
"ResourcePolicy": {
Expand Down

0 comments on commit 12647db

Please sign in to comment.