Skip to content

feat(clients): update clients as of 07/16/2021 #2591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
27 changes: 16 additions & 11 deletions clients/client-acm/ACM.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,14 +77,14 @@ import {
import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";

/**
* <fullname>AWS Certificate Manager</fullname>
* <p>You can use AWS Certificate Manager (ACM) to manage SSL/TLS certificates for your AWS-based websites
* and applications. For more information about using ACM, see the <a href="https://docs.aws.amazon.com/acm/latest/userguide/">AWS Certificate Manager User Guide</a>.</p>
* <fullname>Amazon Web Services Certificate Manager</fullname>
* <p>You can use Amazon Web Services Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites
* and applications. For more information about using ACM, see the <a href="https://docs.aws.amazon.com/acm/latest/userguide/">Amazon Web Services Certificate Manager User Guide</a>.</p>
*/
export class ACM extends ACMClient {
/**
* <p>Adds one or more tags to an ACM certificate. Tags are labels that you can use to
* identify and organize your AWS resources. Each tag consists of a <code>key</code> and an
* identify and organize your Amazon Web Services resources. Each tag consists of a <code>key</code> and an
* optional <code>value</code>. You specify the certificate on input by its Amazon Resource Name
* (ARN). You specify the tag by using a key-value pair. </p>
*
Expand Down Expand Up @@ -131,10 +131,10 @@ export class ACM extends ACMClient {

/**
* <p>Deletes a certificate and its associated private key. If this action succeeds, the
* certificate no longer appears in the list that can be displayed by calling the <a>ListCertificates</a> action or be retrieved by calling the <a>GetCertificate</a> action. The certificate will not be available for use by AWS
* certificate no longer appears in the list that can be displayed by calling the <a>ListCertificates</a> action or be retrieved by calling the <a>GetCertificate</a> action. The certificate will not be available for use by Amazon Web Services
* services integrated with ACM. </p>
* <note>
* <p>You cannot delete an ACM certificate that is being used by another AWS service. To
* <p>You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To
* delete a certificate that is in use, the certificate association must first be
* removed.</p>
* </note>
Expand Down Expand Up @@ -240,7 +240,7 @@ export class ACM extends ACMClient {

/**
* <p>Returns the account
* configuration options associated with an AWS account.</p>
* configuration options associated with an Amazon Web Services account.</p>
*/
public getAccountConfiguration(
args: GetAccountConfigurationCommandInput,
Expand Down Expand Up @@ -307,13 +307,13 @@ export class ACM extends ACMClient {
}

/**
* <p>Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with
* <p>Imports a certificate into Amazon Web Services Certificate Manager (ACM) to use with services that are integrated with
* ACM. Note that <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-services.html">integrated
* services</a> allow only certificate types and keys they support to be associated with
* their resources. Further, their support differs depending on whether the certificate is
* imported into IAM or into ACM. For more information, see the documentation for each
* service. For more information about importing certificates into ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing
* Certificates</a> in the <i>AWS Certificate Manager User Guide</i>. </p>
* Certificates</a> in the <i>Amazon Web Services Certificate Manager User Guide</i>. </p>
*
* <note>
* <p>ACM does not provide <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a> for certificates that you import.</p>
Expand Down Expand Up @@ -594,16 +594,21 @@ export class ACM extends ACMClient {
}

/**
* <p>Requests an ACM certificate for use with other AWS services. To request an ACM
* <p>Requests an ACM certificate for use with other Amazon Web Services services. To request an ACM
* certificate, you must specify a fully qualified domain name (FQDN) in the
* <code>DomainName</code> parameter. You can also specify additional FQDNs in the
* <code>SubjectAlternativeNames</code> parameter. </p>
*
* <p>If you are requesting a private certificate, domain validation is not required. If you are
* requesting a public certificate, each domain name that you specify must be validated to verify
* that you own or control the domain. You can use <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html">DNS validation</a> or <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html">email validation</a>.
* We recommend that you use DNS validation. ACM issues public certificates after receiving
* approval from the domain owner. </p>
*
* <note>
* <p>ACM behavior differs from the <a href="https://tools.ietf.org/html/rfc6125#appendix-B.2">https://tools.ietf.org/html/rfc6125#appendix-B.2</a>RFC 6125 specification of the
* certificate validation process. first checks for a subject alternative name, and, if it
* finds one, ignores the common name (CN)</p>
* </note>
*/
public requestCertificate(
args: RequestCertificateCommandInput,
Expand Down
6 changes: 3 additions & 3 deletions clients/client-acm/ACMClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -263,9 +263,9 @@ type ACMClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOp
export interface ACMClientResolvedConfig extends ACMClientResolvedConfigType {}

/**
* <fullname>AWS Certificate Manager</fullname>
* <p>You can use AWS Certificate Manager (ACM) to manage SSL/TLS certificates for your AWS-based websites
* and applications. For more information about using ACM, see the <a href="https://docs.aws.amazon.com/acm/latest/userguide/">AWS Certificate Manager User Guide</a>.</p>
* <fullname>Amazon Web Services Certificate Manager</fullname>
* <p>You can use Amazon Web Services Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites
* and applications. For more information about using ACM, see the <a href="https://docs.aws.amazon.com/acm/latest/userguide/">Amazon Web Services Certificate Manager User Guide</a>.</p>
*/
export class ACMClient extends __Client<
__HttpHandlerOptions,
Expand Down
6 changes: 3 additions & 3 deletions clients/client-acm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@

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

<fullname>AWS Certificate Manager</fullname>
<fullname>Amazon Web Services Certificate Manager</fullname>

<p>You can use AWS Certificate Manager (ACM) to manage SSL/TLS certificates for your AWS-based websites
and applications. For more information about using ACM, see the <a href="https://docs.aws.amazon.com/acm/latest/userguide/">AWS Certificate Manager User Guide</a>.</p>
<p>You can use Amazon Web Services Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites
and applications. For more information about using ACM, see the <a href="https://docs.aws.amazon.com/acm/latest/userguide/">Amazon Web Services Certificate Manager User Guide</a>.</p>

## Installing

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export interface AddTagsToCertificateCommandOutput extends __MetadataBearer {}

/**
* <p>Adds one or more tags to an ACM certificate. Tags are labels that you can use to
* identify and organize your AWS resources. Each tag consists of a <code>key</code> and an
* identify and organize your Amazon Web Services resources. Each tag consists of a <code>key</code> and an
* optional <code>value</code>. You specify the certificate on input by its Amazon Resource Name
* (ARN). You specify the tag by using a key-value pair. </p>
*
Expand Down
4 changes: 2 additions & 2 deletions clients/client-acm/commands/DeleteCertificateCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ export interface DeleteCertificateCommandOutput extends __MetadataBearer {}

/**
* <p>Deletes a certificate and its associated private key. If this action succeeds, the
* certificate no longer appears in the list that can be displayed by calling the <a>ListCertificates</a> action or be retrieved by calling the <a>GetCertificate</a> action. The certificate will not be available for use by AWS
* certificate no longer appears in the list that can be displayed by calling the <a>ListCertificates</a> action or be retrieved by calling the <a>GetCertificate</a> action. The certificate will not be available for use by Amazon Web Services
* services integrated with ACM. </p>
* <note>
* <p>You cannot delete an ACM certificate that is being used by another AWS service. To
* <p>You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To
* delete a certificate that is in use, the certificate association must first be
* removed.</p>
* </note>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export interface GetAccountConfigurationCommandOutput extends GetAccountConfigur

/**
* <p>Returns the account
* configuration options associated with an AWS account.</p>
* configuration options associated with an Amazon Web Services account.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
4 changes: 2 additions & 2 deletions clients/client-acm/commands/ImportCertificateCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ export interface ImportCertificateCommandInput extends ImportCertificateRequest
export interface ImportCertificateCommandOutput extends ImportCertificateResponse, __MetadataBearer {}

/**
* <p>Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with
* <p>Imports a certificate into Amazon Web Services Certificate Manager (ACM) to use with services that are integrated with
* ACM. Note that <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-services.html">integrated
* services</a> allow only certificate types and keys they support to be associated with
* their resources. Further, their support differs depending on whether the certificate is
* imported into IAM or into ACM. For more information, see the documentation for each
* service. For more information about importing certificates into ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing
* Certificates</a> in the <i>AWS Certificate Manager User Guide</i>. </p>
* Certificates</a> in the <i>Amazon Web Services Certificate Manager User Guide</i>. </p>
*
* <note>
* <p>ACM does not provide <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a> for certificates that you import.</p>
Expand Down
9 changes: 7 additions & 2 deletions clients/client-acm/commands/RequestCertificateCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,21 @@ export interface RequestCertificateCommandInput extends RequestCertificateReques
export interface RequestCertificateCommandOutput extends RequestCertificateResponse, __MetadataBearer {}

/**
* <p>Requests an ACM certificate for use with other AWS services. To request an ACM
* <p>Requests an ACM certificate for use with other Amazon Web Services services. To request an ACM
* certificate, you must specify a fully qualified domain name (FQDN) in the
* <code>DomainName</code> parameter. You can also specify additional FQDNs in the
* <code>SubjectAlternativeNames</code> parameter. </p>
*
* <p>If you are requesting a private certificate, domain validation is not required. If you are
* requesting a public certificate, each domain name that you specify must be validated to verify
* that you own or control the domain. You can use <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html">DNS validation</a> or <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html">email validation</a>.
* We recommend that you use DNS validation. ACM issues public certificates after receiving
* approval from the domain owner. </p>
*
* <note>
* <p>ACM behavior differs from the <a href="https://tools.ietf.org/html/rfc6125#appendix-B.2">https://tools.ietf.org/html/rfc6125#appendix-B.2</a>RFC 6125 specification of the
* certificate validation process. first checks for a subject alternative name, and, if it
* finds one, ignores the common name (CN)</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
23 changes: 12 additions & 11 deletions clients/client-acm/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ export enum RecordType {
}

/**
* <p>Contains a DNS record value that you can use to can use to validate ownership or control
* <p>Contains a DNS record value that you can use to validate ownership or control
* of a domain. This is used by the <a>DescribeCertificate</a> action. </p>
*/
export interface ResourceRecord {
Expand Down Expand Up @@ -429,6 +429,7 @@ export enum KeyAlgorithm {
EC_secp521r1 = "EC_secp521r1",
RSA_1024 = "RSA_1024",
RSA_2048 = "RSA_2048",
RSA_3072 = "RSA_3072",
RSA_4096 = "RSA_4096",
}

Expand Down Expand Up @@ -585,7 +586,7 @@ export interface CertificateDetail {
/**
* <p>The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in
* the <i>AWS General Reference</i>.</p>
* the <i>Amazon Web Services General Reference</i>.</p>
*/
CertificateArn?: string;

Expand Down Expand Up @@ -681,15 +682,15 @@ export interface CertificateDetail {
SignatureAlgorithm?: string;

/**
* <p>A list of ARNs for the AWS resources that are using the certificate. A certificate can
* be used by multiple AWS resources. </p>
* <p>A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can
* be used by multiple Amazon Web Services resources. </p>
*/
InUseBy?: string[];

/**
* <p>The reason the certificate request failed. This value exists only when the certificate
* status is <code>FAILED</code>. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed">Certificate Request
* Failed</a> in the <i>AWS Certificate Manager User Guide</i>. </p>
* Failed</a> in the <i>Amazon Web Services Certificate Manager User Guide</i>. </p>
*/
FailureReason?: FailureReason | string;

Expand All @@ -699,7 +700,7 @@ export interface CertificateDetail {
* <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a> for
* imported certificates. For more information about the differences between certificates that
* you import and those that ACM provides, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing Certificates</a> in the
* <i>AWS Certificate Manager User Guide</i>. </p>
* <i>Amazon Web Services Certificate Manager User Guide</i>. </p>
*/
Type?: CertificateType | string;

Expand Down Expand Up @@ -779,7 +780,7 @@ export namespace DeleteCertificateRequest {
}

/**
* <p>The certificate is in use by another AWS service in the caller's account. Remove the
* <p>The certificate is in use by another Amazon Web Services service in the caller's account. Remove the
* association and try again.</p>
*/
export interface ResourceInUseException extends __SmithyException, $MetadataBearer {
Expand Down Expand Up @@ -914,7 +915,7 @@ export namespace RequestInProgressException {

/**
* <p>Object containing
* expiration events options associated with an AWS account.</p>
* expiration events options associated with an Amazon Web Services account.</p>
*/
export interface ExpiryEventsConfiguration {
/**
Expand All @@ -938,7 +939,7 @@ export namespace ExpiryEventsConfiguration {
export interface GetAccountConfigurationResponse {
/**
* <p>Expiration events
* configuration options associated with the AWS account.</p>
* configuration options associated with the Amazon Web Services account.</p>
*/
ExpiryEvents?: ExpiryEventsConfiguration;
}
Expand Down Expand Up @@ -1300,7 +1301,7 @@ export namespace PutAccountConfigurationRequest {

/**
* <p>The supplied input
* failed to satisfy constraints of an AWS service.</p>
* failed to satisfy constraints of an Amazon Web Services service.</p>
*/
export interface ValidationException extends __SmithyException, $MetadataBearer {
name: "ValidationException";
Expand Down Expand Up @@ -1512,7 +1513,7 @@ export interface RequestCertificateRequest {
* <p>The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used
* to issue the certificate. If you do not provide an ARN and you are trying to request a private
* certificate, ACM will attempt to issue a public certificate. For more information about
* private CAs, see the <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaWelcome.html">AWS Certificate Manager Private Certificate Authority (PCA)</a> user guide. The ARN must have the following form: </p>
* private CAs, see the <a href="https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaWelcome.html">Amazon Web Services Certificate Manager Private Certificate Authority (PCA)</a> user guide. The ARN must have the following form: </p>
*
* <p>
* <code>arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012</code>
Expand Down
Loading