Skip to content

Commit 7cd40a5

Browse files
authored
feat(clients): update clients as of 03/21/2022 (#3455)
* chore(models): update models as of 03/21/2022 * feat(clients): update clients as of 03/21/2022
1 parent e15b0f5 commit 7cd40a5

File tree

337 files changed

+33178
-8613
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

337 files changed

+33178
-8613
lines changed

clients/client-acm-pca/README.md

+13-14
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,22 @@
77

88
AWS SDK for JavaScript ACMPCA Client for Node.js, Browser and React Native.
99

10-
<p>This is the <i>ACM Private CA API Reference</i>. It provides descriptions,
10+
<p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,
1111
syntax, and usage examples for each of the actions and data types involved in creating
12-
and managing private certificate authorities (CA) for your organization.</p>
13-
<p>The documentation for each action shows the Query API request parameters and the XML
14-
response. Alternatively, you can use one of the AWS SDKs to access an API that's
15-
tailored to the programming language or platform that you're using. For more
16-
information, see <a href="https://aws.amazon.com/tools/#SDKs">AWS
17-
SDKs</a>.</p>
18-
<p>Each ACM Private CA API operation has a quota that determines the number of times the operation
19-
can be called per second. ACM Private CA throttles API requests at different rates depending
20-
on the operation. Throttling means that ACM Private CA rejects an otherwise valid request
21-
because the request exceeds the operation's quota for the number of requests per second.
22-
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
12+
and managing a private certificate authority (CA) for your organization.</p>
13+
<p>The documentation for each action shows the API request parameters and the JSON
14+
response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is
15+
tailored to the programming language or platform that you prefer. For more information,
16+
see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p>
17+
<p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the
18+
operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
19+
depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
20+
request because the request exceeds the operation's quota for the number of requests per
21+
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
2322
rate for APIs. </p>
2423

25-
<p>To see an up-to-date list of your ACM Private CA quotas, or to request a quota increase,
26-
log into your AWS account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
24+
<p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
25+
log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
2726
console.</p>
2827

2928
## Installing

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

+110-111
Large diffs are not rendered by default.

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

+13-14
Original file line numberDiff line numberDiff line change
@@ -319,23 +319,22 @@ type ACMPCAClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandle
319319
export interface ACMPCAClientResolvedConfig extends ACMPCAClientResolvedConfigType {}
320320

321321
/**
322-
* <p>This is the <i>ACM Private CA API Reference</i>. It provides descriptions,
322+
* <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,
323323
* syntax, and usage examples for each of the actions and data types involved in creating
324-
* and managing private certificate authorities (CA) for your organization.</p>
325-
* <p>The documentation for each action shows the Query API request parameters and the XML
326-
* response. Alternatively, you can use one of the AWS SDKs to access an API that's
327-
* tailored to the programming language or platform that you're using. For more
328-
* information, see <a href="https://aws.amazon.com/tools/#SDKs">AWS
329-
* SDKs</a>.</p>
330-
* <p>Each ACM Private CA API operation has a quota that determines the number of times the operation
331-
* can be called per second. ACM Private CA throttles API requests at different rates depending
332-
* on the operation. Throttling means that ACM Private CA rejects an otherwise valid request
333-
* because the request exceeds the operation's quota for the number of requests per second.
334-
* 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
324+
* and managing a private certificate authority (CA) for your organization.</p>
325+
* <p>The documentation for each action shows the API request parameters and the JSON
326+
* response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is
327+
* tailored to the programming language or platform that you prefer. For more information,
328+
* see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p>
329+
* <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the
330+
* operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
331+
* depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
332+
* request because the request exceeds the operation's quota for the number of requests per
333+
* 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
335334
* rate for APIs. </p>
336335
*
337-
* <p>To see an up-to-date list of your ACM Private CA quotas, or to request a quota increase,
338-
* log into your AWS account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
336+
* <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
337+
* log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
339338
* console.</p>
340339
*/
341340
export class ACMPCAClient extends __Client<

clients/client-acm-pca/src/commands/CreateCertificateAuthorityAuditReportCommand.ts

+10-10
Original file line numberDiff line numberDiff line change
@@ -28,22 +28,22 @@ export interface CreateCertificateAuthorityAuditReportCommandOutput
2828
__MetadataBearer {}
2929

3030
/**
31-
* <p>Creates an audit report that lists every time that your CA private key is used. The
32-
* report is saved in the Amazon S3 bucket that you specify on input.
33-
*
34-
* The <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a> and <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> actions use
31+
* <p>Creates an audit report that lists every time that your CA private key is used. The report
32+
* is saved in the Amazon S3 bucket that you specify on input. The <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a> and <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> actions use
3533
* the private key. </p>
36-
* <note>
34+
* <note>
3735
* <p>Both PCA and the IAM principal must have permission to write to
3836
* the S3 bucket that you specify. If the IAM principal making the call
3937
* does not have permission to write to the bucket, then an exception is
40-
* thrown. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuthAccess.html">Configure
41-
* Access to ACM Private CA</a>.</p>
42-
* </note>
43-
*
44-
* <p>ACM Private CA assets that are stored in Amazon S3 can be protected with encryption.
38+
* thrown. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html#s3-policies">Access
39+
* policies for CRLs in Amazon S3</a>.</p>
40+
* </note>
41+
* <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption.
4542
* For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuditReport.html#audit-report-encryption">Encrypting Your Audit
4643
* Reports</a>.</p>
44+
* <note>
45+
* <p>You can generate a maximum of one report every 30 minutes.</p>
46+
* </note>
4747
* @example
4848
* Use a bare-bones client and the command you need to make an API call.
4949
* ```javascript

clients/client-acm-pca/src/commands/CreateCertificateAuthorityCommand.ts

+15-15
Original file line numberDiff line numberDiff line change
@@ -23,26 +23,26 @@ export interface CreateCertificateAuthorityCommandOutput extends CreateCertifica
2323

2424
/**
2525
* <p>Creates a root or subordinate private certificate authority (CA). You must specify the
26-
* CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP)
27-
* and/or a certificate revocation list (CRL), the CA type, and
28-
* an optional idempotency token to avoid accidental creation of multiple CAs. The CA
29-
* configuration specifies the name of the algorithm and key size to be used to create the
30-
* CA private key, the type of signing algorithm that the CA uses, and X.500 subject
31-
* information. The OCSP configuration can optionally specify a custom URL for the OCSP responder.
32-
* The CRL configuration specifies the CRL expiration period in days (the
33-
* validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME
34-
* alias for the S3 bucket that is included in certificates issued by the CA. If
35-
* successful, this action returns the Amazon Resource Name (ARN) of the CA.</p>
36-
* <p>ACM Private CA assets that are stored in Amazon S3 can be protected with encryption.
26+
* CA configuration, an optional configuration for Online Certificate Status Protocol
27+
* (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional
28+
* idempotency token to avoid accidental creation of multiple CAs. The CA configuration
29+
* specifies the name of the algorithm and key size to be used to create the CA private
30+
* key, the type of signing algorithm that the CA uses, and X.500 subject information. The
31+
* OCSP configuration can optionally specify a custom URL for the OCSP responder. The CRL
32+
* configuration specifies the CRL expiration period in days (the validity period of the
33+
* CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3
34+
* bucket that is included in certificates issued by the CA. If successful, this action
35+
* returns the Amazon Resource Name (ARN) of the CA.</p>
36+
* <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption.
3737
* For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#crl-encryption">Encrypting Your
3838
* CRLs</a>.</p>
39-
* <note>
39+
* <note>
4040
* <p>Both PCA and the IAM principal must have permission to write to
4141
* the S3 bucket that you specify. If the IAM principal making the call
4242
* does not have permission to write to the bucket, then an exception is
43-
* thrown. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuthAccess.html">Configure
44-
* Access to ACM Private CA</a>.</p>
45-
* </note>
43+
* thrown. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html#s3-policies">Access
44+
* policies for CRLs in Amazon S3</a>.</p>
45+
* </note>
4646
* @example
4747
* Use a bare-bones client and the command you need to make an API call.
4848
* ```javascript

clients/client-acm-pca/src/commands/CreatePermissionCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ export interface CreatePermissionCommandInput extends CreatePermissionRequest {}
2222
export interface CreatePermissionCommandOutput extends __MetadataBearer {}
2323

2424
/**
25-
* <p>Grants one or more permissions on a private CA to the AWS Certificate Manager (ACM) service
25+
* <p>Grants one or more permissions on a private CA to the Certificate Manager (ACM) service
2626
* principal (<code>acm.amazonaws.com</code>). These permissions allow ACM to issue and
27-
* renew ACM certificates that reside in the same AWS account as the CA.</p>
27+
* renew ACM certificates that reside in the same Amazon Web Services account as the CA.</p>
2828
* <p>You can list current permissions with the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListPermissions.html">ListPermissions</a> action and
2929
* revoke them with the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePermission.html">DeletePermission</a> action.</p>
3030
* <p class="title">
@@ -46,7 +46,7 @@ export interface CreatePermissionCommandOutput extends __MetadataBearer {}
4646
* the ACM certificate owner must set up a resource-based policy to enable
4747
* cross-account issuance and renewals. For more information, see
4848
* <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html">Using a Resource
49-
* Based Policy with ACM Private CA</a>.</p>
49+
* Based Policy with Amazon Web Services Private CA</a>.</p>
5050
* </li>
5151
* </ul>
5252
* @example

clients/client-acm-pca/src/commands/DeleteCertificateAuthorityCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ export interface DeleteCertificateAuthorityCommandOutput extends __MetadataBeare
3333
* To do this, call the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html">UpdateCertificateAuthority</a> action and set the <b>CertificateAuthorityStatus</b> parameter to <code>DISABLED</code>. </p>
3434
* <p>Additionally, you can delete a CA if you are waiting for it to be created (that is,
3535
* the status of the CA is <code>CREATING</code>). You can also delete it if the CA has
36-
* been created but you haven't yet imported the signed certificate into ACM Private CA (that is,
37-
* the status of the CA is <code>PENDING_CERTIFICATE</code>). </p>
36+
* been created but you haven't yet imported the signed certificate into Amazon Web Services Private CA (that
37+
* is, the status of the CA is <code>PENDING_CERTIFICATE</code>). </p>
3838
* <p>When you successfully call <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeleteCertificateAuthority.html">DeleteCertificateAuthority</a>, the CA's status changes to
3939
* <code>DELETED</code>. However, the CA won't be permanently deleted until the restoration
4040
* period has passed. By default, if you do not set the

clients/client-acm-pca/src/commands/DeletePermissionCommand.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@ export interface DeletePermissionCommandInput extends DeletePermissionRequest {}
2222
export interface DeletePermissionCommandOutput extends __MetadataBearer {}
2323

2424
/**
25-
* <p>Revokes permissions on a private CA granted to the AWS Certificate Manager (ACM) service principal
25+
* <p>Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal
2626
* (acm.amazonaws.com). </p>
2727
* <p>These permissions allow ACM to issue and renew ACM certificates that reside in the
28-
* same AWS account as the CA. If you revoke these permissions, ACM will no longer
28+
* same Amazon Web Services account as the CA. If you revoke these permissions, ACM will no longer
2929
* renew the affected certificates automatically.</p>
3030
* <p>Permissions can be granted with the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreatePermission.html">CreatePermission</a> action and
3131
* listed with the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListPermissions.html">ListPermissions</a> action. </p>
32-
* <p class="title">
32+
* <p class="title">
3333
* <b>About Permissions</b>
3434
* </p>
3535
* <ul>
@@ -48,7 +48,7 @@ export interface DeletePermissionCommandOutput extends __MetadataBearer {}
4848
* the ACM certificate owner must set up a resource-based policy to enable
4949
* cross-account issuance and renewals. For more information, see
5050
* <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html">Using a Resource
51-
* Based Policy with ACM Private CA</a>.</p>
51+
* Based Policy with Amazon Web Services Private CA</a>.</p>
5252
* </li>
5353
* </ul>
5454
* @example

clients/client-acm-pca/src/commands/DeletePolicyCommand.ts

+9-9
Original file line numberDiff line numberDiff line change
@@ -25,34 +25,34 @@ export interface DeletePolicyCommandOutput extends __MetadataBearer {}
2525
* <p>Deletes the resource-based policy attached to a private CA. Deletion will remove any
2626
* access that the policy has granted. If there is no policy attached to the private CA,
2727
* this action will return successful.</p>
28-
* <p>If you delete a policy that was applied through AWS Resource Access Manager (RAM), the
29-
* CA will be removed from all shares in which it was included. </p>
30-
* <p>The AWS Certificate Manager Service Linked Role that the policy supports is not affected when you
28+
* <p>If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM),
29+
* the CA will be removed from all shares in which it was included. </p>
30+
* <p>The Certificate Manager Service Linked Role that the policy supports is not affected when you
3131
* delete the policy. </p>
3232
* <p>The current policy can be shown with <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetPolicy.html">GetPolicy</a> and updated with <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_PutPolicy.html">PutPolicy</a>.</p>
3333
* <p class="title">
3434
* <b>About Policies</b>
3535
* </p>
3636
* <ul>
3737
* <li>
38-
* <p>A policy grants access on a private CA to an AWS customer account, to AWS Organizations, or to
39-
* an AWS Organizations unit. Policies are under the control of a CA administrator. For more information,
40-
* see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html">Using a Resource Based Policy with ACM Private CA</a>.</p>
38+
* <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to
39+
* an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information,
40+
* see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html">Using a Resource Based Policy with Amazon Web Services Private CA</a>.</p>
4141
* </li>
4242
* <li>
43-
* <p>A policy permits a user of AWS Certificate Manager (ACM) to issue ACM certificates
43+
* <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates
4444
* signed by a CA in another account.</p>
4545
* </li>
4646
* <li>
4747
* <p>For ACM to manage automatic renewal of these certificates,
4848
* the ACM user must configure a Service Linked Role (SLR). The SLR allows
4949
* the ACM service to assume the identity of the user, subject to confirmation against the
50-
* ACM Private CA policy. For more information, see
50+
* Amazon Web Services Private CA policy. For more information, see
5151
* <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using a
5252
* Service Linked Role with ACM</a>.</p>
5353
* </li>
5454
* <li>
55-
* <p>Updates made in AWS Resource Manager (RAM) are reflected in policies. For more information,
55+
* <p>Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information,
5656
* see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-ram.html">Attach a Policy for Cross-Account
5757
* Access</a>.</p>
5858
* </li>

0 commit comments

Comments
 (0)