Skip to content

Commit 6a5d800

Browse files
author
awstools
committed
docs(client-acm-pca): Documentation correction for AWS Private CA
1 parent 2aecb8b commit 6a5d800

File tree

6 files changed

+18
-18
lines changed

6 files changed

+18
-18
lines changed

clients/client-acm-pca/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</
1717
operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
1818
depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
1919
request because the request exceeds the operation's quota for the number of requests per
20-
second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request
20+
second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request
2121
rate for APIs. </p>
2222
<p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
2323
log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>

clients/client-acm-pca/src/ACMPCA.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ export interface ACMPCA {
509509
* operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
510510
* depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
511511
* request because the request exceeds the operation's quota for the number of requests per
512-
* second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request
512+
* second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request
513513
* rate for APIs. </p>
514514
* <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
515515
* log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>

clients/client-acm-pca/src/ACMPCAClient.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ export interface ACMPCAClientResolvedConfig extends ACMPCAClientResolvedConfigTy
352352
* operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
353353
* depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
354354
* request because the request exceeds the operation's quota for the number of requests per
355-
* second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request
355+
* second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request
356356
* rate for APIs. </p>
357357
* <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
358358
* log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>

clients/client-acm-pca/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
* operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
1313
* depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
1414
* request because the request exceeds the operation's quota for the number of requests per
15-
* second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request
15+
* second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request
1616
* rate for APIs. </p>
1717
* <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
1818
* log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>

clients/client-acm-pca/src/models/models_0.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -845,9 +845,9 @@ export interface CreateCertificateAuthorityRequest {
845845
* keys.</p>
846846
* <p>Default: FIPS_140_2_LEVEL_3_OR_HIGHER</p>
847847
* <note>
848-
* <p>Some Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you
849-
* must provide <code>FIPS_140_2_LEVEL_2_OR_HIGHER</code> as the argument for
850-
* <code>KeyStorageSecurityStandard</code>. Failure to do this results in an
848+
* <p>Some Amazon Web Services Regions do not support the default. When creating a CA in these
849+
* Regions, you must provide <code>FIPS_140_2_LEVEL_2_OR_HIGHER</code> as the argument
850+
* for <code>KeyStorageSecurityStandard</code>. Failure to do this results in an
851851
* <code>InvalidArgsException</code> with the message, "A certificate authority
852852
* cannot be created in this region with the specified security standard."</p>
853853
* <p>For information about security standard support in various Regions, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/data-protection.html#private-keys">Storage
@@ -2152,8 +2152,8 @@ export interface IssueCertificateRequest {
21522152
* <p>This parameter should not be confused with the <code>SigningAlgorithm</code> parameter
21532153
* used to sign a CSR in the <code>CreateCertificateAuthority</code> action.</p>
21542154
* <note>
2155-
* <p>The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of
2156-
* the CA's secret key.</p>
2155+
* <p>The specified signing algorithm family (RSA or ECDSA) must match the algorithm
2156+
* family of the CA's secret key.</p>
21572157
* </note>
21582158
*/
21592159
SigningAlgorithm: SigningAlgorithm | string | undefined;
@@ -2212,11 +2212,11 @@ export interface IssueCertificateRequest {
22122212

22132213
/**
22142214
* @public
2215-
* <p>Alphanumeric string that can be used to distinguish between calls to the <b>IssueCertificate</b> action. Idempotency tokens for <b>IssueCertificate</b> time out after one minute. Therefore, if you
2216-
* call <b>IssueCertificate</b> multiple times with the same
2217-
* idempotency token within one minute, Amazon Web Services Private CA recognizes that you are requesting only
2218-
* one certificate and will issue only one. If you change the idempotency token for each
2219-
* call, Amazon Web Services Private CA recognizes that you are requesting multiple certificates.</p>
2215+
* <p>Alphanumeric string that can be used to distinguish between calls to the <b>IssueCertificate</b> action. Idempotency tokens for <b>IssueCertificate</b> time out after five minutes. Therefore, if
2216+
* you call <b>IssueCertificate</b> multiple times with the same
2217+
* idempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting
2218+
* only one certificate and will issue only one. If you change the idempotency token for
2219+
* each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificates.</p>
22202220
*/
22212221
IdempotencyToken?: string;
22222222
}

codegen/sdk-codegen/aws-models/acm-pca.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@
115115
"name": "acm-pca"
116116
},
117117
"aws.protocols#awsJson1_1": {},
118-
"smithy.api#documentation": "<p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,\n\t\t\tsyntax, and usage examples for each of the actions and data types involved in creating\n\t\t\tand managing a private certificate authority (CA) for your organization.</p>\n <p>The documentation for each action shows the API request parameters and the JSON\n\t\t\tresponse. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is\n\t\t\ttailored to the programming language or platform that you prefer. For more information,\n\t\t\tsee <a href=\"https://aws.amazon.com/tools/#SDKs\">Amazon Web Services SDKs</a>.</p>\n <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the\n\t\t\toperation can be called per second. Amazon Web Services Private CA throttles API requests at different rates\n\t\t\tdepending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid\n\t\t\trequest because the request exceeds the operation's quota for the number of requests per\n\t\t\tsecond. When a request is throttled, Amazon Web Services Private CA returns a <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html\">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request\n\t\t\trate for APIs. </p>\n <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,\n\t\t\tlog into your Amazon Web Services account and visit the <a href=\"https://console.aws.amazon.com/servicequotas/\">Service Quotas</a>\n\t\t\tconsole.</p>",
118+
"smithy.api#documentation": "<p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,\n\t\t\tsyntax, and usage examples for each of the actions and data types involved in creating\n\t\t\tand managing a private certificate authority (CA) for your organization.</p>\n <p>The documentation for each action shows the API request parameters and the JSON\n\t\t\tresponse. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is\n\t\t\ttailored to the programming language or platform that you prefer. For more information,\n\t\t\tsee <a href=\"https://aws.amazon.com/tools/#SDKs\">Amazon Web Services SDKs</a>.</p>\n <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the\n\t\t\toperation can be called per second. Amazon Web Services Private CA throttles API requests at different rates\n\t\t\tdepending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid\n\t\t\trequest because the request exceeds the operation's quota for the number of requests per\n\t\t\tsecond. When a request is throttled, Amazon Web Services Private CA returns a <a href=\"https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html\">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request\n\t\t\trate for APIs. </p>\n <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,\n\t\t\tlog into your Amazon Web Services account and visit the <a href=\"https://console.aws.amazon.com/servicequotas/\">Service Quotas</a>\n\t\t\tconsole.</p>",
119119
"smithy.api#title": "AWS Certificate Manager Private Certificate Authority",
120120
"smithy.rules#endpointRuleSet": {
121121
"version": "1.0",
@@ -1927,7 +1927,7 @@
19271927
"KeyStorageSecurityStandard": {
19281928
"target": "com.amazonaws.acmpca#KeyStorageSecurityStandard",
19291929
"traits": {
1930-
"smithy.api#documentation": "<p>Specifies a cryptographic key management compliance standard used for handling CA\n\t\t\tkeys.</p>\n <p>Default: FIPS_140_2_LEVEL_3_OR_HIGHER</p>\n <note>\n <p>Some Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you\n\t\t\t\tmust provide <code>FIPS_140_2_LEVEL_2_OR_HIGHER</code> as the argument for\n\t\t\t\t\t<code>KeyStorageSecurityStandard</code>. Failure to do this results in an\n\t\t\t\t\t<code>InvalidArgsException</code> with the message, \"A certificate authority\n\t\t\t\tcannot be created in this region with the specified security standard.\"</p>\n <p>For information about security standard support in various Regions, see <a href=\"https://docs.aws.amazon.com/privateca/latest/userguide/data-protection.html#private-keys\">Storage\n\t\t\t\t\tand security compliance of Amazon Web Services Private CA private keys</a>.</p>\n </note>"
1930+
"smithy.api#documentation": "<p>Specifies a cryptographic key management compliance standard used for handling CA\n\t\t\tkeys.</p>\n <p>Default: FIPS_140_2_LEVEL_3_OR_HIGHER</p>\n <note>\n <p>Some Amazon Web Services Regions do not support the default. When creating a CA in these\n\t\t\t\tRegions, you must provide <code>FIPS_140_2_LEVEL_2_OR_HIGHER</code> as the argument\n\t\t\t\tfor <code>KeyStorageSecurityStandard</code>. Failure to do this results in an\n\t\t\t\t\t<code>InvalidArgsException</code> with the message, \"A certificate authority\n\t\t\t\tcannot be created in this region with the specified security standard.\"</p>\n <p>For information about security standard support in various Regions, see <a href=\"https://docs.aws.amazon.com/privateca/latest/userguide/data-protection.html#private-keys\">Storage\n\t\t\t\t\tand security compliance of Amazon Web Services Private CA private keys</a>.</p>\n </note>"
19311931
}
19321932
},
19331933
"Tags": {
@@ -3235,7 +3235,7 @@
32353235
"SigningAlgorithm": {
32363236
"target": "com.amazonaws.acmpca#SigningAlgorithm",
32373237
"traits": {
3238-
"smithy.api#documentation": "<p>The name of the algorithm that will be used to sign the certificate to be issued. </p>\n <p>This parameter should not be confused with the <code>SigningAlgorithm</code> parameter\n\t\t\tused to sign a CSR in the <code>CreateCertificateAuthority</code> action.</p>\n <note>\n <p>The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of\n\t\t\t\tthe CA's secret key.</p>\n </note>",
3238+
"smithy.api#documentation": "<p>The name of the algorithm that will be used to sign the certificate to be issued. </p>\n <p>This parameter should not be confused with the <code>SigningAlgorithm</code> parameter\n\t\t\tused to sign a CSR in the <code>CreateCertificateAuthority</code> action.</p>\n <note>\n <p>The specified signing algorithm family (RSA or ECDSA) must match the algorithm\n\t\t\t\tfamily of the CA's secret key.</p>\n </note>",
32393239
"smithy.api#required": {}
32403240
}
32413241
},
@@ -3261,7 +3261,7 @@
32613261
"IdempotencyToken": {
32623262
"target": "com.amazonaws.acmpca#IdempotencyToken",
32633263
"traits": {
3264-
"smithy.api#documentation": "<p>Alphanumeric string that can be used to distinguish between calls to the <b>IssueCertificate</b> action. Idempotency tokens for <b>IssueCertificate</b> time out after one minute. Therefore, if you\n\t\t\tcall <b>IssueCertificate</b> multiple times with the same\n\t\t\tidempotency token within one minute, Amazon Web Services Private CA recognizes that you are requesting only\n\t\t\tone certificate and will issue only one. If you change the idempotency token for each\n\t\t\tcall, Amazon Web Services Private CA recognizes that you are requesting multiple certificates.</p>"
3264+
"smithy.api#documentation": "<p>Alphanumeric string that can be used to distinguish between calls to the <b>IssueCertificate</b> action. Idempotency tokens for <b>IssueCertificate</b> time out after five minutes. Therefore, if\n\t\t\tyou call <b>IssueCertificate</b> multiple times with the same\n\t\t\tidempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting\n\t\t\tonly one certificate and will issue only one. If you change the idempotency token for\n\t\t\teach call, Amazon Web Services Private CA recognizes that you are requesting multiple certificates.</p>"
32653265
}
32663266
}
32673267
},

0 commit comments

Comments
 (0)