@aws-sdk/client-cloudhsm 3.379.1 → 3.385.0

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

@@ -7,10 +7,12 @@ import { CloudHSMServiceException as __BaseException } from "./CloudHSMServiceEx
  */
 export interface Tag {
     /**
+     * @public
      * <p>The key of the tag.</p>
      */
     Key: string | undefined;
     /**
+     * @public
      * <p>The value of the tag.</p>
      */
     Value: string | undefined;
@@ -20,10 +22,12 @@ export interface Tag {
  */
 export interface AddTagsToResourceRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag.</p>
      */
     ResourceArn: string | undefined;
     /**
+     * @public
      * <p>One or more tags.</p>
      */
     TagList: Tag[] | undefined;
@@ -33,6 +37,7 @@ export interface AddTagsToResourceRequest {
  */
 export interface AddTagsToResourceResponse {
     /**
+     * @public
      * <p>The status of the operation.</p>
      */
     Status: string | undefined;
@@ -45,6 +50,7 @@ export declare class CloudHsmInternalException extends __BaseException {
     readonly name: "CloudHsmInternalException";
     readonly $fault: "server";
     /**
+     * @public
      * <p>Indicates if the action can be retried.</p>
      */
     retryable?: boolean;
@@ -61,6 +67,7 @@ export declare class CloudHsmServiceException extends __BaseException {
     readonly name: "CloudHsmServiceException";
     readonly $fault: "client";
     /**
+     * @public
      * <p>Indicates if the action can be retried.</p>
      */
     retryable?: boolean;
@@ -77,6 +84,7 @@ export declare class InvalidRequestException extends __BaseException {
     readonly name: "InvalidRequestException";
     readonly $fault: "client";
     /**
+     * @public
      * <p>Indicates if the action can be retried.</p>
      */
     retryable?: boolean;
@@ -103,6 +111,7 @@ export type ClientVersion = (typeof ClientVersion)[keyof typeof ClientVersion];
  */
 export interface CreateHapgRequest {
     /**
+     * @public
      * <p>The label of the new high-availability partition group.</p>
      */
     Label: string | undefined;
@@ -113,6 +122,7 @@ export interface CreateHapgRequest {
  */
 export interface CreateHapgResponse {
     /**
+     * @public
      * <p>The ARN of the high-availability partition group.</p>
      */
     HapgArn?: string;
@@ -134,29 +144,35 @@ export type SubscriptionType = (typeof SubscriptionType)[keyof typeof Subscripti
  */
 export interface CreateHsmRequest {
     /**
+     * @public
      * <p>The identifier of the subnet in your VPC in which to place the HSM.</p>
      */
     SubnetId: string | undefined;
     /**
+     * @public
      * <p>The SSH public key to install on the HSM.</p>
      */
     SshKey: string | undefined;
     /**
+     * @public
      * <p>The IP address to assign to the HSM's ENI.</p>
      *          <p>If an IP address is not specified, an IP address will be randomly chosen from the CIDR
      *       range of the subnet.</p>
      */
     EniIp?: string;
     /**
+     * @public
      * <p>The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your
      *       behalf.</p>
      */
     IamRoleArn: string | undefined;
     /**
+     * @public
      * <p>The external ID from <code>IamRoleArn</code>, if present.</p>
      */
     ExternalId?: string;
     /**
+     * @public
      * <p>Specifies the type of subscription for the HSM.</p>
      *          <ul>
      *             <li>
@@ -173,11 +189,13 @@ export interface CreateHsmRequest {
      */
     SubscriptionType: SubscriptionType | string | undefined;
     /**
+     * @public
      * <p>A user-defined token to ensure idempotence. Subsequent calls to this operation with the
      *       same token will be ignored.</p>
      */
     ClientToken?: string;
     /**
+     * @public
      * <p>The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one
      *       syslog monitoring server.</p>
      */
@@ -189,6 +207,7 @@ export interface CreateHsmRequest {
  */
 export interface CreateHsmResponse {
     /**
+     * @public
      * <p>The ARN of the HSM.</p>
      */
     HsmArn?: string;
@@ -199,10 +218,12 @@ export interface CreateHsmResponse {
  */
 export interface CreateLunaClientRequest {
     /**
+     * @public
      * <p>The label for the client.</p>
      */
     Label?: string;
     /**
+     * @public
      * <p>The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used
      *       by this client.</p>
      */
@@ -214,6 +235,7 @@ export interface CreateLunaClientRequest {
  */
 export interface CreateLunaClientResponse {
     /**
+     * @public
      * <p>The ARN of the client.</p>
      */
     ClientArn?: string;
@@ -224,6 +246,7 @@ export interface CreateLunaClientResponse {
  */
 export interface DeleteHapgRequest {
     /**
+     * @public
      * <p>The ARN of the high-availability partition group to delete.</p>
      */
     HapgArn: string | undefined;
@@ -234,6 +257,7 @@ export interface DeleteHapgRequest {
  */
 export interface DeleteHapgResponse {
     /**
+     * @public
      * <p>The status of the action.</p>
      */
     Status: string | undefined;
@@ -244,6 +268,7 @@ export interface DeleteHapgResponse {
  */
 export interface DeleteHsmRequest {
     /**
+     * @public
      * <p>The ARN of the HSM to delete.</p>
      */
     HsmArn: string | undefined;
@@ -254,6 +279,7 @@ export interface DeleteHsmRequest {
  */
 export interface DeleteHsmResponse {
     /**
+     * @public
      * <p>The status of the operation.</p>
      */
     Status: string | undefined;
@@ -263,6 +289,7 @@ export interface DeleteHsmResponse {
  */
 export interface DeleteLunaClientRequest {
     /**
+     * @public
      * <p>The ARN of the client to delete.</p>
      */
     ClientArn: string | undefined;
@@ -272,6 +299,7 @@ export interface DeleteLunaClientRequest {
  */
 export interface DeleteLunaClientResponse {
     /**
+     * @public
      * <p>The status of the action.</p>
      */
     Status: string | undefined;
@@ -282,6 +310,7 @@ export interface DeleteLunaClientResponse {
  */
 export interface DescribeHapgRequest {
     /**
+     * @public
      * <p>The ARN of the high-availability partition group to describe.</p>
      */
     HapgArn: string | undefined;
@@ -305,39 +334,48 @@ export type CloudHsmObjectState = (typeof CloudHsmObjectState)[keyof typeof Clou
  */
 export interface DescribeHapgResponse {
     /**
+     * @public
      * <p>The ARN of the high-availability partition group.</p>
      */
     HapgArn?: string;
     /**
+     * @public
      * <p>The serial number of the high-availability partition group.</p>
      */
     HapgSerial?: string;
     /**
+     * @public
      * <p></p>
      */
     HsmsLastActionFailed?: string[];
     /**
+     * @public
      * <p></p>
      */
     HsmsPendingDeletion?: string[];
     /**
+     * @public
      * <p></p>
      */
     HsmsPendingRegistration?: string[];
     /**
+     * @public
      * <p>The label for the high-availability partition group.</p>
      */
     Label?: string;
     /**
+     * @public
      * <p>The date and time the high-availability partition group was last modified.</p>
      */
     LastModifiedTimestamp?: string;
     /**
+     * @public
      * <p>The list of partition serial numbers that belong to the high-availability partition
      *       group.</p>
      */
     PartitionSerialList?: string[];
     /**
+     * @public
      * <p>The state of the high-availability partition group.</p>
      */
     State?: CloudHsmObjectState | string;
@@ -348,11 +386,13 @@ export interface DescribeHapgResponse {
  */
 export interface DescribeHsmRequest {
     /**
+     * @public
      * <p>The ARN of the HSM. Either the <code>HsmArn</code> or the <code>SerialNumber</code>
      *       parameter must be specified.</p>
      */
     HsmArn?: string;
     /**
+     * @public
      * <p>The serial number of the HSM. Either the <code>HsmArn</code> or the
      *         <code>HsmSerialNumber</code> parameter must be specified.</p>
      */
@@ -381,30 +421,37 @@ export type HsmStatus = (typeof HsmStatus)[keyof typeof HsmStatus];
  */
 export interface DescribeHsmResponse {
     /**
+     * @public
      * <p>The ARN of the HSM.</p>
      */
     HsmArn?: string;
     /**
+     * @public
      * <p>The status of the HSM.</p>
      */
     Status?: HsmStatus | string;
     /**
+     * @public
      * <p>Contains additional information about the status of the HSM.</p>
      */
     StatusDetails?: string;
     /**
+     * @public
      * <p>The Availability Zone that the HSM is in.</p>
      */
     AvailabilityZone?: string;
     /**
+     * @public
      * <p>The identifier of the elastic network interface (ENI) attached to the HSM.</p>
      */
     EniId?: string;
     /**
+     * @public
      * <p>The IP address assigned to the HSM's ENI.</p>
      */
     EniIp?: string;
     /**
+     * @public
      * <p>Specifies the type of subscription for the HSM.</p>
      *          <ul>
      *             <li>
@@ -421,58 +468,72 @@ export interface DescribeHsmResponse {
      */
     SubscriptionType?: SubscriptionType | string;
     /**
+     * @public
      * <p>The subscription start date.</p>
      */
     SubscriptionStartDate?: string;
     /**
+     * @public
      * <p>The subscription end date.</p>
      */
     SubscriptionEndDate?: string;
     /**
+     * @public
      * <p>The identifier of the VPC that the HSM is in.</p>
      */
     VpcId?: string;
     /**
+     * @public
      * <p>The identifier of the subnet that the HSM is in.</p>
      */
     SubnetId?: string;
     /**
+     * @public
      * <p>The ARN of the IAM role assigned to the HSM.</p>
      */
     IamRoleArn?: string;
     /**
+     * @public
      * <p>The serial number of the HSM.</p>
      */
     SerialNumber?: string;
     /**
+     * @public
      * <p>The name of the HSM vendor.</p>
      */
     VendorName?: string;
     /**
+     * @public
      * <p>The HSM model type.</p>
      */
     HsmType?: string;
     /**
+     * @public
      * <p>The HSM software version.</p>
      */
     SoftwareVersion?: string;
     /**
+     * @public
      * <p>The public SSH key.</p>
      */
     SshPublicKey?: string;
     /**
+     * @public
      * <p>The date and time that the SSH key was last updated.</p>
      */
     SshKeyLastUpdated?: string;
     /**
+     * @public
      * <p>The URI of the certificate server.</p>
      */
     ServerCertUri?: string;
     /**
+     * @public
      * <p>The date and time that the server certificate was last updated.</p>
      */
     ServerCertLastUpdated?: string;
     /**
+     * @public
      * <p>The list of partitions on the HSM.</p>
      */
     Partitions?: string[];
@@ -482,10 +543,12 @@ export interface DescribeHsmResponse {
  */
 export interface DescribeLunaClientRequest {
     /**
+     * @public
      * <p>The ARN of the client.</p>
      */
     ClientArn?: string;
     /**
+     * @public
      * <p>The certificate fingerprint.</p>
      */
     CertificateFingerprint?: string;
@@ -495,22 +558,27 @@ export interface DescribeLunaClientRequest {
  */
 export interface DescribeLunaClientResponse {
     /**
+     * @public
      * <p>The ARN of the client.</p>
      */
     ClientArn?: string;
     /**
+     * @public
      * <p>The certificate installed on the HSMs used by this client.</p>
      */
     Certificate?: string;
     /**
+     * @public
      * <p>The certificate fingerprint.</p>
      */
     CertificateFingerprint?: string;
     /**
+     * @public
      * <p>The date and time the client was last modified.</p>
      */
     LastModifiedTimestamp?: string;
     /**
+     * @public
      * <p>The label of the client.</p>
      */
     Label?: string;
@@ -520,14 +588,17 @@ export interface DescribeLunaClientResponse {
  */
 export interface GetConfigRequest {
     /**
+     * @public
      * <p>The ARN of the client.</p>
      */
     ClientArn: string | undefined;
     /**
+     * @public
      * <p>The client version.</p>
      */
     ClientVersion: ClientVersion | string | undefined;
     /**
+     * @public
      * <p>A list of ARNs that identify the high-availability partition groups that are associated
      *       with the client.</p>
      */
@@ -538,14 +609,17 @@ export interface GetConfigRequest {
  */
 export interface GetConfigResponse {
     /**
+     * @public
      * <p>The type of credentials.</p>
      */
     ConfigType?: string;
     /**
+     * @public
      * <p>The chrystoki.conf configuration file.</p>
      */
     ConfigFile?: string;
     /**
+     * @public
      * <p>The certificate file containing the server.pem files of the HSMs.</p>
      */
     ConfigCred?: string;
@@ -561,6 +635,7 @@ export interface ListAvailableZonesRequest {
  */
 export interface ListAvailableZonesResponse {
     /**
+     * @public
      * <p>The list of Availability Zones that have available AWS CloudHSM capacity.</p>
      */
     AZList?: string[];
@@ -570,6 +645,7 @@ export interface ListAvailableZonesResponse {
  */
 export interface ListHapgsRequest {
     /**
+     * @public
      * <p>The <code>NextToken</code> value from a previous call to <code>ListHapgs</code>. Pass
      *       null if this is the first call.</p>
      */
@@ -580,10 +656,12 @@ export interface ListHapgsRequest {
  */
 export interface ListHapgsResponse {
     /**
+     * @public
      * <p>The list of high-availability partition groups.</p>
      */
     HapgList: string[] | undefined;
     /**
+     * @public
      * <p>If not null, more results are available. Pass this value to <code>ListHapgs</code> to
      *       retrieve the next set of items.</p>
      */
@@ -594,6 +672,7 @@ export interface ListHapgsResponse {
  */
 export interface ListHsmsRequest {
     /**
+     * @public
      * <p>The <code>NextToken</code> value from a previous call to <code>ListHsms</code>. Pass
      *       null if this is the first call.</p>
      */
@@ -605,10 +684,12 @@ export interface ListHsmsRequest {
  */
 export interface ListHsmsResponse {
     /**
+     * @public
      * <p>The list of ARNs that identify the HSMs.</p>
      */
     HsmList?: string[];
     /**
+     * @public
      * <p>If not null, more results are available. Pass this value to <code>ListHsms</code> to
      *       retrieve the next set of items.</p>
      */
@@ -619,6 +700,7 @@ export interface ListHsmsResponse {
  */
 export interface ListLunaClientsRequest {
     /**
+     * @public
      * <p>The <code>NextToken</code> value from a previous call to <code>ListLunaClients</code>.
      *       Pass null if this is the first call.</p>
      */
@@ -629,10 +711,12 @@ export interface ListLunaClientsRequest {
  */
 export interface ListLunaClientsResponse {
     /**
+     * @public
      * <p>The list of clients.</p>
      */
     ClientList: string[] | undefined;
     /**
+     * @public
      * <p>If not null, more results are available. Pass this to <code>ListLunaClients</code> to
      *       retrieve the next set of items.</p>
      */
@@ -643,6 +727,7 @@ export interface ListLunaClientsResponse {
  */
 export interface ListTagsForResourceRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the AWS CloudHSM resource.</p>
      */
     ResourceArn: string | undefined;
@@ -652,6 +737,7 @@ export interface ListTagsForResourceRequest {
  */
 export interface ListTagsForResourceResponse {
     /**
+     * @public
      * <p>One or more tags.</p>
      */
     TagList: Tag[] | undefined;
@@ -661,14 +747,17 @@ export interface ListTagsForResourceResponse {
  */
 export interface ModifyHapgRequest {
     /**
+     * @public
      * <p>The ARN of the high-availability partition group to modify.</p>
      */
     HapgArn: string | undefined;
     /**
+     * @public
      * <p>The new label for the high-availability partition group.</p>
      */
     Label?: string;
     /**
+     * @public
      * <p>The list of partition serial numbers to make members of the high-availability partition
      *       group.</p>
      */
@@ -679,6 +768,7 @@ export interface ModifyHapgRequest {
  */
 export interface ModifyHapgResponse {
     /**
+     * @public
      * <p>The ARN of the high-availability partition group.</p>
      */
     HapgArn?: string;
@@ -689,15 +779,18 @@ export interface ModifyHapgResponse {
  */
 export interface ModifyHsmRequest {
     /**
+     * @public
      * <p>The ARN of the HSM to modify.</p>
      */
     HsmArn: string | undefined;
     /**
+     * @public
      * <p>The new identifier of the subnet that the HSM is in. The new subnet must be in the same
      *       Availability Zone as the current subnet.</p>
      */
     SubnetId?: string;
     /**
+     * @public
      * <p>The new IP address for the elastic network interface (ENI) attached to the
      *       HSM.</p>
      *          <p>If the HSM is moved to a different subnet, and an IP address is not specified, an IP
@@ -705,14 +798,17 @@ export interface ModifyHsmRequest {
      */
     EniIp?: string;
     /**
+     * @public
      * <p>The new IAM role ARN.</p>
      */
     IamRoleArn?: string;
     /**
+     * @public
      * <p>The new external ID.</p>
      */
     ExternalId?: string;
     /**
+     * @public
      * <p>The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports
      *       one syslog monitoring server.</p>
      */
@@ -724,6 +820,7 @@ export interface ModifyHsmRequest {
  */
 export interface ModifyHsmResponse {
     /**
+     * @public
      * <p>The ARN of the HSM.</p>
      */
     HsmArn?: string;
@@ -733,10 +830,12 @@ export interface ModifyHsmResponse {
  */
 export interface ModifyLunaClientRequest {
     /**
+     * @public
      * <p>The ARN of the client.</p>
      */
     ClientArn: string | undefined;
     /**
+     * @public
      * <p>The new certificate for the client.</p>
      */
     Certificate: string | undefined;
@@ -746,6 +845,7 @@ export interface ModifyLunaClientRequest {
  */
 export interface ModifyLunaClientResponse {
     /**
+     * @public
      * <p>The ARN of the client.</p>
      */
     ClientArn?: string;
@@ -755,10 +855,12 @@ export interface ModifyLunaClientResponse {
  */
 export interface RemoveTagsFromResourceRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the AWS CloudHSM resource.</p>
      */
     ResourceArn: string | undefined;
     /**
+     * @public
      * <p>The tag key or keys to remove.</p>
      *          <p>Specify only the tag key to remove (not the value). To overwrite the value for an
      *       existing tag, use <a>AddTagsToResource</a>.</p>
@@ -770,6 +872,7 @@ export interface RemoveTagsFromResourceRequest {
  */
 export interface RemoveTagsFromResourceResponse {
     /**
+     * @public
      * <p>The status of the operation.</p>
      */
     Status: string | undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-cloudhsm",
   "description": "AWS SDK for JavaScript Cloudhsm Client for Node.js, Browser and React Native",
-  "version": "3.379.1",
+  "version": "3.385.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.379.1",
-    "@aws-sdk/credential-provider-node": "3.379.1",
+    "@aws-sdk/client-sts": "3.385.0",
+    "@aws-sdk/credential-provider-node": "3.385.0",
     "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
     "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",