From 6a5d80068bc1c1a39c0d035d82b266bfc0a41c64 Mon Sep 17 00:00:00 2001 From: awstools Date: Fri, 4 Aug 2023 18:24:44 +0000 Subject: [PATCH] docs(client-acm-pca): Documentation correction for AWS Private CA --- clients/client-acm-pca/README.md | 2 +- clients/client-acm-pca/src/ACMPCA.ts | 2 +- clients/client-acm-pca/src/ACMPCAClient.ts | 2 +- clients/client-acm-pca/src/index.ts | 2 +- clients/client-acm-pca/src/models/models_0.ts | 20 +++++++++---------- codegen/sdk-codegen/aws-models/acm-pca.json | 8 ++++---- 6 files changed, 18 insertions(+), 18 deletions(-) diff --git a/clients/client-acm-pca/README.md b/clients/client-acm-pca/README.md index 4dc6a230d9b4..3de4ae0b313b 100644 --- a/clients/client-acm-pca/README.md +++ b/clients/client-acm-pca/README.md @@ -17,7 +17,7 @@ see Amazon Web Services SDKs.ThrottlingException 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 ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request rate for APIs.

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 Service Quotas diff --git a/clients/client-acm-pca/src/ACMPCA.ts b/clients/client-acm-pca/src/ACMPCA.ts index d3d653d0b0eb..aedab51b4205 100644 --- a/clients/client-acm-pca/src/ACMPCA.ts +++ b/clients/client-acm-pca/src/ACMPCA.ts @@ -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 ThrottlingException 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 ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request * rate for APIs.

*

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 Service Quotas diff --git a/clients/client-acm-pca/src/ACMPCAClient.ts b/clients/client-acm-pca/src/ACMPCAClient.ts index a54455161b3b..f46aeb48512b 100644 --- a/clients/client-acm-pca/src/ACMPCAClient.ts +++ b/clients/client-acm-pca/src/ACMPCAClient.ts @@ -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 ThrottlingException 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 ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request * rate for APIs.

*

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 Service Quotas diff --git a/clients/client-acm-pca/src/index.ts b/clients/client-acm-pca/src/index.ts index f275ec5196be..e23662987a77 100644 --- a/clients/client-acm-pca/src/index.ts +++ b/clients/client-acm-pca/src/index.ts @@ -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 ThrottlingException 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 ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request * rate for APIs.

*

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 Service Quotas diff --git a/clients/client-acm-pca/src/models/models_0.ts b/clients/client-acm-pca/src/models/models_0.ts index a46b2b1473c3..54466ad5a063 100644 --- a/clients/client-acm-pca/src/models/models_0.ts +++ b/clients/client-acm-pca/src/models/models_0.ts @@ -845,9 +845,9 @@ export interface CreateCertificateAuthorityRequest { * keys.

*

Default: FIPS_140_2_LEVEL_3_OR_HIGHER

* - *

Some Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you - * must provide FIPS_140_2_LEVEL_2_OR_HIGHER as the argument for - * KeyStorageSecurityStandard. Failure to do this results in an + *

Some Amazon Web Services Regions do not support the default. When creating a CA in these + * Regions, you must provide FIPS_140_2_LEVEL_2_OR_HIGHER as the argument + * for KeyStorageSecurityStandard. Failure to do this results in an * InvalidArgsException with the message, "A certificate authority * cannot be created in this region with the specified security standard."

*

For information about security standard support in various Regions, see Storage @@ -2152,8 +2152,8 @@ export interface IssueCertificateRequest { *

This parameter should not be confused with the SigningAlgorithm parameter * used to sign a CSR in the CreateCertificateAuthority action.

* - *

The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of - * the CA's secret key.

+ *

The specified signing algorithm family (RSA or ECDSA) must match the algorithm + * family of the CA's secret key.

* */ SigningAlgorithm: SigningAlgorithm | string | undefined; @@ -2212,11 +2212,11 @@ export interface IssueCertificateRequest { /** * @public - *

Alphanumeric string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens for IssueCertificate time out after one minute. Therefore, if you - * call IssueCertificate 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.

+ *

Alphanumeric string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens for IssueCertificate time out after five minutes. Therefore, if + * you call IssueCertificate 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.

*/ IdempotencyToken?: string; } diff --git a/codegen/sdk-codegen/aws-models/acm-pca.json b/codegen/sdk-codegen/aws-models/acm-pca.json index 597ac1b6b9ac..9f0c8f1d646f 100644 --- a/codegen/sdk-codegen/aws-models/acm-pca.json +++ b/codegen/sdk-codegen/aws-models/acm-pca.json @@ -115,7 +115,7 @@ "name": "acm-pca" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

This is the Amazon Web Services Private Certificate Authority API Reference. 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.

\n

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 Amazon Web Services SDKs.

\n

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 ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request\n\t\t\trate for APIs.

\n

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 Service Quotas\n\t\t\tconsole.

", + "smithy.api#documentation": "

This is the Amazon Web Services Private Certificate Authority API Reference. 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.

\n

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 Amazon Web Services SDKs.

\n

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 ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request\n\t\t\trate for APIs.

\n

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 Service Quotas\n\t\t\tconsole.

", "smithy.api#title": "AWS Certificate Manager Private Certificate Authority", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1927,7 +1927,7 @@ "KeyStorageSecurityStandard": { "target": "com.amazonaws.acmpca#KeyStorageSecurityStandard", "traits": { - "smithy.api#documentation": "

Specifies a cryptographic key management compliance standard used for handling CA\n\t\t\tkeys.

\n

Default: FIPS_140_2_LEVEL_3_OR_HIGHER

\n \n

Some Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you\n\t\t\t\tmust provide FIPS_140_2_LEVEL_2_OR_HIGHER as the argument for\n\t\t\t\t\tKeyStorageSecurityStandard. Failure to do this results in an\n\t\t\t\t\tInvalidArgsException with the message, \"A certificate authority\n\t\t\t\tcannot be created in this region with the specified security standard.\"

\n

For information about security standard support in various Regions, see Storage\n\t\t\t\t\tand security compliance of Amazon Web Services Private CA private keys.

\n " + "smithy.api#documentation": "

Specifies a cryptographic key management compliance standard used for handling CA\n\t\t\tkeys.

\n

Default: FIPS_140_2_LEVEL_3_OR_HIGHER

\n \n

Some Amazon Web Services Regions do not support the default. When creating a CA in these\n\t\t\t\tRegions, you must provide FIPS_140_2_LEVEL_2_OR_HIGHER as the argument\n\t\t\t\tfor KeyStorageSecurityStandard. Failure to do this results in an\n\t\t\t\t\tInvalidArgsException with the message, \"A certificate authority\n\t\t\t\tcannot be created in this region with the specified security standard.\"

\n

For information about security standard support in various Regions, see Storage\n\t\t\t\t\tand security compliance of Amazon Web Services Private CA private keys.

\n " } }, "Tags": { @@ -3235,7 +3235,7 @@ "SigningAlgorithm": { "target": "com.amazonaws.acmpca#SigningAlgorithm", "traits": { - "smithy.api#documentation": "

The name of the algorithm that will be used to sign the certificate to be issued.

\n

This parameter should not be confused with the SigningAlgorithm parameter\n\t\t\tused to sign a CSR in the CreateCertificateAuthority action.

\n \n

The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of\n\t\t\t\tthe CA's secret key.

\n ", + "smithy.api#documentation": "

The name of the algorithm that will be used to sign the certificate to be issued.

\n

This parameter should not be confused with the SigningAlgorithm parameter\n\t\t\tused to sign a CSR in the CreateCertificateAuthority action.

\n \n

The specified signing algorithm family (RSA or ECDSA) must match the algorithm\n\t\t\t\tfamily of the CA's secret key.

\n ", "smithy.api#required": {} } }, @@ -3261,7 +3261,7 @@ "IdempotencyToken": { "target": "com.amazonaws.acmpca#IdempotencyToken", "traits": { - "smithy.api#documentation": "

Alphanumeric string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens for IssueCertificate time out after one minute. Therefore, if you\n\t\t\tcall IssueCertificate 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.

" + "smithy.api#documentation": "

Alphanumeric string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens for IssueCertificate time out after five minutes. Therefore, if\n\t\t\tyou call IssueCertificate 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.

" } } },