Skip to content

Commit ca6e1e4

Browse files
author
AWS
committed
AWS Secrets Manager Update: Documentation updates for AWS Secrets Manager
1 parent b3c11ca commit ca6e1e4

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Secrets Manager",
4+
"contributor": "",
5+
"description": "Documentation updates for AWS Secrets Manager"
6+
}

services/secretsmanager/src/main/resources/codegen-resources/service-2.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
"endpointPrefix":"secretsmanager",
66
"jsonVersion":"1.1",
77
"protocol":"json",
8+
"protocols":["json"],
89
"serviceFullName":"AWS Secrets Manager",
910
"serviceId":"Secrets Manager",
1011
"signatureVersion":"v4",
@@ -673,7 +674,7 @@
673674
},
674675
"RotationEnabled":{
675676
"shape":"RotationEnabledType",
676-
"documentation":"<p>Specifies whether automatic rotation is turned on for this secret.</p> <p>To turn on rotation, use <a>RotateSecret</a>. To turn off rotation, use <a>CancelRotateSecret</a>.</p>",
677+
"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> <p>To turn on rotation, use <a>RotateSecret</a>. To turn off rotation, use <a>CancelRotateSecret</a>.</p>",
677678
"box":true
678679
},
679680
"RotationLambdaARN":{
@@ -892,7 +893,7 @@
892893
"members":{
893894
"SecretId":{
894895
"shape":"SecretIdType",
895-
"documentation":"<p>The ARN or name of the secret to retrieve.</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>"
896+
"documentation":"<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>"
896897
},
897898
"VersionId":{
898899
"shape":"SecretVersionIdType",
@@ -1410,7 +1411,7 @@
14101411
},
14111412
"RotateImmediately":{
14121413
"shape":"BooleanType",
1413-
"documentation":"<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\"> <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>",
1414+
"documentation":"<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_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>",
14141415
"box":true
14151416
}
14161417
}
@@ -1872,7 +1873,7 @@
18721873
"members":{
18731874
"SecretId":{
18741875
"shape":"SecretIdType",
1875-
"documentation":"<p>This field is reserved for internal use.</p>"
1876+
"documentation":"<p>The ARN or name of the secret with the resource-based policy you want to validate.</p>"
18761877
},
18771878
"ResourcePolicy":{
18781879
"shape":"NonEmptyResourcePolicyType",

0 commit comments

Comments
 (0)