Skip to content

Commit

Permalink
feat(clients): update clients as of 03/21/2022 (#3455)
Browse files Browse the repository at this point in the history 
* chore(models): update models as of 03/21/2022

* feat(clients): update clients as of 03/21/2022
  • Loading branch information
@AllanZhengYP
AllanZhengYP committed Mar 21, 2022
1 parent e15b0f5 commit 7cd40a5
Show file tree
Hide file tree
Showing 337 changed files with 33,178 additions and 8,613 deletions.
27 changes: 13 additions & 14 deletions clients/client-acm-pca/README.md
View file
Expand Up @@ -7,23 +7,22 @@

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

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

<p>To see an up-to-date list of your ACM Private CA quotas, or to request a quota increase,
log into your AWS account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
<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>
console.</p>

## Installing
Expand Down
221 changes: 110 additions & 111 deletions clients/client-acm-pca/src/ACMPCA.ts
View file

Large diffs are not rendered by default.

27 changes: 13 additions & 14 deletions clients/client-acm-pca/src/ACMPCAClient.ts
View file
Expand Up @@ -319,23 +319,22 @@ type ACMPCAClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandle
export interface ACMPCAClientResolvedConfig extends ACMPCAClientResolvedConfigType {}

/**
* <p>This is the <i>ACM Private CA API Reference</i>. It provides descriptions,
* <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,
* syntax, and usage examples for each of the actions and data types involved in creating
* and managing private certificate authorities (CA) for your organization.</p>
* <p>The documentation for each action shows the Query API request parameters and the XML
* response. Alternatively, you can use one of the AWS SDKs to access an API that's
* tailored to the programming language or platform that you're using. For more
* information, see <a href="https://aws.amazon.com/tools/#SDKs">AWS
* SDKs</a>.</p>
* <p>Each ACM Private CA API operation has a quota that determines the number of times the operation
* can be called per second. ACM Private CA throttles API requests at different rates depending
* on the operation. Throttling means that ACM 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, 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
* and managing a private certificate authority (CA) for your organization.</p>
* <p>The documentation for each action shows the API request parameters and the JSON
* response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is
* tailored to the programming language or platform that you prefer. For more information,
* see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p>
* <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the
* 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
* rate for APIs. </p>
*
* <p>To see an up-to-date list of your ACM Private CA quotas, or to request a quota increase,
* log into your AWS account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
* <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>
* console.</p>
*/
export class ACMPCAClient extends __Client<
Expand Down
20 changes: 10 additions & 10 deletions clients/client-acm-pca/src/commands/CreateCertificateAuthorityAuditReportCommand.ts
View file
Expand Up @@ -28,22 +28,22 @@ export interface CreateCertificateAuthorityAuditReportCommandOutput
__MetadataBearer {}

/**
* <p>Creates an audit report that lists every time that your CA private key is used. The
* report 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
* <p>Creates an audit report that lists every time that your CA private key is used. The report
* 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
* the private key. </p>
* <note>
* <note>
* <p>Both PCA and the IAM principal must have permission to write to
* the S3 bucket that you specify. If the IAM principal making the call
* does not have permission to write to the bucket, then an exception is
* thrown. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuthAccess.html">Configure
* Access to ACM Private CA</a>.</p>
* </note>
*
* <p>ACM Private CA assets that are stored in Amazon S3 can be protected with encryption.
* thrown. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html#s3-policies">Access
* policies for CRLs in Amazon S3</a>.</p>
* </note>
* <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption.
* For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuditReport.html#audit-report-encryption">Encrypting Your Audit
* Reports</a>.</p>
* <note>
* <p>You can generate a maximum of one report every 30 minutes.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
30 changes: 15 additions & 15 deletions clients/client-acm-pca/src/commands/CreateCertificateAuthorityCommand.ts
View file
Expand Up @@ -23,26 +23,26 @@ export interface CreateCertificateAuthorityCommandOutput extends CreateCertifica

/**
* <p>Creates a root or subordinate private certificate authority (CA). You must specify the
* CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP)
* and/or a certificate revocation list (CRL), the CA type, and
* an optional idempotency token to avoid accidental creation of multiple CAs. The CA
* configuration specifies the name of the algorithm and key size to be used to create the
* CA private key, the type of signing algorithm that the CA uses, and X.500 subject
* information. The OCSP configuration can optionally specify a custom URL for the OCSP responder.
* The CRL configuration specifies the CRL expiration period in days (the
* validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME
* alias for the S3 bucket that is included in certificates issued by the CA. If
* successful, this action returns the Amazon Resource Name (ARN) of the CA.</p>
* <p>ACM Private CA assets that are stored in Amazon S3 can be protected with encryption.
* CA configuration, an optional configuration for Online Certificate Status Protocol
* (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional
* idempotency token to avoid accidental creation of multiple CAs. The CA configuration
* specifies the name of the algorithm and key size to be used to create the CA private
* key, the type of signing algorithm that the CA uses, and X.500 subject information. The
* OCSP configuration can optionally specify a custom URL for the OCSP responder. The CRL
* configuration specifies the CRL expiration period in days (the validity period of the
* CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3
* bucket that is included in certificates issued by the CA. If successful, this action
* returns the Amazon Resource Name (ARN) of the CA.</p>
* <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption.
* For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#crl-encryption">Encrypting Your
* CRLs</a>.</p>
* <note>
* <note>
* <p>Both PCA and the IAM principal must have permission to write to
* the S3 bucket that you specify. If the IAM principal making the call
* does not have permission to write to the bucket, then an exception is
* thrown. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuthAccess.html">Configure
* Access to ACM Private CA</a>.</p>
* </note>
* thrown. For more information, see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html#s3-policies">Access
* policies for CRLs in Amazon S3</a>.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
6 changes: 3 additions & 3 deletions clients/client-acm-pca/src/commands/CreatePermissionCommand.ts
View file
Expand Up @@ -22,9 +22,9 @@ export interface CreatePermissionCommandInput extends CreatePermissionRequest {}
export interface CreatePermissionCommandOutput extends __MetadataBearer {}

/**
* <p>Grants one or more permissions on a private CA to the AWS Certificate Manager (ACM) service
* <p>Grants one or more permissions on a private CA to the Certificate Manager (ACM) service
* principal (<code>acm.amazonaws.com</code>). These permissions allow ACM to issue and
* renew ACM certificates that reside in the same AWS account as the CA.</p>
* renew ACM certificates that reside in the same Amazon Web Services account as the CA.</p>
* <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
* revoke them with the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePermission.html">DeletePermission</a> action.</p>
* <p class="title">
Expand All @@ -46,7 +46,7 @@ export interface CreatePermissionCommandOutput extends __MetadataBearer {}
* the ACM certificate owner must set up a resource-based policy to enable
* cross-account issuance and renewals. For more information, 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>
* Based Policy with Amazon Web Services Private CA</a>.</p>
* </li>
* </ul>
* @example
Expand Down
4 changes: 2 additions & 2 deletions clients/client-acm-pca/src/commands/DeleteCertificateAuthorityCommand.ts
View file
Expand Up @@ -33,8 +33,8 @@ export interface DeleteCertificateAuthorityCommandOutput extends __MetadataBeare
* 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>
* <p>Additionally, you can delete a CA if you are waiting for it to be created (that is,
* the status of the CA is <code>CREATING</code>). You can also delete it if the CA has
* been created but you haven't yet imported the signed certificate into ACM Private CA (that is,
* the status of the CA is <code>PENDING_CERTIFICATE</code>). </p>
* been created but you haven't yet imported the signed certificate into Amazon Web Services Private CA (that
* is, the status of the CA is <code>PENDING_CERTIFICATE</code>). </p>
* <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
* <code>DELETED</code>. However, the CA won't be permanently deleted until the restoration
* period has passed. By default, if you do not set the
Expand Down
8 changes: 4 additions & 4 deletions clients/client-acm-pca/src/commands/DeletePermissionCommand.ts
View file
Expand Up @@ -22,14 +22,14 @@ export interface DeletePermissionCommandInput extends DeletePermissionRequest {}
export interface DeletePermissionCommandOutput extends __MetadataBearer {}

/**
* <p>Revokes permissions on a private CA granted to the AWS Certificate Manager (ACM) service principal
* <p>Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal
* (acm.amazonaws.com). </p>
* <p>These permissions allow ACM to issue and renew ACM certificates that reside in the
* same AWS account as the CA. If you revoke these permissions, ACM will no longer
* same Amazon Web Services account as the CA. If you revoke these permissions, ACM will no longer
* renew the affected certificates automatically.</p>
* <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
* listed with the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListPermissions.html">ListPermissions</a> action. </p>
* <p class="title">
* <p class="title">
* <b>About Permissions</b>
* </p>
* <ul>
Expand All @@ -48,7 +48,7 @@ export interface DeletePermissionCommandOutput extends __MetadataBearer {}
* the ACM certificate owner must set up a resource-based policy to enable
* cross-account issuance and renewals. For more information, 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>
* Based Policy with Amazon Web Services Private CA</a>.</p>
* </li>
* </ul>
* @example
Expand Down
18 changes: 9 additions & 9 deletions clients/client-acm-pca/src/commands/DeletePolicyCommand.ts
View file
Expand Up @@ -25,34 +25,34 @@ export interface DeletePolicyCommandOutput extends __MetadataBearer {}
* <p>Deletes the resource-based policy attached to a private CA. Deletion will remove any
* access that the policy has granted. If there is no policy attached to the private CA,
* this action will return successful.</p>
* <p>If you delete a policy that was applied through AWS Resource Access Manager (RAM), the
* CA will be removed from all shares in which it was included. </p>
* <p>The AWS Certificate Manager Service Linked Role that the policy supports is not affected when you
* <p>If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM),
* the CA will be removed from all shares in which it was included. </p>
* <p>The Certificate Manager Service Linked Role that the policy supports is not affected when you
* delete the policy. </p>
* <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>
* <p class="title">
* <b>About Policies</b>
* </p>
* <ul>
* <li>
* <p>A policy grants access on a private CA to an AWS customer account, to AWS Organizations, or to
* an AWS Organizations unit. Policies are under the control of a CA administrator. For more information,
* 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>
* <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to
* an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information,
* 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>
* </li>
* <li>
* <p>A policy permits a user of AWS Certificate Manager (ACM) to issue ACM certificates
* <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates
* signed by a CA in another account.</p>
* </li>
* <li>
* <p>For ACM to manage automatic renewal of these certificates,
* the ACM user must configure a Service Linked Role (SLR). The SLR allows
* the ACM service to assume the identity of the user, subject to confirmation against the
* ACM Private CA policy. For more information, see
* Amazon Web Services Private CA policy. For more information, see
* <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html">Using a
* Service Linked Role with ACM</a>.</p>
* </li>
* <li>
* <p>Updates made in AWS Resource Manager (RAM) are reflected in policies. For more information,
* <p>Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information,
* see <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-ram.html">Attach a Policy for Cross-Account
* Access</a>.</p>
* </li>
Expand Down

0 comments on commit 7cd40a5

Please sign in to comment.