@aws-sdk/client-payment-cryptography 3.830.0 → 3.833.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 (29) hide show
  1. package/README.md +1 -5
  2. package/dist-cjs/index.js +10 -1
  3. package/dist-es/models/models_0.js +9 -0
  4. package/dist-types/PaymentCryptography.d.ts +1 -5
  5. package/dist-types/PaymentCryptographyClient.d.ts +1 -5
  6. package/dist-types/commands/CreateAliasCommand.d.ts +1 -30
  7. package/dist-types/commands/CreateKeyCommand.d.ts +1 -26
  8. package/dist-types/commands/DeleteAliasCommand.d.ts +1 -29
  9. package/dist-types/commands/DeleteKeyCommand.d.ts +1 -25
  10. package/dist-types/commands/ExportKeyCommand.d.ts +2 -102
  11. package/dist-types/commands/GetAliasCommand.d.ts +1 -28
  12. package/dist-types/commands/GetKeyCommand.d.ts +1 -23
  13. package/dist-types/commands/GetParametersForExportCommand.d.ts +1 -19
  14. package/dist-types/commands/GetParametersForImportCommand.d.ts +1 -19
  15. package/dist-types/commands/GetPublicKeyCertificateCommand.d.ts +1 -4
  16. package/dist-types/commands/ImportKeyCommand.d.ts +2 -129
  17. package/dist-types/commands/ListAliasesCommand.d.ts +1 -30
  18. package/dist-types/commands/ListKeysCommand.d.ts +1 -26
  19. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -21
  20. package/dist-types/commands/RestoreKeyCommand.d.ts +1 -25
  21. package/dist-types/commands/StartKeyUsageCommand.d.ts +1 -13
  22. package/dist-types/commands/StopKeyUsageCommand.d.ts +1 -19
  23. package/dist-types/commands/TagResourceCommand.d.ts +1 -22
  24. package/dist-types/commands/UntagResourceCommand.d.ts +1 -21
  25. package/dist-types/commands/UpdateAliasCommand.d.ts +1 -28
  26. package/dist-types/index.d.ts +1 -5
  27. package/dist-types/models/models_0.d.ts +57 -91
  28. package/dist-types/ts3.4/models/models_0.d.ts +9 -0
  29. package/package.json +1 -1
@@ -19,10 +19,7 @@ export declare class AccessDeniedException extends __BaseException {
19
19
  */
20
20
  export interface Alias {
21
21
  /**
22
- * <p>A friendly name that you can use to refer to a key. The value must begin with <code>alias/</code>.</p>
23
- * <important>
24
- * <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
25
- * </important>
22
+ * <p>A friendly name that you can use to refer to a key. The value must begin with <code>alias/</code>.</p> <important> <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p> </important>
26
23
  * @public
27
24
  */
28
25
  AliasName: string | undefined;
@@ -50,10 +47,7 @@ export declare class ConflictException extends __BaseException {
50
47
  */
51
48
  export interface CreateAliasInput {
52
49
  /**
53
- * <p>A friendly name that you can use to refer to a key. An alias must begin with <code>alias/</code> followed by a name, for example <code>alias/ExampleAlias</code>. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-).</p>
54
- * <important>
55
- * <p>Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
56
- * </important>
50
+ * <p>A friendly name that you can use to refer to a key. An alias must begin with <code>alias/</code> followed by a name, for example <code>alias/ExampleAlias</code>. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-).</p> <important> <p>Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p> </important>
57
51
  * @public
58
52
  */
59
53
  AliasName: string | undefined;
@@ -205,8 +199,7 @@ export interface ListAliasesInput {
205
199
  */
206
200
  NextToken?: string | undefined;
207
201
  /**
208
- * <p>Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.</p>
209
- * <p>This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.</p>
202
+ * <p>Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.</p> <p>This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.</p>
210
203
  * @public
211
204
  */
212
205
  MaxResults?: number | undefined;
@@ -291,6 +284,10 @@ export declare const KeyAlgorithm: {
291
284
  readonly ECC_NIST_P256: "ECC_NIST_P256";
292
285
  readonly ECC_NIST_P384: "ECC_NIST_P384";
293
286
  readonly ECC_NIST_P521: "ECC_NIST_P521";
287
+ readonly HMAC_SHA224: "HMAC_SHA224";
288
+ readonly HMAC_SHA256: "HMAC_SHA256";
289
+ readonly HMAC_SHA384: "HMAC_SHA384";
290
+ readonly HMAC_SHA512: "HMAC_SHA512";
294
291
  readonly RSA_2048: "RSA_2048";
295
292
  readonly RSA_3072: "RSA_3072";
296
293
  readonly RSA_4096: "RSA_4096";
@@ -415,8 +412,7 @@ export interface KeyAttributes {
415
412
  */
416
413
  KeyClass: KeyClass | undefined;
417
414
  /**
418
- * <p>The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.</p>
419
- * <p>For symmetric keys, Amazon Web Services Payment Cryptography supports <code>AES</code> and <code>TDES</code> algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports <code>RSA</code> and <code>ECC_NIST</code> algorithms.</p>
415
+ * <p>The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.</p> <p>For symmetric keys, Amazon Web Services Payment Cryptography supports <code>AES</code> and <code>TDES</code> algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports <code>RSA</code> and <code>ECC_NIST</code> algorithms.</p>
420
416
  * @public
421
417
  */
422
418
  KeyAlgorithm: KeyAlgorithm | undefined;
@@ -433,6 +429,7 @@ export interface KeyAttributes {
433
429
  export declare const KeyCheckValueAlgorithm: {
434
430
  readonly ANSI_X9_24: "ANSI_X9_24";
435
431
  readonly CMAC: "CMAC";
432
+ readonly HMAC: "HMAC";
436
433
  };
437
434
  /**
438
435
  * @public
@@ -464,8 +461,7 @@ export interface CreateKeyInput {
464
461
  */
465
462
  KeyAttributes: KeyAttributes | undefined;
466
463
  /**
467
- * <p>The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.</p>
468
- * <p>For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.</p>
464
+ * <p>The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.</p> <p>For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.</p>
469
465
  * @public
470
466
  */
471
467
  KeyCheckValueAlgorithm?: KeyCheckValueAlgorithm | undefined;
@@ -480,19 +476,12 @@ export interface CreateKeyInput {
480
476
  */
481
477
  Enabled?: boolean | undefined;
482
478
  /**
483
- * <p>Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html">TagResource</a> operation.</p>
484
- * <p>Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. </p>
485
- * <important>
486
- * <p>Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
487
- * </important>
488
- * <note>
489
- * <p>Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.</p>
490
- * </note>
479
+ * <p>Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html">TagResource</a> operation.</p> <p>Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. </p> <important> <p>Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p> </important> <note> <p>Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.</p> </note>
491
480
  * @public
492
481
  */
493
482
  Tags?: Tag[] | undefined;
494
483
  /**
495
- * <p>The cryptographic usage of an ECDH derived key as defined in section A.5.2 of the TR-31 spec.</p>
484
+ * <p>The intended cryptographic usage of keys derived from the ECC key pair to be created.</p> <p>After creating an ECC key pair, you cannot change the intended cryptographic usage of keys derived from it using ECDH.</p>
496
485
  * @public
497
486
  */
498
487
  DeriveKeyUsage?: DeriveKeyUsage | undefined;
@@ -544,8 +533,7 @@ export interface Key {
544
533
  */
545
534
  KeyCheckValue: string | undefined;
546
535
  /**
547
- * <p>The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.</p>
548
- * <p>For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.</p>
536
+ * <p>The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.</p> <p>For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.</p>
549
537
  * @public
550
538
  */
551
539
  KeyCheckValueAlgorithm: KeyCheckValueAlgorithm | undefined;
@@ -636,7 +624,7 @@ export interface DeleteKeyOutput {
636
624
  Key: Key | undefined;
637
625
  }
638
626
  /**
639
- * <p>Derivation data used to derive an ECDH key.</p>
627
+ * <p>The shared information used when deriving a key using ECDH.</p>
640
628
  * @public
641
629
  */
642
630
  export type DiffieHellmanDerivationData = DiffieHellmanDerivationData.SharedInformationMember | DiffieHellmanDerivationData.$UnknownMember;
@@ -645,8 +633,7 @@ export type DiffieHellmanDerivationData = DiffieHellmanDerivationData.SharedInfo
645
633
  */
646
634
  export declare namespace DiffieHellmanDerivationData {
647
635
  /**
648
- * <p>A byte string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.</p>
649
- * <p>It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes, and re-using shared information for multiple ECDH key derivations is not recommended.</p>
636
+ * <p>A string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.</p> <p>It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes. It is not recommended to reuse shared information for multiple ECDH key derivations, as it could result in derived key material being the same across different derivations.</p>
650
637
  * @public
651
638
  */
652
639
  interface SharedInformationMember {
@@ -672,8 +659,7 @@ export declare namespace DiffieHellmanDerivationData {
672
659
  */
673
660
  export interface ExportDukptInitialKey {
674
661
  /**
675
- * <p>The KSN for IPEK generation using DUKPT. </p>
676
- * <p>KSN must be padded before sending to Amazon Web Services Payment Cryptography. KSN hex length should be 20 for a TDES_2KEY key or 24 for an AES key.</p>
662
+ * <p>The KSN for IPEK generation using DUKPT. </p> <p>KSN must be padded before sending to Amazon Web Services Payment Cryptography. KSN hex length should be 20 for a TDES_2KEY key or 24 for an AES key.</p>
677
663
  * @public
678
664
  */
679
665
  KeySerialNumber: string | undefined;
@@ -689,8 +675,7 @@ export interface ExportAttributes {
689
675
  */
690
676
  ExportDukptInitialKey?: ExportDukptInitialKey | undefined;
691
677
  /**
692
- * <p>The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity. Specify KCV for IPEK export only.</p>
693
- * <p>For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.</p>
678
+ * <p>The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity. Specify KCV for IPEK export only.</p> <p>For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.</p>
694
679
  * @public
695
680
  */
696
681
  KeyCheckValueAlgorithm?: KeyCheckValueAlgorithm | undefined;
@@ -703,6 +688,10 @@ export declare const SymmetricKeyAlgorithm: {
703
688
  readonly AES_128: "AES_128";
704
689
  readonly AES_192: "AES_192";
705
690
  readonly AES_256: "AES_256";
691
+ readonly HMAC_SHA224: "HMAC_SHA224";
692
+ readonly HMAC_SHA256: "HMAC_SHA256";
693
+ readonly HMAC_SHA384: "HMAC_SHA384";
694
+ readonly HMAC_SHA512: "HMAC_SHA512";
706
695
  readonly TDES_2KEY: "TDES_2KEY";
707
696
  readonly TDES_3KEY: "TDES_3KEY";
708
697
  };
@@ -734,8 +723,7 @@ export interface KeyBlockHeaders {
734
723
  */
735
724
  KeyModesOfUse?: KeyModesOfUse | undefined;
736
725
  /**
737
- * <p>Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.</p>
738
- * <p>When set to <code>EXPORTABLE</code>, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to <code>NON_EXPORTABLE</code>, the key cannot be subsequently exported by the receiver. When set to <code>SENSITIVE</code>, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to <a href="https://webstore.ansi.org/standards/ascx9/ansix91432022">ANSI X9.143-2022</a>.</p>
726
+ * <p>Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.</p> <p>When set to <code>EXPORTABLE</code>, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to <code>NON_EXPORTABLE</code>, the key cannot be subsequently exported by the receiver. When set to <code>SENSITIVE</code>, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to <a href="https://webstore.ansi.org/standards/ascx9/ansix91432022">ANSI X9.143-2022</a>.</p>
739
727
  * @public
740
728
  */
741
729
  KeyExportability?: KeyExportability | undefined;
@@ -745,8 +733,7 @@ export interface KeyBlockHeaders {
745
733
  */
746
734
  KeyVersion?: string | undefined;
747
735
  /**
748
- * <p>Parameter used to indicate the type of optional data in key block headers. Refer to <a href="https://webstore.ansi.org/standards/ascx9/ansix91432022">ANSI X9.143-2022</a> for information on allowed data type for optional blocks.</p>
749
- * <p>Optional block character limit is 112 characters. For each optional block, 2 characters are reserved for optional block ID and 2 characters reserved for optional block length. More than one optional blocks can be included as long as the combined length does not increase 112 characters.</p>
736
+ * <p>Parameter used to indicate the type of optional data in key block headers. Refer to <a href="https://webstore.ansi.org/standards/ascx9/ansix91432022">ANSI X9.143-2022</a> for information on allowed data type for optional blocks.</p> <p>Optional block character limit is 112 characters. For each optional block, 2 characters are reserved for optional block ID and 2 characters reserved for optional block length. More than one optional blocks can be included as long as the combined length does not increase 112 characters.</p>
750
737
  * @public
751
738
  */
752
739
  OptionalBlocks?: Record<string, string> | undefined;
@@ -777,42 +764,42 @@ export declare const KeyDerivationHashAlgorithm: {
777
764
  */
778
765
  export type KeyDerivationHashAlgorithm = (typeof KeyDerivationHashAlgorithm)[keyof typeof KeyDerivationHashAlgorithm];
779
766
  /**
780
- * <p>Parameter information for key material export using the asymmetric ECDH key exchange method.</p>
767
+ * <p>Key derivation parameter information for key material export using asymmetric ECDH key exchange method.</p>
781
768
  * @public
782
769
  */
783
770
  export interface ExportDiffieHellmanTr31KeyBlock {
784
771
  /**
785
- * <p>The <code>keyARN</code> of the asymmetric ECC key.</p>
772
+ * <p>The <code>keyARN</code> of the asymmetric ECC key created within Amazon Web Services Payment Cryptography.</p>
786
773
  * @public
787
774
  */
788
775
  PrivateKeyIdentifier: string | undefined;
789
776
  /**
790
- * <p>The <code>keyARN</code> of the certificate that signed the client's <code>PublicKeyCertificate</code>.</p>
777
+ * <p>The <code>keyARN</code> of the CA that signed the <code>PublicKeyCertificate</code> for the client's receiving ECC key pair.</p>
791
778
  * @public
792
779
  */
793
780
  CertificateAuthorityPublicKeyIdentifier: string | undefined;
794
781
  /**
795
- * <p>The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.</p>
782
+ * <p>The public key certificate of the client's receiving ECC key pair, in PEM format (base64 encoded), to use for ECDH key derivation.</p>
796
783
  * @public
797
784
  */
798
785
  PublicKeyCertificate: string | undefined;
799
786
  /**
800
- * <p>The key algorithm of the derived ECDH key.</p>
787
+ * <p>The key algorithm of the shared derived ECDH key.</p>
801
788
  * @public
802
789
  */
803
790
  DeriveKeyAlgorithm: SymmetricKeyAlgorithm | undefined;
804
791
  /**
805
- * <p>The key derivation function to use for deriving a key using ECDH.</p>
792
+ * <p>The key derivation function to use when deriving a key using ECDH.</p>
806
793
  * @public
807
794
  */
808
795
  KeyDerivationFunction: KeyDerivationFunction | undefined;
809
796
  /**
810
- * <p>The hash type to use for deriving a key using ECDH.</p>
797
+ * <p>The hash type to use when deriving a key using ECDH.</p>
811
798
  * @public
812
799
  */
813
800
  KeyDerivationHashAlgorithm: KeyDerivationHashAlgorithm | undefined;
814
801
  /**
815
- * <p>Derivation data used to derive an ECDH key.</p>
802
+ * <p>The shared information used when deriving a key using ECDH.</p>
816
803
  * @public
817
804
  */
818
805
  DerivationData: DiffieHellmanDerivationData | undefined;
@@ -898,7 +885,7 @@ export interface ExportTr34KeyBlock {
898
885
  */
899
886
  WrappingKeyCertificate: string | undefined;
900
887
  /**
901
- * <p>The export token to initiate key export from Amazon Web Services Payment Cryptography. It also contains the signing key certificate that will sign the wrapped key during TR-34 key block generation. Call <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForExport.html">GetParametersForExport</a> to receive an export token. It expires after 7 days. You can use the same export token to export multiple keys from the same service account.</p>
888
+ * <p>The export token to initiate key export from Amazon Web Services Payment Cryptography. It also contains the signing key certificate that will sign the wrapped key during TR-34 key block generation. Call <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForExport.html">GetParametersForExport</a> to receive an export token. It expires after 30 days. You can use the same export token to export multiple keys from the same service account.</p>
902
889
  * @public
903
890
  */
904
891
  ExportToken: string | undefined;
@@ -961,7 +948,7 @@ export declare namespace ExportKeyMaterial {
961
948
  $unknown?: never;
962
949
  }
963
950
  /**
964
- * <p>Parameter information for key material export using the asymmetric ECDH key exchange method.</p>
951
+ * <p>Key derivation parameter information for key material export using asymmetric ECDH key exchange method.</p>
965
952
  * @public
966
953
  */
967
954
  interface DiffieHellmanTr31KeyBlockMember {
@@ -1049,8 +1036,7 @@ export interface WrappedKey {
1049
1036
  */
1050
1037
  KeyCheckValue?: string | undefined;
1051
1038
  /**
1052
- * <p>The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.</p>
1053
- * <p>For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.</p>
1039
+ * <p>The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.</p> <p>For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.</p>
1054
1040
  * @public
1055
1041
  */
1056
1042
  KeyCheckValueAlgorithm?: KeyCheckValueAlgorithm | undefined;
@@ -1120,7 +1106,7 @@ export interface GetParametersForExportInput {
1120
1106
  */
1121
1107
  export interface GetParametersForExportOutput {
1122
1108
  /**
1123
- * <p>The signing key certificate in PEM format (base64 encoded) of the public key for signature within the TR-34 key block. The certificate expires after 7 days.</p>
1109
+ * <p>The signing key certificate in PEM format (base64 encoded) of the public key for signature within the TR-34 key block. The certificate expires after 30 days.</p>
1124
1110
  * @public
1125
1111
  */
1126
1112
  SigningKeyCertificate: string | undefined;
@@ -1135,7 +1121,7 @@ export interface GetParametersForExportOutput {
1135
1121
  */
1136
1122
  SigningKeyAlgorithm: KeyAlgorithm | undefined;
1137
1123
  /**
1138
- * <p>The export token to initiate key export from Amazon Web Services Payment Cryptography. The export token expires after 7 days. You can use the same export token to export multiple keys from the same service account.</p>
1124
+ * <p>The export token to initiate key export from Amazon Web Services Payment Cryptography. The export token expires after 30 days. You can use the same export token to export multiple keys from the same service account.</p>
1139
1125
  * @public
1140
1126
  */
1141
1127
  ExportToken: string | undefined;
@@ -1150,14 +1136,12 @@ export interface GetParametersForExportOutput {
1150
1136
  */
1151
1137
  export interface GetParametersForImportInput {
1152
1138
  /**
1153
- * <p>The method to use for key material import. Import token is only required for TR-34 WrappedKeyBlock (<code>TR34_KEY_BLOCK</code>) and RSA WrappedKeyCryptogram (<code>KEY_CRYPTOGRAM</code>).</p>
1154
- * <p>Import token is not required for TR-31, root public key cerificate or trusted public key certificate.</p>
1139
+ * <p>The method to use for key material import. Import token is only required for TR-34 WrappedKeyBlock (<code>TR34_KEY_BLOCK</code>) and RSA WrappedKeyCryptogram (<code>KEY_CRYPTOGRAM</code>).</p> <p>Import token is not required for TR-31, root public key cerificate or trusted public key certificate.</p>
1155
1140
  * @public
1156
1141
  */
1157
1142
  KeyMaterialType: KeyMaterialType | undefined;
1158
1143
  /**
1159
- * <p>The wrapping key algorithm to generate a wrapping key certificate. This certificate wraps the key under import.</p>
1160
- * <p>At this time, <code>RSA_2048</code> is the allowed algorithm for TR-34 WrappedKeyBlock import. Additionally, <code>RSA_2048</code>, <code>RSA_3072</code>, <code>RSA_4096</code> are the allowed algorithms for RSA WrappedKeyCryptogram import.</p>
1144
+ * <p>The wrapping key algorithm to generate a wrapping key certificate. This certificate wraps the key under import.</p> <p>At this time, <code>RSA_2048</code> is the allowed algorithm for TR-34 WrappedKeyBlock import. Additionally, <code>RSA_2048</code>, <code>RSA_3072</code>, <code>RSA_4096</code> are the allowed algorithms for RSA WrappedKeyCryptogram import.</p>
1161
1145
  * @public
1162
1146
  */
1163
1147
  WrappingKeyAlgorithm: KeyAlgorithm | undefined;
@@ -1167,7 +1151,7 @@ export interface GetParametersForImportInput {
1167
1151
  */
1168
1152
  export interface GetParametersForImportOutput {
1169
1153
  /**
1170
- * <p>The wrapping key certificate in PEM format (base64 encoded) of the wrapping key for use within the TR-34 key block. The certificate expires in 7 days.</p>
1154
+ * <p>The wrapping key certificate in PEM format (base64 encoded) of the wrapping key for use within the TR-34 key block. The certificate expires in 30 days.</p>
1171
1155
  * @public
1172
1156
  */
1173
1157
  WrappingKeyCertificate: string | undefined;
@@ -1182,7 +1166,7 @@ export interface GetParametersForImportOutput {
1182
1166
  */
1183
1167
  WrappingKeyAlgorithm: KeyAlgorithm | undefined;
1184
1168
  /**
1185
- * <p>The import token to initiate key import into Amazon Web Services Payment Cryptography. The import token expires after 7 days. You can use the same import token to import multiple keys to the same service account.</p>
1169
+ * <p>The import token to initiate key import into Amazon Web Services Payment Cryptography. The import token expires after 30 days. You can use the same import token to import multiple keys to the same service account.</p>
1186
1170
  * @public
1187
1171
  */
1188
1172
  ImportToken: string | undefined;
@@ -1218,42 +1202,42 @@ export interface GetPublicKeyCertificateOutput {
1218
1202
  KeyCertificateChain: string | undefined;
1219
1203
  }
1220
1204
  /**
1221
- * <p>Parameter information for key material import using the asymmetric ECDH key exchange method.</p>
1205
+ * <p>Key derivation parameter information for key material import using asymmetric ECDH key exchange method.</p>
1222
1206
  * @public
1223
1207
  */
1224
1208
  export interface ImportDiffieHellmanTr31KeyBlock {
1225
1209
  /**
1226
- * <p>The <code>keyARN</code> of the asymmetric ECC key.</p>
1210
+ * <p>The <code>keyARN</code> of the asymmetric ECC key created within Amazon Web Services Payment Cryptography.</p>
1227
1211
  * @public
1228
1212
  */
1229
1213
  PrivateKeyIdentifier: string | undefined;
1230
1214
  /**
1231
- * <p>The <code>keyARN</code> of the certificate that signed the client's <code>PublicKeyCertificate</code>.</p>
1215
+ * <p>The <code>keyARN</code> of the CA that signed the <code>PublicKeyCertificate</code> for the client's receiving ECC key pair.</p>
1232
1216
  * @public
1233
1217
  */
1234
1218
  CertificateAuthorityPublicKeyIdentifier: string | undefined;
1235
1219
  /**
1236
- * <p>The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.</p>
1220
+ * <p>The public key certificate of the client's receiving ECC key pair, in PEM format (base64 encoded), to use for ECDH key derivation.</p>
1237
1221
  * @public
1238
1222
  */
1239
1223
  PublicKeyCertificate: string | undefined;
1240
1224
  /**
1241
- * <p>The key algorithm of the derived ECDH key.</p>
1225
+ * <p>The key algorithm of the shared derived ECDH key.</p>
1242
1226
  * @public
1243
1227
  */
1244
1228
  DeriveKeyAlgorithm: SymmetricKeyAlgorithm | undefined;
1245
1229
  /**
1246
- * <p>The key derivation function to use for deriving a key using ECDH.</p>
1230
+ * <p>The key derivation function to use when deriving a key using ECDH.</p>
1247
1231
  * @public
1248
1232
  */
1249
1233
  KeyDerivationFunction: KeyDerivationFunction | undefined;
1250
1234
  /**
1251
- * <p>The hash type to use for deriving a key using ECDH.</p>
1235
+ * <p>The hash type to use when deriving a key using ECDH.</p>
1252
1236
  * @public
1253
1237
  */
1254
1238
  KeyDerivationHashAlgorithm: KeyDerivationHashAlgorithm | undefined;
1255
1239
  /**
1256
- * <p>Derivation data used to derive an ECDH key.</p>
1240
+ * <p>The shared information used when deriving a key using ECDH.</p>
1257
1241
  * @public
1258
1242
  */
1259
1243
  DerivationData: DiffieHellmanDerivationData | undefined;
@@ -1284,7 +1268,7 @@ export interface ImportKeyCryptogram {
1284
1268
  */
1285
1269
  WrappedKeyCryptogram: string | undefined;
1286
1270
  /**
1287
- * <p>The import token that initiates key import using the asymmetric RSA wrap and unwrap key exchange method into AWS Payment Cryptography. It expires after 7 days. You can use the same import token to import multiple keys to the same service account.</p>
1271
+ * <p>The import token that initiates key import using the asymmetric RSA wrap and unwrap key exchange method into AWS Payment Cryptography. It expires after 30 days. You can use the same import token to import multiple keys to the same service account.</p>
1288
1272
  * @public
1289
1273
  */
1290
1274
  ImportToken: string | undefined;
@@ -1342,7 +1326,7 @@ export interface ImportTr34KeyBlock {
1342
1326
  */
1343
1327
  SigningKeyCertificate: string | undefined;
1344
1328
  /**
1345
- * <p>The import token that initiates key import using the asymmetric TR-34 key exchange method into Amazon Web Services Payment Cryptography. It expires after 7 days. You can use the same import token to import multiple keys to the same service account.</p>
1329
+ * <p>The import token that initiates key import using the asymmetric TR-34 key exchange method into Amazon Web Services Payment Cryptography. It expires after 30 days. You can use the same import token to import multiple keys to the same service account.</p>
1346
1330
  * @public
1347
1331
  */
1348
1332
  ImportToken: string | undefined;
@@ -1458,7 +1442,7 @@ export declare namespace ImportKeyMaterial {
1458
1442
  $unknown?: never;
1459
1443
  }
1460
1444
  /**
1461
- * <p>Parameter information for key material import using the asymmetric ECDH key exchange method.</p>
1445
+ * <p>Key derivation parameter information for key material import using asymmetric ECDH key exchange method.</p>
1462
1446
  * @public
1463
1447
  */
1464
1448
  interface DiffieHellmanTr31KeyBlockMember {
@@ -1503,8 +1487,7 @@ export interface ImportKeyInput {
1503
1487
  */
1504
1488
  KeyMaterial: ImportKeyMaterial | undefined;
1505
1489
  /**
1506
- * <p>The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.</p>
1507
- * <p>For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.</p>
1490
+ * <p>The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.</p> <p>For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.</p>
1508
1491
  * @public
1509
1492
  */
1510
1493
  KeyCheckValueAlgorithm?: KeyCheckValueAlgorithm | undefined;
@@ -1514,14 +1497,7 @@ export interface ImportKeyInput {
1514
1497
  */
1515
1498
  Enabled?: boolean | undefined;
1516
1499
  /**
1517
- * <p>Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is imported. To tag an existing Amazon Web Services Payment Cryptography key, use the <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html">TagResource</a> operation.</p>
1518
- * <p>Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.</p>
1519
- * <important>
1520
- * <p>Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
1521
- * </important>
1522
- * <note>
1523
- * <p>Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.</p>
1524
- * </note>
1500
+ * <p>Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is imported. To tag an existing Amazon Web Services Payment Cryptography key, use the <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html">TagResource</a> operation.</p> <p>Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.</p> <important> <p>Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p> </important> <note> <p>Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.</p> </note>
1525
1501
  * @public
1526
1502
  */
1527
1503
  Tags?: Tag[] | undefined;
@@ -1551,8 +1527,7 @@ export interface ListKeysInput {
1551
1527
  */
1552
1528
  NextToken?: string | undefined;
1553
1529
  /**
1554
- * <p>Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.</p>
1555
- * <p>This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.</p>
1530
+ * <p>Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.</p> <p>This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.</p>
1556
1531
  * @public
1557
1532
  */
1558
1533
  MaxResults?: number | undefined;
@@ -1683,8 +1658,7 @@ export interface ListTagsForResourceInput {
1683
1658
  */
1684
1659
  NextToken?: string | undefined;
1685
1660
  /**
1686
- * <p>Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.</p>
1687
- * <p>This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.</p>
1661
+ * <p>Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.</p> <p>This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.</p>
1688
1662
  * @public
1689
1663
  */
1690
1664
  MaxResults?: number | undefined;
@@ -1714,14 +1688,7 @@ export interface TagResourceInput {
1714
1688
  */
1715
1689
  ResourceArn: string | undefined;
1716
1690
  /**
1717
- * <p>One or more tags. Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the new one.</p>
1718
- * <important>
1719
- * <p>Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
1720
- * </important>
1721
- * <p>To use this parameter, you must have <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html">TagResource</a> permission in an IAM policy.</p>
1722
- * <important>
1723
- * <p>Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
1724
- * </important>
1691
+ * <p>One or more tags. Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the new one.</p> <important> <p>Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p> </important> <p>To use this parameter, you must have <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html">TagResource</a> permission in an IAM policy.</p> <important> <p>Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p> </important>
1725
1692
  * @public
1726
1693
  */
1727
1694
  Tags: Tag[] | undefined;
@@ -1741,8 +1708,7 @@ export interface UntagResourceInput {
1741
1708
  */
1742
1709
  ResourceArn: string | undefined;
1743
1710
  /**
1744
- * <p>One or more tag keys. Don't include the tag values.</p>
1745
- * <p>If the Amazon Web Services Payment Cryptography key doesn't have the specified tag key, Amazon Web Services Payment Cryptography doesn't throw an exception or return a response. To confirm that the operation succeeded, use the <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a> operation.</p>
1711
+ * <p>One or more tag keys. Don't include the tag values.</p> <p>If the Amazon Web Services Payment Cryptography key doesn't have the specified tag key, Amazon Web Services Payment Cryptography doesn't throw an exception or return a response. To confirm that the operation succeeded, use the <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a> operation.</p>
1746
1712
  * @public
1747
1713
  */
1748
1714
  TagKeys: string[] | undefined;
@@ -129,6 +129,10 @@ export declare const KeyAlgorithm: {
129
129
  readonly ECC_NIST_P256: "ECC_NIST_P256";
130
130
  readonly ECC_NIST_P384: "ECC_NIST_P384";
131
131
  readonly ECC_NIST_P521: "ECC_NIST_P521";
132
+ readonly HMAC_SHA224: "HMAC_SHA224";
133
+ readonly HMAC_SHA256: "HMAC_SHA256";
134
+ readonly HMAC_SHA384: "HMAC_SHA384";
135
+ readonly HMAC_SHA512: "HMAC_SHA512";
132
136
  readonly RSA_2048: "RSA_2048";
133
137
  readonly RSA_3072: "RSA_3072";
134
138
  readonly RSA_4096: "RSA_4096";
@@ -189,6 +193,7 @@ export interface KeyAttributes {
189
193
  export declare const KeyCheckValueAlgorithm: {
190
194
  readonly ANSI_X9_24: "ANSI_X9_24";
191
195
  readonly CMAC: "CMAC";
196
+ readonly HMAC: "HMAC";
192
197
  };
193
198
  export type KeyCheckValueAlgorithm =
194
199
  (typeof KeyCheckValueAlgorithm)[keyof typeof KeyCheckValueAlgorithm];
@@ -274,6 +279,10 @@ export declare const SymmetricKeyAlgorithm: {
274
279
  readonly AES_128: "AES_128";
275
280
  readonly AES_192: "AES_192";
276
281
  readonly AES_256: "AES_256";
282
+ readonly HMAC_SHA224: "HMAC_SHA224";
283
+ readonly HMAC_SHA256: "HMAC_SHA256";
284
+ readonly HMAC_SHA384: "HMAC_SHA384";
285
+ readonly HMAC_SHA512: "HMAC_SHA512";
277
286
  readonly TDES_2KEY: "TDES_2KEY";
278
287
  readonly TDES_3KEY: "TDES_3KEY";
279
288
  };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-payment-cryptography",
3
3
  "description": "AWS SDK for JavaScript Payment Cryptography Client for Node.js, Browser and React Native",
4
- "version": "3.830.0",
4
+ "version": "3.833.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-payment-cryptography",