@aws-sdk/client-acm 3.296.0 → 3.297.0

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { ACMServiceException as __BaseException } from "./ACMServiceException";
 /**
+ * @public
  * <p>You do not have access required to perform this action.</p>
  */
 export declare class AccessDeniedException extends __BaseException {
@@ -13,6 +14,7 @@ export declare class AccessDeniedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
 /**
+ * @public
  * <p>A key-value pair that identifies or specifies metadata about an ACM resource.</p>
  */
 export interface Tag {
@@ -25,6 +27,9 @@ export interface Tag {
      */
     Value?: string;
 }
+/**
+ * @public
+ */
 export interface AddTagsToCertificateRequest {
     /**
      * <p>String that contains the ARN of the ACM certificate to which the tag is to be applied.
@@ -41,6 +46,7 @@ export interface AddTagsToCertificateRequest {
     Tags: Tag[] | undefined;
 }
 /**
+ * @public
  * <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
  */
 export declare class InvalidArnException extends __BaseException {
@@ -52,6 +58,7 @@ export declare class InvalidArnException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidArnException, __BaseException>);
 }
 /**
+ * @public
  * <p>An input parameter was invalid.</p>
  */
 export declare class InvalidParameterException extends __BaseException {
@@ -63,6 +70,7 @@ export declare class InvalidParameterException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
 }
 /**
+ * @public
  * <p>One or both of the values that make up the key-value pair is not valid. For example, you
  *       cannot specify a tag value that begins with <code>aws:</code>.</p>
  */
@@ -75,6 +83,7 @@ export declare class InvalidTagException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidTagException, __BaseException>);
 }
 /**
+ * @public
  * <p>The specified certificate cannot be found in the caller's account or the caller's account
  *       cannot be found.</p>
  */
@@ -87,6 +96,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>A specified tag did not comply with an existing tag policy and was rejected.</p>
  */
 export declare class TagPolicyException extends __BaseException {
@@ -98,6 +108,7 @@ export declare class TagPolicyException extends __BaseException {
     constructor(opts: __ExceptionOptionType<TagPolicyException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request was denied because it exceeded a quota.</p>
  */
 export declare class ThrottlingException extends __BaseException {
@@ -109,6 +120,7 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request contains too many tags. Try the request again with fewer tags.</p>
  */
 export declare class TooManyTagsException extends __BaseException {
@@ -119,10 +131,14 @@ export declare class TooManyTagsException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum RecordType {
     CNAME = "CNAME"
 }
 /**
+ * @public
  * <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>
  */
@@ -141,16 +157,23 @@ export interface ResourceRecord {
      */
     Value: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ValidationMethod {
     DNS = "DNS",
     EMAIL = "EMAIL"
 }
+/**
+ * @public
+ */
 export declare enum DomainStatus {
     FAILED = "FAILED",
     PENDING_VALIDATION = "PENDING_VALIDATION",
     SUCCESS = "SUCCESS"
 }
 /**
+ * @public
  * <p>Contains information about the validation of each domain name in the certificate.</p>
  */
 export interface DomainValidation {
@@ -202,6 +225,9 @@ export interface DomainValidation {
      */
     ValidationMethod?: ValidationMethod | string;
 }
+/**
+ * @public
+ */
 export declare enum ExtendedKeyUsageName {
     ANY = "ANY",
     CODE_SIGNING = "CODE_SIGNING",
@@ -217,6 +243,7 @@ export declare enum ExtendedKeyUsageName {
     TLS_WEB_SERVER_AUTHENTICATION = "TLS_WEB_SERVER_AUTHENTICATION"
 }
 /**
+ * @public
  * <p>The Extended Key Usage X.509 v3 extension defines one or more purposes for which the
  *       public key can be used. This is in addition to or in place of the basic purposes specified by
  *       the Key Usage extension. </p>
@@ -279,6 +306,9 @@ export interface ExtendedKeyUsage {
      */
     OID?: string;
 }
+/**
+ * @public
+ */
 export declare enum FailureReason {
     ADDITIONAL_VERIFICATION_REQUIRED = "ADDITIONAL_VERIFICATION_REQUIRED",
     CAA_ERROR = "CAA_ERROR",
@@ -298,6 +328,9 @@ export declare enum FailureReason {
     PCA_RESOURCE_NOT_FOUND = "PCA_RESOURCE_NOT_FOUND",
     SLR_NOT_FOUND = "SLR_NOT_FOUND"
 }
+/**
+ * @public
+ */
 export declare enum KeyAlgorithm {
     EC_prime256v1 = "EC_prime256v1",
     EC_secp384r1 = "EC_secp384r1",
@@ -307,6 +340,9 @@ export declare enum KeyAlgorithm {
     RSA_3072 = "RSA_3072",
     RSA_4096 = "RSA_4096"
 }
+/**
+ * @public
+ */
 export declare enum KeyUsageName {
     ANY = "ANY",
     CERTIFICATE_SIGNING = "CERTIFICATE_SIGNING",
@@ -321,6 +357,7 @@ export declare enum KeyUsageName {
     NON_REPUDATION = "NON_REPUDIATION"
 }
 /**
+ * @public
  * <p>The Key Usage X.509 v3 extension defines the purpose of the public key contained in the
  *       certificate.</p>
  */
@@ -330,11 +367,15 @@ export interface KeyUsage {
      */
     Name?: KeyUsageName | string;
 }
+/**
+ * @public
+ */
 export declare enum CertificateTransparencyLoggingPreference {
     DISABLED = "DISABLED",
     ENABLED = "ENABLED"
 }
 /**
+ * @public
  * <p>Structure that contains options for your certificate. Currently, you can use this only to
  *       specify whether to opt in to or out of certificate transparency logging. Some browsers require
  *       that public certificates issued for your domain be recorded in a log. Certificates that are
@@ -350,10 +391,16 @@ export interface CertificateOptions {
      */
     CertificateTransparencyLoggingPreference?: CertificateTransparencyLoggingPreference | string;
 }
+/**
+ * @public
+ */
 export declare enum RenewalEligibility {
     ELIGIBLE = "ELIGIBLE",
     INELIGIBLE = "INELIGIBLE"
 }
+/**
+ * @public
+ */
 export declare enum RenewalStatus {
     FAILED = "FAILED",
     PENDING_AUTO_RENEWAL = "PENDING_AUTO_RENEWAL",
@@ -361,6 +408,7 @@ export declare enum RenewalStatus {
     SUCCESS = "SUCCESS"
 }
 /**
+ * @public
  * <p>Contains information about the status of ACM's <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a> for the certificate. This
  *       structure exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>
  */
@@ -386,6 +434,9 @@ export interface RenewalSummary {
      */
     UpdatedAt: Date | undefined;
 }
+/**
+ * @public
+ */
 export declare enum RevocationReason {
     AFFILIATION_CHANGED = "AFFILIATION_CHANGED",
     A_A_COMPROMISE = "A_A_COMPROMISE",
@@ -398,6 +449,9 @@ export declare enum RevocationReason {
     SUPERCEDED = "SUPERCEDED",
     UNSPECIFIED = "UNSPECIFIED"
 }
+/**
+ * @public
+ */
 export declare enum CertificateStatus {
     EXPIRED = "EXPIRED",
     FAILED = "FAILED",
@@ -407,12 +461,16 @@ export declare enum CertificateStatus {
     REVOKED = "REVOKED",
     VALIDATION_TIMED_OUT = "VALIDATION_TIMED_OUT"
 }
+/**
+ * @public
+ */
 export declare enum CertificateType {
     AMAZON_ISSUED = "AMAZON_ISSUED",
     IMPORTED = "IMPORTED",
     PRIVATE = "PRIVATE"
 }
 /**
+ * @public
  * <p>Contains metadata about an ACM certificate. This structure is returned in the response
  *       to a <a>DescribeCertificate</a> request. </p>
  */
@@ -564,6 +622,7 @@ export interface CertificateDetail {
     Options?: CertificateOptions;
 }
 /**
+ * @public
  * <p>You are trying to update a resource or configuration that is already being created or
  *       updated. Wait for the previous operation to finish and try again.</p>
  */
@@ -575,6 +634,9 @@ export declare class ConflictException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DeleteCertificateRequest {
     /**
      * <p>String that contains the ARN of the ACM certificate to be deleted. This must be of the
@@ -587,6 +649,7 @@ export interface DeleteCertificateRequest {
     CertificateArn: string | undefined;
 }
 /**
+ * @public
  * <p>The certificate is in use by another Amazon Web Services service in the caller's account. Remove the
  *       association and try again.</p>
  */
@@ -598,6 +661,9 @@ export declare class ResourceInUseException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DescribeCertificateRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following
@@ -609,12 +675,18 @@ export interface DescribeCertificateRequest {
      */
     CertificateArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeCertificateResponse {
     /**
      * <p>Metadata about an ACM certificate.</p>
      */
     Certificate?: CertificateDetail;
 }
+/**
+ * @public
+ */
 export interface ExportCertificateRequest {
     /**
      * <p>An Amazon Resource Name (ARN) of the issued certificate. This must be of the form:</p>
@@ -637,6 +709,9 @@ export interface ExportCertificateRequest {
      */
     Passphrase: Uint8Array | undefined;
 }
+/**
+ * @public
+ */
 export interface ExportCertificateResponse {
     /**
      * <p>The base64 PEM-encoded certificate.</p>
@@ -654,6 +729,7 @@ export interface ExportCertificateResponse {
     PrivateKey?: string;
 }
 /**
+ * @public
  * <p>The certificate request is in process and the certificate in your account has not yet been
  *       issued.</p>
  */
@@ -666,6 +742,7 @@ export declare class RequestInProgressException extends __BaseException {
     constructor(opts: __ExceptionOptionType<RequestInProgressException, __BaseException>);
 }
 /**
+ * @public
  * <p>Object containing expiration events options associated with an Amazon Web Services account.</p>
  */
 export interface ExpiryEventsConfiguration {
@@ -677,12 +754,18 @@ export interface ExpiryEventsConfiguration {
      */
     DaysBeforeExpiry?: number;
 }
+/**
+ * @public
+ */
 export interface GetAccountConfigurationResponse {
     /**
      * <p>Expiration events configuration options associated with the Amazon Web Services account.</p>
      */
     ExpiryEvents?: ExpiryEventsConfiguration;
 }
+/**
+ * @public
+ */
 export interface GetCertificateRequest {
     /**
      * <p>String that contains a certificate ARN in the following format:</p>
@@ -693,6 +776,9 @@ export interface GetCertificateRequest {
      */
     CertificateArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetCertificateResponse {
     /**
      * <p>The ACM-issued certificate corresponding to the ARN specified as input.</p>
@@ -705,6 +791,9 @@ export interface GetCertificateResponse {
      */
     CertificateChain?: string;
 }
+/**
+ * @public
+ */
 export interface ImportCertificateRequest {
     /**
      * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name
@@ -730,6 +819,9 @@ export interface ImportCertificateRequest {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface ImportCertificateResponse {
     /**
      * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name
@@ -738,6 +830,7 @@ export interface ImportCertificateResponse {
     CertificateArn?: string;
 }
 /**
+ * @public
  * <p>An ACM quota has been exceeded.</p>
  */
 export declare class LimitExceededException extends __BaseException {
@@ -749,6 +842,7 @@ export declare class LimitExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>One or more of of request parameters specified is not valid.</p>
  */
 export declare class InvalidArgsException extends __BaseException {
@@ -760,6 +854,7 @@ export declare class InvalidArgsException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidArgsException, __BaseException>);
 }
 /**
+ * @public
  * <p>This structure can be used in the <a>ListCertificates</a> action to filter the
  *       output of the certificate list. </p>
  */
@@ -782,13 +877,22 @@ export interface Filters {
      */
     keyTypes?: (KeyAlgorithm | string)[];
 }
+/**
+ * @public
+ */
 export declare enum SortBy {
     CREATED_AT = "CREATED_AT"
 }
+/**
+ * @public
+ */
 export declare enum SortOrder {
     ASCENDING = "ASCENDING",
     DESCENDING = "DESCENDING"
 }
+/**
+ * @public
+ */
 export interface ListCertificatesRequest {
     /**
      * <p>Filter the certificate list by status value.</p>
@@ -824,6 +928,7 @@ export interface ListCertificatesRequest {
     SortOrder?: SortOrder | string;
 }
 /**
+ * @public
  * <p>This structure is returned in the response object of <a>ListCertificates</a>
  *       action. </p>
  */
@@ -937,6 +1042,9 @@ export interface CertificateSummary {
      */
     RevokedAt?: Date;
 }
+/**
+ * @public
+ */
 export interface ListCertificatesResponse {
     /**
      * <p>When the list is truncated, this value is present and contains the value to use for the
@@ -949,6 +1057,7 @@ export interface ListCertificatesResponse {
     CertificateSummaryList?: CertificateSummary[];
 }
 /**
+ * @public
  * <p>The supplied input failed to satisfy constraints of an Amazon Web Services service.</p>
  */
 export declare class ValidationException extends __BaseException {
@@ -959,6 +1068,9 @@ export declare class ValidationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface ListTagsForCertificateRequest {
     /**
      * <p>String that contains the ARN of the ACM certificate for which you want to list the tags.
@@ -970,12 +1082,18 @@ export interface ListTagsForCertificateRequest {
      */
     CertificateArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForCertificateResponse {
     /**
      * <p>The key-value pairs that define the applied tags.</p>
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface PutAccountConfigurationRequest {
     /**
      * <p>Specifies expiration events associated with an account.</p>
@@ -990,6 +1108,9 @@ export interface PutAccountConfigurationRequest {
      */
     IdempotencyToken: string | undefined;
 }
+/**
+ * @public
+ */
 export interface RemoveTagsFromCertificateRequest {
     /**
      * <p>String that contains the ARN of the ACM Certificate with one or more tags that you want
@@ -1005,6 +1126,9 @@ export interface RemoveTagsFromCertificateRequest {
      */
     Tags: Tag[] | undefined;
 }
+/**
+ * @public
+ */
 export interface RenewCertificateRequest {
     /**
      * <p>String that contains the ARN of the ACM certificate to be renewed. This must be of the
@@ -1017,6 +1141,7 @@ export interface RenewCertificateRequest {
     CertificateArn: string | undefined;
 }
 /**
+ * @public
  * <p>One or more values in the <a>DomainValidationOption</a> structure is
  *       incorrect.</p>
  */
@@ -1029,6 +1154,7 @@ export declare class InvalidDomainValidationOptionsException extends __BaseExcep
     constructor(opts: __ExceptionOptionType<InvalidDomainValidationOptionsException, __BaseException>);
 }
 /**
+ * @public
  * <p>Contains information about the domain names that you want ACM to use to send you emails
  *       that enable you to validate domain ownership.</p>
  */
@@ -1064,6 +1190,9 @@ export interface DomainValidationOption {
      */
     ValidationDomain: string | undefined;
 }
+/**
+ * @public
+ */
 export interface RequestCertificateRequest {
     /**
      * <p>Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with
@@ -1159,6 +1288,9 @@ export interface RequestCertificateRequest {
      */
     KeyAlgorithm?: KeyAlgorithm | string;
 }
+/**
+ * @public
+ */
 export interface RequestCertificateResponse {
     /**
      * <p>String that contains the ARN of the issued certificate. This must be of the form:</p>
@@ -1169,6 +1301,7 @@ export interface RequestCertificateResponse {
     CertificateArn?: string;
 }
 /**
+ * @public
  * <p>Processing has reached an invalid state.</p>
  */
 export declare class InvalidStateException extends __BaseException {
@@ -1179,6 +1312,9 @@ export declare class InvalidStateException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InvalidStateException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface ResendValidationEmailRequest {
     /**
      * <p>String that contains the ARN of the requested certificate. The certificate ARN is
@@ -1222,6 +1358,9 @@ export interface ResendValidationEmailRequest {
      */
     ValidationDomain: string | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateCertificateOptionsRequest {
     /**
      * <p>ARN of the requested certificate to update. This must be of the form:</p>

package/dist-types/pagination/Interfaces.d.ts

@@ -1,5 +1,8 @@
 import { PaginationConfiguration } from "@aws-sdk/types";
 import { ACMClient } from "../ACMClient";
+/**
+ * @public
+ */
 export interface ACMPaginationConfiguration extends PaginationConfiguration {
     client: ACMClient;
 }

package/dist-types/pagination/ListCertificatesPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListCertificatesCommandInput, ListCertificatesCommandOutput } from "../commands/ListCertificatesCommand";
 import { ACMPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListCertificates(config: ACMPaginationConfiguration, input: ListCertificatesCommandInput, ...additionalArguments: any): Paginator<ListCertificatesCommandOutput>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-acm",
   "description": "AWS SDK for JavaScript Acm Client for Node.js, Browser and React Native",
-  "version": "3.296.0",
+  "version": "3.297.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,9 +20,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.296.0",
+    "@aws-sdk/client-sts": "3.297.0",
     "@aws-sdk/config-resolver": "3.296.0",
-    "@aws-sdk/credential-provider-node": "3.296.0",
+    "@aws-sdk/credential-provider-node": "3.297.0",
     "@aws-sdk/fetch-http-handler": "3.296.0",
     "@aws-sdk/hash-node": "3.296.0",
     "@aws-sdk/invalid-dependency": "3.296.0",