@aws-sdk/client-cloudhsm-v2 3.296.0 → 3.298.0

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

@@ -1,5 +1,8 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { CloudHSMV2ServiceException as __BaseException } from "./CloudHSMV2ServiceException";
+/**
+ * @public
+ */
 export declare enum BackupState {
     CREATE_IN_PROGRESS = "CREATE_IN_PROGRESS",
     DELETED = "DELETED",
@@ -7,6 +10,7 @@ export declare enum BackupState {
     READY = "READY"
 }
 /**
+ * @public
  * <p>Contains a tag. A tag is a key-value pair.</p>
  */
 export interface Tag {
@@ -20,6 +24,7 @@ export interface Tag {
     Value: string | undefined;
 }
 /**
+ * @public
  * <p>Contains information about a backup of an AWS CloudHSM cluster. All backup objects
  *       contain the <code>BackupId</code>, <code>BackupState</code>, <code>ClusterId</code>, and
  *         <code>CreateTimestamp</code> parameters. Backups that were copied into a destination region
@@ -77,13 +82,20 @@ export interface Backup {
      */
     TagList?: Tag[];
 }
+/**
+ * @public
+ */
 export declare enum BackupPolicy {
     DEFAULT = "DEFAULT"
 }
+/**
+ * @public
+ */
 export declare enum BackupRetentionType {
     DAYS = "DAYS"
 }
 /**
+ * @public
  * <p>A policy that defines the number of days to retain backups.</p>
  */
 export interface BackupRetentionPolicy {
@@ -98,6 +110,7 @@ export interface BackupRetentionPolicy {
     Value?: string;
 }
 /**
+ * @public
  * <p>The request was rejected because the requester does not have permission to perform the
  *       requested operation.</p>
  */
@@ -111,6 +124,7 @@ export declare class CloudHsmAccessDeniedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<CloudHsmAccessDeniedException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request was rejected because of an AWS CloudHSM internal failure. The request can
  *       be retried.</p>
  */
@@ -124,6 +138,7 @@ export declare class CloudHsmInternalFailureException extends __BaseException {
     constructor(opts: __ExceptionOptionType<CloudHsmInternalFailureException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request was rejected because it is not a valid request.</p>
  */
 export declare class CloudHsmInvalidRequestException extends __BaseException {
@@ -136,6 +151,7 @@ export declare class CloudHsmInvalidRequestException extends __BaseException {
     constructor(opts: __ExceptionOptionType<CloudHsmInvalidRequestException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request was rejected because it refers to a resource that cannot be
  *       found.</p>
  */
@@ -149,6 +165,7 @@ export declare class CloudHsmResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<CloudHsmResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request was rejected because an error occurred.</p>
  */
 export declare class CloudHsmServiceException extends __BaseException {
@@ -161,6 +178,7 @@ export declare class CloudHsmServiceException extends __BaseException {
     constructor(opts: __ExceptionOptionType<CloudHsmServiceException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.</p>
  */
 export declare class CloudHsmTagException extends __BaseException {
@@ -172,6 +190,9 @@ export declare class CloudHsmTagException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<CloudHsmTagException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface CopyBackupToRegionRequest {
     /**
      * <p>The AWS region that will contain your copied CloudHSM cluster backup.</p>
@@ -187,6 +208,7 @@ export interface CopyBackupToRegionRequest {
     TagList?: Tag[];
 }
 /**
+ * @public
  * <p>Contains information about the backup that will be copied and created by the <a>CopyBackupToRegion</a> operation.</p>
  */
 export interface DestinationBackup {
@@ -207,6 +229,9 @@ export interface DestinationBackup {
      */
     SourceCluster?: string;
 }
+/**
+ * @public
+ */
 export interface CopyBackupToRegionResponse {
     /**
      * <p>Information on the backup that will be copied to the destination region, including
@@ -218,6 +243,9 @@ export interface CopyBackupToRegionResponse {
      */
     DestinationBackup?: DestinationBackup;
 }
+/**
+ * @public
+ */
 export interface CreateClusterRequest {
     /**
      * <p>A policy that defines how the service retains backups.</p>
@@ -253,6 +281,7 @@ export interface CreateClusterRequest {
     TagList?: Tag[];
 }
 /**
+ * @public
  * <p>Contains one or more certificates or a certificate signing request (CSR).</p>
  */
 export interface Certificates {
@@ -279,6 +308,9 @@ export interface Certificates {
      */
     ClusterCertificate?: string;
 }
+/**
+ * @public
+ */
 export declare enum HsmState {
     ACTIVE = "ACTIVE",
     CREATE_IN_PROGRESS = "CREATE_IN_PROGRESS",
@@ -287,6 +319,7 @@ export declare enum HsmState {
     DELETE_IN_PROGRESS = "DELETE_IN_PROGRESS"
 }
 /**
+ * @public
  * <p>Contains information about a hardware security module (HSM) in an AWS CloudHSM
  *       cluster.</p>
  */
@@ -324,6 +357,9 @@ export interface Hsm {
      */
     StateMessage?: string;
 }
+/**
+ * @public
+ */
 export declare enum ClusterState {
     ACTIVE = "ACTIVE",
     CREATE_IN_PROGRESS = "CREATE_IN_PROGRESS",
@@ -336,6 +372,7 @@ export declare enum ClusterState {
     UPDATE_IN_PROGRESS = "UPDATE_IN_PROGRESS"
 }
 /**
+ * @public
  * <p>Contains information about an AWS CloudHSM cluster.</p>
  */
 export interface Cluster {
@@ -402,12 +439,18 @@ export interface Cluster {
      */
     TagList?: Tag[];
 }
+/**
+ * @public
+ */
 export interface CreateClusterResponse {
     /**
      * <p>Information about the cluster that was created.</p>
      */
     Cluster?: Cluster;
 }
+/**
+ * @public
+ */
 export interface CreateHsmRequest {
     /**
      * <p>The identifier (ID) of the HSM's cluster. To find the cluster ID, use <a>DescribeClusters</a>.</p>
@@ -425,24 +468,36 @@ export interface CreateHsmRequest {
      */
     IpAddress?: string;
 }
+/**
+ * @public
+ */
 export interface CreateHsmResponse {
     /**
      * <p>Information about the HSM that was created.</p>
      */
     Hsm?: Hsm;
 }
+/**
+ * @public
+ */
 export interface DeleteBackupRequest {
     /**
      * <p>The ID of the backup to be deleted. To find the ID of a backup, use the <a>DescribeBackups</a> operation.</p>
      */
     BackupId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteBackupResponse {
     /**
      * <p>Information on the <code>Backup</code> object deleted.</p>
      */
     Backup?: Backup;
 }
+/**
+ * @public
+ */
 export interface DeleteClusterRequest {
     /**
      * <p>The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use
@@ -450,12 +505,18 @@ export interface DeleteClusterRequest {
      */
     ClusterId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteClusterResponse {
     /**
      * <p>Information about the cluster that was deleted.</p>
      */
     Cluster?: Cluster;
 }
+/**
+ * @public
+ */
 export interface DeleteHsmRequest {
     /**
      * <p>The identifier (ID) of the cluster that contains the HSM that you are
@@ -477,12 +538,18 @@ export interface DeleteHsmRequest {
      */
     EniIp?: string;
 }
+/**
+ * @public
+ */
 export interface DeleteHsmResponse {
     /**
      * <p>The identifier (ID) of the HSM that was deleted.</p>
      */
     HsmId?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeBackupsRequest {
     /**
      * <p>The <code>NextToken</code> value that you received in the previous response. Use this
@@ -516,6 +583,9 @@ export interface DescribeBackupsRequest {
      */
     SortAscending?: boolean;
 }
+/**
+ * @public
+ */
 export interface DescribeBackupsResponse {
     /**
      * <p>A list of backups.</p>
@@ -528,6 +598,9 @@ export interface DescribeBackupsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeClustersRequest {
     /**
      * <p>One or more filters to limit the items returned in the response.</p>
@@ -550,6 +623,9 @@ export interface DescribeClustersRequest {
      */
     MaxResults?: number;
 }
+/**
+ * @public
+ */
 export interface DescribeClustersResponse {
     /**
      * <p>A list of clusters.</p>
@@ -562,6 +638,9 @@ export interface DescribeClustersResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface InitializeClusterRequest {
     /**
      * <p>The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use
@@ -581,6 +660,9 @@ export interface InitializeClusterRequest {
      */
     TrustAnchor: string | undefined;
 }
+/**
+ * @public
+ */
 export interface InitializeClusterResponse {
     /**
      * <p>The cluster's state.</p>
@@ -591,6 +673,9 @@ export interface InitializeClusterResponse {
      */
     StateMessage?: string;
 }
+/**
+ * @public
+ */
 export interface ListTagsRequest {
     /**
      * <p>The cluster identifier (ID) for the cluster whose tags you are getting. To find the
@@ -608,6 +693,9 @@ export interface ListTagsRequest {
      */
     MaxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListTagsResponse {
     /**
      * <p>A list of tags.</p>
@@ -619,6 +707,9 @@ export interface ListTagsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ModifyBackupAttributesRequest {
     /**
      * <p>The identifier (ID) of the backup to modify. To find the ID of a backup, use the <a>DescribeBackups</a> operation.</p>
@@ -630,6 +721,9 @@ export interface ModifyBackupAttributesRequest {
      */
     NeverExpires: boolean | undefined;
 }
+/**
+ * @public
+ */
 export interface ModifyBackupAttributesResponse {
     /**
      * <p>Contains information about a backup of an AWS CloudHSM cluster. All backup objects
@@ -641,6 +735,9 @@ export interface ModifyBackupAttributesResponse {
      */
     Backup?: Backup;
 }
+/**
+ * @public
+ */
 export interface ModifyClusterRequest {
     /**
      * <p>A policy that defines how the service retains backups.</p>
@@ -652,24 +749,36 @@ export interface ModifyClusterRequest {
      */
     ClusterId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ModifyClusterResponse {
     /**
      * <p>Contains information about an AWS CloudHSM cluster.</p>
      */
     Cluster?: Cluster;
 }
+/**
+ * @public
+ */
 export interface RestoreBackupRequest {
     /**
      * <p>The ID of the backup to be restored. To find the ID of a backup, use the <a>DescribeBackups</a> operation.</p>
      */
     BackupId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface RestoreBackupResponse {
     /**
      * <p>Information on the <code>Backup</code> object created.</p>
      */
     Backup?: Backup;
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The cluster identifier (ID) for the cluster that you are tagging. To find the cluster
@@ -681,8 +790,14 @@ export interface TagResourceRequest {
      */
     TagList: Tag[] | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>The cluster identifier (ID) for the cluster whose tags you are removing. To find the
@@ -695,153 +810,8 @@ export interface UntagResourceRequest {
      */
     TagKeyList: string[] | undefined;
 }
-export interface UntagResourceResponse {
-}
-/**
- * @internal
- */
-export declare const TagFilterSensitiveLog: (obj: Tag) => any;
 /**
- * @internal
+ * @public
  */
-export declare const BackupFilterSensitiveLog: (obj: Backup) => any;
-/**
- * @internal
- */
-export declare const BackupRetentionPolicyFilterSensitiveLog: (obj: BackupRetentionPolicy) => any;
-/**
- * @internal
- */
-export declare const CopyBackupToRegionRequestFilterSensitiveLog: (obj: CopyBackupToRegionRequest) => any;
-/**
- * @internal
- */
-export declare const DestinationBackupFilterSensitiveLog: (obj: DestinationBackup) => any;
-/**
- * @internal
- */
-export declare const CopyBackupToRegionResponseFilterSensitiveLog: (obj: CopyBackupToRegionResponse) => any;
-/**
- * @internal
- */
-export declare const CreateClusterRequestFilterSensitiveLog: (obj: CreateClusterRequest) => any;
-/**
- * @internal
- */
-export declare const CertificatesFilterSensitiveLog: (obj: Certificates) => any;
-/**
- * @internal
- */
-export declare const HsmFilterSensitiveLog: (obj: Hsm) => any;
-/**
- * @internal
- */
-export declare const ClusterFilterSensitiveLog: (obj: Cluster) => any;
-/**
- * @internal
- */
-export declare const CreateClusterResponseFilterSensitiveLog: (obj: CreateClusterResponse) => any;
-/**
- * @internal
- */
-export declare const CreateHsmRequestFilterSensitiveLog: (obj: CreateHsmRequest) => any;
-/**
- * @internal
- */
-export declare const CreateHsmResponseFilterSensitiveLog: (obj: CreateHsmResponse) => any;
-/**
- * @internal
- */
-export declare const DeleteBackupRequestFilterSensitiveLog: (obj: DeleteBackupRequest) => any;
-/**
- * @internal
- */
-export declare const DeleteBackupResponseFilterSensitiveLog: (obj: DeleteBackupResponse) => any;
-/**
- * @internal
- */
-export declare const DeleteClusterRequestFilterSensitiveLog: (obj: DeleteClusterRequest) => any;
-/**
- * @internal
- */
-export declare const DeleteClusterResponseFilterSensitiveLog: (obj: DeleteClusterResponse) => any;
-/**
- * @internal
- */
-export declare const DeleteHsmRequestFilterSensitiveLog: (obj: DeleteHsmRequest) => any;
-/**
- * @internal
- */
-export declare const DeleteHsmResponseFilterSensitiveLog: (obj: DeleteHsmResponse) => any;
-/**
- * @internal
- */
-export declare const DescribeBackupsRequestFilterSensitiveLog: (obj: DescribeBackupsRequest) => any;
-/**
- * @internal
- */
-export declare const DescribeBackupsResponseFilterSensitiveLog: (obj: DescribeBackupsResponse) => any;
-/**
- * @internal
- */
-export declare const DescribeClustersRequestFilterSensitiveLog: (obj: DescribeClustersRequest) => any;
-/**
- * @internal
- */
-export declare const DescribeClustersResponseFilterSensitiveLog: (obj: DescribeClustersResponse) => any;
-/**
- * @internal
- */
-export declare const InitializeClusterRequestFilterSensitiveLog: (obj: InitializeClusterRequest) => any;
-/**
- * @internal
- */
-export declare const InitializeClusterResponseFilterSensitiveLog: (obj: InitializeClusterResponse) => any;
-/**
- * @internal
- */
-export declare const ListTagsRequestFilterSensitiveLog: (obj: ListTagsRequest) => any;
-/**
- * @internal
- */
-export declare const ListTagsResponseFilterSensitiveLog: (obj: ListTagsResponse) => any;
-/**
- * @internal
- */
-export declare const ModifyBackupAttributesRequestFilterSensitiveLog: (obj: ModifyBackupAttributesRequest) => any;
-/**
- * @internal
- */
-export declare const ModifyBackupAttributesResponseFilterSensitiveLog: (obj: ModifyBackupAttributesResponse) => any;
-/**
- * @internal
- */
-export declare const ModifyClusterRequestFilterSensitiveLog: (obj: ModifyClusterRequest) => any;
-/**
- * @internal
- */
-export declare const ModifyClusterResponseFilterSensitiveLog: (obj: ModifyClusterResponse) => any;
-/**
- * @internal
- */
-export declare const RestoreBackupRequestFilterSensitiveLog: (obj: RestoreBackupRequest) => any;
-/**
- * @internal
- */
-export declare const RestoreBackupResponseFilterSensitiveLog: (obj: RestoreBackupResponse) => any;
-/**
- * @internal
- */
-export declare const TagResourceRequestFilterSensitiveLog: (obj: TagResourceRequest) => any;
-/**
- * @internal
- */
-export declare const TagResourceResponseFilterSensitiveLog: (obj: TagResourceResponse) => any;
-/**
- * @internal
- */
-export declare const UntagResourceRequestFilterSensitiveLog: (obj: UntagResourceRequest) => any;
-/**
- * @internal
- */
-export declare const UntagResourceResponseFilterSensitiveLog: (obj: UntagResourceResponse) => any;
+export interface UntagResourceResponse {
+}

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { DescribeBackupsCommandInput, DescribeBackupsCommandOutput } from "../commands/DescribeBackupsCommand";
 import { CloudHSMV2PaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateDescribeBackups(config: CloudHSMV2PaginationConfiguration, input: DescribeBackupsCommandInput, ...additionalArguments: any): Paginator<DescribeBackupsCommandOutput>;

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { DescribeClustersCommandInput, DescribeClustersCommandOutput } from "../commands/DescribeClustersCommand";
 import { CloudHSMV2PaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateDescribeClusters(config: CloudHSMV2PaginationConfiguration, input: DescribeClustersCommandInput, ...additionalArguments: any): Paginator<DescribeClustersCommandOutput>;

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

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

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListTagsCommandInput, ListTagsCommandOutput } from "../commands/ListTagsCommand";
 import { CloudHSMV2PaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListTags(config: CloudHSMV2PaginationConfiguration, input: ListTagsCommandInput, ...additionalArguments: any): Paginator<ListTagsCommandOutput>;

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

@@ -262,104 +262,3 @@ export interface UntagResourceRequest {
   TagKeyList: string[] | undefined;
 }
 export interface UntagResourceResponse {}
-export declare const TagFilterSensitiveLog: (obj: Tag) => any;
-export declare const BackupFilterSensitiveLog: (obj: Backup) => any;
-export declare const BackupRetentionPolicyFilterSensitiveLog: (
-  obj: BackupRetentionPolicy
-) => any;
-export declare const CopyBackupToRegionRequestFilterSensitiveLog: (
-  obj: CopyBackupToRegionRequest
-) => any;
-export declare const DestinationBackupFilterSensitiveLog: (
-  obj: DestinationBackup
-) => any;
-export declare const CopyBackupToRegionResponseFilterSensitiveLog: (
-  obj: CopyBackupToRegionResponse
-) => any;
-export declare const CreateClusterRequestFilterSensitiveLog: (
-  obj: CreateClusterRequest
-) => any;
-export declare const CertificatesFilterSensitiveLog: (obj: Certificates) => any;
-export declare const HsmFilterSensitiveLog: (obj: Hsm) => any;
-export declare const ClusterFilterSensitiveLog: (obj: Cluster) => any;
-export declare const CreateClusterResponseFilterSensitiveLog: (
-  obj: CreateClusterResponse
-) => any;
-export declare const CreateHsmRequestFilterSensitiveLog: (
-  obj: CreateHsmRequest
-) => any;
-export declare const CreateHsmResponseFilterSensitiveLog: (
-  obj: CreateHsmResponse
-) => any;
-export declare const DeleteBackupRequestFilterSensitiveLog: (
-  obj: DeleteBackupRequest
-) => any;
-export declare const DeleteBackupResponseFilterSensitiveLog: (
-  obj: DeleteBackupResponse
-) => any;
-export declare const DeleteClusterRequestFilterSensitiveLog: (
-  obj: DeleteClusterRequest
-) => any;
-export declare const DeleteClusterResponseFilterSensitiveLog: (
-  obj: DeleteClusterResponse
-) => any;
-export declare const DeleteHsmRequestFilterSensitiveLog: (
-  obj: DeleteHsmRequest
-) => any;
-export declare const DeleteHsmResponseFilterSensitiveLog: (
-  obj: DeleteHsmResponse
-) => any;
-export declare const DescribeBackupsRequestFilterSensitiveLog: (
-  obj: DescribeBackupsRequest
-) => any;
-export declare const DescribeBackupsResponseFilterSensitiveLog: (
-  obj: DescribeBackupsResponse
-) => any;
-export declare const DescribeClustersRequestFilterSensitiveLog: (
-  obj: DescribeClustersRequest
-) => any;
-export declare const DescribeClustersResponseFilterSensitiveLog: (
-  obj: DescribeClustersResponse
-) => any;
-export declare const InitializeClusterRequestFilterSensitiveLog: (
-  obj: InitializeClusterRequest
-) => any;
-export declare const InitializeClusterResponseFilterSensitiveLog: (
-  obj: InitializeClusterResponse
-) => any;
-export declare const ListTagsRequestFilterSensitiveLog: (
-  obj: ListTagsRequest
-) => any;
-export declare const ListTagsResponseFilterSensitiveLog: (
-  obj: ListTagsResponse
-) => any;
-export declare const ModifyBackupAttributesRequestFilterSensitiveLog: (
-  obj: ModifyBackupAttributesRequest
-) => any;
-export declare const ModifyBackupAttributesResponseFilterSensitiveLog: (
-  obj: ModifyBackupAttributesResponse
-) => any;
-export declare const ModifyClusterRequestFilterSensitiveLog: (
-  obj: ModifyClusterRequest
-) => any;
-export declare const ModifyClusterResponseFilterSensitiveLog: (
-  obj: ModifyClusterResponse
-) => any;
-export declare const RestoreBackupRequestFilterSensitiveLog: (
-  obj: RestoreBackupRequest
-) => any;
-export declare const RestoreBackupResponseFilterSensitiveLog: (
-  obj: RestoreBackupResponse
-) => any;
-export declare const TagResourceRequestFilterSensitiveLog: (
-  obj: TagResourceRequest
-) => any;
-export declare const TagResourceResponseFilterSensitiveLog: (
-  obj: TagResourceResponse
-) => any;
-export declare const UntagResourceRequestFilterSensitiveLog: (
-  obj: UntagResourceRequest
-) => any;
-export declare const UntagResourceResponseFilterSensitiveLog: (
-  obj: UntagResourceResponse
-) => any;