@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.
- package/LICENSE +201 -0
- package/README.md +369 -0
- package/dist-cjs/PaymentCryptography.js +51 -0
- package/dist-cjs/PaymentCryptographyClient.js +41 -0
- package/dist-cjs/commands/CreateAliasCommand.js +46 -0
- package/dist-cjs/commands/CreateKeyCommand.js +46 -0
- package/dist-cjs/commands/DeleteAliasCommand.js +46 -0
- package/dist-cjs/commands/DeleteKeyCommand.js +46 -0
- package/dist-cjs/commands/ExportKeyCommand.js +47 -0
- package/dist-cjs/commands/GetAliasCommand.js +46 -0
- package/dist-cjs/commands/GetKeyCommand.js +46 -0
- package/dist-cjs/commands/GetParametersForExportCommand.js +47 -0
- package/dist-cjs/commands/GetParametersForImportCommand.js +47 -0
- package/dist-cjs/commands/GetPublicKeyCertificateCommand.js +47 -0
- package/dist-cjs/commands/ImportKeyCommand.js +47 -0
- package/dist-cjs/commands/ListAliasesCommand.js +46 -0
- package/dist-cjs/commands/ListKeysCommand.js +46 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +46 -0
- package/dist-cjs/commands/RestoreKeyCommand.js +46 -0
- package/dist-cjs/commands/StartKeyUsageCommand.js +46 -0
- package/dist-cjs/commands/StopKeyUsageCommand.js +46 -0
- package/dist-cjs/commands/TagResourceCommand.js +46 -0
- package/dist-cjs/commands/UntagResourceCommand.js +46 -0
- package/dist-cjs/commands/UpdateAliasCommand.js +46 -0
- package/dist-cjs/commands/index.js +23 -0
- package/dist-cjs/endpoint/EndpointParameters.js +12 -0
- package/dist-cjs/endpoint/endpointResolver.js +12 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/index.js +11 -0
- package/dist-cjs/models/PaymentCryptographyServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +291 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListAliasesPaginator.js +29 -0
- package/dist-cjs/pagination/ListKeysPaginator.js +29 -0
- package/dist-cjs/pagination/ListTagsForResourcePaginator.js +29 -0
- package/dist-cjs/pagination/index.js +7 -0
- package/dist-cjs/protocols/Aws_json1_0.js +1396 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +48 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +21 -0
- package/dist-es/PaymentCryptography.js +47 -0
- package/dist-es/PaymentCryptographyClient.js +37 -0
- package/dist-es/commands/CreateAliasCommand.js +42 -0
- package/dist-es/commands/CreateKeyCommand.js +42 -0
- package/dist-es/commands/DeleteAliasCommand.js +42 -0
- package/dist-es/commands/DeleteKeyCommand.js +42 -0
- package/dist-es/commands/ExportKeyCommand.js +43 -0
- package/dist-es/commands/GetAliasCommand.js +42 -0
- package/dist-es/commands/GetKeyCommand.js +42 -0
- package/dist-es/commands/GetParametersForExportCommand.js +43 -0
- package/dist-es/commands/GetParametersForImportCommand.js +43 -0
- package/dist-es/commands/GetPublicKeyCertificateCommand.js +43 -0
- package/dist-es/commands/ImportKeyCommand.js +43 -0
- package/dist-es/commands/ListAliasesCommand.js +42 -0
- package/dist-es/commands/ListKeysCommand.js +42 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +42 -0
- package/dist-es/commands/RestoreKeyCommand.js +42 -0
- package/dist-es/commands/StartKeyUsageCommand.js +42 -0
- package/dist-es/commands/StopKeyUsageCommand.js +42 -0
- package/dist-es/commands/TagResourceCommand.js +42 -0
- package/dist-es/commands/UntagResourceCommand.js +42 -0
- package/dist-es/commands/UpdateAliasCommand.js +42 -0
- package/dist-es/commands/index.js +20 -0
- package/dist-es/endpoint/EndpointParameters.js +8 -0
- package/dist-es/endpoint/endpointResolver.js +8 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/index.js +6 -0
- package/dist-es/models/PaymentCryptographyServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +267 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListAliasesPaginator.js +25 -0
- package/dist-es/pagination/ListKeysPaginator.js +25 -0
- package/dist-es/pagination/ListTagsForResourcePaginator.js +25 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/protocols/Aws_json1_0.js +1353 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +43 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +17 -0
- package/dist-types/PaymentCryptography.d.ts +154 -0
- package/dist-types/PaymentCryptographyClient.d.ts +186 -0
- package/dist-types/commands/CreateAliasCommand.d.ts +130 -0
- package/dist-types/commands/CreateKeyCommand.d.ts +175 -0
- package/dist-types/commands/DeleteAliasCommand.d.ts +120 -0
- package/dist-types/commands/DeleteKeyCommand.d.ts +149 -0
- package/dist-types/commands/ExportKeyCommand.d.ts +153 -0
- package/dist-types/commands/GetAliasCommand.d.ts +121 -0
- package/dist-types/commands/GetKeyCommand.d.ts +142 -0
- package/dist-types/commands/GetParametersForExportCommand.d.ts +120 -0
- package/dist-types/commands/GetParametersForImportCommand.d.ts +120 -0
- package/dist-types/commands/GetPublicKeyCertificateCommand.d.ts +95 -0
- package/dist-types/commands/ImportKeyCommand.d.ts +301 -0
- package/dist-types/commands/ListAliasesCommand.d.ts +127 -0
- package/dist-types/commands/ListKeysCommand.d.ts +143 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +119 -0
- package/dist-types/commands/RestoreKeyCommand.d.ts +150 -0
- package/dist-types/commands/StartKeyUsageCommand.d.ts +138 -0
- package/dist-types/commands/StopKeyUsageCommand.d.ts +144 -0
- package/dist-types/commands/TagResourceCommand.d.ts +122 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +115 -0
- package/dist-types/commands/UpdateAliasCommand.d.ts +125 -0
- package/dist-types/commands/index.d.ts +20 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +20 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/index.d.ts +15 -0
- package/dist-types/models/PaymentCryptographyServiceException.d.ts +13 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1222 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListAliasesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListKeysPaginator.d.ts +7 -0
- package/dist-types/pagination/ListTagsForResourcePaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/protocols/Aws_json1_0.d.ts +182 -0
- package/dist-types/runtimeConfig.browser.d.ts +42 -0
- package/dist-types/runtimeConfig.d.ts +42 -0
- package/dist-types/runtimeConfig.native.d.ts +41 -0
- package/dist-types/runtimeConfig.shared.d.ts +18 -0
- package/dist-types/ts3.4/PaymentCryptography.d.ts +347 -0
- package/dist-types/ts3.4/PaymentCryptographyClient.d.ts +235 -0
- package/dist-types/ts3.4/commands/CreateAliasCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/CreateKeyCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/DeleteAliasCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/DeleteKeyCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/ExportKeyCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetAliasCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetKeyCommand.d.ts +33 -0
- package/dist-types/ts3.4/commands/GetParametersForExportCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetParametersForImportCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetPublicKeyCertificateCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ImportKeyCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/ListAliasesCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/ListKeysCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/RestoreKeyCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/StartKeyUsageCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/StopKeyUsageCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/UpdateAliasCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/index.d.ts +20 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +32 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/index.d.ts +6 -0
- package/dist-types/ts3.4/models/PaymentCryptographyServiceException.d.ts +8 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +490 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListAliasesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListKeysPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListTagsForResourcePaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +245 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +96 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +93 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +87 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +20 -0
- package/package.json +99 -0
|
@@ -0,0 +1,301 @@
|
|
|
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 { ImportKeyInput, ImportKeyOutput } 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 ImportKeyCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ImportKeyCommandInput extends ImportKeyInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ImportKeyCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ImportKeyCommandOutput extends ImportKeyOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Imports keys and public key certificates into Amazon Web Services Payment Cryptography.</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>ImportKey</code> to import main or root keys such as KEK (Key Encryption Key) using asymmetric key exchange technique following the 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. </p>
|
|
29
|
+
* <p>After you have imported a main or root key, you can import working keys to perform various cryptographic operations within Amazon Web Services Payment Cryptography using the ANSI X9 TR-31 symmetric key exchange standard as mandated by PCI PIN.</p>
|
|
30
|
+
* <p>You can also import a <i>root public key certificate</i>, a self-signed certificate used to sign other public key certificates, or a <i>trusted public key certificate</i> under an already established root public key certificate. </p>
|
|
31
|
+
* <p>
|
|
32
|
+
* <b>To import a public root key certificate</b>
|
|
33
|
+
* </p>
|
|
34
|
+
* <p>Using this operation, you can import the public component (in PEM cerificate format) of your private root key. You can use the imported public root key certificate for digital signatures, for example signing wrapping key or signing key in TR-34, within your Amazon Web Services Payment Cryptography account. </p>
|
|
35
|
+
* <p>Set the following parameters:</p>
|
|
36
|
+
* <ul>
|
|
37
|
+
* <li>
|
|
38
|
+
* <p>
|
|
39
|
+
* <code>KeyMaterial</code>: <code>RootCertificatePublicKey</code>
|
|
40
|
+
* </p>
|
|
41
|
+
* </li>
|
|
42
|
+
* <li>
|
|
43
|
+
* <p>
|
|
44
|
+
* <code>KeyClass</code>: <code>PUBLIC_KEY</code>
|
|
45
|
+
* </p>
|
|
46
|
+
* </li>
|
|
47
|
+
* <li>
|
|
48
|
+
* <p>
|
|
49
|
+
* <code>KeyModesOfUse</code>: <code>Verify</code>
|
|
50
|
+
* </p>
|
|
51
|
+
* </li>
|
|
52
|
+
* <li>
|
|
53
|
+
* <p>
|
|
54
|
+
* <code>KeyUsage</code>: <code>TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE</code>
|
|
55
|
+
* </p>
|
|
56
|
+
* </li>
|
|
57
|
+
* <li>
|
|
58
|
+
* <p>
|
|
59
|
+
* <code>PublicKeyCertificate</code>: The certificate authority used to sign the root public key certificate.</p>
|
|
60
|
+
* </li>
|
|
61
|
+
* </ul>
|
|
62
|
+
* <p>
|
|
63
|
+
* <b>To import a trusted public key certificate</b>
|
|
64
|
+
* </p>
|
|
65
|
+
* <p>The root public key certificate must be in place and operational before you import a trusted public key certificate. Set the following parameters:</p>
|
|
66
|
+
* <ul>
|
|
67
|
+
* <li>
|
|
68
|
+
* <p>
|
|
69
|
+
* <code>KeyMaterial</code>: <code>TrustedCertificatePublicKey</code>
|
|
70
|
+
* </p>
|
|
71
|
+
* </li>
|
|
72
|
+
* <li>
|
|
73
|
+
* <p>
|
|
74
|
+
* <code>CertificateAuthorityPublicKeyIdentifier</code>: <code>KeyArn</code> of the <code>RootCertificatePublicKey</code>.</p>
|
|
75
|
+
* </li>
|
|
76
|
+
* <li>
|
|
77
|
+
* <p>
|
|
78
|
+
* <code>KeyModesOfUse</code> and <code>KeyUsage</code>: Corresponding to the cryptographic operations such as wrap, sign, or encrypt that you will allow the trusted public key certificate to perform.</p>
|
|
79
|
+
* </li>
|
|
80
|
+
* <li>
|
|
81
|
+
* <p>
|
|
82
|
+
* <code>PublicKeyCertificate</code>: The certificate authority used to sign the trusted public key certificate.</p>
|
|
83
|
+
* </li>
|
|
84
|
+
* </ul>
|
|
85
|
+
* <p>
|
|
86
|
+
* <b>Import main keys</b>
|
|
87
|
+
* </p>
|
|
88
|
+
* <p>Amazon Web Services Payment Cryptography uses TR-34 asymmetric key exchange standard to import 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). During the key import process, KDH is the user who initiates the key import and KRH is Amazon Web Services Payment Cryptography who receives the key. Before initiating TR-34 key import, you must obtain an import token by calling <a>GetParametersForImport</a>. This operation also returns the wrapping key certificate that KDH uses wrap key under import to generate a TR-34 wrapped key block. The import token expires after 7 days.</p>
|
|
89
|
+
* <p>Set the following parameters:</p>
|
|
90
|
+
* <ul>
|
|
91
|
+
* <li>
|
|
92
|
+
* <p>
|
|
93
|
+
* <code>CertificateAuthorityPublicKeyIdentifier</code>: The <code>KeyArn</code> of the certificate chain that will sign the signing key certificate and should exist within Amazon Web Services Payment Cryptography before initiating TR-34 key import. If it does not exist, you can import it by calling by calling <code>ImportKey</code> for <code>RootCertificatePublicKey</code>.</p>
|
|
94
|
+
* </li>
|
|
95
|
+
* <li>
|
|
96
|
+
* <p>
|
|
97
|
+
* <code>ImportToken</code>: Obtained from KRH by calling <a>GetParametersForImport</a>.</p>
|
|
98
|
+
* </li>
|
|
99
|
+
* <li>
|
|
100
|
+
* <p>
|
|
101
|
+
* <code>WrappedKeyBlock</code>: The TR-34 wrapped key block from KDH. It contains the KDH key under import, wrapped with KRH provided wrapping key certificate and signed by the KDH private signing key. This TR-34 key block is generated by the KDH Hardware Security Module (HSM) outside of Amazon Web Services Payment Cryptography.</p>
|
|
102
|
+
* </li>
|
|
103
|
+
* <li>
|
|
104
|
+
* <p>
|
|
105
|
+
* <code>SigningKeyCertificate</code>: The public component of the private key that signed the KDH TR-34 wrapped key block. In PEM certificate format.</p>
|
|
106
|
+
* </li>
|
|
107
|
+
* </ul>
|
|
108
|
+
* <note>
|
|
109
|
+
* <p>TR-34 is intended primarily to exchange 3DES keys. Your ability to export AES-128 and larger AES keys may be dependent on your source system.</p>
|
|
110
|
+
* </note>
|
|
111
|
+
* <p>
|
|
112
|
+
* <b>Import working keys</b>
|
|
113
|
+
* </p>
|
|
114
|
+
* <p>Amazon Web Services Payment Cryptography uses TR-31 symmetric key exchange standard to import working keys. A KEK must be established within Amazon Web Services Payment Cryptography by using TR-34 key import. To initiate a TR-31 key import, set the following parameters:</p>
|
|
115
|
+
* <ul>
|
|
116
|
+
* <li>
|
|
117
|
+
* <p>
|
|
118
|
+
* <code>WrappedKeyBlock</code>: The key under import and encrypted using KEK. The TR-31 key block generated by your HSM outside of Amazon Web Services Payment Cryptography. </p>
|
|
119
|
+
* </li>
|
|
120
|
+
* <li>
|
|
121
|
+
* <p>
|
|
122
|
+
* <code>WrappingKeyIdentifier</code>: The <code>KeyArn</code> of the KEK that Amazon Web Services Payment Cryptography uses to decrypt or unwrap the key under import.</p>
|
|
123
|
+
* </li>
|
|
124
|
+
* </ul>
|
|
125
|
+
* <p>
|
|
126
|
+
* <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p>
|
|
127
|
+
* <p>
|
|
128
|
+
* <b>Related operations:</b>
|
|
129
|
+
* </p>
|
|
130
|
+
* <ul>
|
|
131
|
+
* <li>
|
|
132
|
+
* <p>
|
|
133
|
+
* <a>ExportKey</a>
|
|
134
|
+
* </p>
|
|
135
|
+
* </li>
|
|
136
|
+
* <li>
|
|
137
|
+
* <p>
|
|
138
|
+
* <a>GetParametersForImport</a>
|
|
139
|
+
* </p>
|
|
140
|
+
* </li>
|
|
141
|
+
* </ul>
|
|
142
|
+
* @example
|
|
143
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
144
|
+
* ```javascript
|
|
145
|
+
* import { PaymentCryptographyClient, ImportKeyCommand } from "@aws-sdk/client-payment-cryptography"; // ES Modules import
|
|
146
|
+
* // const { PaymentCryptographyClient, ImportKeyCommand } = require("@aws-sdk/client-payment-cryptography"); // CommonJS import
|
|
147
|
+
* const client = new PaymentCryptographyClient(config);
|
|
148
|
+
* const input = { // ImportKeyInput
|
|
149
|
+
* KeyMaterial: { // ImportKeyMaterial Union: only one key present
|
|
150
|
+
* RootCertificatePublicKey: { // RootCertificatePublicKey
|
|
151
|
+
* KeyAttributes: { // KeyAttributes
|
|
152
|
+
* KeyUsage: "STRING_VALUE", // required
|
|
153
|
+
* KeyClass: "STRING_VALUE", // required
|
|
154
|
+
* KeyAlgorithm: "STRING_VALUE", // required
|
|
155
|
+
* KeyModesOfUse: { // KeyModesOfUse
|
|
156
|
+
* Encrypt: true || false,
|
|
157
|
+
* Decrypt: true || false,
|
|
158
|
+
* Wrap: true || false,
|
|
159
|
+
* Unwrap: true || false,
|
|
160
|
+
* Generate: true || false,
|
|
161
|
+
* Sign: true || false,
|
|
162
|
+
* Verify: true || false,
|
|
163
|
+
* DeriveKey: true || false,
|
|
164
|
+
* NoRestrictions: true || false,
|
|
165
|
+
* },
|
|
166
|
+
* },
|
|
167
|
+
* PublicKeyCertificate: "STRING_VALUE", // required
|
|
168
|
+
* },
|
|
169
|
+
* TrustedCertificatePublicKey: { // TrustedCertificatePublicKey
|
|
170
|
+
* KeyAttributes: {
|
|
171
|
+
* KeyUsage: "STRING_VALUE", // required
|
|
172
|
+
* KeyClass: "STRING_VALUE", // required
|
|
173
|
+
* KeyAlgorithm: "STRING_VALUE", // required
|
|
174
|
+
* KeyModesOfUse: {
|
|
175
|
+
* Encrypt: true || false,
|
|
176
|
+
* Decrypt: true || false,
|
|
177
|
+
* Wrap: true || false,
|
|
178
|
+
* Unwrap: true || false,
|
|
179
|
+
* Generate: true || false,
|
|
180
|
+
* Sign: true || false,
|
|
181
|
+
* Verify: true || false,
|
|
182
|
+
* DeriveKey: true || false,
|
|
183
|
+
* NoRestrictions: true || false,
|
|
184
|
+
* },
|
|
185
|
+
* },
|
|
186
|
+
* PublicKeyCertificate: "STRING_VALUE", // required
|
|
187
|
+
* CertificateAuthorityPublicKeyIdentifier: "STRING_VALUE", // required
|
|
188
|
+
* },
|
|
189
|
+
* Tr31KeyBlock: { // ImportTr31KeyBlock
|
|
190
|
+
* WrappingKeyIdentifier: "STRING_VALUE", // required
|
|
191
|
+
* WrappedKeyBlock: "STRING_VALUE", // required
|
|
192
|
+
* },
|
|
193
|
+
* Tr34KeyBlock: { // ImportTr34KeyBlock
|
|
194
|
+
* CertificateAuthorityPublicKeyIdentifier: "STRING_VALUE", // required
|
|
195
|
+
* SigningKeyCertificate: "STRING_VALUE", // required
|
|
196
|
+
* ImportToken: "STRING_VALUE", // required
|
|
197
|
+
* WrappedKeyBlock: "STRING_VALUE", // required
|
|
198
|
+
* KeyBlockFormat: "STRING_VALUE", // required
|
|
199
|
+
* RandomNonce: "STRING_VALUE",
|
|
200
|
+
* },
|
|
201
|
+
* },
|
|
202
|
+
* KeyCheckValueAlgorithm: "STRING_VALUE",
|
|
203
|
+
* Enabled: true || false,
|
|
204
|
+
* Tags: [ // Tags
|
|
205
|
+
* { // Tag
|
|
206
|
+
* Key: "STRING_VALUE", // required
|
|
207
|
+
* Value: "STRING_VALUE",
|
|
208
|
+
* },
|
|
209
|
+
* ],
|
|
210
|
+
* };
|
|
211
|
+
* const command = new ImportKeyCommand(input);
|
|
212
|
+
* const response = await client.send(command);
|
|
213
|
+
* // { // ImportKeyOutput
|
|
214
|
+
* // Key: { // Key
|
|
215
|
+
* // KeyArn: "STRING_VALUE", // required
|
|
216
|
+
* // KeyAttributes: { // KeyAttributes
|
|
217
|
+
* // KeyUsage: "STRING_VALUE", // required
|
|
218
|
+
* // KeyClass: "STRING_VALUE", // required
|
|
219
|
+
* // KeyAlgorithm: "STRING_VALUE", // required
|
|
220
|
+
* // KeyModesOfUse: { // KeyModesOfUse
|
|
221
|
+
* // Encrypt: true || false,
|
|
222
|
+
* // Decrypt: true || false,
|
|
223
|
+
* // Wrap: true || false,
|
|
224
|
+
* // Unwrap: true || false,
|
|
225
|
+
* // Generate: true || false,
|
|
226
|
+
* // Sign: true || false,
|
|
227
|
+
* // Verify: true || false,
|
|
228
|
+
* // DeriveKey: true || false,
|
|
229
|
+
* // NoRestrictions: true || false,
|
|
230
|
+
* // },
|
|
231
|
+
* // },
|
|
232
|
+
* // KeyCheckValue: "STRING_VALUE", // required
|
|
233
|
+
* // KeyCheckValueAlgorithm: "STRING_VALUE", // required
|
|
234
|
+
* // Enabled: true || false, // required
|
|
235
|
+
* // Exportable: true || false, // required
|
|
236
|
+
* // KeyState: "STRING_VALUE", // required
|
|
237
|
+
* // KeyOrigin: "STRING_VALUE", // required
|
|
238
|
+
* // CreateTimestamp: new Date("TIMESTAMP"), // required
|
|
239
|
+
* // UsageStartTimestamp: new Date("TIMESTAMP"),
|
|
240
|
+
* // UsageStopTimestamp: new Date("TIMESTAMP"),
|
|
241
|
+
* // DeletePendingTimestamp: new Date("TIMESTAMP"),
|
|
242
|
+
* // DeleteTimestamp: new Date("TIMESTAMP"),
|
|
243
|
+
* // },
|
|
244
|
+
* // };
|
|
245
|
+
*
|
|
246
|
+
* ```
|
|
247
|
+
*
|
|
248
|
+
* @param ImportKeyCommandInput - {@link ImportKeyCommandInput}
|
|
249
|
+
* @returns {@link ImportKeyCommandOutput}
|
|
250
|
+
* @see {@link ImportKeyCommandInput} for command's `input` shape.
|
|
251
|
+
* @see {@link ImportKeyCommandOutput} for command's `response` shape.
|
|
252
|
+
* @see {@link PaymentCryptographyClientResolvedConfig | config} for PaymentCryptographyClient's `config` shape.
|
|
253
|
+
*
|
|
254
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
255
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
256
|
+
*
|
|
257
|
+
* @throws {@link ConflictException} (client fault)
|
|
258
|
+
* <p>This request can cause an inconsistent state for the resource.</p>
|
|
259
|
+
*
|
|
260
|
+
* @throws {@link InternalServerException} (server fault)
|
|
261
|
+
* <p>The request processing has failed because of an unknown error, exception, or failure.</p>
|
|
262
|
+
*
|
|
263
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
264
|
+
* <p>The request was denied due to an invalid resource error.</p>
|
|
265
|
+
*
|
|
266
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
267
|
+
* <p>This request would cause a service quota to be exceeded.</p>
|
|
268
|
+
*
|
|
269
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
270
|
+
* <p>The service cannot complete the request.</p>
|
|
271
|
+
*
|
|
272
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
273
|
+
* <p>The request was denied due to request throttling.</p>
|
|
274
|
+
*
|
|
275
|
+
* @throws {@link ValidationException} (client fault)
|
|
276
|
+
* <p>The request was denied due to an invalid request error.</p>
|
|
277
|
+
*
|
|
278
|
+
* @throws {@link PaymentCryptographyServiceException}
|
|
279
|
+
* <p>Base exception class for all service exceptions from PaymentCryptography service.</p>
|
|
280
|
+
*
|
|
281
|
+
*/
|
|
282
|
+
export declare class ImportKeyCommand extends $Command<ImportKeyCommandInput, ImportKeyCommandOutput, PaymentCryptographyClientResolvedConfig> {
|
|
283
|
+
readonly input: ImportKeyCommandInput;
|
|
284
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
285
|
+
/**
|
|
286
|
+
* @public
|
|
287
|
+
*/
|
|
288
|
+
constructor(input: ImportKeyCommandInput);
|
|
289
|
+
/**
|
|
290
|
+
* @internal
|
|
291
|
+
*/
|
|
292
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PaymentCryptographyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ImportKeyCommandInput, ImportKeyCommandOutput>;
|
|
293
|
+
/**
|
|
294
|
+
* @internal
|
|
295
|
+
*/
|
|
296
|
+
private serialize;
|
|
297
|
+
/**
|
|
298
|
+
* @internal
|
|
299
|
+
*/
|
|
300
|
+
private deserialize;
|
|
301
|
+
}
|
|
@@ -0,0 +1,127 @@
|
|
|
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 { ListAliasesInput, ListAliasesOutput } 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 ListAliasesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListAliasesCommandInput extends ListAliasesInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListAliasesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListAliasesCommandOutput extends ListAliasesOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of aliases. For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-managealias.html">Using aliases</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p>
|
|
27
|
+
* <p>This is a paginated operation, which means that each response might contain only a subset of all the aliases. When the response contains only a subset of aliases, it includes a <code>NextToken</code> value.
|
|
28
|
+
* Use this value in a subsequent <code>ListAliases</code> request to get more aliases. When you receive a response with no NextToken (or an empty or null value), that means there are no more aliases to get.</p>
|
|
29
|
+
* <p>
|
|
30
|
+
* <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p>
|
|
31
|
+
* <p>
|
|
32
|
+
* <b>Related operations:</b>
|
|
33
|
+
* </p>
|
|
34
|
+
* <ul>
|
|
35
|
+
* <li>
|
|
36
|
+
* <p>
|
|
37
|
+
* <a>CreateAlias</a>
|
|
38
|
+
* </p>
|
|
39
|
+
* </li>
|
|
40
|
+
* <li>
|
|
41
|
+
* <p>
|
|
42
|
+
* <a>DeleteAlias</a>
|
|
43
|
+
* </p>
|
|
44
|
+
* </li>
|
|
45
|
+
* <li>
|
|
46
|
+
* <p>
|
|
47
|
+
* <a>GetAlias</a>
|
|
48
|
+
* </p>
|
|
49
|
+
* </li>
|
|
50
|
+
* <li>
|
|
51
|
+
* <p>
|
|
52
|
+
* <a>UpdateAlias</a>
|
|
53
|
+
* </p>
|
|
54
|
+
* </li>
|
|
55
|
+
* </ul>
|
|
56
|
+
* @example
|
|
57
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
58
|
+
* ```javascript
|
|
59
|
+
* import { PaymentCryptographyClient, ListAliasesCommand } from "@aws-sdk/client-payment-cryptography"; // ES Modules import
|
|
60
|
+
* // const { PaymentCryptographyClient, ListAliasesCommand } = require("@aws-sdk/client-payment-cryptography"); // CommonJS import
|
|
61
|
+
* const client = new PaymentCryptographyClient(config);
|
|
62
|
+
* const input = { // ListAliasesInput
|
|
63
|
+
* NextToken: "STRING_VALUE",
|
|
64
|
+
* MaxResults: Number("int"),
|
|
65
|
+
* };
|
|
66
|
+
* const command = new ListAliasesCommand(input);
|
|
67
|
+
* const response = await client.send(command);
|
|
68
|
+
* // { // ListAliasesOutput
|
|
69
|
+
* // Aliases: [ // Aliases // required
|
|
70
|
+
* // { // Alias
|
|
71
|
+
* // AliasName: "STRING_VALUE", // required
|
|
72
|
+
* // KeyArn: "STRING_VALUE",
|
|
73
|
+
* // },
|
|
74
|
+
* // ],
|
|
75
|
+
* // NextToken: "STRING_VALUE",
|
|
76
|
+
* // };
|
|
77
|
+
*
|
|
78
|
+
* ```
|
|
79
|
+
*
|
|
80
|
+
* @param ListAliasesCommandInput - {@link ListAliasesCommandInput}
|
|
81
|
+
* @returns {@link ListAliasesCommandOutput}
|
|
82
|
+
* @see {@link ListAliasesCommandInput} for command's `input` shape.
|
|
83
|
+
* @see {@link ListAliasesCommandOutput} for command's `response` shape.
|
|
84
|
+
* @see {@link PaymentCryptographyClientResolvedConfig | config} for PaymentCryptographyClient's `config` shape.
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
87
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link InternalServerException} (server fault)
|
|
90
|
+
* <p>The request processing has failed because of an unknown error, exception, or failure.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
93
|
+
* <p>The request was denied due to an invalid resource error.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
96
|
+
* <p>The service cannot complete the request.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
99
|
+
* <p>The request was denied due to request throttling.</p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link ValidationException} (client fault)
|
|
102
|
+
* <p>The request was denied due to an invalid request error.</p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link PaymentCryptographyServiceException}
|
|
105
|
+
* <p>Base exception class for all service exceptions from PaymentCryptography service.</p>
|
|
106
|
+
*
|
|
107
|
+
*/
|
|
108
|
+
export declare class ListAliasesCommand extends $Command<ListAliasesCommandInput, ListAliasesCommandOutput, PaymentCryptographyClientResolvedConfig> {
|
|
109
|
+
readonly input: ListAliasesCommandInput;
|
|
110
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
111
|
+
/**
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
constructor(input: ListAliasesCommandInput);
|
|
115
|
+
/**
|
|
116
|
+
* @internal
|
|
117
|
+
*/
|
|
118
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PaymentCryptographyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAliasesCommandInput, ListAliasesCommandOutput>;
|
|
119
|
+
/**
|
|
120
|
+
* @internal
|
|
121
|
+
*/
|
|
122
|
+
private serialize;
|
|
123
|
+
/**
|
|
124
|
+
* @internal
|
|
125
|
+
*/
|
|
126
|
+
private deserialize;
|
|
127
|
+
}
|
|
@@ -0,0 +1,143 @@
|
|
|
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 { ListKeysInput, ListKeysOutput } 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 ListKeysCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListKeysCommandInput extends ListKeysInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListKeysCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListKeysCommandOutput extends ListKeysOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of keys.</p>
|
|
27
|
+
* <p>This is a paginated operation, which means that each response might contain only a subset of all the keys.
|
|
28
|
+
* When the response contains only a subset of keys, it includes a <code>NextToken</code> value. Use this value in a subsequent <code>ListKeys</code> request to get more keys.
|
|
29
|
+
* When you receive a response with no NextToken (or an empty or null value), that means there are no more keys to get.</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>CreateKey</a>
|
|
39
|
+
* </p>
|
|
40
|
+
* </li>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>
|
|
43
|
+
* <a>DeleteKey</a>
|
|
44
|
+
* </p>
|
|
45
|
+
* </li>
|
|
46
|
+
* <li>
|
|
47
|
+
* <p>
|
|
48
|
+
* <a>GetKey</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, ListKeysCommand } from "@aws-sdk/client-payment-cryptography"; // ES Modules import
|
|
56
|
+
* // const { PaymentCryptographyClient, ListKeysCommand } = require("@aws-sdk/client-payment-cryptography"); // CommonJS import
|
|
57
|
+
* const client = new PaymentCryptographyClient(config);
|
|
58
|
+
* const input = { // ListKeysInput
|
|
59
|
+
* KeyState: "STRING_VALUE",
|
|
60
|
+
* NextToken: "STRING_VALUE",
|
|
61
|
+
* MaxResults: Number("int"),
|
|
62
|
+
* };
|
|
63
|
+
* const command = new ListKeysCommand(input);
|
|
64
|
+
* const response = await client.send(command);
|
|
65
|
+
* // { // ListKeysOutput
|
|
66
|
+
* // Keys: [ // KeySummaryList // required
|
|
67
|
+
* // { // KeySummary
|
|
68
|
+
* // KeyArn: "STRING_VALUE", // required
|
|
69
|
+
* // KeyState: "STRING_VALUE", // required
|
|
70
|
+
* // KeyAttributes: { // KeyAttributes
|
|
71
|
+
* // KeyUsage: "STRING_VALUE", // required
|
|
72
|
+
* // KeyClass: "STRING_VALUE", // required
|
|
73
|
+
* // KeyAlgorithm: "STRING_VALUE", // required
|
|
74
|
+
* // KeyModesOfUse: { // KeyModesOfUse
|
|
75
|
+
* // Encrypt: true || false,
|
|
76
|
+
* // Decrypt: true || false,
|
|
77
|
+
* // Wrap: true || false,
|
|
78
|
+
* // Unwrap: true || false,
|
|
79
|
+
* // Generate: true || false,
|
|
80
|
+
* // Sign: true || false,
|
|
81
|
+
* // Verify: true || false,
|
|
82
|
+
* // DeriveKey: true || false,
|
|
83
|
+
* // NoRestrictions: true || false,
|
|
84
|
+
* // },
|
|
85
|
+
* // },
|
|
86
|
+
* // KeyCheckValue: "STRING_VALUE", // required
|
|
87
|
+
* // Exportable: true || false, // required
|
|
88
|
+
* // Enabled: true || false, // required
|
|
89
|
+
* // },
|
|
90
|
+
* // ],
|
|
91
|
+
* // NextToken: "STRING_VALUE",
|
|
92
|
+
* // };
|
|
93
|
+
*
|
|
94
|
+
* ```
|
|
95
|
+
*
|
|
96
|
+
* @param ListKeysCommandInput - {@link ListKeysCommandInput}
|
|
97
|
+
* @returns {@link ListKeysCommandOutput}
|
|
98
|
+
* @see {@link ListKeysCommandInput} for command's `input` shape.
|
|
99
|
+
* @see {@link ListKeysCommandOutput} for command's `response` shape.
|
|
100
|
+
* @see {@link PaymentCryptographyClientResolvedConfig | config} for PaymentCryptographyClient's `config` shape.
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
103
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link InternalServerException} (server fault)
|
|
106
|
+
* <p>The request processing has failed because of an unknown error, exception, or failure.</p>
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
109
|
+
* <p>The request was denied due to an invalid resource error.</p>
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
112
|
+
* <p>The service cannot complete the request.</p>
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
115
|
+
* <p>The request was denied due to request throttling.</p>
|
|
116
|
+
*
|
|
117
|
+
* @throws {@link ValidationException} (client fault)
|
|
118
|
+
* <p>The request was denied due to an invalid request error.</p>
|
|
119
|
+
*
|
|
120
|
+
* @throws {@link PaymentCryptographyServiceException}
|
|
121
|
+
* <p>Base exception class for all service exceptions from PaymentCryptography service.</p>
|
|
122
|
+
*
|
|
123
|
+
*/
|
|
124
|
+
export declare class ListKeysCommand extends $Command<ListKeysCommandInput, ListKeysCommandOutput, PaymentCryptographyClientResolvedConfig> {
|
|
125
|
+
readonly input: ListKeysCommandInput;
|
|
126
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
127
|
+
/**
|
|
128
|
+
* @public
|
|
129
|
+
*/
|
|
130
|
+
constructor(input: ListKeysCommandInput);
|
|
131
|
+
/**
|
|
132
|
+
* @internal
|
|
133
|
+
*/
|
|
134
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PaymentCryptographyClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListKeysCommandInput, ListKeysCommandOutput>;
|
|
135
|
+
/**
|
|
136
|
+
* @internal
|
|
137
|
+
*/
|
|
138
|
+
private serialize;
|
|
139
|
+
/**
|
|
140
|
+
* @internal
|
|
141
|
+
*/
|
|
142
|
+
private deserialize;
|
|
143
|
+
}
|