Skip to content

Commit 6447aca

Browse files
author
awstools
committed
docs(client-acm-pca): AWS Certificate Manager (ACM) Private Certificate Authority (PCA) documentation updates
1 parent 358a73e commit 6447aca

File tree

5 files changed

+72
-59
lines changed

5 files changed

+72
-59
lines changed

clients/client-acm-pca/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ depending on the operation. Throttling means that ACM Private CA rejects an othe
2222
request because the request exceeds the operation's quota for the number of requests per
2323
second. When a request is throttled, ACM Private CA returns a <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. ACM Private CA does not guarantee a minimum request
2424
rate for APIs. </p>
25-
2625
<p>To see an up-to-date list of your ACM Private CA quotas, or to request a quota increase,
2726
log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
2827
console.</p>

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,6 @@ import {
120120
* request because the request exceeds the operation's quota for the number of requests per
121121
* second. When a request is throttled, ACM Private CA returns a <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. ACM Private CA does not guarantee a minimum request
122122
* rate for APIs. </p>
123-
*
124123
* <p>To see an up-to-date list of your ACM Private CA quotas, or to request a quota increase,
125124
* log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
126125
* console.</p>

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,6 @@ export interface ACMPCAClientResolvedConfig extends ACMPCAClientResolvedConfigTy
334334
* request because the request exceeds the operation's quota for the number of requests per
335335
* second. When a request is throttled, ACM Private CA returns a <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. ACM Private CA does not guarantee a minimum request
336336
* rate for APIs. </p>
337-
*
338337
* <p>To see an up-to-date list of your ACM Private CA quotas, or to request a quota increase,
339338
* log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
340339
* console.</p>

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

Lines changed: 28 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,14 @@ import { ACMPCAServiceException as __BaseException } from "./ACMPCAServiceExcept
88
*/
99
export interface CustomAttribute {
1010
/**
11-
* <p>Specifies the object identifier (OID) of the attribute type of
12-
* the
13-
* relative distinguished name
14-
* (RDN).</p>
11+
* <p>Specifies the object identifier (OID) of the attribute type of the relative
12+
* distinguished name (RDN).</p>
1513
*/
1614
ObjectIdentifier: string | undefined;
1715

1816
/**
1917
* <p></p>
20-
* <p>Specifies the attribute value of relative distinguished name
21-
* (RDN).</p>
18+
* <p>Specifies the attribute value of relative distinguished name (RDN).</p>
2219
*/
2320
Value: string | undefined;
2421
}
@@ -125,16 +122,9 @@ export interface ASN1Subject {
125122

126123
/**
127124
* <p></p>
128-
* <p>Contains a sequence of one or more X.500 relative distinguished
129-
* names
130-
* (RDNs),
131-
* each of which consists of an object identifier (OID) and
132-
* a
133-
* value. For more information, see NIST’s definition of
134-
* <a href="https://csrc.nist.gov/glossary/term/Object_Identifier">Object
135-
* Identifier
136-
* (OID)</a>.</p>
137-
*
125+
* <p>Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of
126+
* which consists of an object identifier (OID) and a value. For more information, see
127+
* NIST’s definition of <a href="https://csrc.nist.gov/glossary/term/Object_Identifier">Object Identifier (OID)</a>.</p>
138128
* <note>
139129
* <p>Custom attributes cannot be used in combination with standard attributes.</p>
140130
* </note>
@@ -504,11 +494,9 @@ export enum S3ObjectAcl {
504494
* certificate's expiration date or when a certificate is revoked. When a certificate is
505495
* revoked, it appears in the CRL until the certificate expires, and then in one additional
506496
* CRL after expiration, and it always appears in the audit report.</p>
507-
*
508497
* <p>A CRL is typically updated approximately 30 minutes after a certificate
509498
* is revoked. If for any reason a CRL update fails, ACM Private CA makes further attempts
510499
* every 15 minutes.</p>
511-
*
512500
* <p>CRLs contain the following fields:</p>
513501
* <ul>
514502
* <li>
@@ -792,11 +780,22 @@ export interface CreateCertificateAuthorityRequest {
792780
IdempotencyToken?: string;
793781

794782
/**
795-
* <p>Specifies a
796-
* cryptographic key management compliance standard used for handling CA keys.</p>
783+
* <p>Specifies a cryptographic key management compliance standard used for handling CA
784+
* keys.</p>
797785
* <p>Default: FIPS_140_2_LEVEL_3_OR_HIGHER</p>
798-
* <p>Note: <code>FIPS_140_2_LEVEL_3_OR_HIGHER</code> is not supported in Region
799-
* ap-northeast-3. When creating a CA in the ap-northeast-3, you must provide
786+
* <p>
787+
* <i>Note:</i>
788+
* <code>FIPS_140_2_LEVEL_3_OR_HIGHER</code> is not supported in the following
789+
* Regions:</p>
790+
* <ul>
791+
* <li>
792+
* <p>ap-northeast-3</p>
793+
* </li>
794+
* <li>
795+
* <p>ap-southeast-3</p>
796+
* </li>
797+
* </ul>
798+
* <p>When creating a CA in these Regions, you must provide
800799
* <code>FIPS_140_2_LEVEL_2_OR_HIGHER</code> as the argument for
801800
* <code>KeyStorageSecurityStandard</code>. Failure to do this results in an
802801
* <code>InvalidArgsException</code> with the message, "A certificate authority cannot
@@ -1819,8 +1818,7 @@ export namespace PolicyInformation {
18191818

18201819
/**
18211820
* <p></p>
1822-
* <p>Specifies the X.509 extension information for a
1823-
* certificate.</p>
1821+
* <p>Specifies the X.509 extension information for a certificate.</p>
18241822
* <p>Extensions present in <code>CustomExtensions</code> follow the
18251823
* <code>ApiPassthrough</code>
18261824
* <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/UsingTemplates.html#template-order-of-operations">template
@@ -1829,27 +1827,21 @@ export namespace PolicyInformation {
18291827
export interface CustomExtension {
18301828
/**
18311829
* <p></p>
1832-
* <p>Specifies the object identifier (OID) of the X.509 extension. For more information,
1833-
* see the
1834-
* <a href="https://oidref.com/2.5.29">Global OID reference
1835-
* database.</a>
1830+
* <p>Specifies the object identifier (OID) of the X.509 extension. For more information, see the
1831+
* <a href="https://oidref.com/2.5.29">Global OID reference database.</a>
18361832
* </p>
18371833
*/
18381834
ObjectIdentifier: string | undefined;
18391835

18401836
/**
18411837
* <p></p>
1842-
* <p>Specifies the base64-encoded value of the X.509
1843-
* extension.</p>
1838+
* <p>Specifies the base64-encoded value of the X.509 extension.</p>
18441839
*/
18451840
Value: string | undefined;
18461841

18471842
/**
18481843
* <p></p>
1849-
* <p>Specifies the critical flag of
1850-
* the
1851-
* X.509
1852-
* extension.</p>
1844+
* <p>Specifies the critical flag of the X.509 extension.</p>
18531845
*/
18541846
Critical?: boolean;
18551847
}
@@ -1940,19 +1932,10 @@ export interface Extensions {
19401932
/**
19411933
* <p></p>
19421934
* <p>Contains a sequence of one or more X.509 extensions, each of which consists of an
1943-
* object identifier (OID), a base64-encoded
1944-
* value,
1945-
* and the
1946-
* critical flag.
1947-
* For
1948-
* more information, see the <a href="https://oidref.com/2.5.29">Global OID reference
1935+
* object identifier (OID), a base64-encoded value, and the critical flag. For more
1936+
* information, see the <a href="https://oidref.com/2.5.29">Global OID reference
19491937
* database.</a>
19501938
* </p>
1951-
*
1952-
* <note>
1953-
* <p>The OID value of a <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CustomExtension.html">CustomExtension</a> must not
1954-
* match the OID of a predefined extension.</p>
1955-
* </note>
19561939
*/
19571940
CustomExtensions?: CustomExtension[];
19581941
}

0 commit comments

Comments
 (0)