@aws-sdk/client-payment-cryptography 3.1039.0 → 3.1040.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 (56) hide show
  1. package/README.md +42 -0
  2. package/dist-cjs/index.js +101 -0
  3. package/dist-cjs/models/errors.js +16 -1
  4. package/dist-cjs/schemas/schemas_0.js +131 -7
  5. package/dist-es/PaymentCryptography.js +12 -0
  6. package/dist-es/commands/AssociateMpaTeamCommand.js +16 -0
  7. package/dist-es/commands/DeleteResourcePolicyCommand.js +16 -0
  8. package/dist-es/commands/DisassociateMpaTeamCommand.js +16 -0
  9. package/dist-es/commands/GetMpaTeamAssociationCommand.js +16 -0
  10. package/dist-es/commands/GetResourcePolicyCommand.js +16 -0
  11. package/dist-es/commands/PutResourcePolicyCommand.js +16 -0
  12. package/dist-es/commands/index.js +6 -0
  13. package/dist-es/models/enums.js +14 -0
  14. package/dist-es/models/errors.js +14 -0
  15. package/dist-es/schemas/schemas_0.js +129 -5
  16. package/dist-types/PaymentCryptography.d.ts +42 -0
  17. package/dist-types/PaymentCryptographyClient.d.ts +8 -2
  18. package/dist-types/commands/AddKeyReplicationRegionsCommand.d.ts +7 -1
  19. package/dist-types/commands/AssociateMpaTeamCommand.d.ts +110 -0
  20. package/dist-types/commands/CreateKeyCommand.d.ts +6 -0
  21. package/dist-types/commands/DeleteKeyCommand.d.ts +7 -1
  22. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +93 -0
  23. package/dist-types/commands/DisassociateMpaTeamCommand.d.ts +109 -0
  24. package/dist-types/commands/ExportKeyCommand.d.ts +1 -1
  25. package/dist-types/commands/GetKeyCommand.d.ts +7 -1
  26. package/dist-types/commands/GetMpaTeamAssociationCommand.d.ts +108 -0
  27. package/dist-types/commands/GetPublicKeyCertificateCommand.d.ts +1 -1
  28. package/dist-types/commands/GetResourcePolicyCommand.d.ts +93 -0
  29. package/dist-types/commands/ImportKeyCommand.d.ts +8 -1
  30. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  31. package/dist-types/commands/PutResourcePolicyCommand.d.ts +103 -0
  32. package/dist-types/commands/RemoveKeyReplicationRegionsCommand.d.ts +7 -1
  33. package/dist-types/commands/RestoreKeyCommand.d.ts +7 -1
  34. package/dist-types/commands/StartKeyUsageCommand.d.ts +7 -1
  35. package/dist-types/commands/StopKeyUsageCommand.d.ts +7 -1
  36. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  37. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  38. package/dist-types/commands/index.d.ts +6 -0
  39. package/dist-types/models/enums.d.ts +38 -0
  40. package/dist-types/models/errors.d.ts +13 -0
  41. package/dist-types/models/models_0.d.ts +208 -1
  42. package/dist-types/schemas/schemas_0.d.ts +21 -0
  43. package/dist-types/ts3.4/PaymentCryptography.d.ts +102 -0
  44. package/dist-types/ts3.4/PaymentCryptographyClient.d.ts +36 -0
  45. package/dist-types/ts3.4/commands/AssociateMpaTeamCommand.d.ts +50 -0
  46. package/dist-types/ts3.4/commands/DeleteResourcePolicyCommand.d.ts +51 -0
  47. package/dist-types/ts3.4/commands/DisassociateMpaTeamCommand.d.ts +51 -0
  48. package/dist-types/ts3.4/commands/GetMpaTeamAssociationCommand.d.ts +51 -0
  49. package/dist-types/ts3.4/commands/GetResourcePolicyCommand.d.ts +50 -0
  50. package/dist-types/ts3.4/commands/PutResourcePolicyCommand.d.ts +50 -0
  51. package/dist-types/ts3.4/commands/index.d.ts +6 -0
  52. package/dist-types/ts3.4/models/enums.d.ts +18 -0
  53. package/dist-types/ts3.4/models/errors.d.ts +8 -0
  54. package/dist-types/ts3.4/models/models_0.d.ts +57 -0
  55. package/dist-types/ts3.4/schemas/schemas_0.d.ts +21 -0
  56. package/package.json +1 -1
@@ -0,0 +1,108 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { GetMpaTeamAssociationInput, GetMpaTeamAssociationOutput } from "../models/models_0";
4
+ import type { PaymentCryptographyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PaymentCryptographyClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetMpaTeamAssociationCommand}.
14
+ */
15
+ export interface GetMpaTeamAssociationCommandInput extends GetMpaTeamAssociationInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetMpaTeamAssociationCommand}.
21
+ */
22
+ export interface GetMpaTeamAssociationCommandOutput extends GetMpaTeamAssociationOutput, __MetadataBearer {
23
+ }
24
+ declare const GetMpaTeamAssociationCommand_base: {
25
+ new (input: GetMpaTeamAssociationCommandInput): import("@smithy/smithy-client").CommandImpl<GetMpaTeamAssociationCommandInput, GetMpaTeamAssociationCommandOutput, PaymentCryptographyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: GetMpaTeamAssociationCommandInput): import("@smithy/smithy-client").CommandImpl<GetMpaTeamAssociationCommandInput, GetMpaTeamAssociationCommandOutput, PaymentCryptographyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Returns the Multi-Party Approval (MPA) team association for a protected operation.</p> <p> <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_AssociateMpaTeam.html">AssociateMpaTeam</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DisassociateMpaTeam.html">DisassociateMpaTeam</a> </p> </li> </ul>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { PaymentCryptographyClient, GetMpaTeamAssociationCommand } from "@aws-sdk/client-payment-cryptography"; // ES Modules import
35
+ * // const { PaymentCryptographyClient, GetMpaTeamAssociationCommand } = require("@aws-sdk/client-payment-cryptography"); // CommonJS import
36
+ * // import type { PaymentCryptographyClientConfig } from "@aws-sdk/client-payment-cryptography";
37
+ * const config = {}; // type is PaymentCryptographyClientConfig
38
+ * const client = new PaymentCryptographyClient(config);
39
+ * const input = { // GetMpaTeamAssociationInput
40
+ * Action: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new GetMpaTeamAssociationCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // GetMpaTeamAssociationOutput
45
+ * // MpaTeamAssociation: { // MpaTeamAssociation
46
+ * // Action: "STRING_VALUE", // required
47
+ * // MpaTeamArn: "STRING_VALUE", // required
48
+ * // AssociationState: "STRING_VALUE", // required
49
+ * // MpaStatus: { // MpaStatus
50
+ * // MpaSessionArn: "STRING_VALUE", // required
51
+ * // Status: "STRING_VALUE", // required
52
+ * // InitiationDate: new Date("TIMESTAMP"), // required
53
+ * // StatusMessage: "STRING_VALUE",
54
+ * // },
55
+ * // },
56
+ * // };
57
+ *
58
+ * ```
59
+ *
60
+ * @param GetMpaTeamAssociationCommandInput - {@link GetMpaTeamAssociationCommandInput}
61
+ * @returns {@link GetMpaTeamAssociationCommandOutput}
62
+ * @see {@link GetMpaTeamAssociationCommandInput} for command's `input` shape.
63
+ * @see {@link GetMpaTeamAssociationCommandOutput} for command's `response` shape.
64
+ * @see {@link PaymentCryptographyClientResolvedConfig | config} for PaymentCryptographyClient's `config` shape.
65
+ *
66
+ * @throws {@link AccessDeniedException} (client fault)
67
+ * <p>You do not have sufficient access to perform this action.</p> <p>This exception is thrown when the caller lacks the necessary IAM permissions to perform the requested operation. Verify that your IAM policy includes the required permissions for the specific Amazon Web Services Payment Cryptography action you're attempting.</p>
68
+ *
69
+ * @throws {@link ConflictException} (client fault)
70
+ * <p>This request can cause an inconsistent state for the resource.</p> <p>The requested operation conflicts with the current state of the resource. For example, attempting to delete a key that is currently being used, or trying to create a resource that already exists.</p>
71
+ *
72
+ * @throws {@link InternalServerException} (server fault)
73
+ * <p>The request processing has failed because of an unknown error, exception, or failure.</p> <p>This indicates a server-side error within the Amazon Web Services Payment Cryptography service. If this error persists, contact support for assistance.</p>
74
+ *
75
+ * @throws {@link ResourceNotFoundException} (client fault)
76
+ * <p>The request was denied due to resource not found.</p> <p>The specified key, alias, or other resource does not exist in your account or region. Verify that the resource identifier is correct and that the resource exists in the expected region.</p>
77
+ *
78
+ * @throws {@link ServiceQuotaExceededException} (client fault)
79
+ * <p>This request would cause a service quota to be exceeded.</p> <p>You have reached the maximum number of keys, aliases, or other resources allowed in your account. Review your current usage and consider deleting unused resources or requesting a quota increase.</p>
80
+ *
81
+ * @throws {@link ServiceUnavailableException} (server fault)
82
+ * <p>The service cannot complete the request.</p> <p>The Amazon Web Services Payment Cryptography service is temporarily unavailable. This is typically a temporary condition - retry your request after a brief delay.</p>
83
+ *
84
+ * @throws {@link ThrottlingException} (client fault)
85
+ * <p>The request was denied due to request throttling.</p> <p>You have exceeded the rate limits for Amazon Web Services Payment Cryptography API calls. Implement exponential backoff and retry logic in your application to handle throttling gracefully.</p>
86
+ *
87
+ * @throws {@link ValidationException} (client fault)
88
+ * <p>The request was denied due to an invalid request error.</p> <p>One or more parameters in your request are invalid. Check the parameter values, formats, and constraints specified in the API documentation.</p>
89
+ *
90
+ * @throws {@link PaymentCryptographyServiceException}
91
+ * <p>Base exception class for all service exceptions from PaymentCryptography service.</p>
92
+ *
93
+ *
94
+ * @public
95
+ */
96
+ export declare class GetMpaTeamAssociationCommand extends GetMpaTeamAssociationCommand_base {
97
+ /** @internal type navigation helper, not in runtime. */
98
+ protected static __types: {
99
+ api: {
100
+ input: GetMpaTeamAssociationInput;
101
+ output: GetMpaTeamAssociationOutput;
102
+ };
103
+ sdk: {
104
+ input: GetMpaTeamAssociationCommandInput;
105
+ output: GetMpaTeamAssociationCommandOutput;
106
+ };
107
+ };
108
+ }
@@ -27,7 +27,7 @@ declare const GetPublicKeyCertificateCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets the public key certificate of the asymmetric key pair that exists within Amazon Web Services Payment Cryptography.</p> <p>Unlike the private key of an asymmetric key, which never leaves Amazon Web Services Payment Cryptography unencrypted, callers with <code>GetPublicKeyCertificate</code> permission can download the public key certificate of the asymmetric key. You can share the public key certificate to allow others to encrypt messages and verify signatures outside of Amazon Web Services Payment Cryptography</p> <p> <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p>
30
+ * <p>Gets the public key certificate of the asymmetric key pair that exists within Amazon Web Services Payment Cryptography.</p> <p>Unlike the private key of an asymmetric key, which never leaves Amazon Web Services Payment Cryptography unencrypted, callers with <code>GetPublicKeyCertificate</code> permission can download the public key certificate of the asymmetric key. You can share the public key certificate to allow others to encrypt messages and verify signatures outside of Amazon Web Services Payment Cryptography</p> <p> <b>Cross-account use:</b> This operation supports cross-account use when the key has a resource-based policy that grants access. For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html">Resource-based policies</a>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -0,0 +1,93 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { GetResourcePolicyInput, GetResourcePolicyOutput } from "../models/models_0";
4
+ import type { PaymentCryptographyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PaymentCryptographyClient";
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 GetResourcePolicyInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetResourcePolicyCommand}.
21
+ */
22
+ export interface GetResourcePolicyCommandOutput extends GetResourcePolicyOutput, __MetadataBearer {
23
+ }
24
+ declare const GetResourcePolicyCommand_base: {
25
+ new (input: GetResourcePolicyCommandInput): import("@smithy/smithy-client").CommandImpl<GetResourcePolicyCommandInput, GetResourcePolicyCommandOutput, PaymentCryptographyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: GetResourcePolicyCommandInput): import("@smithy/smithy-client").CommandImpl<GetResourcePolicyCommandInput, GetResourcePolicyCommandOutput, PaymentCryptographyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Returns the resource-based policy attached to an Amazon Web Services Payment Cryptography key.</p> <p> <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_PutResourcePolicy.html">PutResourcePolicy</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteResourcePolicy.html">DeleteResourcePolicy</a> </p> </li> </ul>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { PaymentCryptographyClient, GetResourcePolicyCommand } from "@aws-sdk/client-payment-cryptography"; // ES Modules import
35
+ * // const { PaymentCryptographyClient, GetResourcePolicyCommand } = require("@aws-sdk/client-payment-cryptography"); // CommonJS import
36
+ * // import type { PaymentCryptographyClientConfig } from "@aws-sdk/client-payment-cryptography";
37
+ * const config = {}; // type is PaymentCryptographyClientConfig
38
+ * const client = new PaymentCryptographyClient(config);
39
+ * const input = { // GetResourcePolicyInput
40
+ * ResourceArn: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new GetResourcePolicyCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // GetResourcePolicyOutput
45
+ * // ResourceArn: "STRING_VALUE", // required
46
+ * // Policy: "STRING_VALUE", // required
47
+ * // };
48
+ *
49
+ * ```
50
+ *
51
+ * @param GetResourcePolicyCommandInput - {@link GetResourcePolicyCommandInput}
52
+ * @returns {@link GetResourcePolicyCommandOutput}
53
+ * @see {@link GetResourcePolicyCommandInput} for command's `input` shape.
54
+ * @see {@link GetResourcePolicyCommandOutput} for command's `response` shape.
55
+ * @see {@link PaymentCryptographyClientResolvedConfig | config} for PaymentCryptographyClient's `config` shape.
56
+ *
57
+ * @throws {@link AccessDeniedException} (client fault)
58
+ * <p>You do not have sufficient access to perform this action.</p> <p>This exception is thrown when the caller lacks the necessary IAM permissions to perform the requested operation. Verify that your IAM policy includes the required permissions for the specific Amazon Web Services Payment Cryptography action you're attempting.</p>
59
+ *
60
+ * @throws {@link InternalServerException} (server fault)
61
+ * <p>The request processing has failed because of an unknown error, exception, or failure.</p> <p>This indicates a server-side error within the Amazon Web Services Payment Cryptography service. If this error persists, contact support for assistance.</p>
62
+ *
63
+ * @throws {@link ResourceNotFoundException} (client fault)
64
+ * <p>The request was denied due to resource not found.</p> <p>The specified key, alias, or other resource does not exist in your account or region. Verify that the resource identifier is correct and that the resource exists in the expected region.</p>
65
+ *
66
+ * @throws {@link ServiceUnavailableException} (server fault)
67
+ * <p>The service cannot complete the request.</p> <p>The Amazon Web Services Payment Cryptography service is temporarily unavailable. This is typically a temporary condition - retry your request after a brief delay.</p>
68
+ *
69
+ * @throws {@link ThrottlingException} (client fault)
70
+ * <p>The request was denied due to request throttling.</p> <p>You have exceeded the rate limits for Amazon Web Services Payment Cryptography API calls. Implement exponential backoff and retry logic in your application to handle throttling gracefully.</p>
71
+ *
72
+ * @throws {@link ValidationException} (client fault)
73
+ * <p>The request was denied due to an invalid request error.</p> <p>One or more parameters in your request are invalid. Check the parameter values, formats, and constraints specified in the API documentation.</p>
74
+ *
75
+ * @throws {@link PaymentCryptographyServiceException}
76
+ * <p>Base exception class for all service exceptions from PaymentCryptography service.</p>
77
+ *
78
+ *
79
+ * @public
80
+ */
81
+ export declare class GetResourcePolicyCommand extends GetResourcePolicyCommand_base {
82
+ /** @internal type navigation helper, not in runtime. */
83
+ protected static __types: {
84
+ api: {
85
+ input: GetResourcePolicyInput;
86
+ output: GetResourcePolicyOutput;
87
+ };
88
+ sdk: {
89
+ input: GetResourcePolicyCommandInput;
90
+ output: GetResourcePolicyCommandOutput;
91
+ };
92
+ };
93
+ }
@@ -27,7 +27,7 @@ declare const ImportKeyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Imports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography.</p> <p>Amazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With <code>ImportKey</code> you can import symmetric keys using either symmetric and asymmetric key exchange mechanisms.</p> <p>For symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm, RSA unwrap, and ECDH (Elliptic Curve Diffie-Hellman) key exchange mechanisms. Asymmetric key exchange methods are typically used to establish bi-directional trust between the two parties exhanging keys and are used for initial key exchange such as Key Encryption Key (KEK) or Zone Master Key (ZMK). After which you can import working keys using symmetric method to perform various cryptographic operations within Amazon Web Services Payment Cryptography.</p> <p>PCI requires specific minimum key strength of wrapping keys used to protect the keys being exchanged electronically. These requirements can change when PCI standards are revised. The rules specify that wrapping keys used for transport must be at least as strong as the key being protected. For more information on recommended key strength of wrapping keys and key exchange mechanism, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-importexport.html">Importing and exporting keys</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p> <p>You can also import a <i>root public key certificate</i>, used to sign other public key certificates, or a <i>trusted public key certificate</i> under an already established root public key certificate.</p> <p> <b>To import a public root key certificate</b> </p> <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> <p>Set the following parameters:</p> <ul> <li> <p> <code>KeyMaterial</code>: <code>RootCertificatePublicKey</code> </p> </li> <li> <p> <code>KeyClass</code>: <code>PUBLIC_KEY</code> </p> </li> <li> <p> <code>KeyModesOfUse</code>: <code>Verify</code> </p> </li> <li> <p> <code>KeyUsage</code>: <code>TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE</code> </p> </li> <li> <p> <code>PublicKeyCertificate</code>: The public key certificate in PEM format (base64 encoded) of the private root key under import.</p> </li> </ul> <p> <b>To import a trusted public key certificate</b> </p> <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> <ul> <li> <p> <code>KeyMaterial</code>: <code>TrustedCertificatePublicKey</code> </p> </li> <li> <p> <code>CertificateAuthorityPublicKeyIdentifier</code>: <code>KeyArn</code> of the <code>RootCertificatePublicKey</code>.</p> </li> <li> <p> <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> </li> <li> <p> <code>PublicKeyCertificate</code>: The trusted public key certificate in PEM format (base64 encoded) under import.</p> </li> </ul> <p> <b>To import initial keys (KEK or ZMK or similar) using TR-34</b> </p> <p>Using this operation, you can import initial key using TR-34 asymmetric key exchange. 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 Device (KRD). During the key import process, KDH is the user who initiates the key import and KRD is Amazon Web Services Payment Cryptography who receives the key.</p> <p>To initiate TR-34 key import, the KDH must obtain an import token by calling <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html">GetParametersForImport</a>. This operation generates an encryption keypair for the purpose of key import, signs the key and returns back the wrapping key certificate (also known as KRD wrapping certificate) and the root certificate chain. The KDH must trust and install the KRD wrapping certificate on its HSM and use it to encrypt (wrap) the KDH key during TR-34 WrappedKeyBlock generation. The import token and associated KRD wrapping certificate expires after 30 days.</p> <p>Next the KDH generates a key pair for the purpose of signing the encrypted KDH key and provides the public certificate of the signing key to Amazon Web Services Payment Cryptography. The KDH will also need to import the root certificate chain of the KDH signing certificate by calling <code>ImportKey</code> for <code>RootCertificatePublicKey</code>. For more information on TR-34 key import, see section <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-import.html">Importing symmetric keys</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p> <p>Set the following parameters:</p> <ul> <li> <p> <code>KeyMaterial</code>: Use <code>Tr34KeyBlock</code> parameters.</p> </li> <li> <p> <code>CertificateAuthorityPublicKeyIdentifier</code>: The <code>KeyARN</code> of the certificate chain that signed the KDH signing key certificate.</p> </li> <li> <p> <code>ImportToken</code>: Obtained from KRD by calling <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html">GetParametersForImport</a>.</p> </li> <li> <p> <code>WrappedKeyBlock</code>: The TR-34 wrapped key material from KDH. It contains the KDH key under import, wrapped with KRD wrapping certificate and signed by KDH signing private key. This TR-34 key block is typically generated by the KDH Hardware Security Module (HSM) outside of Amazon Web Services Payment Cryptography.</p> </li> <li> <p> <code>SigningKeyCertificate</code>: The public key certificate in PEM format (base64 encoded) of the KDH signing key generated under the root certificate (CertificateAuthorityPublicKeyIdentifier) imported in Amazon Web Services Payment Cryptography.</p> </li> </ul> <p> <b>To import initial keys (KEK or ZMK or similar) using RSA Wrap and Unwrap</b> </p> <p>Using this operation, you can import initial key using asymmetric RSA wrap and unwrap key exchange method. To initiate import, call <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html">GetParametersForImport</a> with <code>KeyMaterial</code> set to <code>KEY_CRYPTOGRAM</code> to generate an import token. This operation also generates an encryption keypair for the purpose of key import, signs the key and returns back the wrapping key certificate in PEM format (base64 encoded) and its root certificate chain. The import token and associated KRD wrapping certificate expires after 30 days. </p> <p>You must trust and install the wrapping certificate and its certificate chain on the sending HSM and use it to wrap the key under export for WrappedKeyCryptogram generation. Next call <code>ImportKey</code> with <code>KeyMaterial</code> set to <code>KEY_CRYPTOGRAM</code> and provide the <code>ImportToken</code> and <code>KeyAttributes</code> for the key under import.</p> <p> <b>To import working keys using TR-31</b> </p> <p>Amazon Web Services Payment Cryptography uses TR-31 symmetric key exchange norm to import working keys. A KEK must be established within Amazon Web Services Payment Cryptography by using TR-34 key import or by using <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html">CreateKey</a>. To initiate a TR-31 key import, set the following parameters:</p> <ul> <li> <p> <code>KeyMaterial</code>: Use <code>Tr31KeyBlock</code> parameters.</p> </li> <li> <p> <code>WrappedKeyBlock</code>: The TR-31 wrapped key material. It contains the key under import, encrypted using KEK. The TR-31 key block is typically generated by a HSM outside of Amazon Web Services Payment Cryptography. </p> </li> <li> <p> <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> </li> </ul> <p> <b>To import working keys using ECDH</b> </p> <p>You can also use ECDH key agreement to import working keys as a TR-31 keyblock, where the wrapping key is an ECDH derived key.</p> <p>To initiate a TR-31 key import using ECDH, both sides must create an ECC key pair with key usage K3 and exchange public key certificates. In Amazon Web Services Payment Cryptography, you can do this by calling <code>CreateKey</code> and then <code>GetPublicKeyCertificate</code> to retrieve its public key certificate. Next, you can then generate a TR-31 WrappedKeyBlock using your own ECC key pair, the public certificate of the service's ECC key pair, and the key derivation parameters including key derivation function, hash algorithm, derivation data, and key algorithm. If you have not already done so, you must import the CA chain that issued the receiving public key certificate by calling <code>ImportKey</code> with input <code>RootCertificatePublicKey</code> for root CA or <code>TrustedPublicKey</code> for intermediate CA. To complete the TR-31 key import, you can use the following parameters. It is important that the ECDH key derivation parameters you use should match those used during import to derive the same shared wrapping key within Amazon Web Services Payment Cryptography.</p> <ul> <li> <p> <code>KeyMaterial</code>: Use <code>DiffieHellmanTr31KeyBlock</code> parameters.</p> </li> <li> <p> <code>PrivateKeyIdentifier</code>: The <code>KeyArn</code> of the ECC key pair created within Amazon Web Services Payment Cryptography to derive a shared KEK.</p> </li> <li> <p> <code>PublicKeyCertificate</code>: The public key certificate of the receiving ECC key pair in PEM format (base64 encoded) to derive a shared KEK.</p> </li> <li> <p> <code>CertificateAuthorityPublicKeyIdentifier</code>: The <code>keyARN</code> of the CA that signed the public key certificate of the receiving ECC key pair.</p> </li> </ul> <p> <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ExportKey.html">ExportKey</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html">GetParametersForImport</a> </p> </li> </ul>
30
+ * <p>Imports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography.</p> <p>Amazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With <code>ImportKey</code> you can import symmetric keys using either symmetric and asymmetric key exchange mechanisms.</p> <p>For symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm, RSA unwrap, and ECDH (Elliptic Curve Diffie-Hellman) key exchange mechanisms. Asymmetric key exchange methods are typically used to establish bi-directional trust between the two parties exhanging keys and are used for initial key exchange such as Key Encryption Key (KEK) or Zone Master Key (ZMK). After which you can import working keys using symmetric method to perform various cryptographic operations within Amazon Web Services Payment Cryptography.</p> <p>PCI requires specific minimum key strength of wrapping keys used to protect the keys being exchanged electronically. These requirements can change when PCI standards are revised. The rules specify that wrapping keys used for transport must be at least as strong as the key being protected. For more information on recommended key strength of wrapping keys and key exchange mechanism, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-importexport.html">Importing and exporting keys</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p> <p>You can also import a <i>root public key certificate</i>, used to sign other public key certificates, or a <i>trusted public key certificate</i> under an already established root public key certificate.</p> <p> <b>To import a public root key certificate</b> </p> <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> <p>Set the following parameters:</p> <ul> <li> <p> <code>KeyMaterial</code>: <code>RootCertificatePublicKey</code> </p> </li> <li> <p> <code>KeyClass</code>: <code>PUBLIC_KEY</code> </p> </li> <li> <p> <code>KeyModesOfUse</code>: <code>Verify</code> </p> </li> <li> <p> <code>KeyUsage</code>: <code>TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE</code> </p> </li> <li> <p> <code>PublicKeyCertificate</code>: The public key certificate in PEM format (base64 encoded) of the private root key under import.</p> </li> </ul> <p> <b>To import a trusted public key certificate</b> </p> <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> <ul> <li> <p> <code>KeyMaterial</code>: <code>TrustedCertificatePublicKey</code> </p> </li> <li> <p> <code>CertificateAuthorityPublicKeyIdentifier</code>: <code>KeyArn</code> of the <code>RootCertificatePublicKey</code>.</p> </li> <li> <p> <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> </li> <li> <p> <code>PublicKeyCertificate</code>: The trusted public key certificate in PEM format (base64 encoded) under import.</p> </li> </ul> <p> <b>To import initial keys (KEK or ZMK or similar) using TR-34</b> </p> <p>Using this operation, you can import initial key using TR-34 asymmetric key exchange. 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 Device (KRD). During the key import process, KDH is the user who initiates the key import and KRD is Amazon Web Services Payment Cryptography who receives the key.</p> <p>To initiate TR-34 key import, the KDH must obtain an import token by calling <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html">GetParametersForImport</a>. This operation generates an encryption keypair for the purpose of key import, signs the key and returns back the wrapping key certificate (also known as KRD wrapping certificate) and the root certificate chain. The KDH must trust and install the KRD wrapping certificate on its HSM and use it to encrypt (wrap) the KDH key during TR-34 WrappedKeyBlock generation. The import token and associated KRD wrapping certificate expires after 30 days.</p> <p>Next the KDH generates a key pair for the purpose of signing the encrypted KDH key and provides the public certificate of the signing key to Amazon Web Services Payment Cryptography. The KDH will also need to import the root certificate chain of the KDH signing certificate by calling <code>ImportKey</code> for <code>RootCertificatePublicKey</code>. For more information on TR-34 key import, see section <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-import.html">Importing symmetric keys</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p> <p>Set the following parameters:</p> <ul> <li> <p> <code>KeyMaterial</code>: Use <code>Tr34KeyBlock</code> parameters.</p> </li> <li> <p> <code>CertificateAuthorityPublicKeyIdentifier</code>: The <code>KeyARN</code> of the certificate chain that signed the KDH signing key certificate.</p> </li> <li> <p> <code>ImportToken</code>: Obtained from KRD by calling <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html">GetParametersForImport</a>.</p> </li> <li> <p> <code>WrappedKeyBlock</code>: The TR-34 wrapped key material from KDH. It contains the KDH key under import, wrapped with KRD wrapping certificate and signed by KDH signing private key. This TR-34 key block is typically generated by the KDH Hardware Security Module (HSM) outside of Amazon Web Services Payment Cryptography.</p> </li> <li> <p> <code>SigningKeyCertificate</code>: The public key certificate in PEM format (base64 encoded) of the KDH signing key generated under the root certificate (CertificateAuthorityPublicKeyIdentifier) imported in Amazon Web Services Payment Cryptography.</p> </li> </ul> <p> <b>To import initial keys (KEK or ZMK or similar) using RSA Wrap and Unwrap</b> </p> <p>Using this operation, you can import initial key using asymmetric RSA wrap and unwrap key exchange method. To initiate import, call <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html">GetParametersForImport</a> with <code>KeyMaterial</code> set to <code>KEY_CRYPTOGRAM</code> to generate an import token. This operation also generates an encryption keypair for the purpose of key import, signs the key and returns back the wrapping key certificate in PEM format (base64 encoded) and its root certificate chain. The import token and associated KRD wrapping certificate expires after 30 days. </p> <p>You must trust and install the wrapping certificate and its certificate chain on the sending HSM and use it to wrap the key under export for WrappedKeyCryptogram generation. Next call <code>ImportKey</code> with <code>KeyMaterial</code> set to <code>KEY_CRYPTOGRAM</code> and provide the <code>ImportToken</code> and <code>KeyAttributes</code> for the key under import.</p> <p> <b>To import working keys using TR-31</b> </p> <p>Amazon Web Services Payment Cryptography uses TR-31 symmetric key exchange norm to import working keys. A KEK must be established within Amazon Web Services Payment Cryptography by using TR-34 key import or by using <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html">CreateKey</a>. To initiate a TR-31 key import, set the following parameters:</p> <ul> <li> <p> <code>KeyMaterial</code>: Use <code>Tr31KeyBlock</code> parameters.</p> </li> <li> <p> <code>WrappedKeyBlock</code>: The TR-31 wrapped key material. It contains the key under import, encrypted using KEK. The TR-31 key block is typically generated by a HSM outside of Amazon Web Services Payment Cryptography. </p> </li> <li> <p> <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> </li> </ul> <p> <b>To import working keys using ECDH</b> </p> <p>You can also use ECDH key agreement to import working keys as a TR-31 keyblock, where the wrapping key is an ECDH derived key.</p> <p>To initiate a TR-31 key import using ECDH, both sides must create an ECC key pair with key usage K3 and exchange public key certificates. In Amazon Web Services Payment Cryptography, you can do this by calling <code>CreateKey</code> and then <code>GetPublicKeyCertificate</code> to retrieve its public key certificate. Next, you can then generate a TR-31 WrappedKeyBlock using your own ECC key pair, the public certificate of the service's ECC key pair, and the key derivation parameters including key derivation function, hash algorithm, derivation data, and key algorithm. If you have not already done so, you must import the CA chain that issued the receiving public key certificate by calling <code>ImportKey</code> with input <code>RootCertificatePublicKey</code> for root CA or <code>TrustedPublicKey</code> for intermediate CA. To complete the TR-31 key import, you can use the following parameters. It is important that the ECDH key derivation parameters you use should match those used during import to derive the same shared wrapping key within Amazon Web Services Payment Cryptography.</p> <ul> <li> <p> <code>KeyMaterial</code>: Use <code>DiffieHellmanTr31KeyBlock</code> parameters.</p> </li> <li> <p> <code>PrivateKeyIdentifier</code>: The <code>KeyArn</code> of the ECC key pair created within Amazon Web Services Payment Cryptography to derive a shared KEK.</p> </li> <li> <p> <code>PublicKeyCertificate</code>: The public key certificate of the receiving ECC key pair in PEM format (base64 encoded) to derive a shared KEK.</p> </li> <li> <p> <code>CertificateAuthorityPublicKeyIdentifier</code>: The <code>keyARN</code> of the CA that signed the public key certificate of the receiving ECC key pair.</p> </li> </ul> <p> <b>Cross-account use:</b> This operation supports cross-account use when the key has a resource-based policy that grants access. For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html">Resource-based policies</a>.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ExportKey.html">ExportKey</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html">GetParametersForImport</a> </p> </li> </ul>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -155,6 +155,7 @@ declare const ImportKeyCommand_base: {
155
155
  * ReplicationRegions: [ // Regions
156
156
  * "STRING_VALUE",
157
157
  * ],
158
+ * RequesterComment: "STRING_VALUE",
158
159
  * };
159
160
  * const command = new ImportKeyCommand(input);
160
161
  * const response = await client.send(command);
@@ -198,6 +199,12 @@ declare const ImportKeyCommand_base: {
198
199
  * // },
199
200
  * // },
200
201
  * // UsingDefaultReplicationRegions: true || false,
202
+ * // MpaStatus: { // MpaStatus
203
+ * // MpaSessionArn: "STRING_VALUE", // required
204
+ * // Status: "STRING_VALUE", // required
205
+ * // InitiationDate: new Date("TIMESTAMP"), // required
206
+ * // StatusMessage: "STRING_VALUE",
207
+ * // },
201
208
  * // },
202
209
  * // };
203
210
  *
@@ -27,7 +27,7 @@ declare const ListTagsForResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Lists the tags for an Amazon Web Services resource.</p> <p>This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a <code>NextToken</code> value. Use this value in a subsequent <code>ListTagsForResource</code> request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.</p> <p> <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html">TagResource</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UntagResource.html">UntagResource</a> </p> </li> </ul>
30
+ * <p>Lists the tags for an Amazon Web Services resource.</p> <p>This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a <code>NextToken</code> value. Use this value in a subsequent <code>ListTagsForResource</code> request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.</p> <p> <b>Cross-account use:</b> This operation supports cross-account use when the key has a resource-based policy that grants access. For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html">Resource-based policies</a>.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html">TagResource</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UntagResource.html">UntagResource</a> </p> </li> </ul>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -0,0 +1,103 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { PutResourcePolicyInput, PutResourcePolicyOutput } from "../models/models_0";
4
+ import type { PaymentCryptographyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PaymentCryptographyClient";
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 PutResourcePolicyInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link PutResourcePolicyCommand}.
21
+ */
22
+ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyOutput, __MetadataBearer {
23
+ }
24
+ declare const PutResourcePolicyCommand_base: {
25
+ new (input: PutResourcePolicyCommandInput): import("@smithy/smithy-client").CommandImpl<PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput, PaymentCryptographyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: PutResourcePolicyCommandInput): import("@smithy/smithy-client").CommandImpl<PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput, PaymentCryptographyClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Attaches or replaces a resource-based policy on an Amazon Web Services Payment Cryptography key. A resource-based policy can grant cross-account access to your key.</p> <p>If the policy would grant public access, the request fails with a <code>PublicPolicyException</code>.</p> <p>To remove a resource-based policy from a key, use <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteResourcePolicy.html">DeleteResourcePolicy</a>.</p> <p> <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetResourcePolicy.html">GetResourcePolicy</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteResourcePolicy.html">DeleteResourcePolicy</a> </p> </li> </ul>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { PaymentCryptographyClient, PutResourcePolicyCommand } from "@aws-sdk/client-payment-cryptography"; // ES Modules import
35
+ * // const { PaymentCryptographyClient, PutResourcePolicyCommand } = require("@aws-sdk/client-payment-cryptography"); // CommonJS import
36
+ * // import type { PaymentCryptographyClientConfig } from "@aws-sdk/client-payment-cryptography";
37
+ * const config = {}; // type is PaymentCryptographyClientConfig
38
+ * const client = new PaymentCryptographyClient(config);
39
+ * const input = { // PutResourcePolicyInput
40
+ * ResourceArn: "STRING_VALUE", // required
41
+ * Policy: "STRING_VALUE", // required
42
+ * };
43
+ * const command = new PutResourcePolicyCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // PutResourcePolicyOutput
46
+ * // ResourceArn: "STRING_VALUE", // required
47
+ * // Policy: "STRING_VALUE", // required
48
+ * // };
49
+ *
50
+ * ```
51
+ *
52
+ * @param PutResourcePolicyCommandInput - {@link PutResourcePolicyCommandInput}
53
+ * @returns {@link PutResourcePolicyCommandOutput}
54
+ * @see {@link PutResourcePolicyCommandInput} for command's `input` shape.
55
+ * @see {@link PutResourcePolicyCommandOutput} for command's `response` shape.
56
+ * @see {@link PaymentCryptographyClientResolvedConfig | config} for PaymentCryptographyClient's `config` shape.
57
+ *
58
+ * @throws {@link AccessDeniedException} (client fault)
59
+ * <p>You do not have sufficient access to perform this action.</p> <p>This exception is thrown when the caller lacks the necessary IAM permissions to perform the requested operation. Verify that your IAM policy includes the required permissions for the specific Amazon Web Services Payment Cryptography action you're attempting.</p>
60
+ *
61
+ * @throws {@link ConflictException} (client fault)
62
+ * <p>This request can cause an inconsistent state for the resource.</p> <p>The requested operation conflicts with the current state of the resource. For example, attempting to delete a key that is currently being used, or trying to create a resource that already exists.</p>
63
+ *
64
+ * @throws {@link InternalServerException} (server fault)
65
+ * <p>The request processing has failed because of an unknown error, exception, or failure.</p> <p>This indicates a server-side error within the Amazon Web Services Payment Cryptography service. If this error persists, contact support for assistance.</p>
66
+ *
67
+ * @throws {@link PublicPolicyException} (client fault)
68
+ * <p>The resource-based policy would grant public access to the key.</p> <p>Modify the policy to restrict access to specific principals and resubmit the request.</p>
69
+ *
70
+ * @throws {@link ResourceNotFoundException} (client fault)
71
+ * <p>The request was denied due to resource not found.</p> <p>The specified key, alias, or other resource does not exist in your account or region. Verify that the resource identifier is correct and that the resource exists in the expected region.</p>
72
+ *
73
+ * @throws {@link ServiceQuotaExceededException} (client fault)
74
+ * <p>This request would cause a service quota to be exceeded.</p> <p>You have reached the maximum number of keys, aliases, or other resources allowed in your account. Review your current usage and consider deleting unused resources or requesting a quota increase.</p>
75
+ *
76
+ * @throws {@link ServiceUnavailableException} (server fault)
77
+ * <p>The service cannot complete the request.</p> <p>The Amazon Web Services Payment Cryptography service is temporarily unavailable. This is typically a temporary condition - retry your request after a brief delay.</p>
78
+ *
79
+ * @throws {@link ThrottlingException} (client fault)
80
+ * <p>The request was denied due to request throttling.</p> <p>You have exceeded the rate limits for Amazon Web Services Payment Cryptography API calls. Implement exponential backoff and retry logic in your application to handle throttling gracefully.</p>
81
+ *
82
+ * @throws {@link ValidationException} (client fault)
83
+ * <p>The request was denied due to an invalid request error.</p> <p>One or more parameters in your request are invalid. Check the parameter values, formats, and constraints specified in the API documentation.</p>
84
+ *
85
+ * @throws {@link PaymentCryptographyServiceException}
86
+ * <p>Base exception class for all service exceptions from PaymentCryptography service.</p>
87
+ *
88
+ *
89
+ * @public
90
+ */
91
+ export declare class PutResourcePolicyCommand extends PutResourcePolicyCommand_base {
92
+ /** @internal type navigation helper, not in runtime. */
93
+ protected static __types: {
94
+ api: {
95
+ input: PutResourcePolicyInput;
96
+ output: PutResourcePolicyOutput;
97
+ };
98
+ sdk: {
99
+ input: PutResourcePolicyCommandInput;
100
+ output: PutResourcePolicyCommandOutput;
101
+ };
102
+ };
103
+ }
@@ -27,7 +27,7 @@ declare const RemoveKeyReplicationRegionsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Removes Replication Regions from an existing Amazon Web Services Payment Cryptography key, disabling the key's availability for cryptographic operations in the specified Amazon Web Services Regions.</p> <p>When you remove Replication Regions, the key material is securely deleted from those regions and can no longer be used for cryptographic operations there. This operation is irreversible for the specified Amazon Web Services Regions. For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-multi-region-replication.html">Multi-Region key replication</a>.</p> <important> <p>Ensure that no active cryptographic operations or applications depend on the key in the regions you're removing before performing this operation.</p> </important> <p> <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_AddKeyReplicationRegions.html">AddKeyReplicationRegions</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DisableDefaultKeyReplicationRegions.html">DisableDefaultKeyReplicationRegions</a> </p> </li> </ul>
30
+ * <p>Removes Replication Regions from an existing Amazon Web Services Payment Cryptography key, disabling the key's availability for cryptographic operations in the specified Amazon Web Services Regions.</p> <p>When you remove Replication Regions, the key material is securely deleted from those regions and can no longer be used for cryptographic operations there. This operation is irreversible for the specified Amazon Web Services Regions. For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-multi-region-replication.html">Multi-Region key replication</a>.</p> <important> <p>Ensure that no active cryptographic operations or applications depend on the key in the regions you're removing before performing this operation.</p> </important> <p> <b>Cross-account use:</b> This operation supports cross-account use when the key has a resource-based policy that grants access. For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html">Resource-based policies</a>.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_AddKeyReplicationRegions.html">AddKeyReplicationRegions</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DisableDefaultKeyReplicationRegions.html">DisableDefaultKeyReplicationRegions</a> </p> </li> </ul>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -84,6 +84,12 @@ declare const RemoveKeyReplicationRegionsCommand_base: {
84
84
  * // },
85
85
  * // },
86
86
  * // UsingDefaultReplicationRegions: true || false,
87
+ * // MpaStatus: { // MpaStatus
88
+ * // MpaSessionArn: "STRING_VALUE", // required
89
+ * // Status: "STRING_VALUE", // required
90
+ * // InitiationDate: new Date("TIMESTAMP"), // required
91
+ * // StatusMessage: "STRING_VALUE",
92
+ * // },
87
93
  * // },
88
94
  * // };
89
95
  *
@@ -27,7 +27,7 @@ declare const RestoreKeyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Cancels a scheduled key deletion during the waiting period. Use this operation to restore a <code>Key</code> that is scheduled for deletion.</p> <p>During the waiting period, the <code>KeyState</code> is <code>DELETE_PENDING</code> and <code>deletePendingTimestamp</code> contains the date and time after which the <code>Key</code> will be deleted. After <code>Key</code> is restored, the <code>KeyState</code> is <code>CREATE_COMPLETE</code>, and the value for <code>deletePendingTimestamp</code> is removed.</p> <p> <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html">DeleteKey</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StartKeyUsage.html">StartKeyUsage</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StopKeyUsage.html">StopKeyUsage</a> </p> </li> </ul>
30
+ * <p>Cancels a scheduled key deletion during the waiting period. Use this operation to restore a <code>Key</code> that is scheduled for deletion.</p> <p>During the waiting period, the <code>KeyState</code> is <code>DELETE_PENDING</code> and <code>deletePendingTimestamp</code> contains the date and time after which the <code>Key</code> will be deleted. After <code>Key</code> is restored, the <code>KeyState</code> is <code>CREATE_COMPLETE</code>, and the value for <code>deletePendingTimestamp</code> is removed.</p> <p> <b>Cross-account use:</b> This operation supports cross-account use when the key has a resource-based policy that grants access. For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html">Resource-based policies</a>.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html">DeleteKey</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StartKeyUsage.html">StartKeyUsage</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StopKeyUsage.html">StopKeyUsage</a> </p> </li> </ul>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -81,6 +81,12 @@ declare const RestoreKeyCommand_base: {
81
81
  * // },
82
82
  * // },
83
83
  * // UsingDefaultReplicationRegions: true || false,
84
+ * // MpaStatus: { // MpaStatus
85
+ * // MpaSessionArn: "STRING_VALUE", // required
86
+ * // Status: "STRING_VALUE", // required
87
+ * // InitiationDate: new Date("TIMESTAMP"), // required
88
+ * // StatusMessage: "STRING_VALUE",
89
+ * // },
84
90
  * // },
85
91
  * // };
86
92
  *
@@ -27,7 +27,7 @@ declare const StartKeyUsageCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Enables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography</p> <p> <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StopKeyUsage.html">StopKeyUsage</a> </p> </li> </ul>
30
+ * <p>Enables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography</p> <p> <b>Cross-account use:</b> This operation supports cross-account use when the key has a resource-based policy that grants access. For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html">Resource-based policies</a>.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StopKeyUsage.html">StopKeyUsage</a> </p> </li> </ul>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -81,6 +81,12 @@ declare const StartKeyUsageCommand_base: {
81
81
  * // },
82
82
  * // },
83
83
  * // UsingDefaultReplicationRegions: true || false,
84
+ * // MpaStatus: { // MpaStatus
85
+ * // MpaSessionArn: "STRING_VALUE", // required
86
+ * // Status: "STRING_VALUE", // required
87
+ * // InitiationDate: new Date("TIMESTAMP"), // required
88
+ * // StatusMessage: "STRING_VALUE",
89
+ * // },
84
90
  * // },
85
91
  * // };
86
92
  *
@@ -27,7 +27,7 @@ declare const StopKeyUsageCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.</p> <p>You can use this operation instead of <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html">DeleteKey</a> to deactivate a key. You can enable the key in the future by calling <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StartKeyUsage.html">StartKeyUsage</a>.</p> <p> <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html">DeleteKey</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StartKeyUsage.html">StartKeyUsage</a> </p> </li> </ul>
30
+ * <p>Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.</p> <p>You can use this operation instead of <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html">DeleteKey</a> to deactivate a key. You can enable the key in the future by calling <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StartKeyUsage.html">StartKeyUsage</a>.</p> <p> <b>Cross-account use:</b> This operation supports cross-account use when the key has a resource-based policy that grants access. For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html">Resource-based policies</a>.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html">DeleteKey</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StartKeyUsage.html">StartKeyUsage</a> </p> </li> </ul>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -81,6 +81,12 @@ declare const StopKeyUsageCommand_base: {
81
81
  * // },
82
82
  * // },
83
83
  * // UsingDefaultReplicationRegions: true || false,
84
+ * // MpaStatus: { // MpaStatus
85
+ * // MpaSessionArn: "STRING_VALUE", // required
86
+ * // Status: "STRING_VALUE", // required
87
+ * // InitiationDate: new Date("TIMESTAMP"), // required
88
+ * // StatusMessage: "STRING_VALUE",
89
+ * // },
84
90
  * // },
85
91
  * // };
86
92
  *
@@ -27,7 +27,7 @@ declare const TagResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Adds or edits tags on an Amazon Web Services Payment Cryptography key.</p> <note> <p>Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.</p> </note> <p>Each tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. You can also add tags to an Amazon Web Services Payment Cryptography key when you create it with <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html">CreateKey</a>.</p> <p> <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UntagResource.html">UntagResource</a> </p> </li> </ul>
30
+ * <p>Adds or edits tags on an Amazon Web Services Payment Cryptography key.</p> <note> <p>Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.</p> </note> <p>Each tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. You can also add tags to an Amazon Web Services Payment Cryptography key when you create it with <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html">CreateKey</a>.</p> <p> <b>Cross-account use:</b> This operation supports cross-account use when the key has a resource-based policy that grants access. For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html">Resource-based policies</a>.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UntagResource.html">UntagResource</a> </p> </li> </ul>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -27,7 +27,7 @@ declare const UntagResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a tag from an Amazon Web Services Payment Cryptography key.</p> <note> <p>Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.</p> </note> <p> <b>Cross-account use:</b> This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html">TagResource</a> </p> </li> </ul>
30
+ * <p>Deletes a tag from an Amazon Web Services Payment Cryptography key.</p> <note> <p>Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.</p> </note> <p> <b>Cross-account use:</b> This operation supports cross-account use when the key has a resource-based policy that grants access. For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security_iam_resource-based-policies.html">Resource-based policies</a>.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html">TagResource</a> </p> </li> </ul>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -1,22 +1,28 @@
1
1
  export * from "./AddKeyReplicationRegionsCommand";
2
+ export * from "./AssociateMpaTeamCommand";
2
3
  export * from "./CreateAliasCommand";
3
4
  export * from "./CreateKeyCommand";
4
5
  export * from "./DeleteAliasCommand";
5
6
  export * from "./DeleteKeyCommand";
7
+ export * from "./DeleteResourcePolicyCommand";
6
8
  export * from "./DisableDefaultKeyReplicationRegionsCommand";
9
+ export * from "./DisassociateMpaTeamCommand";
7
10
  export * from "./EnableDefaultKeyReplicationRegionsCommand";
8
11
  export * from "./ExportKeyCommand";
9
12
  export * from "./GetAliasCommand";
10
13
  export * from "./GetCertificateSigningRequestCommand";
11
14
  export * from "./GetDefaultKeyReplicationRegionsCommand";
12
15
  export * from "./GetKeyCommand";
16
+ export * from "./GetMpaTeamAssociationCommand";
13
17
  export * from "./GetParametersForExportCommand";
14
18
  export * from "./GetParametersForImportCommand";
15
19
  export * from "./GetPublicKeyCertificateCommand";
20
+ export * from "./GetResourcePolicyCommand";
16
21
  export * from "./ImportKeyCommand";
17
22
  export * from "./ListAliasesCommand";
18
23
  export * from "./ListKeysCommand";
19
24
  export * from "./ListTagsForResourceCommand";
25
+ export * from "./PutResourcePolicyCommand";
20
26
  export * from "./RemoveKeyReplicationRegionsCommand";
21
27
  export * from "./RestoreKeyCommand";
22
28
  export * from "./StartKeyUsageCommand";