UNPKG

41.9 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class CloudHSM extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: CloudHSM.Types.ClientConfiguration)
13 config: Config & CloudHSM.Types.ClientConfiguration;
14 /**
15 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Adds or overwrites one or more tags for the specified AWS CloudHSM resource. Each tag consists of a key and a value. Tag keys must be unique to each resource.
16 */
17 addTagsToResource(params: CloudHSM.Types.AddTagsToResourceRequest, callback?: (err: AWSError, data: CloudHSM.Types.AddTagsToResourceResponse) => void): Request<CloudHSM.Types.AddTagsToResourceResponse, AWSError>;
18 /**
19 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Adds or overwrites one or more tags for the specified AWS CloudHSM resource. Each tag consists of a key and a value. Tag keys must be unique to each resource.
20 */
21 addTagsToResource(callback?: (err: AWSError, data: CloudHSM.Types.AddTagsToResourceResponse) => void): Request<CloudHSM.Types.AddTagsToResourceResponse, AWSError>;
22 /**
23 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.
24 */
25 createHapg(params: CloudHSM.Types.CreateHapgRequest, callback?: (err: AWSError, data: CloudHSM.Types.CreateHapgResponse) => void): Request<CloudHSM.Types.CreateHapgResponse, AWSError>;
26 /**
27 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.
28 */
29 createHapg(callback?: (err: AWSError, data: CloudHSM.Types.CreateHapgResponse) => void): Request<CloudHSM.Types.CreateHapgResponse, AWSError>;
30 /**
31 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Creates an uninitialized HSM instance. There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center, create a new case, and select Account and Billing Support. It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING.
32 */
33 createHsm(params: CloudHSM.Types.CreateHsmRequest, callback?: (err: AWSError, data: CloudHSM.Types.CreateHsmResponse) => void): Request<CloudHSM.Types.CreateHsmResponse, AWSError>;
34 /**
35 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Creates an uninitialized HSM instance. There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center, create a new case, and select Account and Billing Support. It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING.
36 */
37 createHsm(callback?: (err: AWSError, data: CloudHSM.Types.CreateHsmResponse) => void): Request<CloudHSM.Types.CreateHsmResponse, AWSError>;
38 /**
39 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Creates an HSM client.
40 */
41 createLunaClient(params: CloudHSM.Types.CreateLunaClientRequest, callback?: (err: AWSError, data: CloudHSM.Types.CreateLunaClientResponse) => void): Request<CloudHSM.Types.CreateLunaClientResponse, AWSError>;
42 /**
43 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Creates an HSM client.
44 */
45 createLunaClient(callback?: (err: AWSError, data: CloudHSM.Types.CreateLunaClientResponse) => void): Request<CloudHSM.Types.CreateLunaClientResponse, AWSError>;
46 /**
47 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Deletes a high-availability partition group.
48 */
49 deleteHapg(params: CloudHSM.Types.DeleteHapgRequest, callback?: (err: AWSError, data: CloudHSM.Types.DeleteHapgResponse) => void): Request<CloudHSM.Types.DeleteHapgResponse, AWSError>;
50 /**
51 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Deletes a high-availability partition group.
52 */
53 deleteHapg(callback?: (err: AWSError, data: CloudHSM.Types.DeleteHapgResponse) => void): Request<CloudHSM.Types.DeleteHapgResponse, AWSError>;
54 /**
55 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.
56 */
57 deleteHsm(params: CloudHSM.Types.DeleteHsmRequest, callback?: (err: AWSError, data: CloudHSM.Types.DeleteHsmResponse) => void): Request<CloudHSM.Types.DeleteHsmResponse, AWSError>;
58 /**
59 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.
60 */
61 deleteHsm(callback?: (err: AWSError, data: CloudHSM.Types.DeleteHsmResponse) => void): Request<CloudHSM.Types.DeleteHsmResponse, AWSError>;
62 /**
63 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Deletes a client.
64 */
65 deleteLunaClient(params: CloudHSM.Types.DeleteLunaClientRequest, callback?: (err: AWSError, data: CloudHSM.Types.DeleteLunaClientResponse) => void): Request<CloudHSM.Types.DeleteLunaClientResponse, AWSError>;
66 /**
67 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Deletes a client.
68 */
69 deleteLunaClient(callback?: (err: AWSError, data: CloudHSM.Types.DeleteLunaClientResponse) => void): Request<CloudHSM.Types.DeleteLunaClientResponse, AWSError>;
70 /**
71 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves information about a high-availability partition group.
72 */
73 describeHapg(params: CloudHSM.Types.DescribeHapgRequest, callback?: (err: AWSError, data: CloudHSM.Types.DescribeHapgResponse) => void): Request<CloudHSM.Types.DescribeHapgResponse, AWSError>;
74 /**
75 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves information about a high-availability partition group.
76 */
77 describeHapg(callback?: (err: AWSError, data: CloudHSM.Types.DescribeHapgResponse) => void): Request<CloudHSM.Types.DescribeHapgResponse, AWSError>;
78 /**
79 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.
80 */
81 describeHsm(params: CloudHSM.Types.DescribeHsmRequest, callback?: (err: AWSError, data: CloudHSM.Types.DescribeHsmResponse) => void): Request<CloudHSM.Types.DescribeHsmResponse, AWSError>;
82 /**
83 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.
84 */
85 describeHsm(callback?: (err: AWSError, data: CloudHSM.Types.DescribeHsmResponse) => void): Request<CloudHSM.Types.DescribeHsmResponse, AWSError>;
86 /**
87 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves information about an HSM client.
88 */
89 describeLunaClient(params: CloudHSM.Types.DescribeLunaClientRequest, callback?: (err: AWSError, data: CloudHSM.Types.DescribeLunaClientResponse) => void): Request<CloudHSM.Types.DescribeLunaClientResponse, AWSError>;
90 /**
91 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves information about an HSM client.
92 */
93 describeLunaClient(callback?: (err: AWSError, data: CloudHSM.Types.DescribeLunaClientResponse) => void): Request<CloudHSM.Types.DescribeLunaClientResponse, AWSError>;
94 /**
95 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.
96 */
97 getConfig(params: CloudHSM.Types.GetConfigRequest, callback?: (err: AWSError, data: CloudHSM.Types.GetConfigResponse) => void): Request<CloudHSM.Types.GetConfigResponse, AWSError>;
98 /**
99 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.
100 */
101 getConfig(callback?: (err: AWSError, data: CloudHSM.Types.GetConfigResponse) => void): Request<CloudHSM.Types.GetConfigResponse, AWSError>;
102 /**
103 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Lists the Availability Zones that have available AWS CloudHSM capacity.
104 */
105 listAvailableZones(params: CloudHSM.Types.ListAvailableZonesRequest, callback?: (err: AWSError, data: CloudHSM.Types.ListAvailableZonesResponse) => void): Request<CloudHSM.Types.ListAvailableZonesResponse, AWSError>;
106 /**
107 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Lists the Availability Zones that have available AWS CloudHSM capacity.
108 */
109 listAvailableZones(callback?: (err: AWSError, data: CloudHSM.Types.ListAvailableZonesResponse) => void): Request<CloudHSM.Types.ListAvailableZonesResponse, AWSError>;
110 /**
111 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Lists the high-availability partition groups for the account. This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.
112 */
113 listHapgs(params: CloudHSM.Types.ListHapgsRequest, callback?: (err: AWSError, data: CloudHSM.Types.ListHapgsResponse) => void): Request<CloudHSM.Types.ListHapgsResponse, AWSError>;
114 /**
115 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Lists the high-availability partition groups for the account. This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.
116 */
117 listHapgs(callback?: (err: AWSError, data: CloudHSM.Types.ListHapgsResponse) => void): Request<CloudHSM.Types.ListHapgsResponse, AWSError>;
118 /**
119 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves the identifiers of all of the HSMs provisioned for the current customer. This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.
120 */
121 listHsms(params: CloudHSM.Types.ListHsmsRequest, callback?: (err: AWSError, data: CloudHSM.Types.ListHsmsResponse) => void): Request<CloudHSM.Types.ListHsmsResponse, AWSError>;
122 /**
123 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves the identifiers of all of the HSMs provisioned for the current customer. This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.
124 */
125 listHsms(callback?: (err: AWSError, data: CloudHSM.Types.ListHsmsResponse) => void): Request<CloudHSM.Types.ListHsmsResponse, AWSError>;
126 /**
127 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Lists all of the clients. This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.
128 */
129 listLunaClients(params: CloudHSM.Types.ListLunaClientsRequest, callback?: (err: AWSError, data: CloudHSM.Types.ListLunaClientsResponse) => void): Request<CloudHSM.Types.ListLunaClientsResponse, AWSError>;
130 /**
131 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Lists all of the clients. This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.
132 */
133 listLunaClients(callback?: (err: AWSError, data: CloudHSM.Types.ListLunaClientsResponse) => void): Request<CloudHSM.Types.ListLunaClientsResponse, AWSError>;
134 /**
135 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Returns a list of all tags for the specified AWS CloudHSM resource.
136 */
137 listTagsForResource(params: CloudHSM.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: CloudHSM.Types.ListTagsForResourceResponse) => void): Request<CloudHSM.Types.ListTagsForResourceResponse, AWSError>;
138 /**
139 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Returns a list of all tags for the specified AWS CloudHSM resource.
140 */
141 listTagsForResource(callback?: (err: AWSError, data: CloudHSM.Types.ListTagsForResourceResponse) => void): Request<CloudHSM.Types.ListTagsForResourceResponse, AWSError>;
142 /**
143 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Modifies an existing high-availability partition group.
144 */
145 modifyHapg(params: CloudHSM.Types.ModifyHapgRequest, callback?: (err: AWSError, data: CloudHSM.Types.ModifyHapgResponse) => void): Request<CloudHSM.Types.ModifyHapgResponse, AWSError>;
146 /**
147 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Modifies an existing high-availability partition group.
148 */
149 modifyHapg(callback?: (err: AWSError, data: CloudHSM.Types.ModifyHapgResponse) => void): Request<CloudHSM.Types.ModifyHapgResponse, AWSError>;
150 /**
151 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Modifies an HSM. This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.
152 */
153 modifyHsm(params: CloudHSM.Types.ModifyHsmRequest, callback?: (err: AWSError, data: CloudHSM.Types.ModifyHsmResponse) => void): Request<CloudHSM.Types.ModifyHsmResponse, AWSError>;
154 /**
155 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Modifies an HSM. This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.
156 */
157 modifyHsm(callback?: (err: AWSError, data: CloudHSM.Types.ModifyHsmResponse) => void): Request<CloudHSM.Types.ModifyHsmResponse, AWSError>;
158 /**
159 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Modifies the certificate used by the client. This action can potentially start a workflow to install the new certificate on the client's HSMs.
160 */
161 modifyLunaClient(params: CloudHSM.Types.ModifyLunaClientRequest, callback?: (err: AWSError, data: CloudHSM.Types.ModifyLunaClientResponse) => void): Request<CloudHSM.Types.ModifyLunaClientResponse, AWSError>;
162 /**
163 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Modifies the certificate used by the client. This action can potentially start a workflow to install the new certificate on the client's HSMs.
164 */
165 modifyLunaClient(callback?: (err: AWSError, data: CloudHSM.Types.ModifyLunaClientResponse) => void): Request<CloudHSM.Types.ModifyLunaClientResponse, AWSError>;
166 /**
167 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Removes one or more tags from the specified AWS CloudHSM resource. To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.
168 */
169 removeTagsFromResource(params: CloudHSM.Types.RemoveTagsFromResourceRequest, callback?: (err: AWSError, data: CloudHSM.Types.RemoveTagsFromResourceResponse) => void): Request<CloudHSM.Types.RemoveTagsFromResourceResponse, AWSError>;
170 /**
171 * This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Removes one or more tags from the specified AWS CloudHSM resource. To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.
172 */
173 removeTagsFromResource(callback?: (err: AWSError, data: CloudHSM.Types.RemoveTagsFromResourceResponse) => void): Request<CloudHSM.Types.RemoveTagsFromResourceResponse, AWSError>;
174}
175declare namespace CloudHSM {
176 export type AZ = string;
177 export type AZList = AZ[];
178 export interface AddTagsToResourceRequest {
179 /**
180 * The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag.
181 */
182 ResourceArn: String;
183 /**
184 * One or more tags.
185 */
186 TagList: TagList;
187 }
188 export interface AddTagsToResourceResponse {
189 /**
190 * The status of the operation.
191 */
192 Status: String;
193 }
194 export type Certificate = string;
195 export type CertificateFingerprint = string;
196 export type ClientArn = string;
197 export type ClientLabel = string;
198 export type ClientList = ClientArn[];
199 export type ClientToken = string;
200 export type ClientVersion = "5.1"|"5.3"|string;
201 export type CloudHsmObjectState = "READY"|"UPDATING"|"DEGRADED"|string;
202 export interface CreateHapgRequest {
203 /**
204 * The label of the new high-availability partition group.
205 */
206 Label: Label;
207 }
208 export interface CreateHapgResponse {
209 /**
210 * The ARN of the high-availability partition group.
211 */
212 HapgArn?: HapgArn;
213 }
214 export interface CreateHsmRequest {
215 /**
216 * The identifier of the subnet in your VPC in which to place the HSM.
217 */
218 SubnetId: SubnetId;
219 /**
220 * The SSH public key to install on the HSM.
221 */
222 SshKey: SshKey;
223 /**
224 * The IP address to assign to the HSM's ENI. If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.
225 */
226 EniIp?: IpAddress;
227 /**
228 * The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
229 */
230 IamRoleArn: IamRoleArn;
231 /**
232 * The external ID from IamRoleArn, if present.
233 */
234 ExternalId?: ExternalId;
235 SubscriptionType: SubscriptionType;
236 /**
237 * A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.
238 */
239 ClientToken?: ClientToken;
240 /**
241 * The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.
242 */
243 SyslogIp?: IpAddress;
244 }
245 export interface CreateHsmResponse {
246 /**
247 * The ARN of the HSM.
248 */
249 HsmArn?: HsmArn;
250 }
251 export interface CreateLunaClientRequest {
252 /**
253 * The label for the client.
254 */
255 Label?: ClientLabel;
256 /**
257 * The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client.
258 */
259 Certificate: Certificate;
260 }
261 export interface CreateLunaClientResponse {
262 /**
263 * The ARN of the client.
264 */
265 ClientArn?: ClientArn;
266 }
267 export interface DeleteHapgRequest {
268 /**
269 * The ARN of the high-availability partition group to delete.
270 */
271 HapgArn: HapgArn;
272 }
273 export interface DeleteHapgResponse {
274 /**
275 * The status of the action.
276 */
277 Status: String;
278 }
279 export interface DeleteHsmRequest {
280 /**
281 * The ARN of the HSM to delete.
282 */
283 HsmArn: HsmArn;
284 }
285 export interface DeleteHsmResponse {
286 /**
287 * The status of the operation.
288 */
289 Status: String;
290 }
291 export interface DeleteLunaClientRequest {
292 /**
293 * The ARN of the client to delete.
294 */
295 ClientArn: ClientArn;
296 }
297 export interface DeleteLunaClientResponse {
298 /**
299 * The status of the action.
300 */
301 Status: String;
302 }
303 export interface DescribeHapgRequest {
304 /**
305 * The ARN of the high-availability partition group to describe.
306 */
307 HapgArn: HapgArn;
308 }
309 export interface DescribeHapgResponse {
310 /**
311 * The ARN of the high-availability partition group.
312 */
313 HapgArn?: HapgArn;
314 /**
315 * The serial number of the high-availability partition group.
316 */
317 HapgSerial?: String;
318 /**
319 *
320 */
321 HsmsLastActionFailed?: HsmList;
322 /**
323 *
324 */
325 HsmsPendingDeletion?: HsmList;
326 /**
327 *
328 */
329 HsmsPendingRegistration?: HsmList;
330 /**
331 * The label for the high-availability partition group.
332 */
333 Label?: Label;
334 /**
335 * The date and time the high-availability partition group was last modified.
336 */
337 LastModifiedTimestamp?: Timestamp;
338 /**
339 * The list of partition serial numbers that belong to the high-availability partition group.
340 */
341 PartitionSerialList?: PartitionSerialList;
342 /**
343 * The state of the high-availability partition group.
344 */
345 State?: CloudHsmObjectState;
346 }
347 export interface DescribeHsmRequest {
348 /**
349 * The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.
350 */
351 HsmArn?: HsmArn;
352 /**
353 * The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified.
354 */
355 HsmSerialNumber?: HsmSerialNumber;
356 }
357 export interface DescribeHsmResponse {
358 /**
359 * The ARN of the HSM.
360 */
361 HsmArn?: HsmArn;
362 /**
363 * The status of the HSM.
364 */
365 Status?: HsmStatus;
366 /**
367 * Contains additional information about the status of the HSM.
368 */
369 StatusDetails?: String;
370 /**
371 * The Availability Zone that the HSM is in.
372 */
373 AvailabilityZone?: AZ;
374 /**
375 * The identifier of the elastic network interface (ENI) attached to the HSM.
376 */
377 EniId?: EniId;
378 /**
379 * The IP address assigned to the HSM's ENI.
380 */
381 EniIp?: IpAddress;
382 SubscriptionType?: SubscriptionType;
383 /**
384 * The subscription start date.
385 */
386 SubscriptionStartDate?: Timestamp;
387 /**
388 * The subscription end date.
389 */
390 SubscriptionEndDate?: Timestamp;
391 /**
392 * The identifier of the VPC that the HSM is in.
393 */
394 VpcId?: VpcId;
395 /**
396 * The identifier of the subnet that the HSM is in.
397 */
398 SubnetId?: SubnetId;
399 /**
400 * The ARN of the IAM role assigned to the HSM.
401 */
402 IamRoleArn?: IamRoleArn;
403 /**
404 * The serial number of the HSM.
405 */
406 SerialNumber?: HsmSerialNumber;
407 /**
408 * The name of the HSM vendor.
409 */
410 VendorName?: String;
411 /**
412 * The HSM model type.
413 */
414 HsmType?: String;
415 /**
416 * The HSM software version.
417 */
418 SoftwareVersion?: String;
419 /**
420 * The public SSH key.
421 */
422 SshPublicKey?: SshKey;
423 /**
424 * The date and time that the SSH key was last updated.
425 */
426 SshKeyLastUpdated?: Timestamp;
427 /**
428 * The URI of the certificate server.
429 */
430 ServerCertUri?: String;
431 /**
432 * The date and time that the server certificate was last updated.
433 */
434 ServerCertLastUpdated?: Timestamp;
435 /**
436 * The list of partitions on the HSM.
437 */
438 Partitions?: PartitionList;
439 }
440 export interface DescribeLunaClientRequest {
441 /**
442 * The ARN of the client.
443 */
444 ClientArn?: ClientArn;
445 /**
446 * The certificate fingerprint.
447 */
448 CertificateFingerprint?: CertificateFingerprint;
449 }
450 export interface DescribeLunaClientResponse {
451 /**
452 * The ARN of the client.
453 */
454 ClientArn?: ClientArn;
455 /**
456 * The certificate installed on the HSMs used by this client.
457 */
458 Certificate?: Certificate;
459 /**
460 * The certificate fingerprint.
461 */
462 CertificateFingerprint?: CertificateFingerprint;
463 /**
464 * The date and time the client was last modified.
465 */
466 LastModifiedTimestamp?: Timestamp;
467 /**
468 * The label of the client.
469 */
470 Label?: Label;
471 }
472 export type EniId = string;
473 export type ExternalId = string;
474 export interface GetConfigRequest {
475 /**
476 * The ARN of the client.
477 */
478 ClientArn: ClientArn;
479 /**
480 * The client version.
481 */
482 ClientVersion: ClientVersion;
483 /**
484 * A list of ARNs that identify the high-availability partition groups that are associated with the client.
485 */
486 HapgList: HapgList;
487 }
488 export interface GetConfigResponse {
489 /**
490 * The type of credentials.
491 */
492 ConfigType?: String;
493 /**
494 * The chrystoki.conf configuration file.
495 */
496 ConfigFile?: String;
497 /**
498 * The certificate file containing the server.pem files of the HSMs.
499 */
500 ConfigCred?: String;
501 }
502 export type HapgArn = string;
503 export type HapgList = HapgArn[];
504 export type HsmArn = string;
505 export type HsmList = HsmArn[];
506 export type HsmSerialNumber = string;
507 export type HsmStatus = "PENDING"|"RUNNING"|"UPDATING"|"SUSPENDED"|"TERMINATING"|"TERMINATED"|"DEGRADED"|string;
508 export type IamRoleArn = string;
509 export type IpAddress = string;
510 export type Label = string;
511 export interface ListAvailableZonesRequest {
512 }
513 export interface ListAvailableZonesResponse {
514 /**
515 * The list of Availability Zones that have available AWS CloudHSM capacity.
516 */
517 AZList?: AZList;
518 }
519 export interface ListHapgsRequest {
520 /**
521 * The NextToken value from a previous call to ListHapgs. Pass null if this is the first call.
522 */
523 NextToken?: PaginationToken;
524 }
525 export interface ListHapgsResponse {
526 /**
527 * The list of high-availability partition groups.
528 */
529 HapgList: HapgList;
530 /**
531 * If not null, more results are available. Pass this value to ListHapgs to retrieve the next set of items.
532 */
533 NextToken?: PaginationToken;
534 }
535 export interface ListHsmsRequest {
536 /**
537 * The NextToken value from a previous call to ListHsms. Pass null if this is the first call.
538 */
539 NextToken?: PaginationToken;
540 }
541 export interface ListHsmsResponse {
542 /**
543 * The list of ARNs that identify the HSMs.
544 */
545 HsmList?: HsmList;
546 /**
547 * If not null, more results are available. Pass this value to ListHsms to retrieve the next set of items.
548 */
549 NextToken?: PaginationToken;
550 }
551 export interface ListLunaClientsRequest {
552 /**
553 * The NextToken value from a previous call to ListLunaClients. Pass null if this is the first call.
554 */
555 NextToken?: PaginationToken;
556 }
557 export interface ListLunaClientsResponse {
558 /**
559 * The list of clients.
560 */
561 ClientList: ClientList;
562 /**
563 * If not null, more results are available. Pass this to ListLunaClients to retrieve the next set of items.
564 */
565 NextToken?: PaginationToken;
566 }
567 export interface ListTagsForResourceRequest {
568 /**
569 * The Amazon Resource Name (ARN) of the AWS CloudHSM resource.
570 */
571 ResourceArn: String;
572 }
573 export interface ListTagsForResourceResponse {
574 /**
575 * One or more tags.
576 */
577 TagList: TagList;
578 }
579 export interface ModifyHapgRequest {
580 /**
581 * The ARN of the high-availability partition group to modify.
582 */
583 HapgArn: HapgArn;
584 /**
585 * The new label for the high-availability partition group.
586 */
587 Label?: Label;
588 /**
589 * The list of partition serial numbers to make members of the high-availability partition group.
590 */
591 PartitionSerialList?: PartitionSerialList;
592 }
593 export interface ModifyHapgResponse {
594 /**
595 * The ARN of the high-availability partition group.
596 */
597 HapgArn?: HapgArn;
598 }
599 export interface ModifyHsmRequest {
600 /**
601 * The ARN of the HSM to modify.
602 */
603 HsmArn: HsmArn;
604 /**
605 * 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.
606 */
607 SubnetId?: SubnetId;
608 /**
609 * The new IP address for the elastic network interface (ENI) attached to the HSM. If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.
610 */
611 EniIp?: IpAddress;
612 /**
613 * The new IAM role ARN.
614 */
615 IamRoleArn?: IamRoleArn;
616 /**
617 * The new external ID.
618 */
619 ExternalId?: ExternalId;
620 /**
621 * The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.
622 */
623 SyslogIp?: IpAddress;
624 }
625 export interface ModifyHsmResponse {
626 /**
627 * The ARN of the HSM.
628 */
629 HsmArn?: HsmArn;
630 }
631 export interface ModifyLunaClientRequest {
632 /**
633 * The ARN of the client.
634 */
635 ClientArn: ClientArn;
636 /**
637 * The new certificate for the client.
638 */
639 Certificate: Certificate;
640 }
641 export interface ModifyLunaClientResponse {
642 /**
643 * The ARN of the client.
644 */
645 ClientArn?: ClientArn;
646 }
647 export type PaginationToken = string;
648 export type PartitionArn = string;
649 export type PartitionList = PartitionArn[];
650 export type PartitionSerial = string;
651 export type PartitionSerialList = PartitionSerial[];
652 export interface RemoveTagsFromResourceRequest {
653 /**
654 * The Amazon Resource Name (ARN) of the AWS CloudHSM resource.
655 */
656 ResourceArn: String;
657 /**
658 * The tag key or keys to remove. Specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.
659 */
660 TagKeyList: TagKeyList;
661 }
662 export interface RemoveTagsFromResourceResponse {
663 /**
664 * The status of the operation.
665 */
666 Status: String;
667 }
668 export type SshKey = string;
669 export type String = string;
670 export type SubnetId = string;
671 export type SubscriptionType = "PRODUCTION"|string;
672 export interface Tag {
673 /**
674 * The key of the tag.
675 */
676 Key: TagKey;
677 /**
678 * The value of the tag.
679 */
680 Value: TagValue;
681 }
682 export type TagKey = string;
683 export type TagKeyList = TagKey[];
684 export type TagList = Tag[];
685 export type TagValue = string;
686 export type Timestamp = string;
687 export type VpcId = string;
688 /**
689 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
690 */
691 export type apiVersion = "2014-05-30"|"latest"|string;
692 export interface ClientApiVersions {
693 /**
694 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
695 */
696 apiVersion?: apiVersion;
697 }
698 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
699 /**
700 * Contains interfaces for use with the CloudHSM client.
701 */
702 export import Types = CloudHSM;
703}
704export = CloudHSM;