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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -16,23 +16,27 @@ import { RestoreBackupCommandInput, RestoreBackupCommandOutput } from "./command
16
16
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
17
17
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
18
18
  /**
19
+ * @public
19
20
  * <p>For more information about AWS CloudHSM, see <a href="http://aws.amazon.com/cloudhsm/">AWS CloudHSM</a> and the <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/">AWS
20
21
  * CloudHSM User Guide</a>.</p>
21
22
  */
22
23
  export declare class CloudHSMV2 extends CloudHSMV2Client {
23
24
  /**
25
+ * @public
24
26
  * <p>Copy an AWS CloudHSM cluster backup to a different region.</p>
25
27
  */
26
28
  copyBackupToRegion(args: CopyBackupToRegionCommandInput, options?: __HttpHandlerOptions): Promise<CopyBackupToRegionCommandOutput>;
27
29
  copyBackupToRegion(args: CopyBackupToRegionCommandInput, cb: (err: any, data?: CopyBackupToRegionCommandOutput) => void): void;
28
30
  copyBackupToRegion(args: CopyBackupToRegionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyBackupToRegionCommandOutput) => void): void;
29
31
  /**
32
+ * @public
30
33
  * <p>Creates a new AWS CloudHSM cluster.</p>
31
34
  */
32
35
  createCluster(args: CreateClusterCommandInput, options?: __HttpHandlerOptions): Promise<CreateClusterCommandOutput>;
33
36
  createCluster(args: CreateClusterCommandInput, cb: (err: any, data?: CreateClusterCommandOutput) => void): void;
34
37
  createCluster(args: CreateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterCommandOutput) => void): void;
35
38
  /**
39
+ * @public
36
40
  * <p>Creates a new hardware security module (HSM) in the specified AWS CloudHSM
37
41
  * cluster.</p>
38
42
  */
@@ -40,6 +44,7 @@ export declare class CloudHSMV2 extends CloudHSMV2Client {
40
44
  createHsm(args: CreateHsmCommandInput, cb: (err: any, data?: CreateHsmCommandOutput) => void): void;
41
45
  createHsm(args: CreateHsmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHsmCommandOutput) => void): void;
42
46
  /**
47
+ * @public
43
48
  * <p>Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days
44
49
  * after the DeleteBackup request is made. For more information on restoring a backup, see
45
50
  * <a>RestoreBackup</a>.</p>
@@ -48,6 +53,7 @@ export declare class CloudHSMV2 extends CloudHSMV2Client {
48
53
  deleteBackup(args: DeleteBackupCommandInput, cb: (err: any, data?: DeleteBackupCommandOutput) => void): void;
49
54
  deleteBackup(args: DeleteBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackupCommandOutput) => void): void;
50
55
  /**
56
+ * @public
51
57
  * <p>Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must
52
58
  * delete all HSMs in the cluster. To see if the cluster contains any HSMs, use <a>DescribeClusters</a>. To delete an HSM, use <a>DeleteHsm</a>.</p>
53
59
  */
@@ -55,6 +61,7 @@ export declare class CloudHSMV2 extends CloudHSMV2Client {
55
61
  deleteCluster(args: DeleteClusterCommandInput, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void;
56
62
  deleteCluster(args: DeleteClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void;
57
63
  /**
64
+ * @public
58
65
  * <p>Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP
59
66
  * address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to
60
67
  * specify only one of these values. To find these values, use <a>DescribeClusters</a>.</p>
@@ -63,6 +70,7 @@ export declare class CloudHSMV2 extends CloudHSMV2Client {
63
70
  deleteHsm(args: DeleteHsmCommandInput, cb: (err: any, data?: DeleteHsmCommandOutput) => void): void;
64
71
  deleteHsm(args: DeleteHsmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHsmCommandOutput) => void): void;
65
72
  /**
73
+ * @public
66
74
  * <p>Gets information about backups of AWS CloudHSM clusters.</p>
67
75
  * <p>This is a paginated operation, which means that each response might contain only a
68
76
  * subset of all the backups. When the response contains only a subset of backups, it includes a
@@ -74,6 +82,7 @@ export declare class CloudHSMV2 extends CloudHSMV2Client {
74
82
  describeBackups(args: DescribeBackupsCommandInput, cb: (err: any, data?: DescribeBackupsCommandOutput) => void): void;
75
83
  describeBackups(args: DescribeBackupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBackupsCommandOutput) => void): void;
76
84
  /**
85
+ * @public
77
86
  * <p>Gets information about AWS CloudHSM clusters.</p>
78
87
  * <p>This is a paginated operation, which means that each response might contain only a
79
88
  * subset of all the clusters. When the response contains only a subset of clusters, it includes
@@ -85,6 +94,7 @@ export declare class CloudHSMV2 extends CloudHSMV2Client {
85
94
  describeClusters(args: DescribeClustersCommandInput, cb: (err: any, data?: DescribeClustersCommandOutput) => void): void;
86
95
  describeClusters(args: DescribeClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClustersCommandOutput) => void): void;
87
96
  /**
97
+ * @public
88
98
  * <p>Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your
89
99
  * issuing certificate authority (CA) and the CA's root certificate. Before you can claim a
90
100
  * cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA.
@@ -94,6 +104,7 @@ export declare class CloudHSMV2 extends CloudHSMV2Client {
94
104
  initializeCluster(args: InitializeClusterCommandInput, cb: (err: any, data?: InitializeClusterCommandOutput) => void): void;
95
105
  initializeCluster(args: InitializeClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitializeClusterCommandOutput) => void): void;
96
106
  /**
107
+ * @public
97
108
  * <p>Gets a list of tags for the specified AWS CloudHSM cluster.</p>
98
109
  * <p>This is a paginated operation, which means that each response might contain only a
99
110
  * subset of all the tags. When the response contains only a subset of tags, it includes a
@@ -105,18 +116,21 @@ export declare class CloudHSMV2 extends CloudHSMV2Client {
105
116
  listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void;
106
117
  listTags(args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void): void;
107
118
  /**
119
+ * @public
108
120
  * <p>Modifies attributes for AWS CloudHSM backup.</p>
109
121
  */
110
122
  modifyBackupAttributes(args: ModifyBackupAttributesCommandInput, options?: __HttpHandlerOptions): Promise<ModifyBackupAttributesCommandOutput>;
111
123
  modifyBackupAttributes(args: ModifyBackupAttributesCommandInput, cb: (err: any, data?: ModifyBackupAttributesCommandOutput) => void): void;
112
124
  modifyBackupAttributes(args: ModifyBackupAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyBackupAttributesCommandOutput) => void): void;
113
125
  /**
126
+ * @public
114
127
  * <p>Modifies AWS CloudHSM cluster.</p>
115
128
  */
116
129
  modifyCluster(args: ModifyClusterCommandInput, options?: __HttpHandlerOptions): Promise<ModifyClusterCommandOutput>;
117
130
  modifyCluster(args: ModifyClusterCommandInput, cb: (err: any, data?: ModifyClusterCommandOutput) => void): void;
118
131
  modifyCluster(args: ModifyClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyClusterCommandOutput) => void): void;
119
132
  /**
133
+ * @public
120
134
  * <p>Restores a specified AWS CloudHSM backup that is in the
121
135
  * <code>PENDING_DELETION</code> state. For mor information on deleting a backup, see
122
136
  * <a>DeleteBackup</a>.</p>
@@ -125,12 +139,14 @@ export declare class CloudHSMV2 extends CloudHSMV2Client {
125
139
  restoreBackup(args: RestoreBackupCommandInput, cb: (err: any, data?: RestoreBackupCommandOutput) => void): void;
126
140
  restoreBackup(args: RestoreBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreBackupCommandOutput) => void): void;
127
141
  /**
142
+ * @public
128
143
  * <p>Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.</p>
129
144
  */
130
145
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
131
146
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
132
147
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
133
148
  /**
149
+ * @public
134
150
  * <p>Removes the specified tag or tags from the specified AWS CloudHSM cluster.</p>
135
151
  */
136
152
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
@@ -23,15 +23,24 @@ import { RestoreBackupCommandInput, RestoreBackupCommandOutput } from "./command
23
23
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
24
24
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
25
25
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
26
+ /**
27
+ * @public
28
+ */
26
29
  export type ServiceInputTypes = CopyBackupToRegionCommandInput | CreateClusterCommandInput | CreateHsmCommandInput | DeleteBackupCommandInput | DeleteClusterCommandInput | DeleteHsmCommandInput | DescribeBackupsCommandInput | DescribeClustersCommandInput | InitializeClusterCommandInput | ListTagsCommandInput | ModifyBackupAttributesCommandInput | ModifyClusterCommandInput | RestoreBackupCommandInput | TagResourceCommandInput | UntagResourceCommandInput;
30
+ /**
31
+ * @public
32
+ */
27
33
  export type ServiceOutputTypes = CopyBackupToRegionCommandOutput | CreateClusterCommandOutput | CreateHsmCommandOutput | DeleteBackupCommandOutput | DeleteClusterCommandOutput | DeleteHsmCommandOutput | DescribeBackupsCommandOutput | DescribeClustersCommandOutput | InitializeClusterCommandOutput | ListTagsCommandOutput | ModifyBackupAttributesCommandOutput | ModifyClusterCommandOutput | RestoreBackupCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput;
34
+ /**
35
+ * @public
36
+ */
28
37
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
29
38
  /**
30
39
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
31
40
  */
32
41
  requestHandler?: __HttpHandler;
33
42
  /**
34
- * A constructor for a class implementing the {@link __Checksum} interface
43
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
35
44
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
36
45
  * @internal
37
46
  */
@@ -121,23 +130,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
121
130
  */
122
131
  logger?: __Logger;
123
132
  /**
124
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
133
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
125
134
  */
126
135
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
127
136
  }
137
+ /**
138
+ * @public
139
+ */
128
140
  type CloudHSMV2ClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
129
141
  /**
130
- * The configuration interface of CloudHSMV2Client class constructor that set the region, credentials and other options.
142
+ * @public
143
+ *
144
+ * The configuration interface of CloudHSMV2Client class constructor that set the region, credentials and other options.
131
145
  */
132
146
  export interface CloudHSMV2ClientConfig extends CloudHSMV2ClientConfigType {
133
147
  }
148
+ /**
149
+ * @public
150
+ */
134
151
  type CloudHSMV2ClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
135
152
  /**
136
- * The resolved configuration interface of CloudHSMV2Client class. This is resolved and normalized from the {@link CloudHSMV2ClientConfig | constructor configuration interface}.
153
+ * @public
154
+ *
155
+ * The resolved configuration interface of CloudHSMV2Client class. This is resolved and normalized from the {@link CloudHSMV2ClientConfig | constructor configuration interface}.
137
156
  */
138
157
  export interface CloudHSMV2ClientResolvedConfig extends CloudHSMV2ClientResolvedConfigType {
139
158
  }
140
159
  /**
160
+ * @public
141
161
  * <p>For more information about AWS CloudHSM, see <a href="http://aws.amazon.com/cloudhsm/">AWS CloudHSM</a> and the <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/">AWS
142
162
  * CloudHSM User Guide</a>.</p>
143
163
  */
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudHSMV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudHSMV2Client";
5
5
  import { CopyBackupToRegionRequest, CopyBackupToRegionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CopyBackupToRegionCommand}.
8
10
  */
9
11
  export interface CopyBackupToRegionCommandInput extends CopyBackupToRegionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CopyBackupToRegionCommand}.
13
17
  */
14
18
  export interface CopyBackupToRegionCommandOutput extends CopyBackupToRegionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Copy an AWS CloudHSM cluster backup to a different region.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CopyBackupToRegionCommandOutput extends CopyBackupToRegionRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CopyBackupToRegionCommandInput - {@link CopyBackupToRegionCommandInput}
34
+ * @returns {@link CopyBackupToRegionCommandOutput}
28
35
  * @see {@link CopyBackupToRegionCommandInput} for command's `input` shape.
29
36
  * @see {@link CopyBackupToRegionCommandOutput} for command's `response` shape.
30
37
  * @see {@link CloudHSMV2ClientResolvedConfig | config} for CloudHSMV2Client's `config` shape.
@@ -55,11 +62,20 @@ export interface CopyBackupToRegionCommandOutput extends CopyBackupToRegionRespo
55
62
  export declare class CopyBackupToRegionCommand extends $Command<CopyBackupToRegionCommandInput, CopyBackupToRegionCommandOutput, CloudHSMV2ClientResolvedConfig> {
56
63
  readonly input: CopyBackupToRegionCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: CopyBackupToRegionCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudHSMV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CopyBackupToRegionCommandInput, CopyBackupToRegionCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudHSMV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudHSMV2Client";
5
5
  import { CreateClusterRequest, CreateClusterResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateClusterCommand}.
8
10
  */
9
11
  export interface CreateClusterCommandInput extends CreateClusterRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateClusterCommand}.
13
17
  */
14
18
  export interface CreateClusterCommandOutput extends CreateClusterResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new AWS CloudHSM cluster.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateClusterCommandInput - {@link CreateClusterCommandInput}
34
+ * @returns {@link CreateClusterCommandOutput}
28
35
  * @see {@link CreateClusterCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateClusterCommandOutput} for command's `response` shape.
30
37
  * @see {@link CloudHSMV2ClientResolvedConfig | config} for CloudHSMV2Client's `config` shape.
@@ -55,11 +62,20 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
55
62
  export declare class CreateClusterCommand extends $Command<CreateClusterCommandInput, CreateClusterCommandOutput, CloudHSMV2ClientResolvedConfig> {
56
63
  readonly input: CreateClusterCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: CreateClusterCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudHSMV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateClusterCommandInput, CreateClusterCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudHSMV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudHSMV2Client";
5
5
  import { CreateHsmRequest, CreateHsmResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateHsmCommand}.
8
10
  */
9
11
  export interface CreateHsmCommandInput extends CreateHsmRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateHsmCommand}.
13
17
  */
14
18
  export interface CreateHsmCommandOutput extends CreateHsmResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new hardware security module (HSM) in the specified AWS CloudHSM
18
23
  * cluster.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateHsmCommandOutput extends CreateHsmResponse, __MetadataBea
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateHsmCommandInput - {@link CreateHsmCommandInput}
35
+ * @returns {@link CreateHsmCommandOutput}
29
36
  * @see {@link CreateHsmCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateHsmCommandOutput} for command's `response` shape.
31
38
  * @see {@link CloudHSMV2ClientResolvedConfig | config} for CloudHSMV2Client's `config` shape.
@@ -53,11 +60,20 @@ export interface CreateHsmCommandOutput extends CreateHsmResponse, __MetadataBea
53
60
  export declare class CreateHsmCommand extends $Command<CreateHsmCommandInput, CreateHsmCommandOutput, CloudHSMV2ClientResolvedConfig> {
54
61
  readonly input: CreateHsmCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: CreateHsmCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudHSMV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateHsmCommandInput, CreateHsmCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudHSMV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudHSMV2Client";
5
5
  import { DeleteBackupRequest, DeleteBackupResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteBackupCommand}.
8
10
  */
9
11
  export interface DeleteBackupCommandInput extends DeleteBackupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteBackupCommand}.
13
17
  */
14
18
  export interface DeleteBackupCommandOutput extends DeleteBackupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days
18
23
  * after the DeleteBackup request is made. For more information on restoring a backup, see
19
24
  * <a>RestoreBackup</a>.</p>
@@ -27,6 +32,8 @@ export interface DeleteBackupCommandOutput extends DeleteBackupResponse, __Metad
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DeleteBackupCommandInput - {@link DeleteBackupCommandInput}
36
+ * @returns {@link DeleteBackupCommandOutput}
30
37
  * @see {@link DeleteBackupCommandInput} for command's `input` shape.
31
38
  * @see {@link DeleteBackupCommandOutput} for command's `response` shape.
32
39
  * @see {@link CloudHSMV2ClientResolvedConfig | config} for CloudHSMV2Client's `config` shape.
@@ -54,11 +61,20 @@ export interface DeleteBackupCommandOutput extends DeleteBackupResponse, __Metad
54
61
  export declare class DeleteBackupCommand extends $Command<DeleteBackupCommandInput, DeleteBackupCommandOutput, CloudHSMV2ClientResolvedConfig> {
55
62
  readonly input: DeleteBackupCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: DeleteBackupCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudHSMV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteBackupCommandInput, DeleteBackupCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudHSMV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudHSMV2Client";
5
5
  import { DeleteClusterRequest, DeleteClusterResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteClusterCommand}.
8
10
  */
9
11
  export interface DeleteClusterCommandInput extends DeleteClusterRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteClusterCommand}.
13
17
  */
14
18
  export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must
18
23
  * delete all HSMs in the cluster. To see if the cluster contains any HSMs, use <a>DescribeClusters</a>. To delete an HSM, use <a>DeleteHsm</a>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteClusterCommandInput - {@link DeleteClusterCommandInput}
35
+ * @returns {@link DeleteClusterCommandOutput}
29
36
  * @see {@link DeleteClusterCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteClusterCommandOutput} for command's `response` shape.
31
38
  * @see {@link CloudHSMV2ClientResolvedConfig | config} for CloudHSMV2Client's `config` shape.
@@ -56,11 +63,20 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
56
63
  export declare class DeleteClusterCommand extends $Command<DeleteClusterCommandInput, DeleteClusterCommandOutput, CloudHSMV2ClientResolvedConfig> {
57
64
  readonly input: DeleteClusterCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: DeleteClusterCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudHSMV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteClusterCommandInput, DeleteClusterCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudHSMV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudHSMV2Client";
5
5
  import { DeleteHsmRequest, DeleteHsmResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteHsmCommand}.
8
10
  */
9
11
  export interface DeleteHsmCommandInput extends DeleteHsmRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteHsmCommand}.
13
17
  */
14
18
  export interface DeleteHsmCommandOutput extends DeleteHsmResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP
18
23
  * address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to
19
24
  * specify only one of these values. To find these values, use <a>DescribeClusters</a>.</p>
@@ -27,6 +32,8 @@ export interface DeleteHsmCommandOutput extends DeleteHsmResponse, __MetadataBea
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DeleteHsmCommandInput - {@link DeleteHsmCommandInput}
36
+ * @returns {@link DeleteHsmCommandOutput}
30
37
  * @see {@link DeleteHsmCommandInput} for command's `input` shape.
31
38
  * @see {@link DeleteHsmCommandOutput} for command's `response` shape.
32
39
  * @see {@link CloudHSMV2ClientResolvedConfig | config} for CloudHSMV2Client's `config` shape.
@@ -54,11 +61,20 @@ export interface DeleteHsmCommandOutput extends DeleteHsmResponse, __MetadataBea
54
61
  export declare class DeleteHsmCommand extends $Command<DeleteHsmCommandInput, DeleteHsmCommandOutput, CloudHSMV2ClientResolvedConfig> {
55
62
  readonly input: DeleteHsmCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: DeleteHsmCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudHSMV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteHsmCommandInput, DeleteHsmCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudHSMV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudHSMV2Client";
5
5
  import { DescribeBackupsRequest, DescribeBackupsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeBackupsCommand}.
8
10
  */
9
11
  export interface DescribeBackupsCommandInput extends DescribeBackupsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeBackupsCommand}.
13
17
  */
14
18
  export interface DescribeBackupsCommandOutput extends DescribeBackupsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets information about backups of AWS CloudHSM clusters.</p>
18
23
  * <p>This is a paginated operation, which means that each response might contain only a
19
24
  * subset of all the backups. When the response contains only a subset of backups, it includes a
@@ -30,6 +35,8 @@ export interface DescribeBackupsCommandOutput extends DescribeBackupsResponse, _
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param DescribeBackupsCommandInput - {@link DescribeBackupsCommandInput}
39
+ * @returns {@link DescribeBackupsCommandOutput}
33
40
  * @see {@link DescribeBackupsCommandInput} for command's `input` shape.
34
41
  * @see {@link DescribeBackupsCommandOutput} for command's `response` shape.
35
42
  * @see {@link CloudHSMV2ClientResolvedConfig | config} for CloudHSMV2Client's `config` shape.
@@ -60,11 +67,20 @@ export interface DescribeBackupsCommandOutput extends DescribeBackupsResponse, _
60
67
  export declare class DescribeBackupsCommand extends $Command<DescribeBackupsCommandInput, DescribeBackupsCommandOutput, CloudHSMV2ClientResolvedConfig> {
61
68
  readonly input: DescribeBackupsCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: DescribeBackupsCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudHSMV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeBackupsCommandInput, DescribeBackupsCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudHSMV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudHSMV2Client";
5
5
  import { DescribeClustersRequest, DescribeClustersResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeClustersCommand}.
8
10
  */
9
11
  export interface DescribeClustersCommandInput extends DescribeClustersRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeClustersCommand}.
13
17
  */
14
18
  export interface DescribeClustersCommandOutput extends DescribeClustersResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets information about AWS CloudHSM clusters.</p>
18
23
  * <p>This is a paginated operation, which means that each response might contain only a
19
24
  * subset of all the clusters. When the response contains only a subset of clusters, it includes
@@ -30,6 +35,8 @@ export interface DescribeClustersCommandOutput extends DescribeClustersResponse,
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param DescribeClustersCommandInput - {@link DescribeClustersCommandInput}
39
+ * @returns {@link DescribeClustersCommandOutput}
33
40
  * @see {@link DescribeClustersCommandInput} for command's `input` shape.
34
41
  * @see {@link DescribeClustersCommandOutput} for command's `response` shape.
35
42
  * @see {@link CloudHSMV2ClientResolvedConfig | config} for CloudHSMV2Client's `config` shape.
@@ -56,11 +63,20 @@ export interface DescribeClustersCommandOutput extends DescribeClustersResponse,
56
63
  export declare class DescribeClustersCommand extends $Command<DescribeClustersCommandInput, DescribeClustersCommandOutput, CloudHSMV2ClientResolvedConfig> {
57
64
  readonly input: DescribeClustersCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: DescribeClustersCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudHSMV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeClustersCommandInput, DescribeClustersCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudHSMV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudHSMV2Client";
5
5
  import { InitializeClusterRequest, InitializeClusterResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link InitializeClusterCommand}.
8
10
  */
9
11
  export interface InitializeClusterCommandInput extends InitializeClusterRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link InitializeClusterCommand}.
13
17
  */
14
18
  export interface InitializeClusterCommandOutput extends InitializeClusterResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your
18
23
  * issuing certificate authority (CA) and the CA's root certificate. Before you can claim a
19
24
  * cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA.
@@ -28,6 +33,8 @@ export interface InitializeClusterCommandOutput extends InitializeClusterRespons
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param InitializeClusterCommandInput - {@link InitializeClusterCommandInput}
37
+ * @returns {@link InitializeClusterCommandOutput}
31
38
  * @see {@link InitializeClusterCommandInput} for command's `input` shape.
32
39
  * @see {@link InitializeClusterCommandOutput} for command's `response` shape.
33
40
  * @see {@link CloudHSMV2ClientResolvedConfig | config} for CloudHSMV2Client's `config` shape.
@@ -55,11 +62,20 @@ export interface InitializeClusterCommandOutput extends InitializeClusterRespons
55
62
  export declare class InitializeClusterCommand extends $Command<InitializeClusterCommandInput, InitializeClusterCommandOutput, CloudHSMV2ClientResolvedConfig> {
56
63
  readonly input: InitializeClusterCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: InitializeClusterCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudHSMV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<InitializeClusterCommandInput, InitializeClusterCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }