Skip to content

Commit

Permalink
docs(client-acm-pca): Documentation correction for AWS Private CA
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Aug 4, 2023
1 parent 2aecb8b commit 6a5d800
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion clients/client-acm-pca/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</
operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
request because the request exceeds the operation's quota for the number of requests per
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
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
rate for APIs. </p>
<p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-acm-pca/src/ACMPCA.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -509,7 +509,7 @@ export interface ACMPCA {
* operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
* depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
* request because the request exceeds the operation's quota for the number of requests per
* 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
* 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
* rate for APIs. </p>
* <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
* log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-acm-pca/src/ACMPCAClient.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ export interface ACMPCAClientResolvedConfig extends ACMPCAClientResolvedConfigTy
* operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
* depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
* request because the request exceeds the operation's quota for the number of requests per
* 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
* 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
* rate for APIs. </p>
* <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
* log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-acm-pca/src/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
* operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
* depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
* request because the request exceeds the operation's quota for the number of requests per
* 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
* 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
* rate for APIs. </p>
* <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
* log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
Expand Down
20 changes: 10 additions & 10 deletions clients/client-acm-pca/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -845,9 +845,9 @@ export interface CreateCertificateAuthorityRequest {
* keys.</p>
* <p>Default: FIPS_140_2_LEVEL_3_OR_HIGHER</p>
* <note>
* <p>Some Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you
* must provide <code>FIPS_140_2_LEVEL_2_OR_HIGHER</code> as the argument for
* <code>KeyStorageSecurityStandard</code>. Failure to do this results in an
* <p>Some Amazon Web Services Regions do not support the default. When creating a CA in these
* Regions, you must provide <code>FIPS_140_2_LEVEL_2_OR_HIGHER</code> as the argument
* for <code>KeyStorageSecurityStandard</code>. Failure to do this results in an
* <code>InvalidArgsException</code> with the message, "A certificate authority
* cannot be created in this region with the specified security standard."</p>
* <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
Expand Down Expand Up @@ -2152,8 +2152,8 @@ export interface IssueCertificateRequest {
* <p>This parameter should not be confused with the <code>SigningAlgorithm</code> parameter
* used to sign a CSR in the <code>CreateCertificateAuthority</code> action.</p>
* <note>
* <p>The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of
* the CA's secret key.</p>
* <p>The specified signing algorithm family (RSA or ECDSA) must match the algorithm
* family of the CA's secret key.</p>
* </note>
*/
SigningAlgorithm: SigningAlgorithm | string | undefined;
Expand Down Expand Up @@ -2212,11 +2212,11 @@ export interface IssueCertificateRequest {

/**
* @public
* <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
* call <b>IssueCertificate</b> multiple times with the same
* idempotency token within one minute, Amazon Web Services Private CA recognizes that you are requesting only
* one certificate and will issue only one. If you change the idempotency token for each
* call, Amazon Web Services Private CA recognizes that you are requesting multiple certificates.</p>
* <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
* you call <b>IssueCertificate</b> multiple times with the same
* idempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting
* only one certificate and will issue only one. If you change the idempotency token for
* each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificates.</p>
*/
IdempotencyToken?: string;
}
Expand Down
8 changes: 4 additions & 4 deletions codegen/sdk-codegen/aws-models/acm-pca.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@
"name": "acm-pca"
},
"aws.protocols#awsJson1_1": {},
"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>",
"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>",
"smithy.api#title": "AWS Certificate Manager Private Certificate Authority",
"smithy.rules#endpointRuleSet": {
"version": "1.0",
Expand Down Expand Up @@ -1927,7 +1927,7 @@
"KeyStorageSecurityStandard": {
"target": "com.amazonaws.acmpca#KeyStorageSecurityStandard",
"traits": {
"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>"
"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>"
}
},
"Tags": {
Expand Down Expand Up @@ -3235,7 +3235,7 @@
"SigningAlgorithm": {
"target": "com.amazonaws.acmpca#SigningAlgorithm",
"traits": {
"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>",
"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>",
"smithy.api#required": {}
}
},
Expand All @@ -3261,7 +3261,7 @@
"IdempotencyToken": {
"target": "com.amazonaws.acmpca#IdempotencyToken",
"traits": {
"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>"
"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>"
}
}
},
Expand Down

0 comments on commit 6a5d800

Please sign in to comment.