Skip to content

Commit

Permalink
docs(client-secrets-manager): Documentation updates for Secrets Manager
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed May 16, 2023
1 parent 602665d commit 971ec65
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
5 changes: 3 additions & 2 deletions clients/client-secrets-manager/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -599,6 +599,7 @@ export interface DeleteSecretRequest {
* <p>Secrets Manager performs the actual deletion with an asynchronous background process, so there might
* be a short delay before the secret is permanently deleted. If you delete a secret and then
* immediately create a secret with the same name, use appropriate back off and retry logic.</p>
* <p>If you forcibly delete an already deleted or nonexistent secret, the operation does not return <code>ResourceNotFoundException</code>.</p>
* <important>
* <p>Use this parameter with caution. This parameter causes the operation to skip the normal
* recovery window before the permanent deletion that Secrets Manager would normally impose with the
Expand Down Expand Up @@ -771,7 +772,7 @@ export interface DescribeSecretResponse {
DeletedDate?: Date;

/**
* <p>The next date and time that Secrets Manager will rotate the secret, rounded to the nearest hour. If the secret isn't configured for rotation, Secrets Manager returns null.</p>
* <p>The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation, Secrets Manager returns null.</p>
*/
NextRotationDate?: Date;

Expand Down Expand Up @@ -1237,7 +1238,7 @@ export interface SecretListEntry {
DeletedDate?: Date;

/**
* <p>The next date and time that Secrets Manager will attempt to rotate the secret, rounded to the nearest hour. This value is null if the secret is not set up for rotation.</p>
* <p>The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation, Secrets Manager returns null.</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 @@ -396,7 +396,7 @@
"target": "com.amazonaws.secretsmanager#BooleanType",
"traits": {
"smithy.api#default": null,
"smithy.api#documentation": "<p>Specifies whether to delete the secret without any recovery window. You\n can't use both this parameter and <code>RecoveryWindowInDays</code> in the same\n call. If you don't use either, then by default Secrets Manager uses a 30 day recovery window.</p>\n <p>Secrets Manager performs the actual deletion with an asynchronous background process, so there might \n be a short delay before the secret is permanently deleted. If you delete a secret and then \n immediately create a secret with the same name, use appropriate back off and retry logic.</p>\n <important>\n <p>Use this parameter with caution. This parameter causes the operation to skip the normal\n recovery window before the permanent deletion that Secrets Manager would normally impose with the\n <code>RecoveryWindowInDays</code> parameter. If you delete a secret with the\n <code>ForceDeleteWithoutRecovery</code> parameter, then you have no opportunity to recover\n the secret. You lose the secret permanently.</p>\n </important>"
"smithy.api#documentation": "<p>Specifies whether to delete the secret without any recovery window. You\n can't use both this parameter and <code>RecoveryWindowInDays</code> in the same\n call. If you don't use either, then by default Secrets Manager uses a 30 day recovery window.</p>\n <p>Secrets Manager performs the actual deletion with an asynchronous background process, so there might \n be a short delay before the secret is permanently deleted. If you delete a secret and then \n immediately create a secret with the same name, use appropriate back off and retry logic.</p>\n <p>If you forcibly delete an already deleted or nonexistent secret, the operation does not return <code>ResourceNotFoundException</code>.</p>\n <important>\n <p>Use this parameter with caution. This parameter causes the operation to skip the normal\n recovery window before the permanent deletion that Secrets Manager would normally impose with the\n <code>RecoveryWindowInDays</code> parameter. If you delete a secret with the\n <code>ForceDeleteWithoutRecovery</code> parameter, then you have no opportunity to recover\n the secret. You lose the secret permanently.</p>\n </important>"
}
}
},
Expand Down Expand Up @@ -547,7 +547,7 @@
"NextRotationDate": {
"target": "com.amazonaws.secretsmanager#NextRotationDateType",
"traits": {
"smithy.api#documentation": "<p>The next date and time that Secrets Manager will rotate the secret, rounded to the nearest hour. If the secret isn't configured for rotation, Secrets Manager returns null.</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, Secrets Manager returns null.</p>"
}
},
"Tags": {
Expand Down Expand Up @@ -2175,7 +2175,7 @@
"NextRotationDate": {
"target": "com.amazonaws.secretsmanager#NextRotationDateType",
"traits": {
"smithy.api#documentation": "<p>The next date and time that Secrets Manager will attempt to rotate the secret, rounded to the nearest hour. This value is null if the secret is not set up for rotation.</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, Secrets Manager returns null.</p>"
}
},
"Tags": {
Expand Down

0 comments on commit 971ec65

Please sign in to comment.