@aws-sdk/client-payment-cryptography 3.349.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 (163) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +369 -0
  3. package/dist-cjs/PaymentCryptography.js +51 -0
  4. package/dist-cjs/PaymentCryptographyClient.js +41 -0
  5. package/dist-cjs/commands/CreateAliasCommand.js +46 -0
  6. package/dist-cjs/commands/CreateKeyCommand.js +46 -0
  7. package/dist-cjs/commands/DeleteAliasCommand.js +46 -0
  8. package/dist-cjs/commands/DeleteKeyCommand.js +46 -0
  9. package/dist-cjs/commands/ExportKeyCommand.js +47 -0
  10. package/dist-cjs/commands/GetAliasCommand.js +46 -0
  11. package/dist-cjs/commands/GetKeyCommand.js +46 -0
  12. package/dist-cjs/commands/GetParametersForExportCommand.js +47 -0
  13. package/dist-cjs/commands/GetParametersForImportCommand.js +47 -0
  14. package/dist-cjs/commands/GetPublicKeyCertificateCommand.js +47 -0
  15. package/dist-cjs/commands/ImportKeyCommand.js +47 -0
  16. package/dist-cjs/commands/ListAliasesCommand.js +46 -0
  17. package/dist-cjs/commands/ListKeysCommand.js +46 -0
  18. package/dist-cjs/commands/ListTagsForResourceCommand.js +46 -0
  19. package/dist-cjs/commands/RestoreKeyCommand.js +46 -0
  20. package/dist-cjs/commands/StartKeyUsageCommand.js +46 -0
  21. package/dist-cjs/commands/StopKeyUsageCommand.js +46 -0
  22. package/dist-cjs/commands/TagResourceCommand.js +46 -0
  23. package/dist-cjs/commands/UntagResourceCommand.js +46 -0
  24. package/dist-cjs/commands/UpdateAliasCommand.js +46 -0
  25. package/dist-cjs/commands/index.js +23 -0
  26. package/dist-cjs/endpoint/EndpointParameters.js +12 -0
  27. package/dist-cjs/endpoint/endpointResolver.js +12 -0
  28. package/dist-cjs/endpoint/ruleset.js +7 -0
  29. package/dist-cjs/index.js +11 -0
  30. package/dist-cjs/models/PaymentCryptographyServiceException.js +12 -0
  31. package/dist-cjs/models/index.js +4 -0
  32. package/dist-cjs/models/models_0.js +291 -0
  33. package/dist-cjs/pagination/Interfaces.js +2 -0
  34. package/dist-cjs/pagination/ListAliasesPaginator.js +29 -0
  35. package/dist-cjs/pagination/ListKeysPaginator.js +29 -0
  36. package/dist-cjs/pagination/ListTagsForResourcePaginator.js +29 -0
  37. package/dist-cjs/pagination/index.js +7 -0
  38. package/dist-cjs/protocols/Aws_json1_0.js +1396 -0
  39. package/dist-cjs/runtimeConfig.browser.js +39 -0
  40. package/dist-cjs/runtimeConfig.js +48 -0
  41. package/dist-cjs/runtimeConfig.native.js +15 -0
  42. package/dist-cjs/runtimeConfig.shared.js +21 -0
  43. package/dist-es/PaymentCryptography.js +47 -0
  44. package/dist-es/PaymentCryptographyClient.js +37 -0
  45. package/dist-es/commands/CreateAliasCommand.js +42 -0
  46. package/dist-es/commands/CreateKeyCommand.js +42 -0
  47. package/dist-es/commands/DeleteAliasCommand.js +42 -0
  48. package/dist-es/commands/DeleteKeyCommand.js +42 -0
  49. package/dist-es/commands/ExportKeyCommand.js +43 -0
  50. package/dist-es/commands/GetAliasCommand.js +42 -0
  51. package/dist-es/commands/GetKeyCommand.js +42 -0
  52. package/dist-es/commands/GetParametersForExportCommand.js +43 -0
  53. package/dist-es/commands/GetParametersForImportCommand.js +43 -0
  54. package/dist-es/commands/GetPublicKeyCertificateCommand.js +43 -0
  55. package/dist-es/commands/ImportKeyCommand.js +43 -0
  56. package/dist-es/commands/ListAliasesCommand.js +42 -0
  57. package/dist-es/commands/ListKeysCommand.js +42 -0
  58. package/dist-es/commands/ListTagsForResourceCommand.js +42 -0
  59. package/dist-es/commands/RestoreKeyCommand.js +42 -0
  60. package/dist-es/commands/StartKeyUsageCommand.js +42 -0
  61. package/dist-es/commands/StopKeyUsageCommand.js +42 -0
  62. package/dist-es/commands/TagResourceCommand.js +42 -0
  63. package/dist-es/commands/UntagResourceCommand.js +42 -0
  64. package/dist-es/commands/UpdateAliasCommand.js +42 -0
  65. package/dist-es/commands/index.js +20 -0
  66. package/dist-es/endpoint/EndpointParameters.js +8 -0
  67. package/dist-es/endpoint/endpointResolver.js +8 -0
  68. package/dist-es/endpoint/ruleset.js +4 -0
  69. package/dist-es/index.js +6 -0
  70. package/dist-es/models/PaymentCryptographyServiceException.js +8 -0
  71. package/dist-es/models/index.js +1 -0
  72. package/dist-es/models/models_0.js +267 -0
  73. package/dist-es/pagination/Interfaces.js +1 -0
  74. package/dist-es/pagination/ListAliasesPaginator.js +25 -0
  75. package/dist-es/pagination/ListKeysPaginator.js +25 -0
  76. package/dist-es/pagination/ListTagsForResourcePaginator.js +25 -0
  77. package/dist-es/pagination/index.js +4 -0
  78. package/dist-es/protocols/Aws_json1_0.js +1353 -0
  79. package/dist-es/runtimeConfig.browser.js +34 -0
  80. package/dist-es/runtimeConfig.js +43 -0
  81. package/dist-es/runtimeConfig.native.js +11 -0
  82. package/dist-es/runtimeConfig.shared.js +17 -0
  83. package/dist-types/PaymentCryptography.d.ts +154 -0
  84. package/dist-types/PaymentCryptographyClient.d.ts +186 -0
  85. package/dist-types/commands/CreateAliasCommand.d.ts +130 -0
  86. package/dist-types/commands/CreateKeyCommand.d.ts +175 -0
  87. package/dist-types/commands/DeleteAliasCommand.d.ts +120 -0
  88. package/dist-types/commands/DeleteKeyCommand.d.ts +149 -0
  89. package/dist-types/commands/ExportKeyCommand.d.ts +153 -0
  90. package/dist-types/commands/GetAliasCommand.d.ts +121 -0
  91. package/dist-types/commands/GetKeyCommand.d.ts +142 -0
  92. package/dist-types/commands/GetParametersForExportCommand.d.ts +120 -0
  93. package/dist-types/commands/GetParametersForImportCommand.d.ts +120 -0
  94. package/dist-types/commands/GetPublicKeyCertificateCommand.d.ts +95 -0
  95. package/dist-types/commands/ImportKeyCommand.d.ts +301 -0
  96. package/dist-types/commands/ListAliasesCommand.d.ts +127 -0
  97. package/dist-types/commands/ListKeysCommand.d.ts +143 -0
  98. package/dist-types/commands/ListTagsForResourceCommand.d.ts +119 -0
  99. package/dist-types/commands/RestoreKeyCommand.d.ts +150 -0
  100. package/dist-types/commands/StartKeyUsageCommand.d.ts +138 -0
  101. package/dist-types/commands/StopKeyUsageCommand.d.ts +144 -0
  102. package/dist-types/commands/TagResourceCommand.d.ts +122 -0
  103. package/dist-types/commands/UntagResourceCommand.d.ts +115 -0
  104. package/dist-types/commands/UpdateAliasCommand.d.ts +125 -0
  105. package/dist-types/commands/index.d.ts +20 -0
  106. package/dist-types/endpoint/EndpointParameters.d.ts +20 -0
  107. package/dist-types/endpoint/endpointResolver.d.ts +5 -0
  108. package/dist-types/endpoint/ruleset.d.ts +2 -0
  109. package/dist-types/index.d.ts +15 -0
  110. package/dist-types/models/PaymentCryptographyServiceException.d.ts +13 -0
  111. package/dist-types/models/index.d.ts +1 -0
  112. package/dist-types/models/models_0.d.ts +1222 -0
  113. package/dist-types/pagination/Interfaces.d.ts +8 -0
  114. package/dist-types/pagination/ListAliasesPaginator.d.ts +7 -0
  115. package/dist-types/pagination/ListKeysPaginator.d.ts +7 -0
  116. package/dist-types/pagination/ListTagsForResourcePaginator.d.ts +7 -0
  117. package/dist-types/pagination/index.d.ts +4 -0
  118. package/dist-types/protocols/Aws_json1_0.d.ts +182 -0
  119. package/dist-types/runtimeConfig.browser.d.ts +42 -0
  120. package/dist-types/runtimeConfig.d.ts +42 -0
  121. package/dist-types/runtimeConfig.native.d.ts +41 -0
  122. package/dist-types/runtimeConfig.shared.d.ts +18 -0
  123. package/dist-types/ts3.4/PaymentCryptography.d.ts +347 -0
  124. package/dist-types/ts3.4/PaymentCryptographyClient.d.ts +235 -0
  125. package/dist-types/ts3.4/commands/CreateAliasCommand.d.ts +35 -0
  126. package/dist-types/ts3.4/commands/CreateKeyCommand.d.ts +35 -0
  127. package/dist-types/ts3.4/commands/DeleteAliasCommand.d.ts +35 -0
  128. package/dist-types/ts3.4/commands/DeleteKeyCommand.d.ts +35 -0
  129. package/dist-types/ts3.4/commands/ExportKeyCommand.d.ts +35 -0
  130. package/dist-types/ts3.4/commands/GetAliasCommand.d.ts +35 -0
  131. package/dist-types/ts3.4/commands/GetKeyCommand.d.ts +33 -0
  132. package/dist-types/ts3.4/commands/GetParametersForExportCommand.d.ts +42 -0
  133. package/dist-types/ts3.4/commands/GetParametersForImportCommand.d.ts +42 -0
  134. package/dist-types/ts3.4/commands/GetPublicKeyCertificateCommand.d.ts +42 -0
  135. package/dist-types/ts3.4/commands/ImportKeyCommand.d.ts +35 -0
  136. package/dist-types/ts3.4/commands/ListAliasesCommand.d.ts +35 -0
  137. package/dist-types/ts3.4/commands/ListKeysCommand.d.ts +35 -0
  138. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +39 -0
  139. package/dist-types/ts3.4/commands/RestoreKeyCommand.d.ts +35 -0
  140. package/dist-types/ts3.4/commands/StartKeyUsageCommand.d.ts +35 -0
  141. package/dist-types/ts3.4/commands/StopKeyUsageCommand.d.ts +35 -0
  142. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +35 -0
  143. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +35 -0
  144. package/dist-types/ts3.4/commands/UpdateAliasCommand.d.ts +35 -0
  145. package/dist-types/ts3.4/commands/index.d.ts +20 -0
  146. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +32 -0
  147. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  148. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  149. package/dist-types/ts3.4/index.d.ts +6 -0
  150. package/dist-types/ts3.4/models/PaymentCryptographyServiceException.d.ts +8 -0
  151. package/dist-types/ts3.4/models/index.d.ts +1 -0
  152. package/dist-types/ts3.4/models/models_0.d.ts +490 -0
  153. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  154. package/dist-types/ts3.4/pagination/ListAliasesPaginator.d.ts +11 -0
  155. package/dist-types/ts3.4/pagination/ListKeysPaginator.d.ts +11 -0
  156. package/dist-types/ts3.4/pagination/ListTagsForResourcePaginator.d.ts +11 -0
  157. package/dist-types/ts3.4/pagination/index.d.ts +4 -0
  158. package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +245 -0
  159. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +96 -0
  160. package/dist-types/ts3.4/runtimeConfig.d.ts +93 -0
  161. package/dist-types/ts3.4/runtimeConfig.native.d.ts +87 -0
  162. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +20 -0
  163. package/package.json +99 -0
@@ -0,0 +1,175 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { CreateKeyInput, CreateKeyOutput } from "../models/models_0";
5
+ import { PaymentCryptographyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PaymentCryptographyClient";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link CreateKeyCommand}.
14
+ */
15
+ export interface CreateKeyCommandInput extends CreateKeyInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreateKeyCommand}.
21
+ */
22
+ export interface CreateKeyCommandOutput extends CreateKeyOutput, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Creates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web Services Region. You use keys for cryptographic functions such as encryption and decryption. </p>
27
+ * <p>In addition to the key material used in cryptographic operations, an Amazon Web Services Payment Cryptography key includes metadata such as the key ARN, key usage, key origin, creation date, description, and key state.</p>
28
+ * <p>When you create a key, you specify both immutable and mutable data about the key. The immutable data contains key attributes that defines the scope and cryptographic operations that you can perform using the key, for example key class (example: <code>SYMMETRIC_KEY</code>), key algorithm (example: <code>TDES_2KEY</code>), key usage (example: <code>TR31_P0_PIN_ENCRYPTION_KEY</code>) and key modes of use (example: <code>Encrypt</code>). For information about valid combinations of key attributes, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html">Understanding key attributes</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>. The mutable data contained within a key includes usage timestamp and key deletion timestamp and can be modified after creation.</p>
29
+ * <p>Amazon Web Services Payment Cryptography binds key attributes to keys using key blocks when you store or export them. Amazon Web Services Payment Cryptography stores the key contents wrapped and never stores or transmits them in the clear. </p>
30
+ * <p>
31
+ * <b>Cross-account use</b>: This operation can't be used across different Amazon Web Services accounts.</p>
32
+ * <p>
33
+ * <b>Related operations:</b>
34
+ * </p>
35
+ * <ul>
36
+ * <li>
37
+ * <p>
38
+ * <a>DeleteKey</a>
39
+ * </p>
40
+ * </li>
41
+ * <li>
42
+ * <p>
43
+ * <a>GetKey</a>
44
+ * </p>
45
+ * </li>
46
+ * <li>
47
+ * <p>
48
+ * <a>ListKeys</a>
49
+ * </p>
50
+ * </li>
51
+ * </ul>
52
+ * @example
53
+ * Use a bare-bones client and the command you need to make an API call.
54
+ * ```javascript
55
+ * import { PaymentCryptographyClient, CreateKeyCommand } from "@aws-sdk/client-payment-cryptography"; // ES Modules import
56
+ * // const { PaymentCryptographyClient, CreateKeyCommand } = require("@aws-sdk/client-payment-cryptography"); // CommonJS import
57
+ * const client = new PaymentCryptographyClient(config);
58
+ * const input = { // CreateKeyInput
59
+ * KeyAttributes: { // KeyAttributes
60
+ * KeyUsage: "STRING_VALUE", // required
61
+ * KeyClass: "STRING_VALUE", // required
62
+ * KeyAlgorithm: "STRING_VALUE", // required
63
+ * KeyModesOfUse: { // KeyModesOfUse
64
+ * Encrypt: true || false,
65
+ * Decrypt: true || false,
66
+ * Wrap: true || false,
67
+ * Unwrap: true || false,
68
+ * Generate: true || false,
69
+ * Sign: true || false,
70
+ * Verify: true || false,
71
+ * DeriveKey: true || false,
72
+ * NoRestrictions: true || false,
73
+ * },
74
+ * },
75
+ * KeyCheckValueAlgorithm: "STRING_VALUE",
76
+ * Exportable: true || false, // required
77
+ * Enabled: true || false,
78
+ * Tags: [ // Tags
79
+ * { // Tag
80
+ * Key: "STRING_VALUE", // required
81
+ * Value: "STRING_VALUE",
82
+ * },
83
+ * ],
84
+ * };
85
+ * const command = new CreateKeyCommand(input);
86
+ * const response = await client.send(command);
87
+ * // { // CreateKeyOutput
88
+ * // Key: { // Key
89
+ * // KeyArn: "STRING_VALUE", // required
90
+ * // KeyAttributes: { // KeyAttributes
91
+ * // KeyUsage: "STRING_VALUE", // required
92
+ * // KeyClass: "STRING_VALUE", // required
93
+ * // KeyAlgorithm: "STRING_VALUE", // required
94
+ * // KeyModesOfUse: { // KeyModesOfUse
95
+ * // Encrypt: true || false,
96
+ * // Decrypt: true || false,
97
+ * // Wrap: true || false,
98
+ * // Unwrap: true || false,
99
+ * // Generate: true || false,
100
+ * // Sign: true || false,
101
+ * // Verify: true || false,
102
+ * // DeriveKey: true || false,
103
+ * // NoRestrictions: true || false,
104
+ * // },
105
+ * // },
106
+ * // KeyCheckValue: "STRING_VALUE", // required
107
+ * // KeyCheckValueAlgorithm: "STRING_VALUE", // required
108
+ * // Enabled: true || false, // required
109
+ * // Exportable: true || false, // required
110
+ * // KeyState: "STRING_VALUE", // required
111
+ * // KeyOrigin: "STRING_VALUE", // required
112
+ * // CreateTimestamp: new Date("TIMESTAMP"), // required
113
+ * // UsageStartTimestamp: new Date("TIMESTAMP"),
114
+ * // UsageStopTimestamp: new Date("TIMESTAMP"),
115
+ * // DeletePendingTimestamp: new Date("TIMESTAMP"),
116
+ * // DeleteTimestamp: new Date("TIMESTAMP"),
117
+ * // },
118
+ * // };
119
+ *
120
+ * ```
121
+ *
122
+ * @param CreateKeyCommandInput - {@link CreateKeyCommandInput}
123
+ * @returns {@link CreateKeyCommandOutput}
124
+ * @see {@link CreateKeyCommandInput} for command's `input` shape.
125
+ * @see {@link CreateKeyCommandOutput} for command's `response` shape.
126
+ * @see {@link PaymentCryptographyClientResolvedConfig | config} for PaymentCryptographyClient's `config` shape.
127
+ *
128
+ * @throws {@link AccessDeniedException} (client fault)
129
+ * <p>You do not have sufficient access to perform this action.</p>
130
+ *
131
+ * @throws {@link ConflictException} (client fault)
132
+ * <p>This request can cause an inconsistent state for the resource.</p>
133
+ *
134
+ * @throws {@link InternalServerException} (server fault)
135
+ * <p>The request processing has failed because of an unknown error, exception, or failure.</p>
136
+ *
137
+ * @throws {@link ResourceNotFoundException} (client fault)
138
+ * <p>The request was denied due to an invalid resource error.</p>
139
+ *
140
+ * @throws {@link ServiceQuotaExceededException} (client fault)
141
+ * <p>This request would cause a service quota to be exceeded.</p>
142
+ *
143
+ * @throws {@link ServiceUnavailableException} (server fault)
144
+ * <p>The service cannot complete the request.</p>
145
+ *
146
+ * @throws {@link ThrottlingException} (client fault)
147
+ * <p>The request was denied due to request throttling.</p>
148
+ *
149
+ * @throws {@link ValidationException} (client fault)
150
+ * <p>The request was denied due to an invalid request error.</p>
151
+ *
152
+ * @throws {@link PaymentCryptographyServiceException}
153
+ * <p>Base exception class for all service exceptions from PaymentCryptography service.</p>
154
+ *
155
+ */
156
+ export declare class CreateKeyCommand extends $Command<CreateKeyCommandInput, CreateKeyCommandOutput, PaymentCryptographyClientResolvedConfig> {
157
+ readonly input: CreateKeyCommandInput;
158
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
159
+ /**
160
+ * @public
161
+ */
162
+ constructor(input: CreateKeyCommandInput);
163
+ /**
164
+ * @internal
165
+ */
166
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PaymentCryptographyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateKeyCommandInput, CreateKeyCommandOutput>;
167
+ /**
168
+ * @internal
169
+ */
170
+ private serialize;
171
+ /**
172
+ * @internal
173
+ */
174
+ private deserialize;
175
+ }
@@ -0,0 +1,120 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { DeleteAliasInput, DeleteAliasOutput } from "../models/models_0";
5
+ import { PaymentCryptographyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PaymentCryptographyClient";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteAliasCommand}.
14
+ */
15
+ export interface DeleteAliasCommandInput extends DeleteAliasInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteAliasCommand}.
21
+ */
22
+ export interface DeleteAliasCommandOutput extends DeleteAliasOutput, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Deletes the alias, but doesn't affect the underlying key.</p>
27
+ * <p>Each key can have multiple aliases. To get the aliases of all keys, use the <a>ListAliases</a> operation. To change the alias of a key, first use <a>DeleteAlias</a> to delete the current alias and then use <a>CreateAlias</a> to create a new alias. To associate an existing alias with a different key, call <a>UpdateAlias</a>.</p>
28
+ * <p>
29
+ * <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p>
30
+ * <p>
31
+ * <b>Related operations:</b>
32
+ * </p>
33
+ * <ul>
34
+ * <li>
35
+ * <p>
36
+ * <a>CreateAlias</a>
37
+ * </p>
38
+ * </li>
39
+ * <li>
40
+ * <p>
41
+ * <a>GetAlias</a>
42
+ * </p>
43
+ * </li>
44
+ * <li>
45
+ * <p>
46
+ * <a>ListAliases</a>
47
+ * </p>
48
+ * </li>
49
+ * <li>
50
+ * <p>
51
+ * <a>UpdateAlias</a>
52
+ * </p>
53
+ * </li>
54
+ * </ul>
55
+ * @example
56
+ * Use a bare-bones client and the command you need to make an API call.
57
+ * ```javascript
58
+ * import { PaymentCryptographyClient, DeleteAliasCommand } from "@aws-sdk/client-payment-cryptography"; // ES Modules import
59
+ * // const { PaymentCryptographyClient, DeleteAliasCommand } = require("@aws-sdk/client-payment-cryptography"); // CommonJS import
60
+ * const client = new PaymentCryptographyClient(config);
61
+ * const input = { // DeleteAliasInput
62
+ * AliasName: "STRING_VALUE", // required
63
+ * };
64
+ * const command = new DeleteAliasCommand(input);
65
+ * const response = await client.send(command);
66
+ * // {};
67
+ *
68
+ * ```
69
+ *
70
+ * @param DeleteAliasCommandInput - {@link DeleteAliasCommandInput}
71
+ * @returns {@link DeleteAliasCommandOutput}
72
+ * @see {@link DeleteAliasCommandInput} for command's `input` shape.
73
+ * @see {@link DeleteAliasCommandOutput} for command's `response` shape.
74
+ * @see {@link PaymentCryptographyClientResolvedConfig | config} for PaymentCryptographyClient's `config` shape.
75
+ *
76
+ * @throws {@link AccessDeniedException} (client fault)
77
+ * <p>You do not have sufficient access to perform this action.</p>
78
+ *
79
+ * @throws {@link ConflictException} (client fault)
80
+ * <p>This request can cause an inconsistent state for the resource.</p>
81
+ *
82
+ * @throws {@link InternalServerException} (server fault)
83
+ * <p>The request processing has failed because of an unknown error, exception, or failure.</p>
84
+ *
85
+ * @throws {@link ResourceNotFoundException} (client fault)
86
+ * <p>The request was denied due to an invalid resource error.</p>
87
+ *
88
+ * @throws {@link ServiceUnavailableException} (server fault)
89
+ * <p>The service cannot complete the request.</p>
90
+ *
91
+ * @throws {@link ThrottlingException} (client fault)
92
+ * <p>The request was denied due to request throttling.</p>
93
+ *
94
+ * @throws {@link ValidationException} (client fault)
95
+ * <p>The request was denied due to an invalid request error.</p>
96
+ *
97
+ * @throws {@link PaymentCryptographyServiceException}
98
+ * <p>Base exception class for all service exceptions from PaymentCryptography service.</p>
99
+ *
100
+ */
101
+ export declare class DeleteAliasCommand extends $Command<DeleteAliasCommandInput, DeleteAliasCommandOutput, PaymentCryptographyClientResolvedConfig> {
102
+ readonly input: DeleteAliasCommandInput;
103
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
104
+ /**
105
+ * @public
106
+ */
107
+ constructor(input: DeleteAliasCommandInput);
108
+ /**
109
+ * @internal
110
+ */
111
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PaymentCryptographyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteAliasCommandInput, DeleteAliasCommandOutput>;
112
+ /**
113
+ * @internal
114
+ */
115
+ private serialize;
116
+ /**
117
+ * @internal
118
+ */
119
+ private deserialize;
120
+ }
@@ -0,0 +1,149 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { DeleteKeyInput, DeleteKeyOutput } from "../models/models_0";
5
+ import { PaymentCryptographyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PaymentCryptographyClient";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteKeyCommand}.
14
+ */
15
+ export interface DeleteKeyCommandInput extends DeleteKeyInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteKeyCommand}.
21
+ */
22
+ export interface DeleteKeyCommandOutput extends DeleteKeyOutput, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Deletes the key material and all metadata associated with Amazon Web Services Payment Cryptography key.</p>
27
+ * <p>Key deletion is irreversible. After a key is deleted, you can't perform cryptographic operations using the key. For example, you can't decrypt data that was encrypted by a deleted Amazon Web Services Payment Cryptography key, and the data may become unrecoverable. Because key deletion is destructive, Amazon Web Services Payment Cryptography has a safety mechanism to prevent accidental deletion of a key. When you call this operation, Amazon Web Services Payment Cryptography disables the specified key but doesn't delete it until after a waiting period. The default waiting period is 7 days. To set a different waiting period, set <code>DeleteKeyInDays</code>. During the waiting period, the <code>KeyState</code> is <code>DELETE_PENDING</code>. After the key is deleted, the <code>KeyState</code> is <code>DELETE_COMPLETE</code>.</p>
28
+ * <p>If you delete key material, you can use <a>ImportKey</a> to reimport the same key material into the Amazon Web Services Payment Cryptography key.</p>
29
+ * <p>You should delete a key only when you are sure that you don't need to use it anymore and no other parties are utilizing this key. If you aren't sure, consider deactivating it instead by calling <a>StopKeyUsage</a>.</p>
30
+ * <p>
31
+ * <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p>
32
+ * <p>
33
+ * <b>Related operations:</b>
34
+ * </p>
35
+ * <ul>
36
+ * <li>
37
+ * <p>
38
+ * <a>RestoreKey</a>
39
+ * </p>
40
+ * </li>
41
+ * <li>
42
+ * <p>
43
+ * <a>StartKeyUsage</a>
44
+ * </p>
45
+ * </li>
46
+ * <li>
47
+ * <p>
48
+ * <a>StopKeyUsage</a>
49
+ * </p>
50
+ * </li>
51
+ * </ul>
52
+ * @example
53
+ * Use a bare-bones client and the command you need to make an API call.
54
+ * ```javascript
55
+ * import { PaymentCryptographyClient, DeleteKeyCommand } from "@aws-sdk/client-payment-cryptography"; // ES Modules import
56
+ * // const { PaymentCryptographyClient, DeleteKeyCommand } = require("@aws-sdk/client-payment-cryptography"); // CommonJS import
57
+ * const client = new PaymentCryptographyClient(config);
58
+ * const input = { // DeleteKeyInput
59
+ * KeyIdentifier: "STRING_VALUE", // required
60
+ * DeleteKeyInDays: Number("int"),
61
+ * };
62
+ * const command = new DeleteKeyCommand(input);
63
+ * const response = await client.send(command);
64
+ * // { // DeleteKeyOutput
65
+ * // Key: { // Key
66
+ * // KeyArn: "STRING_VALUE", // required
67
+ * // KeyAttributes: { // KeyAttributes
68
+ * // KeyUsage: "STRING_VALUE", // required
69
+ * // KeyClass: "STRING_VALUE", // required
70
+ * // KeyAlgorithm: "STRING_VALUE", // required
71
+ * // KeyModesOfUse: { // KeyModesOfUse
72
+ * // Encrypt: true || false,
73
+ * // Decrypt: true || false,
74
+ * // Wrap: true || false,
75
+ * // Unwrap: true || false,
76
+ * // Generate: true || false,
77
+ * // Sign: true || false,
78
+ * // Verify: true || false,
79
+ * // DeriveKey: true || false,
80
+ * // NoRestrictions: true || false,
81
+ * // },
82
+ * // },
83
+ * // KeyCheckValue: "STRING_VALUE", // required
84
+ * // KeyCheckValueAlgorithm: "STRING_VALUE", // required
85
+ * // Enabled: true || false, // required
86
+ * // Exportable: true || false, // required
87
+ * // KeyState: "STRING_VALUE", // required
88
+ * // KeyOrigin: "STRING_VALUE", // required
89
+ * // CreateTimestamp: new Date("TIMESTAMP"), // required
90
+ * // UsageStartTimestamp: new Date("TIMESTAMP"),
91
+ * // UsageStopTimestamp: new Date("TIMESTAMP"),
92
+ * // DeletePendingTimestamp: new Date("TIMESTAMP"),
93
+ * // DeleteTimestamp: new Date("TIMESTAMP"),
94
+ * // },
95
+ * // };
96
+ *
97
+ * ```
98
+ *
99
+ * @param DeleteKeyCommandInput - {@link DeleteKeyCommandInput}
100
+ * @returns {@link DeleteKeyCommandOutput}
101
+ * @see {@link DeleteKeyCommandInput} for command's `input` shape.
102
+ * @see {@link DeleteKeyCommandOutput} for command's `response` shape.
103
+ * @see {@link PaymentCryptographyClientResolvedConfig | config} for PaymentCryptographyClient's `config` shape.
104
+ *
105
+ * @throws {@link AccessDeniedException} (client fault)
106
+ * <p>You do not have sufficient access to perform this action.</p>
107
+ *
108
+ * @throws {@link ConflictException} (client fault)
109
+ * <p>This request can cause an inconsistent state for the resource.</p>
110
+ *
111
+ * @throws {@link InternalServerException} (server fault)
112
+ * <p>The request processing has failed because of an unknown error, exception, or failure.</p>
113
+ *
114
+ * @throws {@link ResourceNotFoundException} (client fault)
115
+ * <p>The request was denied due to an invalid resource error.</p>
116
+ *
117
+ * @throws {@link ServiceUnavailableException} (server fault)
118
+ * <p>The service cannot complete the request.</p>
119
+ *
120
+ * @throws {@link ThrottlingException} (client fault)
121
+ * <p>The request was denied due to request throttling.</p>
122
+ *
123
+ * @throws {@link ValidationException} (client fault)
124
+ * <p>The request was denied due to an invalid request error.</p>
125
+ *
126
+ * @throws {@link PaymentCryptographyServiceException}
127
+ * <p>Base exception class for all service exceptions from PaymentCryptography service.</p>
128
+ *
129
+ */
130
+ export declare class DeleteKeyCommand extends $Command<DeleteKeyCommandInput, DeleteKeyCommandOutput, PaymentCryptographyClientResolvedConfig> {
131
+ readonly input: DeleteKeyCommandInput;
132
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
133
+ /**
134
+ * @public
135
+ */
136
+ constructor(input: DeleteKeyCommandInput);
137
+ /**
138
+ * @internal
139
+ */
140
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PaymentCryptographyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteKeyCommandInput, DeleteKeyCommandOutput>;
141
+ /**
142
+ * @internal
143
+ */
144
+ private serialize;
145
+ /**
146
+ * @internal
147
+ */
148
+ private deserialize;
149
+ }
@@ -0,0 +1,153 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { ExportKeyInput, ExportKeyOutput } from "../models/models_0";
5
+ import { PaymentCryptographyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PaymentCryptographyClient";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ExportKeyCommand}.
14
+ */
15
+ export interface ExportKeyCommandInput extends ExportKeyInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ExportKeyCommand}.
21
+ */
22
+ export interface ExportKeyCommandOutput extends ExportKeyOutput, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Exports a key from Amazon Web Services Payment Cryptography using either ANSI X9 TR-34 or TR-31 key export standard.</p>
27
+ * <p>Amazon Web Services Payment Cryptography simplifies main or root key exchange process by eliminating the need of a paper-based key exchange process. It takes a modern and secure approach based of the ANSI X9 TR-34 key exchange standard.</p>
28
+ * <p>You can use <code>ExportKey</code> to export main or root keys such as KEK (Key Encryption Key), using asymmetric key exchange technique following ANSI X9 TR-34 standard. The ANSI X9 TR-34 standard uses asymmetric keys to establishes bi-directional trust between the two parties exchanging keys. After which you can export working keys using the ANSI X9 TR-31 symmetric key exchange standard as mandated by PCI PIN. Using this operation, you can share your Amazon Web Services Payment Cryptography generated keys with other service partners to perform cryptographic operations outside of Amazon Web Services Payment Cryptography </p>
29
+ * <p>
30
+ * <b>TR-34 key export</b>
31
+ * </p>
32
+ * <p>Amazon Web Services Payment Cryptography uses TR-34 asymmetric key exchange standard to export main keys such as KEK. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Host (KRH). In key export process, KDH is Amazon Web Services Payment Cryptography which initiates key export. KRH is the user receiving the key. Before you initiate TR-34 key export, you must obtain an export token by calling <a>GetParametersForExport</a>. This operation also returns the signing key certificate that KDH uses to sign the wrapped key to generate a TR-34 wrapped key block. The export token expires after 7 days.</p>
33
+ * <p>Set the following parameters:</p>
34
+ * <dl>
35
+ * <dt>CertificateAuthorityPublicKeyIdentifier</dt>
36
+ * <dd>
37
+ * <p>The <code>KeyARN</code> of the certificate chain that will sign the wrapping key certificate. This must exist within Amazon Web Services Payment Cryptography before you initiate TR-34 key export. If it does not exist, you can import it by calling <a>ImportKey</a> for <code>RootCertificatePublicKey</code>.</p>
38
+ * </dd>
39
+ * <dt>ExportToken</dt>
40
+ * <dd>
41
+ * <p>Obtained from KDH by calling <a>GetParametersForExport</a>.</p>
42
+ * </dd>
43
+ * <dt>WrappingKeyCertificate</dt>
44
+ * <dd>
45
+ * <p>Amazon Web Services Payment Cryptography uses this to wrap the key under export.</p>
46
+ * </dd>
47
+ * </dl>
48
+ * <p>When this operation is successful, Amazon Web Services Payment Cryptography returns the TR-34 wrapped key block. </p>
49
+ * <p>
50
+ * <b>TR-31 key export</b>
51
+ * </p>
52
+ * <p>Amazon Web Services Payment Cryptography uses TR-31 symmetric key exchange standard to export working keys. In TR-31, you must use a main key such as KEK to encrypt or wrap the key under export. To establish a KEK, you can use <a>CreateKey</a> or <a>ImportKey</a>. When this operation is successful, Amazon Web Services Payment Cryptography returns a TR-31 wrapped key block. </p>
53
+ * <p>
54
+ * <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p>
55
+ * <p>
56
+ * <b>Related operations:</b>
57
+ * </p>
58
+ * <ul>
59
+ * <li>
60
+ * <p>
61
+ * <a>GetParametersForExport</a>
62
+ * </p>
63
+ * </li>
64
+ * <li>
65
+ * <p>
66
+ * <a>ImportKey</a>
67
+ * </p>
68
+ * </li>
69
+ * </ul>
70
+ * @example
71
+ * Use a bare-bones client and the command you need to make an API call.
72
+ * ```javascript
73
+ * import { PaymentCryptographyClient, ExportKeyCommand } from "@aws-sdk/client-payment-cryptography"; // ES Modules import
74
+ * // const { PaymentCryptographyClient, ExportKeyCommand } = require("@aws-sdk/client-payment-cryptography"); // CommonJS import
75
+ * const client = new PaymentCryptographyClient(config);
76
+ * const input = { // ExportKeyInput
77
+ * KeyMaterial: { // ExportKeyMaterial Union: only one key present
78
+ * Tr31KeyBlock: { // ExportTr31KeyBlock
79
+ * WrappingKeyIdentifier: "STRING_VALUE", // required
80
+ * },
81
+ * Tr34KeyBlock: { // ExportTr34KeyBlock
82
+ * CertificateAuthorityPublicKeyIdentifier: "STRING_VALUE", // required
83
+ * WrappingKeyCertificate: "STRING_VALUE", // required
84
+ * ExportToken: "STRING_VALUE", // required
85
+ * KeyBlockFormat: "STRING_VALUE", // required
86
+ * RandomNonce: "STRING_VALUE",
87
+ * },
88
+ * },
89
+ * ExportKeyIdentifier: "STRING_VALUE", // required
90
+ * };
91
+ * const command = new ExportKeyCommand(input);
92
+ * const response = await client.send(command);
93
+ * // { // ExportKeyOutput
94
+ * // WrappedKey: { // WrappedKey
95
+ * // WrappingKeyArn: "STRING_VALUE", // required
96
+ * // WrappedKeyMaterialFormat: "STRING_VALUE", // required
97
+ * // KeyMaterial: "STRING_VALUE", // required
98
+ * // },
99
+ * // };
100
+ *
101
+ * ```
102
+ *
103
+ * @param ExportKeyCommandInput - {@link ExportKeyCommandInput}
104
+ * @returns {@link ExportKeyCommandOutput}
105
+ * @see {@link ExportKeyCommandInput} for command's `input` shape.
106
+ * @see {@link ExportKeyCommandOutput} for command's `response` shape.
107
+ * @see {@link PaymentCryptographyClientResolvedConfig | config} for PaymentCryptographyClient's `config` shape.
108
+ *
109
+ * @throws {@link AccessDeniedException} (client fault)
110
+ * <p>You do not have sufficient access to perform this action.</p>
111
+ *
112
+ * @throws {@link ConflictException} (client fault)
113
+ * <p>This request can cause an inconsistent state for the resource.</p>
114
+ *
115
+ * @throws {@link InternalServerException} (server fault)
116
+ * <p>The request processing has failed because of an unknown error, exception, or failure.</p>
117
+ *
118
+ * @throws {@link ResourceNotFoundException} (client fault)
119
+ * <p>The request was denied due to an invalid resource error.</p>
120
+ *
121
+ * @throws {@link ServiceUnavailableException} (server fault)
122
+ * <p>The service cannot complete the request.</p>
123
+ *
124
+ * @throws {@link ThrottlingException} (client fault)
125
+ * <p>The request was denied due to request throttling.</p>
126
+ *
127
+ * @throws {@link ValidationException} (client fault)
128
+ * <p>The request was denied due to an invalid request error.</p>
129
+ *
130
+ * @throws {@link PaymentCryptographyServiceException}
131
+ * <p>Base exception class for all service exceptions from PaymentCryptography service.</p>
132
+ *
133
+ */
134
+ export declare class ExportKeyCommand extends $Command<ExportKeyCommandInput, ExportKeyCommandOutput, PaymentCryptographyClientResolvedConfig> {
135
+ readonly input: ExportKeyCommandInput;
136
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
137
+ /**
138
+ * @public
139
+ */
140
+ constructor(input: ExportKeyCommandInput);
141
+ /**
142
+ * @internal
143
+ */
144
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PaymentCryptographyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ExportKeyCommandInput, ExportKeyCommandOutput>;
145
+ /**
146
+ * @internal
147
+ */
148
+ private serialize;
149
+ /**
150
+ * @internal
151
+ */
152
+ private deserialize;
153
+ }