Skip to content

Commit b63da55

Browse files
author
awstools
committed
feat(client-secrets-manager): add v2 smoke tests and smithy smokeTests trait for SDK testing
1 parent 4d44c0d commit b63da55

File tree

2 files changed

+38
-10
lines changed

2 files changed

+38
-10
lines changed

‎clients/client-secrets-manager/src/models/models_0.ts‎

Lines changed: 4 additions & 4 deletions
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. If the secret has never been configured for rotation, Secrets Manager returns null.</p>
969+
* <p>Specifies whether automatic rotation is turned on for this secret.</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. To retrieve a secret from another account, you must use an ARN.</p>
1219+
* <p>The ARN or name of the secret to retrieve.</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_lambda-functions.html#rotate-secrets_lambda-functions-code">
1949+
* <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">
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>The ARN or name of the secret with the resource-based policy you want to validate.</p>
2210+
* <p>This field is reserved for internal use.</p>
22112211
* @public
22122212
*/
22132213
SecretId?: string;

‎codegen/sdk-codegen/aws-models/secrets-manager.json‎

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -663,7 +663,22 @@
663663
}
664664
],
665665
"traits": {
666-
"smithy.api#documentation": "<p>Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager\n only returns fields that have a value in the response. </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:DescribeSecret</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>"
666+
"smithy.api#documentation": "<p>Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager\n only returns fields that have a value in the response. </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:DescribeSecret</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>",
667+
"smithy.test#smokeTests": [
668+
{
669+
"id": "DescribeSecretFailure",
670+
"params": {
671+
"SecretId": "fake-secret-id"
672+
},
673+
"vendorParams": {
674+
"region": "us-west-2"
675+
},
676+
"vendorParamsShape": "aws.test#AwsVendorParams",
677+
"expect": {
678+
"failure": {}
679+
}
680+
}
681+
]
667682
}
668683
},
669684
"com.amazonaws.secretsmanager#DescribeSecretRequest": {
@@ -712,7 +727,7 @@
712727
"target": "com.amazonaws.secretsmanager#RotationEnabledType",
713728
"traits": {
714729
"smithy.api#default": null,
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>"
730+
"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>"
716731
}
717732
},
718733
"RotationLambdaARN": {
@@ -1215,7 +1230,7 @@
12151230
"SecretId": {
12161231
"target": "com.amazonaws.secretsmanager#SecretIdType",
12171232
"traits": {
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>",
1233+
"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>",
12191234
"smithy.api#required": {}
12201235
}
12211236
},
@@ -1559,7 +1574,20 @@
15591574
"inputToken": "NextToken",
15601575
"outputToken": "NextToken",
15611576
"pageSize": "MaxResults"
1562-
}
1577+
},
1578+
"smithy.test#smokeTests": [
1579+
{
1580+
"id": "ListSecretsSuccess",
1581+
"params": {},
1582+
"vendorParams": {
1583+
"region": "us-west-2"
1584+
},
1585+
"vendorParamsShape": "aws.test#AwsVendorParams",
1586+
"expect": {
1587+
"success": {}
1588+
}
1589+
}
1590+
]
15631591
}
15641592
},
15651593
"com.amazonaws.secretsmanager#ListSecretsRequest": {
@@ -2408,7 +2436,7 @@
24082436
"target": "com.amazonaws.secretsmanager#BooleanType",
24092437
"traits": {
24102438
"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_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>"
2439+
"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>"
24122440
}
24132441
}
24142442
},
@@ -3420,7 +3448,7 @@
34203448
"SecretId": {
34213449
"target": "com.amazonaws.secretsmanager#SecretIdType",
34223450
"traits": {
3423-
"smithy.api#documentation": "<p>The ARN or name of the secret with the resource-based policy you want to validate.</p>"
3451+
"smithy.api#documentation": "<p>This field is reserved for internal use.</p>"
34243452
}
34253453
},
34263454
"ResourcePolicy": {

0 commit comments

Comments
 (0)