@aws-sdk/client-payment-cryptography 3.379.1 → 3.385.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.
@@ -19,6 +19,7 @@ export declare class AccessDeniedException extends __BaseException {
19
19
  */
20
20
  export interface Alias {
21
21
  /**
22
+ * @public
22
23
  * <p>A friendly name that you can use to refer to a key. The value must begin with <code>alias/</code>.</p>
23
24
  * <important>
24
25
  * <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>
@@ -26,6 +27,7 @@ export interface Alias {
26
27
  */
27
28
  AliasName: string | undefined;
28
29
  /**
30
+ * @public
29
31
  * <p>The <code>KeyARN</code> of the key associated with the alias.</p>
30
32
  */
31
33
  KeyArn?: string;
@@ -48,6 +50,7 @@ export declare class ConflictException extends __BaseException {
48
50
  */
49
51
  export interface CreateAliasInput {
50
52
  /**
53
+ * @public
51
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>
52
55
  * <important>
53
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>
@@ -55,6 +58,7 @@ export interface CreateAliasInput {
55
58
  */
56
59
  AliasName: string | undefined;
57
60
  /**
61
+ * @public
58
62
  * <p>The <code>KeyARN</code> of the key to associate with the alias.</p>
59
63
  */
60
64
  KeyArn?: string;
@@ -64,6 +68,7 @@ export interface CreateAliasInput {
64
68
  */
65
69
  export interface CreateAliasOutput {
66
70
  /**
71
+ * @public
67
72
  * <p>The alias for the key.</p>
68
73
  */
69
74
  Alias: Alias | undefined;
@@ -89,6 +94,7 @@ export declare class ResourceNotFoundException extends __BaseException {
89
94
  readonly name: "ResourceNotFoundException";
90
95
  readonly $fault: "client";
91
96
  /**
97
+ * @public
92
98
  * <p>The string for the exception.</p>
93
99
  */
94
100
  ResourceId?: string;
@@ -187,38 +193,47 @@ export type KeyClass = (typeof KeyClass)[keyof typeof KeyClass];
187
193
  */
188
194
  export interface KeyModesOfUse {
189
195
  /**
196
+ * @public
190
197
  * <p>Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.</p>
191
198
  */
192
199
  Encrypt?: boolean;
193
200
  /**
201
+ * @public
194
202
  * <p>Specifies whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.</p>
195
203
  */
196
204
  Decrypt?: boolean;
197
205
  /**
206
+ * @public
198
207
  * <p>Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.</p>
199
208
  */
200
209
  Wrap?: boolean;
201
210
  /**
211
+ * @public
202
212
  * <p>Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.</p>
203
213
  */
204
214
  Unwrap?: boolean;
205
215
  /**
216
+ * @public
206
217
  * <p>Specifies whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.</p>
207
218
  */
208
219
  Generate?: boolean;
209
220
  /**
221
+ * @public
210
222
  * <p>Specifies whether an Amazon Web Services Payment Cryptography key can be used for signing.</p>
211
223
  */
212
224
  Sign?: boolean;
213
225
  /**
226
+ * @public
214
227
  * <p>Specifies whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.</p>
215
228
  */
216
229
  Verify?: boolean;
217
230
  /**
231
+ * @public
218
232
  * <p>Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.</p>
219
233
  */
220
234
  DeriveKey?: boolean;
221
235
  /**
236
+ * @public
222
237
  * <p>Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by <code>KeyUsage</code>.</p>
223
238
  */
224
239
  NoRestrictions?: boolean;
@@ -261,19 +276,23 @@ export type KeyUsage = (typeof KeyUsage)[keyof typeof KeyUsage];
261
276
  */
262
277
  export interface KeyAttributes {
263
278
  /**
279
+ * @public
264
280
  * <p>The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.</p>
265
281
  */
266
282
  KeyUsage: KeyUsage | string | undefined;
267
283
  /**
284
+ * @public
268
285
  * <p>The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.</p>
269
286
  */
270
287
  KeyClass: KeyClass | string | undefined;
271
288
  /**
289
+ * @public
272
290
  * <p>The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.</p>
273
291
  * <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>
274
292
  */
275
293
  KeyAlgorithm: KeyAlgorithm | string | undefined;
276
294
  /**
295
+ * @public
277
296
  * <p>The list of cryptographic operations that you can perform using the key.</p>
278
297
  */
279
298
  KeyModesOfUse: KeyModesOfUse | undefined;
@@ -296,10 +315,12 @@ export type KeyCheckValueAlgorithm = (typeof KeyCheckValueAlgorithm)[keyof typeo
296
315
  */
297
316
  export interface Tag {
298
317
  /**
318
+ * @public
299
319
  * <p>The key of the tag.</p>
300
320
  */
301
321
  Key: string | undefined;
302
322
  /**
323
+ * @public
303
324
  * <p>The value of the tag.</p>
304
325
  */
305
326
  Value?: string;
@@ -309,23 +330,28 @@ export interface Tag {
309
330
  */
310
331
  export interface CreateKeyInput {
311
332
  /**
333
+ * @public
312
334
  * <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>
313
335
  */
314
336
  KeyAttributes: KeyAttributes | undefined;
315
337
  /**
338
+ * @public
316
339
  * <p>The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.</p>
317
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>
318
341
  */
319
342
  KeyCheckValueAlgorithm?: KeyCheckValueAlgorithm | string;
320
343
  /**
344
+ * @public
321
345
  * <p>Specifies whether the key is exportable from the service.</p>
322
346
  */
323
347
  Exportable: boolean | undefined;
324
348
  /**
349
+ * @public
325
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>
326
351
  */
327
352
  Enabled?: boolean;
328
353
  /**
354
+ * @public
329
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>
330
356
  * <p>To use this parameter, you must have <code>TagResource</code> permission.</p>
331
357
  * <important>
@@ -369,54 +395,67 @@ export type KeyState = (typeof KeyState)[keyof typeof KeyState];
369
395
  */
370
396
  export interface Key {
371
397
  /**
398
+ * @public
372
399
  * <p>The Amazon Resource Name (ARN) of the key.</p>
373
400
  */
374
401
  KeyArn: string | undefined;
375
402
  /**
403
+ * @public
376
404
  * <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>
377
405
  */
378
406
  KeyAttributes: KeyAttributes | undefined;
379
407
  /**
408
+ * @public
380
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>
381
410
  */
382
411
  KeyCheckValue: string | undefined;
383
412
  /**
413
+ * @public
384
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>
385
415
  */
386
416
  KeyCheckValueAlgorithm: KeyCheckValueAlgorithm | string | undefined;
387
417
  /**
418
+ * @public
388
419
  * <p>Specifies whether the key is enabled. </p>
389
420
  */
390
421
  Enabled: boolean | undefined;
391
422
  /**
423
+ * @public
392
424
  * <p>Specifies whether the key is exportable. This data is immutable after the key is created.</p>
393
425
  */
394
426
  Exportable: boolean | undefined;
395
427
  /**
428
+ * @public
396
429
  * <p>The state of key that is being created or deleted.</p>
397
430
  */
398
431
  KeyState: KeyState | string | undefined;
399
432
  /**
433
+ * @public
400
434
  * <p>The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is <code>AWS_PAYMENT_CRYPTOGRAPHY</code>. For keys imported into Amazon Web Services Payment Cryptography, the value is <code>EXTERNAL</code>.</p>
401
435
  */
402
436
  KeyOrigin: KeyOrigin | string | undefined;
403
437
  /**
438
+ * @public
404
439
  * <p>The date and time when the key was created.</p>
405
440
  */
406
441
  CreateTimestamp: Date | undefined;
407
442
  /**
443
+ * @public
408
444
  * <p>The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.</p>
409
445
  */
410
446
  UsageStartTimestamp?: Date;
411
447
  /**
448
+ * @public
412
449
  * <p>The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.</p>
413
450
  */
414
451
  UsageStopTimestamp?: Date;
415
452
  /**
453
+ * @public
416
454
  * <p>The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when <code>KeyState</code> is <code>DELETE_PENDING</code> and the key is scheduled for deletion.</p>
417
455
  */
418
456
  DeletePendingTimestamp?: Date;
419
457
  /**
458
+ * @public
420
459
  * <p>The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the <code>KeyState</code> is <code>DELETE_COMPLETE</code> and the Amazon Web Services Payment Cryptography key is deleted.</p>
421
460
  */
422
461
  DeleteTimestamp?: Date;
@@ -426,6 +465,7 @@ export interface Key {
426
465
  */
427
466
  export interface CreateKeyOutput {
428
467
  /**
468
+ * @public
429
469
  * <p>The key material that contains all the key attributes.</p>
430
470
  */
431
471
  Key: Key | undefined;
@@ -435,6 +475,7 @@ export interface CreateKeyOutput {
435
475
  */
436
476
  export interface DeleteAliasInput {
437
477
  /**
478
+ * @public
438
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>
439
480
  */
440
481
  AliasName: string | undefined;
@@ -449,10 +490,12 @@ export interface DeleteAliasOutput {
449
490
  */
450
491
  export interface DeleteKeyInput {
451
492
  /**
493
+ * @public
452
494
  * <p>The <code>KeyARN</code> of the key that is scheduled for deletion.</p>
453
495
  */
454
496
  KeyIdentifier: string | undefined;
455
497
  /**
498
+ * @public
456
499
  * <p>The waiting period for key deletion. The default value is seven days.</p>
457
500
  */
458
501
  DeleteKeyInDays?: number;
@@ -462,6 +505,7 @@ export interface DeleteKeyInput {
462
505
  */
463
506
  export interface DeleteKeyOutput {
464
507
  /**
508
+ * @public
465
509
  * <p>The <code>KeyARN</code> of the key that is scheduled for deletion.</p>
466
510
  */
467
511
  Key: Key | undefined;
@@ -472,6 +516,7 @@ export interface DeleteKeyOutput {
472
516
  */
473
517
  export interface ExportTr31KeyBlock {
474
518
  /**
519
+ * @public
475
520
  * <p>The <code>KeyARN</code> of the the wrapping key. This key encrypts or wraps the key under export for TR-31 key block generation.</p>
476
521
  */
477
522
  WrappingKeyIdentifier: string | undefined;
@@ -493,22 +538,27 @@ export type Tr34KeyBlockFormat = (typeof Tr34KeyBlockFormat)[keyof typeof Tr34Ke
493
538
  */
494
539
  export interface ExportTr34KeyBlock {
495
540
  /**
541
+ * @public
496
542
  * <p>The <code>KeyARN</code> of the certificate chain that signs the wrapping key certificate during TR-34 key export.</p>
497
543
  */
498
544
  CertificateAuthorityPublicKeyIdentifier: string | undefined;
499
545
  /**
546
+ * @public
500
547
  * <p>The <code>KeyARN</code> of the wrapping key certificate. Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export.</p>
501
548
  */
502
549
  WrappingKeyCertificate: string | undefined;
503
550
  /**
551
+ * @public
504
552
  * <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>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>
505
553
  */
506
554
  ExportToken: string | undefined;
507
555
  /**
556
+ * @public
508
557
  * <p>The format of key block that Amazon Web Services Payment Cryptography will use during key export.</p>
509
558
  */
510
559
  KeyBlockFormat: Tr34KeyBlockFormat | string | undefined;
511
560
  /**
561
+ * @public
512
562
  * <p>A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.</p>
513
563
  */
514
564
  RandomNonce?: string;
@@ -523,6 +573,7 @@ export type ExportKeyMaterial = ExportKeyMaterial.Tr31KeyBlockMember | ExportKey
523
573
  */
524
574
  export declare namespace ExportKeyMaterial {
525
575
  /**
576
+ * @public
526
577
  * <p>Parameter information for key material export using TR-31 standard.</p>
527
578
  */
528
579
  interface Tr31KeyBlockMember {
@@ -531,6 +582,7 @@ export declare namespace ExportKeyMaterial {
531
582
  $unknown?: never;
532
583
  }
533
584
  /**
585
+ * @public
534
586
  * <p>Parameter information for key material export using TR-34 standard.</p>
535
587
  */
536
588
  interface Tr34KeyBlockMember {
@@ -538,6 +590,9 @@ export declare namespace ExportKeyMaterial {
538
590
  Tr34KeyBlock: ExportTr34KeyBlock;
539
591
  $unknown?: never;
540
592
  }
593
+ /**
594
+ * @public
595
+ */
541
596
  interface $UnknownMember {
542
597
  Tr31KeyBlock?: never;
543
598
  Tr34KeyBlock?: never;
@@ -555,10 +610,12 @@ export declare namespace ExportKeyMaterial {
555
610
  */
556
611
  export interface ExportKeyInput {
557
612
  /**
613
+ * @public
558
614
  * <p>The key block format type, for example, TR-34 or TR-31, to use during key material export.</p>
559
615
  */
560
616
  KeyMaterial: ExportKeyMaterial | undefined;
561
617
  /**
618
+ * @public
562
619
  * <p>The <code>KeyARN</code> of the key under export from Amazon Web Services Payment Cryptography.</p>
563
620
  */
564
621
  ExportKeyIdentifier: string | undefined;
@@ -582,14 +639,17 @@ export type WrappedKeyMaterialFormat = (typeof WrappedKeyMaterialFormat)[keyof t
582
639
  */
583
640
  export interface WrappedKey {
584
641
  /**
642
+ * @public
585
643
  * <p>The <code>KeyARN</code> of the wrapped key.</p>
586
644
  */
587
645
  WrappingKeyArn: string | undefined;
588
646
  /**
647
+ * @public
589
648
  * <p>The key block format of a wrapped key.</p>
590
649
  */
591
650
  WrappedKeyMaterialFormat: WrappedKeyMaterialFormat | string | undefined;
592
651
  /**
652
+ * @public
593
653
  * <p>Parameter information for generating a wrapped key using TR-31 or TR-34 standard.</p>
594
654
  */
595
655
  KeyMaterial: string | undefined;
@@ -599,6 +659,7 @@ export interface WrappedKey {
599
659
  */
600
660
  export interface ExportKeyOutput {
601
661
  /**
662
+ * @public
602
663
  * <p>The key material under export as a TR-34 or TR-31 wrapped key block.</p>
603
664
  */
604
665
  WrappedKey?: WrappedKey;
@@ -608,6 +669,7 @@ export interface ExportKeyOutput {
608
669
  */
609
670
  export interface GetAliasInput {
610
671
  /**
672
+ * @public
611
673
  * <p>The alias of the Amazon Web Services Payment Cryptography key.</p>
612
674
  */
613
675
  AliasName: string | undefined;
@@ -617,6 +679,7 @@ export interface GetAliasInput {
617
679
  */
618
680
  export interface GetAliasOutput {
619
681
  /**
682
+ * @public
620
683
  * <p>The alias of the Amazon Web Services Payment Cryptography key.</p>
621
684
  */
622
685
  Alias: Alias | undefined;
@@ -626,6 +689,7 @@ export interface GetAliasOutput {
626
689
  */
627
690
  export interface GetKeyInput {
628
691
  /**
692
+ * @public
629
693
  * <p>The <code>KeyARN</code> of the Amazon Web Services Payment Cryptography key.</p>
630
694
  */
631
695
  KeyIdentifier: string | undefined;
@@ -635,6 +699,7 @@ export interface GetKeyInput {
635
699
  */
636
700
  export interface GetKeyOutput {
637
701
  /**
702
+ * @public
638
703
  * <p>The key material, including the immutable and mutable data for the key.</p>
639
704
  */
640
705
  Key: Key | undefined;
@@ -658,10 +723,12 @@ export type KeyMaterialType = (typeof KeyMaterialType)[keyof typeof KeyMaterialT
658
723
  */
659
724
  export interface GetParametersForExportInput {
660
725
  /**
726
+ * @public
661
727
  * <p>The key block format type (for example, TR-34 or TR-31) to use during key material export. Export token is only required for a TR-34 key export, <code>TR34_KEY_BLOCK</code>. Export token is not required for TR-31 key export.</p>
662
728
  */
663
729
  KeyMaterialType: KeyMaterialType | string | undefined;
664
730
  /**
731
+ * @public
665
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>
666
733
  */
667
734
  SigningKeyAlgorithm: KeyAlgorithm | string | undefined;
@@ -671,22 +738,27 @@ export interface GetParametersForExportInput {
671
738
  */
672
739
  export interface GetParametersForExportOutput {
673
740
  /**
741
+ * @public
674
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>
675
743
  */
676
744
  SigningKeyCertificate: string | undefined;
677
745
  /**
746
+ * @public
678
747
  * <p>The certificate chain that signed the signing key certificate. This is the root certificate authority (CA) within your service account.</p>
679
748
  */
680
749
  SigningKeyCertificateChain: string | undefined;
681
750
  /**
751
+ * @public
682
752
  * <p>The algorithm of the signing key certificate for use in TR-34 key block generation. <code>RSA_2048</code> is the only signing key algorithm allowed.</p>
683
753
  */
684
754
  SigningKeyAlgorithm: KeyAlgorithm | string | undefined;
685
755
  /**
756
+ * @public
686
757
  * <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>
687
758
  */
688
759
  ExportToken: string | undefined;
689
760
  /**
761
+ * @public
690
762
  * <p>The validity period of the export token.</p>
691
763
  */
692
764
  ParametersValidUntilTimestamp: Date | undefined;
@@ -696,10 +768,12 @@ export interface GetParametersForExportOutput {
696
768
  */
697
769
  export interface GetParametersForImportInput {
698
770
  /**
771
+ * @public
699
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>
700
773
  */
701
774
  KeyMaterialType: KeyMaterialType | string | undefined;
702
775
  /**
776
+ * @public
703
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>
704
778
  */
705
779
  WrappingKeyAlgorithm: KeyAlgorithm | string | undefined;
@@ -709,22 +783,27 @@ export interface GetParametersForImportInput {
709
783
  */
710
784
  export interface GetParametersForImportOutput {
711
785
  /**
786
+ * @public
712
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>
713
788
  */
714
789
  WrappingKeyCertificate: string | undefined;
715
790
  /**
791
+ * @public
716
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>
717
793
  */
718
794
  WrappingKeyCertificateChain: string | undefined;
719
795
  /**
796
+ * @public
720
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>
721
798
  */
722
799
  WrappingKeyAlgorithm: KeyAlgorithm | string | undefined;
723
800
  /**
801
+ * @public
724
802
  * <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>
725
803
  */
726
804
  ImportToken: string | undefined;
727
805
  /**
806
+ * @public
728
807
  * <p>The validity period of the import token.</p>
729
808
  */
730
809
  ParametersValidUntilTimestamp: Date | undefined;
@@ -734,6 +813,7 @@ export interface GetParametersForImportOutput {
734
813
  */
735
814
  export interface GetPublicKeyCertificateInput {
736
815
  /**
816
+ * @public
737
817
  * <p>The <code>KeyARN</code> of the asymmetric key pair.</p>
738
818
  */
739
819
  KeyIdentifier: string | undefined;
@@ -743,10 +823,12 @@ export interface GetPublicKeyCertificateInput {
743
823
  */
744
824
  export interface GetPublicKeyCertificateOutput {
745
825
  /**
826
+ * @public
746
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>
747
828
  */
748
829
  KeyCertificate: string | undefined;
749
830
  /**
831
+ * @public
750
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>
751
833
  */
752
834
  KeyCertificateChain: string | undefined;
@@ -757,10 +839,12 @@ export interface GetPublicKeyCertificateOutput {
757
839
  */
758
840
  export interface RootCertificatePublicKey {
759
841
  /**
842
+ * @public
760
843
  * <p>The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the root public key is imported.</p>
761
844
  */
762
845
  KeyAttributes: KeyAttributes | undefined;
763
846
  /**
847
+ * @public
764
848
  * <p>Parameter information for root public key certificate import.</p>
765
849
  */
766
850
  PublicKeyCertificate: string | undefined;
@@ -771,10 +855,12 @@ export interface RootCertificatePublicKey {
771
855
  */
772
856
  export interface ImportTr31KeyBlock {
773
857
  /**
858
+ * @public
774
859
  * <p>The <code>KeyARN</code> of the key that will decrypt or unwrap a TR-31 key block during import.</p>
775
860
  */
776
861
  WrappingKeyIdentifier: string | undefined;
777
862
  /**
863
+ * @public
778
864
  * <p>The TR-34 wrapped key block to import.</p>
779
865
  */
780
866
  WrappedKeyBlock: string | undefined;
@@ -785,26 +871,32 @@ export interface ImportTr31KeyBlock {
785
871
  */
786
872
  export interface ImportTr34KeyBlock {
787
873
  /**
874
+ * @public
788
875
  * <p>The <code>KeyARN</code> of the certificate chain that signs the signing key certificate during TR-34 key import.</p>
789
876
  */
790
877
  CertificateAuthorityPublicKeyIdentifier: string | undefined;
791
878
  /**
879
+ * @public
792
880
  * <p>The public key component in PEM certificate format of the private key that signs the KDH TR-34 wrapped key block.</p>
793
881
  */
794
882
  SigningKeyCertificate: string | undefined;
795
883
  /**
884
+ * @public
796
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>
797
886
  */
798
887
  ImportToken: string | undefined;
799
888
  /**
889
+ * @public
800
890
  * <p>The TR-34 wrapped key block to import.</p>
801
891
  */
802
892
  WrappedKeyBlock: string | undefined;
803
893
  /**
894
+ * @public
804
895
  * <p>The key block format to use during key import. The only value allowed is <code>X9_TR34_2012</code>.</p>
805
896
  */
806
897
  KeyBlockFormat: Tr34KeyBlockFormat | string | undefined;
807
898
  /**
899
+ * @public
808
900
  * <p>A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.</p>
809
901
  */
810
902
  RandomNonce?: string;
@@ -815,14 +907,17 @@ export interface ImportTr34KeyBlock {
815
907
  */
816
908
  export interface TrustedCertificatePublicKey {
817
909
  /**
910
+ * @public
818
911
  * <p>The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after a trusted public key is imported.</p>
819
912
  */
820
913
  KeyAttributes: KeyAttributes | undefined;
821
914
  /**
915
+ * @public
822
916
  * <p>Parameter information for trusted public key certificate import.</p>
823
917
  */
824
918
  PublicKeyCertificate: string | undefined;
825
919
  /**
920
+ * @public
826
921
  * <p>The <code>KeyARN</code> of the root public key certificate or certificate chain that signs the trusted public key certificate import.</p>
827
922
  */
828
923
  CertificateAuthorityPublicKeyIdentifier: string | undefined;
@@ -837,6 +932,7 @@ export type ImportKeyMaterial = ImportKeyMaterial.RootCertificatePublicKeyMember
837
932
  */
838
933
  export declare namespace ImportKeyMaterial {
839
934
  /**
935
+ * @public
840
936
  * <p>Parameter information for root public key certificate import.</p>
841
937
  */
842
938
  interface RootCertificatePublicKeyMember {
@@ -847,6 +943,7 @@ export declare namespace ImportKeyMaterial {
847
943
  $unknown?: never;
848
944
  }
849
945
  /**
946
+ * @public
850
947
  * <p>Parameter information for trusted public key certificate import.</p>
851
948
  */
852
949
  interface TrustedCertificatePublicKeyMember {
@@ -857,6 +954,7 @@ export declare namespace ImportKeyMaterial {
857
954
  $unknown?: never;
858
955
  }
859
956
  /**
957
+ * @public
860
958
  * <p>Parameter information for key material import using TR-31 standard.</p>
861
959
  */
862
960
  interface Tr31KeyBlockMember {
@@ -867,6 +965,7 @@ export declare namespace ImportKeyMaterial {
867
965
  $unknown?: never;
868
966
  }
869
967
  /**
968
+ * @public
870
969
  * <p>Parameter information for key material import using TR-34 standard.</p>
871
970
  */
872
971
  interface Tr34KeyBlockMember {
@@ -876,6 +975,9 @@ export declare namespace ImportKeyMaterial {
876
975
  Tr34KeyBlock: ImportTr34KeyBlock;
877
976
  $unknown?: never;
878
977
  }
978
+ /**
979
+ * @public
980
+ */
879
981
  interface $UnknownMember {
880
982
  RootCertificatePublicKey?: never;
881
983
  TrustedCertificatePublicKey?: never;
@@ -897,19 +999,23 @@ export declare namespace ImportKeyMaterial {
897
999
  */
898
1000
  export interface ImportKeyInput {
899
1001
  /**
1002
+ * @public
900
1003
  * <p>The key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey.</p>
901
1004
  */
902
1005
  KeyMaterial: ImportKeyMaterial | undefined;
903
1006
  /**
1007
+ * @public
904
1008
  * <p>The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.</p>
905
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>
906
1010
  */
907
1011
  KeyCheckValueAlgorithm?: KeyCheckValueAlgorithm | string;
908
1012
  /**
1013
+ * @public
909
1014
  * <p>Specifies whether import key is enabled.</p>
910
1015
  */
911
1016
  Enabled?: boolean;
912
1017
  /**
1018
+ * @public
913
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>
914
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>
915
1021
  * <p>To use this parameter, you must have <code>TagResource</code> permission.</p>
@@ -927,6 +1033,7 @@ export interface ImportKeyInput {
927
1033
  */
928
1034
  export interface ImportKeyOutput {
929
1035
  /**
1036
+ * @public
930
1037
  * <p>The <code>KeyARN</code> of the key material imported within Amazon Web Services Payment Cryptography.</p>
931
1038
  */
932
1039
  Key: Key | undefined;
@@ -937,26 +1044,32 @@ export interface ImportKeyOutput {
937
1044
  */
938
1045
  export interface KeySummary {
939
1046
  /**
1047
+ * @public
940
1048
  * <p>The Amazon Resource Name (ARN) of the key.</p>
941
1049
  */
942
1050
  KeyArn: string | undefined;
943
1051
  /**
1052
+ * @public
944
1053
  * <p>The state of an Amazon Web Services Payment Cryptography that is being created or deleted.</p>
945
1054
  */
946
1055
  KeyState: KeyState | string | undefined;
947
1056
  /**
1057
+ * @public
948
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>
949
1059
  */
950
1060
  KeyAttributes: KeyAttributes | undefined;
951
1061
  /**
1062
+ * @public
952
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>
953
1064
  */
954
1065
  KeyCheckValue: string | undefined;
955
1066
  /**
1067
+ * @public
956
1068
  * <p>Specifies whether the key is exportable. This data is immutable after the key is created.</p>
957
1069
  */
958
1070
  Exportable: boolean | undefined;
959
1071
  /**
1072
+ * @public
960
1073
  * <p>Specifies whether the key is enabled. </p>
961
1074
  */
962
1075
  Enabled: boolean | undefined;
@@ -966,10 +1079,12 @@ export interface KeySummary {
966
1079
  */
967
1080
  export interface ListAliasesInput {
968
1081
  /**
1082
+ * @public
969
1083
  * <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>
970
1084
  */
971
1085
  NextToken?: string;
972
1086
  /**
1087
+ * @public
973
1088
  * <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>
974
1089
  * <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>
975
1090
  */
@@ -980,10 +1095,12 @@ export interface ListAliasesInput {
980
1095
  */
981
1096
  export interface ListAliasesOutput {
982
1097
  /**
1098
+ * @public
983
1099
  * <p>The list of aliases. Each alias describes the <code>KeyArn</code> contained within.</p>
984
1100
  */
985
1101
  Aliases: Alias[] | undefined;
986
1102
  /**
1103
+ * @public
987
1104
  * <p>The token for the next set of results, or an empty or null value if there are no more results.</p>
988
1105
  */
989
1106
  NextToken?: string;
@@ -993,14 +1110,17 @@ export interface ListAliasesOutput {
993
1110
  */
994
1111
  export interface ListKeysInput {
995
1112
  /**
1113
+ * @public
996
1114
  * <p>The key state of the keys you want to list.</p>
997
1115
  */
998
1116
  KeyState?: KeyState | string;
999
1117
  /**
1118
+ * @public
1000
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>
1001
1120
  */
1002
1121
  NextToken?: string;
1003
1122
  /**
1123
+ * @public
1004
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>
1005
1125
  */
1006
1126
  MaxResults?: number;
@@ -1010,10 +1130,12 @@ export interface ListKeysInput {
1010
1130
  */
1011
1131
  export interface ListKeysOutput {
1012
1132
  /**
1133
+ * @public
1013
1134
  * <p>The list of keys created within the caller's Amazon Web Services account and Amazon Web Services Region.</p>
1014
1135
  */
1015
1136
  Keys: KeySummary[] | undefined;
1016
1137
  /**
1138
+ * @public
1017
1139
  * <p>The token for the next set of results, or an empty or null value if there are no more results.</p>
1018
1140
  */
1019
1141
  NextToken?: string;
@@ -1023,14 +1145,17 @@ export interface ListKeysOutput {
1023
1145
  */
1024
1146
  export interface ListTagsForResourceInput {
1025
1147
  /**
1148
+ * @public
1026
1149
  * <p>The <code>KeyARN</code> of the key whose tags you are getting.</p>
1027
1150
  */
1028
1151
  ResourceArn: string | undefined;
1029
1152
  /**
1153
+ * @public
1030
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>
1031
1155
  */
1032
1156
  NextToken?: string;
1033
1157
  /**
1158
+ * @public
1034
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>
1035
1160
  */
1036
1161
  MaxResults?: number;
@@ -1040,10 +1165,12 @@ export interface ListTagsForResourceInput {
1040
1165
  */
1041
1166
  export interface ListTagsForResourceOutput {
1042
1167
  /**
1168
+ * @public
1043
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>
1044
1170
  */
1045
1171
  Tags: Tag[] | undefined;
1046
1172
  /**
1173
+ * @public
1047
1174
  * <p>The token for the next set of results, or an empty or null value if there are no more results.</p>
1048
1175
  */
1049
1176
  NextToken?: string;
@@ -1053,6 +1180,7 @@ export interface ListTagsForResourceOutput {
1053
1180
  */
1054
1181
  export interface RestoreKeyInput {
1055
1182
  /**
1183
+ * @public
1056
1184
  * <p>The <code>KeyARN</code> of the key to be restored within Amazon Web Services Payment Cryptography.</p>
1057
1185
  */
1058
1186
  KeyIdentifier: string | undefined;
@@ -1062,6 +1190,7 @@ export interface RestoreKeyInput {
1062
1190
  */
1063
1191
  export interface RestoreKeyOutput {
1064
1192
  /**
1193
+ * @public
1065
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>
1066
1195
  */
1067
1196
  Key: Key | undefined;
@@ -1071,6 +1200,7 @@ export interface RestoreKeyOutput {
1071
1200
  */
1072
1201
  export interface StartKeyUsageInput {
1073
1202
  /**
1203
+ * @public
1074
1204
  * <p>The <code>KeyArn</code> of the key.</p>
1075
1205
  */
1076
1206
  KeyIdentifier: string | undefined;
@@ -1080,6 +1210,7 @@ export interface StartKeyUsageInput {
1080
1210
  */
1081
1211
  export interface StartKeyUsageOutput {
1082
1212
  /**
1213
+ * @public
1083
1214
  * <p>The <code>KeyARN</code> of the Amazon Web Services Payment Cryptography key activated for use.</p>
1084
1215
  */
1085
1216
  Key: Key | undefined;
@@ -1089,6 +1220,7 @@ export interface StartKeyUsageOutput {
1089
1220
  */
1090
1221
  export interface StopKeyUsageInput {
1091
1222
  /**
1223
+ * @public
1092
1224
  * <p>The <code>KeyArn</code> of the key.</p>
1093
1225
  */
1094
1226
  KeyIdentifier: string | undefined;
@@ -1098,6 +1230,7 @@ export interface StopKeyUsageInput {
1098
1230
  */
1099
1231
  export interface StopKeyUsageOutput {
1100
1232
  /**
1233
+ * @public
1101
1234
  * <p>The <code>KeyARN</code> of the key.</p>
1102
1235
  */
1103
1236
  Key: Key | undefined;
@@ -1107,10 +1240,12 @@ export interface StopKeyUsageOutput {
1107
1240
  */
1108
1241
  export interface TagResourceInput {
1109
1242
  /**
1243
+ * @public
1110
1244
  * <p>The <code>KeyARN</code> of the key whose tags are being updated.</p>
1111
1245
  */
1112
1246
  ResourceArn: string | undefined;
1113
1247
  /**
1248
+ * @public
1114
1249
  * <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>
1115
1250
  * <important>
1116
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>
@@ -1132,10 +1267,12 @@ export interface TagResourceOutput {
1132
1267
  */
1133
1268
  export interface UntagResourceInput {
1134
1269
  /**
1270
+ * @public
1135
1271
  * <p>The <code>KeyARN</code> of the key whose tags are being removed.</p>
1136
1272
  */
1137
1273
  ResourceArn: string | undefined;
1138
1274
  /**
1275
+ * @public
1139
1276
  * <p>One or more tag keys. Don't include the tag values.</p>
1140
1277
  * <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>ListTagsForResource</a> operation.</p>
1141
1278
  */
@@ -1151,10 +1288,12 @@ export interface UntagResourceOutput {
1151
1288
  */
1152
1289
  export interface UpdateAliasInput {
1153
1290
  /**
1291
+ * @public
1154
1292
  * <p>The alias whose associated key is changing.</p>
1155
1293
  */
1156
1294
  AliasName: string | undefined;
1157
1295
  /**
1296
+ * @public
1158
1297
  * <p>The <code>KeyARN</code> for the key that you are updating or removing from the alias.</p>
1159
1298
  */
1160
1299
  KeyArn?: string;
@@ -1164,6 +1303,7 @@ export interface UpdateAliasInput {
1164
1303
  */
1165
1304
  export interface UpdateAliasOutput {
1166
1305
  /**
1306
+ * @public
1167
1307
  * <p>The alias name.</p>
1168
1308
  */
1169
1309
  Alias: Alias | undefined;
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.379.1",
4
+ "version": "3.385.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.385.0",
25
+ "@aws-sdk/credential-provider-node": "3.385.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",