@aws-sdk/client-payment-cryptography 3.462.0 → 3.468.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.
@@ -51,9 +51,9 @@ export declare class ConflictException extends __BaseException {
51
51
  export interface CreateAliasInput {
52
52
  /**
53
53
  * @public
54
- * <p>A friendly name that you can use to refer 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
+ * <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>
55
55
  * <important>
56
- * <p>Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
56
+ * <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>
57
57
  * </important>
58
58
  */
59
59
  AliasName: string | undefined;
@@ -155,6 +155,97 @@ export declare class ValidationException extends __BaseException {
155
155
  */
156
156
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
157
157
  }
158
+ /**
159
+ * @public
160
+ */
161
+ export interface DeleteAliasInput {
162
+ /**
163
+ * @public
164
+ * <p>A friendly name that you can use to refer Amazon Web Services Payment Cryptography key. This value must begin with <code>alias/</code> followed by a name, such as <code>alias/ExampleAlias</code>.</p>
165
+ */
166
+ AliasName: string | undefined;
167
+ }
168
+ /**
169
+ * @public
170
+ */
171
+ export interface DeleteAliasOutput {
172
+ }
173
+ /**
174
+ * @public
175
+ */
176
+ export interface GetAliasInput {
177
+ /**
178
+ * @public
179
+ * <p>The alias of the Amazon Web Services Payment Cryptography key.</p>
180
+ */
181
+ AliasName: string | undefined;
182
+ }
183
+ /**
184
+ * @public
185
+ */
186
+ export interface GetAliasOutput {
187
+ /**
188
+ * @public
189
+ * <p>The alias of the Amazon Web Services Payment Cryptography key.</p>
190
+ */
191
+ Alias: Alias | undefined;
192
+ }
193
+ /**
194
+ * @public
195
+ */
196
+ export interface ListAliasesInput {
197
+ /**
198
+ * @public
199
+ * <p>Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextToken</code> from the truncated response you just received.</p>
200
+ */
201
+ NextToken?: string;
202
+ /**
203
+ * @public
204
+ * <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>
205
+ * <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>
206
+ */
207
+ MaxResults?: number;
208
+ }
209
+ /**
210
+ * @public
211
+ */
212
+ export interface ListAliasesOutput {
213
+ /**
214
+ * @public
215
+ * <p>The list of aliases. Each alias describes the <code>KeyArn</code> contained within.</p>
216
+ */
217
+ Aliases: Alias[] | undefined;
218
+ /**
219
+ * @public
220
+ * <p>The token for the next set of results, or an empty or null value if there are no more results.</p>
221
+ */
222
+ NextToken?: string;
223
+ }
224
+ /**
225
+ * @public
226
+ */
227
+ export interface UpdateAliasInput {
228
+ /**
229
+ * @public
230
+ * <p>The alias whose associated key is changing.</p>
231
+ */
232
+ AliasName: string | undefined;
233
+ /**
234
+ * @public
235
+ * <p>The <code>KeyARN</code> for the key that you are updating or removing from the alias.</p>
236
+ */
237
+ KeyArn?: string;
238
+ }
239
+ /**
240
+ * @public
241
+ */
242
+ export interface UpdateAliasOutput {
243
+ /**
244
+ * @public
245
+ * <p>The alias name.</p>
246
+ */
247
+ Alias: Alias | undefined;
248
+ }
158
249
  /**
159
250
  * @public
160
251
  * @enum
@@ -336,8 +427,8 @@ export interface CreateKeyInput {
336
427
  KeyAttributes: KeyAttributes | undefined;
337
428
  /**
338
429
  * @public
339
- * <p>The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.</p>
340
- * <p>For DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.</p>
430
+ * <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>
431
+ * <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>
341
432
  */
342
433
  KeyCheckValueAlgorithm?: KeyCheckValueAlgorithm;
343
434
  /**
@@ -347,15 +438,15 @@ export interface CreateKeyInput {
347
438
  Exportable: boolean | undefined;
348
439
  /**
349
440
  * @public
350
- * <p>Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key not enabled, then it is created but not activated. The default value is enabled.</p>
441
+ * <p>Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key is not enabled, then it is created but not activated. The default value is enabled.</p>
351
442
  */
352
443
  Enabled?: boolean;
353
444
  /**
354
445
  * @public
355
- * <p>The tags to attach to the key. 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>
356
- * <p>To use this parameter, you must have <code>TagResource</code> permission.</p>
446
+ * <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>TagResource</a> operation.</p>
447
+ * <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>
357
448
  * <important>
358
- * <p>Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
449
+ * <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>
359
450
  * </important>
360
451
  * <note>
361
452
  * <p>Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.</p>
@@ -406,12 +497,13 @@ export interface Key {
406
497
  KeyAttributes: KeyAttributes | undefined;
407
498
  /**
408
499
  * @public
409
- * <p>The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.</p>
500
+ * <p>The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.</p>
410
501
  */
411
502
  KeyCheckValue: string | undefined;
412
503
  /**
413
504
  * @public
414
- * <p>The algorithm used for calculating key check value (KCV) for DES and AES keys. For a DES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For an AES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.</p>
505
+ * <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>
506
+ * <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>
415
507
  */
416
508
  KeyCheckValueAlgorithm: KeyCheckValueAlgorithm | undefined;
417
509
  /**
@@ -470,21 +562,6 @@ export interface CreateKeyOutput {
470
562
  */
471
563
  Key: Key | undefined;
472
564
  }
473
- /**
474
- * @public
475
- */
476
- export interface DeleteAliasInput {
477
- /**
478
- * @public
479
- * <p>A friendly name that you can use to refer Amazon Web Services Payment Cryptography key. This value must begin with <code>alias/</code> followed by a name, such as <code>alias/ExampleAlias</code>.</p>
480
- */
481
- AliasName: string | undefined;
482
- }
483
- /**
484
- * @public
485
- */
486
- export interface DeleteAliasOutput {
487
- }
488
565
  /**
489
566
  * @public
490
567
  */
@@ -512,7 +589,36 @@ export interface DeleteKeyOutput {
512
589
  }
513
590
  /**
514
591
  * @public
515
- * <p>Parameter information for key material export using TR-31 standard.</p>
592
+ * <p>Parameter information for IPEK generation during export.</p>
593
+ */
594
+ export interface ExportDukptInitialKey {
595
+ /**
596
+ * @public
597
+ * <p>The KSN for IPEK generation using DUKPT. </p>
598
+ * <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>
599
+ */
600
+ KeySerialNumber: string | undefined;
601
+ }
602
+ /**
603
+ * @public
604
+ * <p>The attributes for IPEK generation during export.</p>
605
+ */
606
+ export interface ExportAttributes {
607
+ /**
608
+ * @public
609
+ * <p>Parameter information for IPEK export.</p>
610
+ */
611
+ ExportDukptInitialKey?: ExportDukptInitialKey;
612
+ /**
613
+ * @public
614
+ * <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>
615
+ * <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>
616
+ */
617
+ KeyCheckValueAlgorithm?: KeyCheckValueAlgorithm;
618
+ }
619
+ /**
620
+ * @public
621
+ * <p>Parameter information for key material export using symmetric TR-31 key exchange method.</p>
516
622
  */
517
623
  export interface ExportTr31KeyBlock {
518
624
  /**
@@ -534,7 +640,7 @@ export declare const Tr34KeyBlockFormat: {
534
640
  export type Tr34KeyBlockFormat = (typeof Tr34KeyBlockFormat)[keyof typeof Tr34KeyBlockFormat];
535
641
  /**
536
642
  * @public
537
- * <p>Parameter information for key material export using TR-34 standard.</p>
643
+ * <p>Parameter information for key material export using the asymmetric TR-34 key exchange method.</p>
538
644
  */
539
645
  export interface ExportTr34KeyBlock {
540
646
  /**
@@ -565,7 +671,7 @@ export interface ExportTr34KeyBlock {
565
671
  }
566
672
  /**
567
673
  * @public
568
- * <p>Parameter information for key material export from Amazon Web Services Payment Cryptography.</p>
674
+ * <p>Parameter information for key material export from Amazon Web Services Payment Cryptography using TR-31 or TR-34 key exchange method.</p>
569
675
  */
570
676
  export type ExportKeyMaterial = ExportKeyMaterial.Tr31KeyBlockMember | ExportKeyMaterial.Tr34KeyBlockMember | ExportKeyMaterial.$UnknownMember;
571
677
  /**
@@ -574,7 +680,7 @@ export type ExportKeyMaterial = ExportKeyMaterial.Tr31KeyBlockMember | ExportKey
574
680
  export declare namespace ExportKeyMaterial {
575
681
  /**
576
682
  * @public
577
- * <p>Parameter information for key material export using TR-31 standard.</p>
683
+ * <p>Parameter information for key material export using symmetric TR-31 key exchange method.</p>
578
684
  */
579
685
  interface Tr31KeyBlockMember {
580
686
  Tr31KeyBlock: ExportTr31KeyBlock;
@@ -583,7 +689,7 @@ export declare namespace ExportKeyMaterial {
583
689
  }
584
690
  /**
585
691
  * @public
586
- * <p>Parameter information for key material export using TR-34 standard.</p>
692
+ * <p>Parameter information for key material export using the asymmetric TR-34 key exchange method.</p>
587
693
  */
588
694
  interface Tr34KeyBlockMember {
589
695
  Tr31KeyBlock?: never;
@@ -619,6 +725,11 @@ export interface ExportKeyInput {
619
725
  * <p>The <code>KeyARN</code> of the key under export from Amazon Web Services Payment Cryptography.</p>
620
726
  */
621
727
  ExportKeyIdentifier: string | undefined;
728
+ /**
729
+ * @public
730
+ * <p>The attributes for IPEK generation during export.</p>
731
+ */
732
+ ExportAttributes?: ExportAttributes;
622
733
  }
623
734
  /**
624
735
  * @public
@@ -635,7 +746,7 @@ export declare const WrappedKeyMaterialFormat: {
635
746
  export type WrappedKeyMaterialFormat = (typeof WrappedKeyMaterialFormat)[keyof typeof WrappedKeyMaterialFormat];
636
747
  /**
637
748
  * @public
638
- * <p>Parameter information for generating a wrapped key using TR-31 or TR-34 standard.</p>
749
+ * <p>Parameter information for generating a WrappedKeyBlock for key exchange.</p>
639
750
  */
640
751
  export interface WrappedKey {
641
752
  /**
@@ -650,39 +761,30 @@ export interface WrappedKey {
650
761
  WrappedKeyMaterialFormat: WrappedKeyMaterialFormat | undefined;
651
762
  /**
652
763
  * @public
653
- * <p>Parameter information for generating a wrapped key using TR-31 or TR-34 standard.</p>
764
+ * <p>Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.</p>
654
765
  */
655
766
  KeyMaterial: string | undefined;
656
- }
657
- /**
658
- * @public
659
- */
660
- export interface ExportKeyOutput {
661
767
  /**
662
768
  * @public
663
- * <p>The key material under export as a TR-34 or TR-31 wrapped key block.</p>
769
+ * <p>The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.</p>
664
770
  */
665
- WrappedKey?: WrappedKey;
666
- }
667
- /**
668
- * @public
669
- */
670
- export interface GetAliasInput {
771
+ KeyCheckValue?: string;
671
772
  /**
672
773
  * @public
673
- * <p>The alias of the Amazon Web Services Payment Cryptography key.</p>
774
+ * <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>
775
+ * <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>
674
776
  */
675
- AliasName: string | undefined;
777
+ KeyCheckValueAlgorithm?: KeyCheckValueAlgorithm;
676
778
  }
677
779
  /**
678
780
  * @public
679
781
  */
680
- export interface GetAliasOutput {
782
+ export interface ExportKeyOutput {
681
783
  /**
682
784
  * @public
683
- * <p>The alias of the Amazon Web Services Payment Cryptography key.</p>
785
+ * <p>The key material under export as a TR-34 WrappedKeyBlock or a TR-31 WrappedKeyBlock. </p>
684
786
  */
685
- Alias: Alias | undefined;
787
+ WrappedKey?: WrappedKey;
686
788
  }
687
789
  /**
688
790
  * @public
@@ -729,7 +831,7 @@ export interface GetParametersForExportInput {
729
831
  KeyMaterialType: KeyMaterialType | undefined;
730
832
  /**
731
833
  * @public
732
- * <p>The signing key algorithm to generate a signing key certificate. This certificate signs the wrapped key under export within the TR-34 key block cryptogram. <code>RSA_2048</code> is the only signing key algorithm allowed.</p>
834
+ * <p>The signing key algorithm to generate a signing key certificate. This certificate signs the wrapped key under export within the TR-34 key block. <code>RSA_2048</code> is the only signing key algorithm allowed.</p>
733
835
  */
734
836
  SigningKeyAlgorithm: KeyAlgorithm | undefined;
735
837
  }
@@ -739,12 +841,12 @@ export interface GetParametersForExportInput {
739
841
  export interface GetParametersForExportOutput {
740
842
  /**
741
843
  * @public
742
- * <p>The signing key certificate of the public key for signature within the TR-34 key block cryptogram. The certificate expires after 7 days.</p>
844
+ * <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>
743
845
  */
744
846
  SigningKeyCertificate: string | undefined;
745
847
  /**
746
848
  * @public
747
- * <p>The certificate chain that signed the signing key certificate. This is the root certificate authority (CA) within your service account.</p>
849
+ * <p>The root certificate authority (CA) that signed the signing key certificate in PEM format (base64 encoded).</p>
748
850
  */
749
851
  SigningKeyCertificateChain: string | undefined;
750
852
  /**
@@ -769,12 +871,14 @@ export interface GetParametersForExportOutput {
769
871
  export interface GetParametersForImportInput {
770
872
  /**
771
873
  * @public
772
- * <p>The key block format type such as TR-34 or TR-31 to use during key material import. Import token is only required for TR-34 key import <code>TR34_KEY_BLOCK</code>. Import token is not required for TR-31 key import.</p>
874
+ * <p>The method to use for key material import. Import token is only required for TR-34 WrappedKeyBlock (<code>TR34_KEY_BLOCK</code>).</p>
875
+ * <p>Import token is not required for TR-31, root public key cerificate or trusted public key certificate.</p>
773
876
  */
774
877
  KeyMaterialType: KeyMaterialType | undefined;
775
878
  /**
776
879
  * @public
777
- * <p>The wrapping key algorithm to generate a wrapping key certificate. This certificate wraps the key under import within the TR-34 key block cryptogram. <code>RSA_2048</code> is the only wrapping key algorithm allowed.</p>
880
+ * <p>The wrapping key algorithm to generate a wrapping key certificate. This certificate wraps the key under import.</p>
881
+ * <p>At this time, <code>RSA_2048</code>, <code>RSA_3072</code>, <code>RSA_4096</code> are the only allowed algorithms for TR-34 WrappedKeyBlock import.</p>
778
882
  */
779
883
  WrappingKeyAlgorithm: KeyAlgorithm | undefined;
780
884
  }
@@ -784,17 +888,17 @@ export interface GetParametersForImportInput {
784
888
  export interface GetParametersForImportOutput {
785
889
  /**
786
890
  * @public
787
- * <p>The wrapping key certificate of the wrapping key for use within the TR-34 key block. The certificate expires in 7 days.</p>
891
+ * <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>
788
892
  */
789
893
  WrappingKeyCertificate: string | undefined;
790
894
  /**
791
895
  * @public
792
- * <p>The Amazon Web Services Payment Cryptography certificate chain that signed the wrapping key certificate. This is the root certificate authority (CA) within your service account.</p>
896
+ * <p>The Amazon Web Services Payment Cryptography root certificate authority (CA) that signed the wrapping key certificate in PEM format (base64 encoded).</p>
793
897
  */
794
898
  WrappingKeyCertificateChain: string | undefined;
795
899
  /**
796
900
  * @public
797
- * <p>The algorithm of the wrapping key for use within TR-34 key block. <code>RSA_2048</code> is the only wrapping key algorithm allowed.</p>
901
+ * <p>The algorithm of the wrapping key for use within TR-34 WrappedKeyBlock.</p>
798
902
  */
799
903
  WrappingKeyAlgorithm: KeyAlgorithm | undefined;
800
904
  /**
@@ -824,12 +928,12 @@ export interface GetPublicKeyCertificateInput {
824
928
  export interface GetPublicKeyCertificateOutput {
825
929
  /**
826
930
  * @public
827
- * <p>The public key component of the asymmetric key pair in a certificate (PEM) format. It is signed by the root certificate authority (CA) within your service account. The certificate expires in 90 days.</p>
931
+ * <p>The public key component of the asymmetric key pair in a certificate PEM format (base64 encoded). It is signed by the root certificate authority (CA). The certificate expires in 90 days.</p>
828
932
  */
829
933
  KeyCertificate: string | undefined;
830
934
  /**
831
935
  * @public
832
- * <p>The certificate chain that signed the public key certificate of the asymmetric key pair. This is the root certificate authority (CA) within your service account.</p>
936
+ * <p>The root certificate authority (CA) that signed the public key certificate in PEM format (base64 encoded) of the asymmetric key pair.</p>
833
937
  */
834
938
  KeyCertificateChain: string | undefined;
835
939
  }
@@ -851,7 +955,7 @@ export interface RootCertificatePublicKey {
851
955
  }
852
956
  /**
853
957
  * @public
854
- * <p>Parameter information for key material import using TR-31 standard.</p>
958
+ * <p>Parameter information for key material import using symmetric TR-31 key exchange method.</p>
855
959
  */
856
960
  export interface ImportTr31KeyBlock {
857
961
  /**
@@ -861,13 +965,13 @@ export interface ImportTr31KeyBlock {
861
965
  WrappingKeyIdentifier: string | undefined;
862
966
  /**
863
967
  * @public
864
- * <p>The TR-34 wrapped key block to import.</p>
968
+ * <p>The TR-31 wrapped key block to import.</p>
865
969
  */
866
970
  WrappedKeyBlock: string | undefined;
867
971
  }
868
972
  /**
869
973
  * @public
870
- * <p>Parameter information for key material import using TR-34 standard.</p>
974
+ * <p>Parameter information for key material import using the asymmetric TR-34 key exchange method.</p>
871
975
  */
872
976
  export interface ImportTr34KeyBlock {
873
977
  /**
@@ -877,12 +981,12 @@ export interface ImportTr34KeyBlock {
877
981
  CertificateAuthorityPublicKeyIdentifier: string | undefined;
878
982
  /**
879
983
  * @public
880
- * <p>The public key component in PEM certificate format of the private key that signs the KDH TR-34 wrapped key block.</p>
984
+ * <p>The public key component in PEM certificate format of the private key that signs the KDH TR-34 WrappedKeyBlock.</p>
881
985
  */
882
986
  SigningKeyCertificate: string | undefined;
883
987
  /**
884
988
  * @public
885
- * <p>The import token that initiates key import 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>
989
+ * <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>
886
990
  */
887
991
  ImportToken: string | undefined;
888
992
  /**
@@ -924,7 +1028,7 @@ export interface TrustedCertificatePublicKey {
924
1028
  }
925
1029
  /**
926
1030
  * @public
927
- * <p>Parameter information for key material import.</p>
1031
+ * <p>Parameter information for key material import into Amazon Web Services Payment Cryptography using TR-31 or TR-34 key exchange method.</p>
928
1032
  */
929
1033
  export type ImportKeyMaterial = ImportKeyMaterial.RootCertificatePublicKeyMember | ImportKeyMaterial.Tr31KeyBlockMember | ImportKeyMaterial.Tr34KeyBlockMember | ImportKeyMaterial.TrustedCertificatePublicKeyMember | ImportKeyMaterial.$UnknownMember;
930
1034
  /**
@@ -955,7 +1059,7 @@ export declare namespace ImportKeyMaterial {
955
1059
  }
956
1060
  /**
957
1061
  * @public
958
- * <p>Parameter information for key material import using TR-31 standard.</p>
1062
+ * <p>Parameter information for key material import using symmetric TR-31 key exchange method.</p>
959
1063
  */
960
1064
  interface Tr31KeyBlockMember {
961
1065
  RootCertificatePublicKey?: never;
@@ -966,7 +1070,7 @@ export declare namespace ImportKeyMaterial {
966
1070
  }
967
1071
  /**
968
1072
  * @public
969
- * <p>Parameter information for key material import using TR-34 standard.</p>
1073
+ * <p>Parameter information for key material import using the asymmetric TR-34 key exchange method.</p>
970
1074
  */
971
1075
  interface Tr34KeyBlockMember {
972
1076
  RootCertificatePublicKey?: never;
@@ -1005,8 +1109,8 @@ export interface ImportKeyInput {
1005
1109
  KeyMaterial: ImportKeyMaterial | undefined;
1006
1110
  /**
1007
1111
  * @public
1008
- * <p>The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.</p>
1009
- * <p>For DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.</p>
1112
+ * <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>
1113
+ * <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>
1010
1114
  */
1011
1115
  KeyCheckValueAlgorithm?: KeyCheckValueAlgorithm;
1012
1116
  /**
@@ -1016,11 +1120,10 @@ export interface ImportKeyInput {
1016
1120
  Enabled?: boolean;
1017
1121
  /**
1018
1122
  * @public
1019
- * <p>The tags to attach to the key. 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>
1020
- * <p>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>
1021
- * <p>To use this parameter, you must have <code>TagResource</code> permission.</p>
1123
+ * <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>TagResource</a> operation.</p>
1124
+ * <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>
1022
1125
  * <important>
1023
- * <p>Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
1126
+ * <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>
1024
1127
  * </important>
1025
1128
  * <note>
1026
1129
  * <p>Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.</p>
@@ -1040,44 +1143,13 @@ export interface ImportKeyOutput {
1040
1143
  }
1041
1144
  /**
1042
1145
  * @public
1043
- * <p>Metadata about an Amazon Web Services Payment Cryptography key.</p>
1044
1146
  */
1045
- export interface KeySummary {
1046
- /**
1047
- * @public
1048
- * <p>The Amazon Resource Name (ARN) of the key.</p>
1049
- */
1050
- KeyArn: string | undefined;
1051
- /**
1052
- * @public
1053
- * <p>The state of an Amazon Web Services Payment Cryptography that is being created or deleted.</p>
1054
- */
1055
- KeyState: KeyState | undefined;
1056
- /**
1057
- * @public
1058
- * <p>The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.</p>
1059
- */
1060
- KeyAttributes: KeyAttributes | undefined;
1061
- /**
1062
- * @public
1063
- * <p>The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.</p>
1064
- */
1065
- KeyCheckValue: string | undefined;
1066
- /**
1067
- * @public
1068
- * <p>Specifies whether the key is exportable. This data is immutable after the key is created.</p>
1069
- */
1070
- Exportable: boolean | undefined;
1147
+ export interface ListKeysInput {
1071
1148
  /**
1072
1149
  * @public
1073
- * <p>Specifies whether the key is enabled. </p>
1150
+ * <p>The key state of the keys you want to list.</p>
1074
1151
  */
1075
- Enabled: boolean | undefined;
1076
- }
1077
- /**
1078
- * @public
1079
- */
1080
- export interface ListAliasesInput {
1152
+ KeyState?: KeyState;
1081
1153
  /**
1082
1154
  * @public
1083
1155
  * <p>Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextToken</code> from the truncated response you just received.</p>
@@ -1092,38 +1164,39 @@ export interface ListAliasesInput {
1092
1164
  }
1093
1165
  /**
1094
1166
  * @public
1167
+ * <p>Metadata about an Amazon Web Services Payment Cryptography key.</p>
1095
1168
  */
1096
- export interface ListAliasesOutput {
1169
+ export interface KeySummary {
1097
1170
  /**
1098
1171
  * @public
1099
- * <p>The list of aliases. Each alias describes the <code>KeyArn</code> contained within.</p>
1172
+ * <p>The Amazon Resource Name (ARN) of the key.</p>
1100
1173
  */
1101
- Aliases: Alias[] | undefined;
1174
+ KeyArn: string | undefined;
1102
1175
  /**
1103
1176
  * @public
1104
- * <p>The token for the next set of results, or an empty or null value if there are no more results.</p>
1177
+ * <p>The state of an Amazon Web Services Payment Cryptography that is being created or deleted.</p>
1105
1178
  */
1106
- NextToken?: string;
1107
- }
1108
- /**
1109
- * @public
1110
- */
1111
- export interface ListKeysInput {
1179
+ KeyState: KeyState | undefined;
1112
1180
  /**
1113
1181
  * @public
1114
- * <p>The key state of the keys you want to list.</p>
1182
+ * <p>The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.</p>
1115
1183
  */
1116
- KeyState?: KeyState;
1184
+ KeyAttributes: KeyAttributes | undefined;
1117
1185
  /**
1118
1186
  * @public
1119
- * <p>Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextToken</code> from the truncated response you just received.</p>
1187
+ * <p>The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.</p>
1120
1188
  */
1121
- NextToken?: string;
1189
+ KeyCheckValue: string | undefined;
1122
1190
  /**
1123
1191
  * @public
1124
- * <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>
1192
+ * <p>Specifies whether the key is exportable. This data is immutable after the key is created.</p>
1125
1193
  */
1126
- MaxResults?: number;
1194
+ Exportable: boolean | undefined;
1195
+ /**
1196
+ * @public
1197
+ * <p>Specifies whether the key is enabled. </p>
1198
+ */
1199
+ Enabled: boolean | undefined;
1127
1200
  }
1128
1201
  /**
1129
1202
  * @public
@@ -1143,62 +1216,47 @@ export interface ListKeysOutput {
1143
1216
  /**
1144
1217
  * @public
1145
1218
  */
1146
- export interface ListTagsForResourceInput {
1147
- /**
1148
- * @public
1149
- * <p>The <code>KeyARN</code> of the key whose tags you are getting.</p>
1150
- */
1151
- ResourceArn: string | undefined;
1152
- /**
1153
- * @public
1154
- * <p>Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextToken</code> from the truncated response you just received.</p>
1155
- */
1156
- NextToken?: string;
1219
+ export interface RestoreKeyInput {
1157
1220
  /**
1158
1221
  * @public
1159
- * <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>
1222
+ * <p>The <code>KeyARN</code> of the key to be restored within Amazon Web Services Payment Cryptography.</p>
1160
1223
  */
1161
- MaxResults?: number;
1224
+ KeyIdentifier: string | undefined;
1162
1225
  }
1163
1226
  /**
1164
1227
  * @public
1165
1228
  */
1166
- export interface ListTagsForResourceOutput {
1167
- /**
1168
- * @public
1169
- * <p>The list of tags associated with a <code>ResourceArn</code>. Each tag will list the key-value pair contained within that tag.</p>
1170
- */
1171
- Tags: Tag[] | undefined;
1229
+ export interface RestoreKeyOutput {
1172
1230
  /**
1173
1231
  * @public
1174
- * <p>The token for the next set of results, or an empty or null value if there are no more results.</p>
1232
+ * <p>The key material of the restored key. The <code>KeyState</code> will change to <code>CREATE_COMPLETE</code> and value for <code>DeletePendingTimestamp</code> gets removed. </p>
1175
1233
  */
1176
- NextToken?: string;
1234
+ Key: Key | undefined;
1177
1235
  }
1178
1236
  /**
1179
1237
  * @public
1180
1238
  */
1181
- export interface RestoreKeyInput {
1239
+ export interface StartKeyUsageInput {
1182
1240
  /**
1183
1241
  * @public
1184
- * <p>The <code>KeyARN</code> of the key to be restored within Amazon Web Services Payment Cryptography.</p>
1242
+ * <p>The <code>KeyArn</code> of the key.</p>
1185
1243
  */
1186
1244
  KeyIdentifier: string | undefined;
1187
1245
  }
1188
1246
  /**
1189
1247
  * @public
1190
1248
  */
1191
- export interface RestoreKeyOutput {
1249
+ export interface StartKeyUsageOutput {
1192
1250
  /**
1193
1251
  * @public
1194
- * <p>The key material of the restored key. The <code>KeyState</code> will change to <code>CREATE_COMPLETE</code> and value for <code>DeletePendingTimestamp</code> gets removed. </p>
1252
+ * <p>The <code>KeyARN</code> of the Amazon Web Services Payment Cryptography key activated for use.</p>
1195
1253
  */
1196
1254
  Key: Key | undefined;
1197
1255
  }
1198
1256
  /**
1199
1257
  * @public
1200
1258
  */
1201
- export interface StartKeyUsageInput {
1259
+ export interface StopKeyUsageInput {
1202
1260
  /**
1203
1261
  * @public
1204
1262
  * <p>The <code>KeyArn</code> of the key.</p>
@@ -1208,32 +1266,48 @@ export interface StartKeyUsageInput {
1208
1266
  /**
1209
1267
  * @public
1210
1268
  */
1211
- export interface StartKeyUsageOutput {
1269
+ export interface StopKeyUsageOutput {
1212
1270
  /**
1213
1271
  * @public
1214
- * <p>The <code>KeyARN</code> of the Amazon Web Services Payment Cryptography key activated for use.</p>
1272
+ * <p>The <code>KeyARN</code> of the key.</p>
1215
1273
  */
1216
1274
  Key: Key | undefined;
1217
1275
  }
1218
1276
  /**
1219
1277
  * @public
1220
1278
  */
1221
- export interface StopKeyUsageInput {
1279
+ export interface ListTagsForResourceInput {
1222
1280
  /**
1223
1281
  * @public
1224
- * <p>The <code>KeyArn</code> of the key.</p>
1282
+ * <p>The <code>KeyARN</code> of the key whose tags you are getting.</p>
1225
1283
  */
1226
- KeyIdentifier: string | undefined;
1284
+ ResourceArn: string | undefined;
1285
+ /**
1286
+ * @public
1287
+ * <p>Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextToken</code> from the truncated response you just received.</p>
1288
+ */
1289
+ NextToken?: string;
1290
+ /**
1291
+ * @public
1292
+ * <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>
1293
+ * <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>
1294
+ */
1295
+ MaxResults?: number;
1227
1296
  }
1228
1297
  /**
1229
1298
  * @public
1230
1299
  */
1231
- export interface StopKeyUsageOutput {
1300
+ export interface ListTagsForResourceOutput {
1232
1301
  /**
1233
1302
  * @public
1234
- * <p>The <code>KeyARN</code> of the key.</p>
1303
+ * <p>The list of tags associated with a <code>ResourceArn</code>. Each tag will list the key-value pair contained within that tag.</p>
1235
1304
  */
1236
- Key: Key | undefined;
1305
+ Tags: Tag[] | undefined;
1306
+ /**
1307
+ * @public
1308
+ * <p>The token for the next set of results, or an empty or null value if there are no more results.</p>
1309
+ */
1310
+ NextToken?: string;
1237
1311
  }
1238
1312
  /**
1239
1313
  * @public
@@ -1248,11 +1322,11 @@ export interface TagResourceInput {
1248
1322
  * @public
1249
1323
  * <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>
1250
1324
  * <important>
1251
- * <p>Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
1325
+ * <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>
1252
1326
  * </important>
1253
1327
  * <p>To use this parameter, you must have <a>TagResource</a> permission in an IAM policy.</p>
1254
1328
  * <important>
1255
- * <p>Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p>
1329
+ * <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>
1256
1330
  * </important>
1257
1331
  */
1258
1332
  Tags: Tag[] | undefined;
@@ -1283,31 +1357,6 @@ export interface UntagResourceInput {
1283
1357
  */
1284
1358
  export interface UntagResourceOutput {
1285
1359
  }
1286
- /**
1287
- * @public
1288
- */
1289
- export interface UpdateAliasInput {
1290
- /**
1291
- * @public
1292
- * <p>The alias whose associated key is changing.</p>
1293
- */
1294
- AliasName: string | undefined;
1295
- /**
1296
- * @public
1297
- * <p>The <code>KeyARN</code> for the key that you are updating or removing from the alias.</p>
1298
- */
1299
- KeyArn?: string;
1300
- }
1301
- /**
1302
- * @public
1303
- */
1304
- export interface UpdateAliasOutput {
1305
- /**
1306
- * @public
1307
- * <p>The alias name.</p>
1308
- */
1309
- Alias: Alias | undefined;
1310
- }
1311
1360
  /**
1312
1361
  * @internal
1313
1362
  */