@aws-sdk/client-cloudhsm-v2 3.606.0 → 3.609.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.
Files changed (41) hide show
  1. package/README.md +25 -1
  2. package/dist-cjs/index.js +115 -0
  3. package/dist-es/CloudHSMV2.js +6 -0
  4. package/dist-es/commands/DeleteResourcePolicyCommand.js +24 -0
  5. package/dist-es/commands/GetResourcePolicyCommand.js +24 -0
  6. package/dist-es/commands/PutResourcePolicyCommand.js +24 -0
  7. package/dist-es/commands/index.js +3 -0
  8. package/dist-es/protocols/Aws_json1_1.js +58 -0
  9. package/dist-types/CloudHSMV2.d.ts +25 -1
  10. package/dist-types/CloudHSMV2Client.d.ts +6 -3
  11. package/dist-types/commands/CopyBackupToRegionCommand.d.ts +4 -2
  12. package/dist-types/commands/CreateClusterCommand.d.ts +5 -2
  13. package/dist-types/commands/CreateHsmCommand.d.ts +4 -2
  14. package/dist-types/commands/DeleteBackupCommand.d.ts +5 -2
  15. package/dist-types/commands/DeleteClusterCommand.d.ts +4 -2
  16. package/dist-types/commands/DeleteHsmCommand.d.ts +3 -1
  17. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +83 -0
  18. package/dist-types/commands/DescribeBackupsCommand.d.ts +6 -2
  19. package/dist-types/commands/DescribeClustersCommand.d.ts +4 -2
  20. package/dist-types/commands/GetResourcePolicyCommand.d.ts +80 -0
  21. package/dist-types/commands/InitializeClusterCommand.d.ts +4 -2
  22. package/dist-types/commands/ListTagsCommand.d.ts +4 -2
  23. package/dist-types/commands/ModifyBackupAttributesCommand.d.ts +5 -2
  24. package/dist-types/commands/ModifyClusterCommand.d.ts +4 -2
  25. package/dist-types/commands/PutResourcePolicyCommand.d.ts +99 -0
  26. package/dist-types/commands/RestoreBackupCommand.d.ts +6 -3
  27. package/dist-types/commands/TagResourceCommand.d.ts +4 -2
  28. package/dist-types/commands/UntagResourceCommand.d.ts +4 -2
  29. package/dist-types/commands/index.d.ts +3 -0
  30. package/dist-types/index.d.ts +1 -1
  31. package/dist-types/models/models_0.d.ts +104 -10
  32. package/dist-types/protocols/Aws_json1_1.d.ts +27 -0
  33. package/dist-types/ts3.4/CloudHSMV2.d.ts +54 -0
  34. package/dist-types/ts3.4/CloudHSMV2Client.d.ts +18 -0
  35. package/dist-types/ts3.4/commands/DeleteResourcePolicyCommand.d.ts +40 -0
  36. package/dist-types/ts3.4/commands/GetResourcePolicyCommand.d.ts +40 -0
  37. package/dist-types/ts3.4/commands/PutResourcePolicyCommand.d.ts +40 -0
  38. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  39. package/dist-types/ts3.4/models/models_0.d.ts +23 -0
  40. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +36 -0
  41. package/package.json +35 -35
@@ -27,8 +27,10 @@ declare const CreateHsmCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a new hardware security module (HSM) in the specified AWS CloudHSM
30
+ * <p>Creates a new hardware security module (HSM) in the specified CloudHSM
31
31
  * cluster.</p>
32
+ * <p>
33
+ * <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Service account.</p>
32
34
  * @example
33
35
  * Use a bare-bones client and the command you need to make an API call.
34
36
  * ```javascript
@@ -68,7 +70,7 @@ declare const CreateHsmCommand_base: {
68
70
  * requested operation.</p>
69
71
  *
70
72
  * @throws {@link CloudHsmInternalFailureException} (server fault)
71
- * <p>The request was rejected because of an AWS CloudHSM internal failure. The request can
73
+ * <p>The request was rejected because of an CloudHSM internal failure. The request can
72
74
  * be retried.</p>
73
75
  *
74
76
  * @throws {@link CloudHsmInvalidRequestException} (client fault)
@@ -27,9 +27,11 @@ declare const DeleteBackupCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days
30
+ * <p>Deletes a specified CloudHSM backup. A backup can be restored up to 7 days
31
31
  * after the DeleteBackup request is made. For more information on restoring a backup, see
32
32
  * <a>RestoreBackup</a>.</p>
33
+ * <p>
34
+ * <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.</p>
33
35
  * @example
34
36
  * Use a bare-bones client and the command you need to make an API call.
35
37
  * ```javascript
@@ -44,6 +46,7 @@ declare const DeleteBackupCommand_base: {
44
46
  * // { // DeleteBackupResponse
45
47
  * // Backup: { // Backup
46
48
  * // BackupId: "STRING_VALUE", // required
49
+ * // BackupArn: "STRING_VALUE",
47
50
  * // BackupState: "CREATE_IN_PROGRESS" || "READY" || "DELETED" || "PENDING_DELETION",
48
51
  * // ClusterId: "STRING_VALUE",
49
52
  * // CreateTimestamp: new Date("TIMESTAMP"),
@@ -77,7 +80,7 @@ declare const DeleteBackupCommand_base: {
77
80
  * requested operation.</p>
78
81
  *
79
82
  * @throws {@link CloudHsmInternalFailureException} (server fault)
80
- * <p>The request was rejected because of an AWS CloudHSM internal failure. The request can
83
+ * <p>The request was rejected because of an CloudHSM internal failure. The request can
81
84
  * be retried.</p>
82
85
  *
83
86
  * @throws {@link CloudHsmInvalidRequestException} (client fault)
@@ -27,8 +27,10 @@ declare const DeleteClusterCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must
30
+ * <p>Deletes the specified CloudHSM cluster. Before you can delete a cluster, you must
31
31
  * 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>
32
+ * <p>
33
+ * <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.</p>
32
34
  * @example
33
35
  * Use a bare-bones client and the command you need to make an API call.
34
36
  * ```javascript
@@ -101,7 +103,7 @@ declare const DeleteClusterCommand_base: {
101
103
  * requested operation.</p>
102
104
  *
103
105
  * @throws {@link CloudHsmInternalFailureException} (server fault)
104
- * <p>The request was rejected because of an AWS CloudHSM internal failure. The request can
106
+ * <p>The request was rejected because of an CloudHSM internal failure. The request can
105
107
  * be retried.</p>
106
108
  *
107
109
  * @throws {@link CloudHsmInvalidRequestException} (client fault)
@@ -30,6 +30,8 @@ declare const DeleteHsmCommand_base: {
30
30
  * <p>Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP
31
31
  * address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to
32
32
  * specify only one of these values. To find these values, use <a>DescribeClusters</a>.</p>
33
+ * <p>
34
+ * <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM hsm in a different Amazon Web Services account.</p>
33
35
  * @example
34
36
  * Use a bare-bones client and the command you need to make an API call.
35
37
  * ```javascript
@@ -61,7 +63,7 @@ declare const DeleteHsmCommand_base: {
61
63
  * requested operation.</p>
62
64
  *
63
65
  * @throws {@link CloudHsmInternalFailureException} (server fault)
64
- * <p>The request was rejected because of an AWS CloudHSM internal failure. The request can
66
+ * <p>The request was rejected because of an CloudHSM internal failure. The request can
65
67
  * be retried.</p>
66
68
  *
67
69
  * @throws {@link CloudHsmInvalidRequestException} (client fault)
@@ -0,0 +1,83 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { CloudHSMV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudHSMV2Client";
4
+ import { DeleteResourcePolicyRequest, DeleteResourcePolicyResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteResourcePolicyCommand}.
14
+ */
15
+ export interface DeleteResourcePolicyCommandInput extends DeleteResourcePolicyRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteResourcePolicyCommand}.
21
+ */
22
+ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyResponse, __MetadataBearer {
23
+ }
24
+ declare const DeleteResourcePolicyCommand_base: {
25
+ new (input: DeleteResourcePolicyCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput, CloudHSMV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [DeleteResourcePolicyCommandInput]): import("@smithy/smithy-client").CommandImpl<DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput, CloudHSMV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p> Deletes an CloudHSM resource policy. Deleting a resource policy will result in the resource being unshared and removed from
31
+ * any RAM resource shares. Deleting the resource policy attached to a backup will not impact any clusters created from that
32
+ * backup.</p>
33
+ * <p>
34
+ * <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.</p>
35
+ * @example
36
+ * Use a bare-bones client and the command you need to make an API call.
37
+ * ```javascript
38
+ * import { CloudHSMV2Client, DeleteResourcePolicyCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import
39
+ * // const { CloudHSMV2Client, DeleteResourcePolicyCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import
40
+ * const client = new CloudHSMV2Client(config);
41
+ * const input = { // DeleteResourcePolicyRequest
42
+ * ResourceArn: "STRING_VALUE",
43
+ * };
44
+ * const command = new DeleteResourcePolicyCommand(input);
45
+ * const response = await client.send(command);
46
+ * // { // DeleteResourcePolicyResponse
47
+ * // ResourceArn: "STRING_VALUE",
48
+ * // Policy: "STRING_VALUE",
49
+ * // };
50
+ *
51
+ * ```
52
+ *
53
+ * @param DeleteResourcePolicyCommandInput - {@link DeleteResourcePolicyCommandInput}
54
+ * @returns {@link DeleteResourcePolicyCommandOutput}
55
+ * @see {@link DeleteResourcePolicyCommandInput} for command's `input` shape.
56
+ * @see {@link DeleteResourcePolicyCommandOutput} for command's `response` shape.
57
+ * @see {@link CloudHSMV2ClientResolvedConfig | config} for CloudHSMV2Client's `config` shape.
58
+ *
59
+ * @throws {@link CloudHsmAccessDeniedException} (client fault)
60
+ * <p>The request was rejected because the requester does not have permission to perform the
61
+ * requested operation.</p>
62
+ *
63
+ * @throws {@link CloudHsmInternalFailureException} (server fault)
64
+ * <p>The request was rejected because of an CloudHSM internal failure. The request can
65
+ * be retried.</p>
66
+ *
67
+ * @throws {@link CloudHsmInvalidRequestException} (client fault)
68
+ * <p>The request was rejected because it is not a valid request.</p>
69
+ *
70
+ * @throws {@link CloudHsmResourceNotFoundException} (client fault)
71
+ * <p>The request was rejected because it refers to a resource that cannot be
72
+ * found.</p>
73
+ *
74
+ * @throws {@link CloudHsmServiceException} (client fault)
75
+ * <p>The request was rejected because an error occurred.</p>
76
+ *
77
+ * @throws {@link CloudHSMV2ServiceException}
78
+ * <p>Base exception class for all service exceptions from CloudHSMV2 service.</p>
79
+ *
80
+ * @public
81
+ */
82
+ export declare class DeleteResourcePolicyCommand extends DeleteResourcePolicyCommand_base {
83
+ }
@@ -27,12 +27,14 @@ declare const DescribeBackupsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets information about backups of AWS CloudHSM clusters.</p>
30
+ * <p>Gets information about backups of CloudHSM clusters. Lists either the backups you own or the backups shared with you when the Shared parameter is true.</p>
31
31
  * <p>This is a paginated operation, which means that each response might contain only a
32
32
  * subset of all the backups. When the response contains only a subset of backups, it includes a
33
33
  * <code>NextToken</code> value. Use this value in a subsequent <code>DescribeBackups</code>
34
34
  * request to get more backups. When you receive a response with no <code>NextToken</code> (or an
35
35
  * empty or null value), that means there are no more backups to get.</p>
36
+ * <p>
37
+ * <b>Cross-account use:</b> Yes. Customers can describe backups in other Amazon Web Services accounts that are shared with them.</p>
36
38
  * @example
37
39
  * Use a bare-bones client and the command you need to make an API call.
38
40
  * ```javascript
@@ -47,6 +49,7 @@ declare const DescribeBackupsCommand_base: {
47
49
  * "STRING_VALUE",
48
50
  * ],
49
51
  * },
52
+ * Shared: true || false,
50
53
  * SortAscending: true || false,
51
54
  * };
52
55
  * const command = new DescribeBackupsCommand(input);
@@ -55,6 +58,7 @@ declare const DescribeBackupsCommand_base: {
55
58
  * // Backups: [ // Backups
56
59
  * // { // Backup
57
60
  * // BackupId: "STRING_VALUE", // required
61
+ * // BackupArn: "STRING_VALUE",
58
62
  * // BackupState: "CREATE_IN_PROGRESS" || "READY" || "DELETED" || "PENDING_DELETION",
59
63
  * // ClusterId: "STRING_VALUE",
60
64
  * // CreateTimestamp: new Date("TIMESTAMP"),
@@ -90,7 +94,7 @@ declare const DescribeBackupsCommand_base: {
90
94
  * requested operation.</p>
91
95
  *
92
96
  * @throws {@link CloudHsmInternalFailureException} (server fault)
93
- * <p>The request was rejected because of an AWS CloudHSM internal failure. The request can
97
+ * <p>The request was rejected because of an CloudHSM internal failure. The request can
94
98
  * be retried.</p>
95
99
  *
96
100
  * @throws {@link CloudHsmInvalidRequestException} (client fault)
@@ -27,12 +27,14 @@ declare const DescribeClustersCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets information about AWS CloudHSM clusters.</p>
30
+ * <p>Gets information about CloudHSM clusters.</p>
31
31
  * <p>This is a paginated operation, which means that each response might contain only a
32
32
  * subset of all the clusters. When the response contains only a subset of clusters, it includes
33
33
  * a <code>NextToken</code> value. Use this value in a subsequent <code>DescribeClusters</code>
34
34
  * request to get more clusters. When you receive a response with no <code>NextToken</code> (or
35
35
  * an empty or null value), that means there are no more clusters to get.</p>
36
+ * <p>
37
+ * <b>Cross-account use:</b> No. You cannot perform this operation on CloudHSM clusters in a different Amazon Web Services account.</p>
36
38
  * @example
37
39
  * Use a bare-bones client and the command you need to make an API call.
38
40
  * ```javascript
@@ -114,7 +116,7 @@ declare const DescribeClustersCommand_base: {
114
116
  * requested operation.</p>
115
117
  *
116
118
  * @throws {@link CloudHsmInternalFailureException} (server fault)
117
- * <p>The request was rejected because of an AWS CloudHSM internal failure. The request can
119
+ * <p>The request was rejected because of an CloudHSM internal failure. The request can
118
120
  * be retried.</p>
119
121
  *
120
122
  * @throws {@link CloudHsmInvalidRequestException} (client fault)
@@ -0,0 +1,80 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { CloudHSMV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudHSMV2Client";
4
+ import { GetResourcePolicyRequest, GetResourcePolicyResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetResourcePolicyCommand}.
14
+ */
15
+ export interface GetResourcePolicyCommandInput extends GetResourcePolicyRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetResourcePolicyCommand}.
21
+ */
22
+ export interface GetResourcePolicyCommandOutput extends GetResourcePolicyResponse, __MetadataBearer {
23
+ }
24
+ declare const GetResourcePolicyCommand_base: {
25
+ new (input: GetResourcePolicyCommandInput): import("@smithy/smithy-client").CommandImpl<GetResourcePolicyCommandInput, GetResourcePolicyCommandOutput, CloudHSMV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [GetResourcePolicyCommandInput]): import("@smithy/smithy-client").CommandImpl<GetResourcePolicyCommandInput, GetResourcePolicyCommandOutput, CloudHSMV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p> Retrieves the resource policy document attached to a given resource. </p>
31
+ * <p>
32
+ * <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.</p>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { CloudHSMV2Client, GetResourcePolicyCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import
37
+ * // const { CloudHSMV2Client, GetResourcePolicyCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import
38
+ * const client = new CloudHSMV2Client(config);
39
+ * const input = { // GetResourcePolicyRequest
40
+ * ResourceArn: "STRING_VALUE",
41
+ * };
42
+ * const command = new GetResourcePolicyCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // GetResourcePolicyResponse
45
+ * // Policy: "STRING_VALUE",
46
+ * // };
47
+ *
48
+ * ```
49
+ *
50
+ * @param GetResourcePolicyCommandInput - {@link GetResourcePolicyCommandInput}
51
+ * @returns {@link GetResourcePolicyCommandOutput}
52
+ * @see {@link GetResourcePolicyCommandInput} for command's `input` shape.
53
+ * @see {@link GetResourcePolicyCommandOutput} for command's `response` shape.
54
+ * @see {@link CloudHSMV2ClientResolvedConfig | config} for CloudHSMV2Client's `config` shape.
55
+ *
56
+ * @throws {@link CloudHsmAccessDeniedException} (client fault)
57
+ * <p>The request was rejected because the requester does not have permission to perform the
58
+ * requested operation.</p>
59
+ *
60
+ * @throws {@link CloudHsmInternalFailureException} (server fault)
61
+ * <p>The request was rejected because of an CloudHSM internal failure. The request can
62
+ * be retried.</p>
63
+ *
64
+ * @throws {@link CloudHsmInvalidRequestException} (client fault)
65
+ * <p>The request was rejected because it is not a valid request.</p>
66
+ *
67
+ * @throws {@link CloudHsmResourceNotFoundException} (client fault)
68
+ * <p>The request was rejected because it refers to a resource that cannot be
69
+ * found.</p>
70
+ *
71
+ * @throws {@link CloudHsmServiceException} (client fault)
72
+ * <p>The request was rejected because an error occurred.</p>
73
+ *
74
+ * @throws {@link CloudHSMV2ServiceException}
75
+ * <p>Base exception class for all service exceptions from CloudHSMV2 service.</p>
76
+ *
77
+ * @public
78
+ */
79
+ export declare class GetResourcePolicyCommand extends GetResourcePolicyCommand_base {
80
+ }
@@ -27,10 +27,12 @@ declare const InitializeClusterCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your
30
+ * <p>Claims an CloudHSM cluster by submitting the cluster certificate issued by your
31
31
  * issuing certificate authority (CA) and the CA's root certificate. Before you can claim a
32
32
  * cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA.
33
33
  * To get the cluster's CSR, use <a>DescribeClusters</a>.</p>
34
+ * <p>
35
+ * <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.</p>
34
36
  * @example
35
37
  * Use a bare-bones client and the command you need to make an API call.
36
38
  * ```javascript
@@ -62,7 +64,7 @@ declare const InitializeClusterCommand_base: {
62
64
  * requested operation.</p>
63
65
  *
64
66
  * @throws {@link CloudHsmInternalFailureException} (server fault)
65
- * <p>The request was rejected because of an AWS CloudHSM internal failure. The request can
67
+ * <p>The request was rejected because of an CloudHSM internal failure. The request can
66
68
  * be retried.</p>
67
69
  *
68
70
  * @throws {@link CloudHsmInvalidRequestException} (client fault)
@@ -27,12 +27,14 @@ declare const ListTagsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets a list of tags for the specified AWS CloudHSM cluster.</p>
30
+ * <p>Gets a list of tags for the specified CloudHSM cluster.</p>
31
31
  * <p>This is a paginated operation, which means that each response might contain only a
32
32
  * subset of all the tags. When the response contains only a subset of tags, it includes a
33
33
  * <code>NextToken</code> value. Use this value in a subsequent <code>ListTags</code> request to
34
34
  * get more tags. When you receive a response with no <code>NextToken</code> (or an empty or null
35
35
  * value), that means there are no more tags to get.</p>
36
+ * <p>
37
+ * <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.</p>
36
38
  * @example
37
39
  * Use a bare-bones client and the command you need to make an API call.
38
40
  * ```javascript
@@ -69,7 +71,7 @@ declare const ListTagsCommand_base: {
69
71
  * requested operation.</p>
70
72
  *
71
73
  * @throws {@link CloudHsmInternalFailureException} (server fault)
72
- * <p>The request was rejected because of an AWS CloudHSM internal failure. The request can
74
+ * <p>The request was rejected because of an CloudHSM internal failure. The request can
73
75
  * be retried.</p>
74
76
  *
75
77
  * @throws {@link CloudHsmInvalidRequestException} (client fault)
@@ -27,7 +27,9 @@ declare const ModifyBackupAttributesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Modifies attributes for AWS CloudHSM backup.</p>
30
+ * <p>Modifies attributes for CloudHSM backup.</p>
31
+ * <p>
32
+ * <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.</p>
31
33
  * @example
32
34
  * Use a bare-bones client and the command you need to make an API call.
33
35
  * ```javascript
@@ -43,6 +45,7 @@ declare const ModifyBackupAttributesCommand_base: {
43
45
  * // { // ModifyBackupAttributesResponse
44
46
  * // Backup: { // Backup
45
47
  * // BackupId: "STRING_VALUE", // required
48
+ * // BackupArn: "STRING_VALUE",
46
49
  * // BackupState: "CREATE_IN_PROGRESS" || "READY" || "DELETED" || "PENDING_DELETION",
47
50
  * // ClusterId: "STRING_VALUE",
48
51
  * // CreateTimestamp: new Date("TIMESTAMP"),
@@ -76,7 +79,7 @@ declare const ModifyBackupAttributesCommand_base: {
76
79
  * requested operation.</p>
77
80
  *
78
81
  * @throws {@link CloudHsmInternalFailureException} (server fault)
79
- * <p>The request was rejected because of an AWS CloudHSM internal failure. The request can
82
+ * <p>The request was rejected because of an CloudHSM internal failure. The request can
80
83
  * be retried.</p>
81
84
  *
82
85
  * @throws {@link CloudHsmInvalidRequestException} (client fault)
@@ -27,7 +27,9 @@ declare const ModifyClusterCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Modifies AWS CloudHSM cluster.</p>
30
+ * <p>Modifies CloudHSM cluster.</p>
31
+ * <p>
32
+ * <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.</p>
31
33
  * @example
32
34
  * Use a bare-bones client and the command you need to make an API call.
33
35
  * ```javascript
@@ -104,7 +106,7 @@ declare const ModifyClusterCommand_base: {
104
106
  * requested operation.</p>
105
107
  *
106
108
  * @throws {@link CloudHsmInternalFailureException} (server fault)
107
- * <p>The request was rejected because of an AWS CloudHSM internal failure. The request can
109
+ * <p>The request was rejected because of an CloudHSM internal failure. The request can
108
110
  * be retried.</p>
109
111
  *
110
112
  * @throws {@link CloudHsmInvalidRequestException} (client fault)
@@ -0,0 +1,99 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { CloudHSMV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudHSMV2Client";
4
+ import { PutResourcePolicyRequest, PutResourcePolicyResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link PutResourcePolicyCommand}.
14
+ */
15
+ export interface PutResourcePolicyCommandInput extends PutResourcePolicyRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link PutResourcePolicyCommand}.
21
+ */
22
+ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyResponse, __MetadataBearer {
23
+ }
24
+ declare const PutResourcePolicyCommand_base: {
25
+ new (input: PutResourcePolicyCommandInput): import("@smithy/smithy-client").CommandImpl<PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput, CloudHSMV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [PutResourcePolicyCommandInput]): import("@smithy/smithy-client").CommandImpl<PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput, CloudHSMV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Creates or updates an CloudHSM resource policy. A resource policy helps you to define the IAM entity
31
+ * (for example, an Amazon Web Services account) that can manage your CloudHSM resources. The following resources support
32
+ * CloudHSM resource policies: </p>
33
+ * <ul>
34
+ * <li>
35
+ * <p> Backup - The resource policy allows you to describe the backup and restore a cluster from the backup in another Amazon Web Services account.</p>
36
+ * </li>
37
+ * </ul>
38
+ * <p>In order to share a backup, it must be in a 'READY' state and you must own it.</p>
39
+ * <important>
40
+ * <p>While you can share a backup using the CloudHSM PutResourcePolicy operation, we recommend using Resource Access Manager
41
+ * (RAM) instead. Using RAM provides multiple benefits as it creates the policy for you, allows multiple resources to be shared at
42
+ * one time, and increases the discoverability of shared resources. If you use PutResourcePolicy and want consumers to be able to
43
+ * describe the backups you share with them, you must promote the backup to a standard RAM
44
+ * Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation.
45
+ *
46
+ * For more information, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/sharing.html"> Working with shared backups</a> in the CloudHSM User Guide</p>
47
+ * </important>
48
+ * <p>
49
+ * <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.</p>
50
+ * @example
51
+ * Use a bare-bones client and the command you need to make an API call.
52
+ * ```javascript
53
+ * import { CloudHSMV2Client, PutResourcePolicyCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import
54
+ * // const { CloudHSMV2Client, PutResourcePolicyCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import
55
+ * const client = new CloudHSMV2Client(config);
56
+ * const input = { // PutResourcePolicyRequest
57
+ * ResourceArn: "STRING_VALUE",
58
+ * Policy: "STRING_VALUE",
59
+ * };
60
+ * const command = new PutResourcePolicyCommand(input);
61
+ * const response = await client.send(command);
62
+ * // { // PutResourcePolicyResponse
63
+ * // ResourceArn: "STRING_VALUE",
64
+ * // Policy: "STRING_VALUE",
65
+ * // };
66
+ *
67
+ * ```
68
+ *
69
+ * @param PutResourcePolicyCommandInput - {@link PutResourcePolicyCommandInput}
70
+ * @returns {@link PutResourcePolicyCommandOutput}
71
+ * @see {@link PutResourcePolicyCommandInput} for command's `input` shape.
72
+ * @see {@link PutResourcePolicyCommandOutput} for command's `response` shape.
73
+ * @see {@link CloudHSMV2ClientResolvedConfig | config} for CloudHSMV2Client's `config` shape.
74
+ *
75
+ * @throws {@link CloudHsmAccessDeniedException} (client fault)
76
+ * <p>The request was rejected because the requester does not have permission to perform the
77
+ * requested operation.</p>
78
+ *
79
+ * @throws {@link CloudHsmInternalFailureException} (server fault)
80
+ * <p>The request was rejected because of an CloudHSM internal failure. The request can
81
+ * be retried.</p>
82
+ *
83
+ * @throws {@link CloudHsmInvalidRequestException} (client fault)
84
+ * <p>The request was rejected because it is not a valid request.</p>
85
+ *
86
+ * @throws {@link CloudHsmResourceNotFoundException} (client fault)
87
+ * <p>The request was rejected because it refers to a resource that cannot be
88
+ * found.</p>
89
+ *
90
+ * @throws {@link CloudHsmServiceException} (client fault)
91
+ * <p>The request was rejected because an error occurred.</p>
92
+ *
93
+ * @throws {@link CloudHSMV2ServiceException}
94
+ * <p>Base exception class for all service exceptions from CloudHSMV2 service.</p>
95
+ *
96
+ * @public
97
+ */
98
+ export declare class PutResourcePolicyCommand extends PutResourcePolicyCommand_base {
99
+ }
@@ -27,9 +27,11 @@ declare const RestoreBackupCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Restores a specified AWS CloudHSM backup that is in the
31
- * <code>PENDING_DELETION</code> state. For mor information on deleting a backup, see
30
+ * <p>Restores a specified CloudHSM backup that is in the
31
+ * <code>PENDING_DELETION</code> state. For more information on deleting a backup, see
32
32
  * <a>DeleteBackup</a>.</p>
33
+ * <p>
34
+ * <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.</p>
33
35
  * @example
34
36
  * Use a bare-bones client and the command you need to make an API call.
35
37
  * ```javascript
@@ -44,6 +46,7 @@ declare const RestoreBackupCommand_base: {
44
46
  * // { // RestoreBackupResponse
45
47
  * // Backup: { // Backup
46
48
  * // BackupId: "STRING_VALUE", // required
49
+ * // BackupArn: "STRING_VALUE",
47
50
  * // BackupState: "CREATE_IN_PROGRESS" || "READY" || "DELETED" || "PENDING_DELETION",
48
51
  * // ClusterId: "STRING_VALUE",
49
52
  * // CreateTimestamp: new Date("TIMESTAMP"),
@@ -77,7 +80,7 @@ declare const RestoreBackupCommand_base: {
77
80
  * requested operation.</p>
78
81
  *
79
82
  * @throws {@link CloudHsmInternalFailureException} (server fault)
80
- * <p>The request was rejected because of an AWS CloudHSM internal failure. The request can
83
+ * <p>The request was rejected because of an CloudHSM internal failure. The request can
81
84
  * be retried.</p>
82
85
  *
83
86
  * @throws {@link CloudHsmInvalidRequestException} (client fault)
@@ -27,7 +27,9 @@ declare const TagResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.</p>
30
+ * <p>Adds or overwrites one or more tags for the specified CloudHSM cluster.</p>
31
+ * <p>
32
+ * <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.</p>
31
33
  * @example
32
34
  * Use a bare-bones client and the command you need to make an API call.
33
35
  * ```javascript
@@ -60,7 +62,7 @@ declare const TagResourceCommand_base: {
60
62
  * requested operation.</p>
61
63
  *
62
64
  * @throws {@link CloudHsmInternalFailureException} (server fault)
63
- * <p>The request was rejected because of an AWS CloudHSM internal failure. The request can
65
+ * <p>The request was rejected because of an CloudHSM internal failure. The request can
64
66
  * be retried.</p>
65
67
  *
66
68
  * @throws {@link CloudHsmInvalidRequestException} (client fault)
@@ -27,7 +27,9 @@ declare const UntagResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Removes the specified tag or tags from the specified AWS CloudHSM cluster.</p>
30
+ * <p>Removes the specified tag or tags from the specified CloudHSM cluster.</p>
31
+ * <p>
32
+ * <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.</p>
31
33
  * @example
32
34
  * Use a bare-bones client and the command you need to make an API call.
33
35
  * ```javascript
@@ -57,7 +59,7 @@ declare const UntagResourceCommand_base: {
57
59
  * requested operation.</p>
58
60
  *
59
61
  * @throws {@link CloudHsmInternalFailureException} (server fault)
60
- * <p>The request was rejected because of an AWS CloudHSM internal failure. The request can
62
+ * <p>The request was rejected because of an CloudHSM internal failure. The request can
61
63
  * be retried.</p>
62
64
  *
63
65
  * @throws {@link CloudHsmInvalidRequestException} (client fault)
@@ -4,12 +4,15 @@ export * from "./CreateHsmCommand";
4
4
  export * from "./DeleteBackupCommand";
5
5
  export * from "./DeleteClusterCommand";
6
6
  export * from "./DeleteHsmCommand";
7
+ export * from "./DeleteResourcePolicyCommand";
7
8
  export * from "./DescribeBackupsCommand";
8
9
  export * from "./DescribeClustersCommand";
10
+ export * from "./GetResourcePolicyCommand";
9
11
  export * from "./InitializeClusterCommand";
10
12
  export * from "./ListTagsCommand";
11
13
  export * from "./ModifyBackupAttributesCommand";
12
14
  export * from "./ModifyClusterCommand";
15
+ export * from "./PutResourcePolicyCommand";
13
16
  export * from "./RestoreBackupCommand";
14
17
  export * from "./TagResourceCommand";
15
18
  export * from "./UntagResourceCommand";
@@ -1,5 +1,5 @@
1
1
  /**
2
- * <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
2
+ * <p>For more information about CloudHSM, see <a href="http://aws.amazon.com/cloudhsm/">CloudHSM</a> and the <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/">
3
3
  * CloudHSM User Guide</a>.</p>
4
4
  *
5
5
  * @packageDocumentation