Skip to content

Commit

Permalink
docs(client-secrets-manager): Doc only update for Secrets Manager
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Mar 14, 2024
1 parent 0ca0d28 commit 7cde1da
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export interface GetRandomPasswordCommandOutput extends GetRandomPasswordRespons
* maximum length and include every character type that the system you are generating a password
* for can support. By default, Secrets Manager uses uppercase and lowercase letters, numbers, and the following characters in passwords: <code>!\"#$%&'()*+,-./:;<=>?@[\\]^_`\{|\}~</code>
* </p>
* <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>
* <p>Secrets Manager generates a CloudTrail log entry when you call this action.</p>
* <p>
* <b>Required permissions: </b>
* <code>secretsmanager:GetRandomPassword</code>.
Expand Down
3 changes: 2 additions & 1 deletion clients/client-secrets-manager/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ export interface BatchGetSecretValueRequest {
* <p>The number of results to include in the response.</p>
* <p>If there are more results available, in the response, Secrets Manager includes <code>NextToken</code>.
* To get the next results, call <code>BatchGetSecretValue</code> again with the value from
* <code>NextToken</code>.</p>
* <code>NextToken</code>. To use this parameter, you must also use the <code>Filters</code> parameter.</p>
*/
MaxResults?: number;

Expand Down Expand Up @@ -1021,6 +1021,7 @@ export interface DescribeSecretResponse {
/**
* @public
* <p>The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null. If rotation fails, Secrets Manager retries the entire rotation process multiple times. If rotation is unsuccessful, this date may be in the past.</p>
* <p>This date represents the latest date that rotation will occur, but it is not an approximate rotation date. In some cases, for example if you turn off automatic rotation and then turn it back on, the next rotation may occur much sooner than this date.</p>
*/
NextRotationDate?: Date;

Expand Down
6 changes: 3 additions & 3 deletions codegen/sdk-codegen/aws-models/secrets-manager.json
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@
"MaxResults": {
"target": "com.amazonaws.secretsmanager#MaxResultsBatchType",
"traits": {
"smithy.api#documentation": "<p>The number of results to include in the response.</p>\n <p>If there are more results available, in the response, Secrets Manager includes <code>NextToken</code>. \n To get the next results, call <code>BatchGetSecretValue</code> again with the value from \n <code>NextToken</code>.</p>"
"smithy.api#documentation": "<p>The number of results to include in the response.</p>\n <p>If there are more results available, in the response, Secrets Manager includes <code>NextToken</code>. \n To get the next results, call <code>BatchGetSecretValue</code> again with the value from \n <code>NextToken</code>. To use this parameter, you must also use the <code>Filters</code> parameter.</p>"
}
},
"NextToken": {
Expand Down Expand Up @@ -754,7 +754,7 @@
"NextRotationDate": {
"target": "com.amazonaws.secretsmanager#NextRotationDateType",
"traits": {
"smithy.api#documentation": "<p>The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null. If rotation fails, Secrets Manager retries the entire rotation process multiple times. If rotation is unsuccessful, this date may be in the past.</p>"
"smithy.api#documentation": "<p>The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null. If rotation fails, Secrets Manager retries the entire rotation process multiple times. If rotation is unsuccessful, this date may be in the past.</p>\n <p>This date represents the latest date that rotation will occur, but it is not an approximate rotation date. In some cases, for example if you turn off automatic rotation and then turn it back on, the next rotation may occur much sooner than this date.</p>"
}
},
"Tags": {
Expand Down Expand Up @@ -989,7 +989,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Generates a random password. We recommend that you specify the\n maximum length and include every character type that the system you are generating a password\n for can support. By default, Secrets Manager uses uppercase and lowercase letters, numbers, and the following characters in passwords: <code>!\\\"#$%&'()*+,-./:;<=>?@[\\\\]^_`{|}~</code>\n </p>\n <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>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:GetRandomPassword</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>",
"smithy.api#documentation": "<p>Generates a random password. We recommend that you specify the\n maximum length and include every character type that the system you are generating a password\n for can support. By default, Secrets Manager uses uppercase and lowercase letters, numbers, and the following characters in passwords: <code>!\\\"#$%&'()*+,-./:;<=>?@[\\\\]^_`{|}~</code>\n </p>\n <p>Secrets Manager generates a CloudTrail log entry when you call this action.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:GetRandomPassword</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>",
"smithy.api#examples": [
{
"title": "To generate a random password",
Expand Down

0 comments on commit 7cde1da

Please sign in to comment.