aws-sdk-paymentcryptography 1.11.0 → 1.13.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -96,16 +96,6 @@ module Aws::PaymentCryptography
96
96
  include Aws::Structure
97
97
  end
98
98
 
99
- # @!attribute [rw] enabled
100
- # Specifies whether to enable the key. If the key is enabled, it is
101
- # activated for use within the service. If the key is not enabled,
102
- # then it is created but not activated. The default value is enabled.
103
- # @return [Boolean]
104
- #
105
- # @!attribute [rw] exportable
106
- # Specifies whether the key is exportable from the service.
107
- # @return [Boolean]
108
- #
109
99
  # @!attribute [rw] key_attributes
110
100
  # The role of the key, the algorithm it supports, and the
111
101
  # cryptographic operations allowed with the key. This data is
@@ -125,11 +115,21 @@ module Aws::PaymentCryptography
125
115
  # result.
126
116
  # @return [String]
127
117
  #
118
+ # @!attribute [rw] exportable
119
+ # Specifies whether the key is exportable from the service.
120
+ # @return [Boolean]
121
+ #
122
+ # @!attribute [rw] enabled
123
+ # Specifies whether to enable the key. If the key is enabled, it is
124
+ # activated for use within the service. If the key is not enabled,
125
+ # then it is created but not activated. The default value is enabled.
126
+ # @return [Boolean]
127
+ #
128
128
  # @!attribute [rw] tags
129
129
  # Assigns one or more tags to the Amazon Web Services Payment
130
130
  # Cryptography key. Use this parameter to tag a key when it is
131
131
  # created. To tag an existing Amazon Web Services Payment Cryptography
132
- # key, use the TagResource operation.
132
+ # key, use the [TagResource][1] operation.
133
133
  #
134
134
  # Each tag consists of a tag key and a tag value. Both the tag key and
135
135
  # the tag value are required, but the tag value can be an empty (null)
@@ -144,15 +144,19 @@ module Aws::PaymentCryptography
144
144
  # can allow or deny permission to the key.
145
145
  #
146
146
  # </note>
147
+ #
148
+ #
149
+ #
150
+ # [1]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html
147
151
  # @return [Array<Types::Tag>]
148
152
  #
149
153
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/CreateKeyInput AWS API Documentation
150
154
  #
151
155
  class CreateKeyInput < Struct.new(
152
- :enabled,
153
- :exportable,
154
156
  :key_attributes,
155
157
  :key_check_value_algorithm,
158
+ :exportable,
159
+ :enabled,
156
160
  :tags)
157
161
  SENSITIVE = []
158
162
  include Aws::Structure
@@ -188,20 +192,20 @@ module Aws::PaymentCryptography
188
192
  #
189
193
  class DeleteAliasOutput < Aws::EmptyStructure; end
190
194
 
195
+ # @!attribute [rw] key_identifier
196
+ # The `KeyARN` of the key that is scheduled for deletion.
197
+ # @return [String]
198
+ #
191
199
  # @!attribute [rw] delete_key_in_days
192
200
  # The waiting period for key deletion. The default value is seven
193
201
  # days.
194
202
  # @return [Integer]
195
203
  #
196
- # @!attribute [rw] key_identifier
197
- # The `KeyARN` of the key that is scheduled for deletion.
198
- # @return [String]
199
- #
200
204
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/DeleteKeyInput AWS API Documentation
201
205
  #
202
206
  class DeleteKeyInput < Struct.new(
203
- :delete_key_in_days,
204
- :key_identifier)
207
+ :key_identifier,
208
+ :delete_key_in_days)
205
209
  SENSITIVE = []
206
210
  include Aws::Structure
207
211
  end
@@ -292,26 +296,26 @@ module Aws::PaymentCryptography
292
296
  include Aws::Structure
293
297
  end
294
298
 
295
- # @!attribute [rw] export_attributes
296
- # The attributes for IPEK generation during export.
297
- # @return [Types::ExportAttributes]
299
+ # @!attribute [rw] key_material
300
+ # The key block format type, for example, TR-34 or TR-31, to use
301
+ # during key material export.
302
+ # @return [Types::ExportKeyMaterial]
298
303
  #
299
304
  # @!attribute [rw] export_key_identifier
300
305
  # The `KeyARN` of the key under export from Amazon Web Services
301
306
  # Payment Cryptography.
302
307
  # @return [String]
303
308
  #
304
- # @!attribute [rw] key_material
305
- # The key block format type, for example, TR-34 or TR-31, to use
306
- # during key material export.
307
- # @return [Types::ExportKeyMaterial]
309
+ # @!attribute [rw] export_attributes
310
+ # The attributes for IPEK generation during export.
311
+ # @return [Types::ExportAttributes]
308
312
  #
309
313
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ExportKeyInput AWS API Documentation
310
314
  #
311
315
  class ExportKeyInput < Struct.new(
312
- :export_attributes,
316
+ :key_material,
313
317
  :export_key_identifier,
314
- :key_material)
318
+ :export_attributes)
315
319
  SENSITIVE = []
316
320
  include Aws::Structure
317
321
  end
@@ -322,11 +326,6 @@ module Aws::PaymentCryptography
322
326
  #
323
327
  # @note ExportKeyMaterial is a union - when making an API calls you must set exactly one of the members.
324
328
  #
325
- # @!attribute [rw] key_cryptogram
326
- # Parameter information for key material export using asymmetric RSA
327
- # wrap and unwrap key exchange method
328
- # @return [Types::ExportKeyCryptogram]
329
- #
330
329
  # @!attribute [rw] tr_31_key_block
331
330
  # Parameter information for key material export using symmetric TR-31
332
331
  # key exchange method.
@@ -337,20 +336,25 @@ module Aws::PaymentCryptography
337
336
  # TR-34 key exchange method.
338
337
  # @return [Types::ExportTr34KeyBlock]
339
338
  #
339
+ # @!attribute [rw] key_cryptogram
340
+ # Parameter information for key material export using asymmetric RSA
341
+ # wrap and unwrap key exchange method
342
+ # @return [Types::ExportKeyCryptogram]
343
+ #
340
344
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ExportKeyMaterial AWS API Documentation
341
345
  #
342
346
  class ExportKeyMaterial < Struct.new(
343
- :key_cryptogram,
344
347
  :tr_31_key_block,
345
348
  :tr_34_key_block,
349
+ :key_cryptogram,
346
350
  :unknown)
347
351
  SENSITIVE = []
348
352
  include Aws::Structure
349
353
  include Aws::Structure::Union
350
354
 
351
- class KeyCryptogram < ExportKeyMaterial; end
352
355
  class Tr31KeyBlock < ExportKeyMaterial; end
353
356
  class Tr34KeyBlock < ExportKeyMaterial; end
357
+ class KeyCryptogram < ExportKeyMaterial; end
354
358
  class Unknown < ExportKeyMaterial; end
355
359
  end
356
360
 
@@ -375,10 +379,16 @@ module Aws::PaymentCryptography
375
379
  # key under export for TR-31 key block generation.
376
380
  # @return [String]
377
381
  #
382
+ # @!attribute [rw] key_block_headers
383
+ # Optional metadata for export associated with the key material. This
384
+ # data is signed but transmitted in clear text.
385
+ # @return [Types::KeyBlockHeaders]
386
+ #
378
387
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ExportTr31KeyBlock AWS API Documentation
379
388
  #
380
389
  class ExportTr31KeyBlock < Struct.new(
381
- :wrapping_key_identifier)
390
+ :wrapping_key_identifier,
391
+ :key_block_headers)
382
392
  SENSITIVE = []
383
393
  include Aws::Structure
384
394
  end
@@ -391,13 +401,23 @@ module Aws::PaymentCryptography
391
401
  # certificate during TR-34 key export.
392
402
  # @return [String]
393
403
  #
404
+ # @!attribute [rw] wrapping_key_certificate
405
+ # The `KeyARN` of the wrapping key certificate. Amazon Web Services
406
+ # Payment Cryptography uses this certificate to wrap the key under
407
+ # export.
408
+ # @return [String]
409
+ #
394
410
  # @!attribute [rw] export_token
395
411
  # The export token to initiate key export from Amazon Web Services
396
412
  # Payment Cryptography. It also contains the signing key certificate
397
413
  # that will sign the wrapped key during TR-34 key block generation.
398
- # Call GetParametersForExport to receive an export token. It expires
399
- # after 7 days. You can use the same export token to export multiple
400
- # keys from the same service account.
414
+ # Call [GetParametersForExport][1] to receive an export token. It
415
+ # expires after 7 days. You can use the same export token to export
416
+ # multiple keys from the same service account.
417
+ #
418
+ #
419
+ #
420
+ # [1]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForExport.html
401
421
  # @return [String]
402
422
  #
403
423
  # @!attribute [rw] key_block_format
@@ -411,20 +431,20 @@ module Aws::PaymentCryptography
411
431
  # value is not provided for a TR-34 key block generated using 2 pass.
412
432
  # @return [String]
413
433
  #
414
- # @!attribute [rw] wrapping_key_certificate
415
- # The `KeyARN` of the wrapping key certificate. Amazon Web Services
416
- # Payment Cryptography uses this certificate to wrap the key under
417
- # export.
418
- # @return [String]
434
+ # @!attribute [rw] key_block_headers
435
+ # Optional metadata for export associated with the key material. This
436
+ # data is signed but transmitted in clear text.
437
+ # @return [Types::KeyBlockHeaders]
419
438
  #
420
439
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ExportTr34KeyBlock AWS API Documentation
421
440
  #
422
441
  class ExportTr34KeyBlock < Struct.new(
423
442
  :certificate_authority_public_key_identifier,
443
+ :wrapping_key_certificate,
424
444
  :export_token,
425
445
  :key_block_format,
426
446
  :random_nonce,
427
- :wrapping_key_certificate)
447
+ :key_block_headers)
428
448
  SENSITIVE = [:wrapping_key_certificate]
429
449
  include Aws::Structure
430
450
  end
@@ -500,16 +520,16 @@ module Aws::PaymentCryptography
500
520
  include Aws::Structure
501
521
  end
502
522
 
503
- # @!attribute [rw] export_token
504
- # The export token to initiate key export from Amazon Web Services
505
- # Payment Cryptography. The export token expires after 7 days. You can
506
- # use the same export token to export multiple keys from the same
507
- # service account.
523
+ # @!attribute [rw] signing_key_certificate
524
+ # The signing key certificate in PEM format (base64 encoded) of the
525
+ # public key for signature within the TR-34 key block. The certificate
526
+ # expires after 7 days.
508
527
  # @return [String]
509
528
  #
510
- # @!attribute [rw] parameters_valid_until_timestamp
511
- # The validity period of the export token.
512
- # @return [Time]
529
+ # @!attribute [rw] signing_key_certificate_chain
530
+ # The root certificate authority (CA) that signed the signing key
531
+ # certificate in PEM format (base64 encoded).
532
+ # @return [String]
513
533
  #
514
534
  # @!attribute [rw] signing_key_algorithm
515
535
  # The algorithm of the signing key certificate for use in TR-34 key
@@ -517,25 +537,25 @@ module Aws::PaymentCryptography
517
537
  # allowed.
518
538
  # @return [String]
519
539
  #
520
- # @!attribute [rw] signing_key_certificate
521
- # The signing key certificate in PEM format (base64 encoded) of the
522
- # public key for signature within the TR-34 key block. The certificate
523
- # expires after 7 days.
540
+ # @!attribute [rw] export_token
541
+ # The export token to initiate key export from Amazon Web Services
542
+ # Payment Cryptography. The export token expires after 7 days. You can
543
+ # use the same export token to export multiple keys from the same
544
+ # service account.
524
545
  # @return [String]
525
546
  #
526
- # @!attribute [rw] signing_key_certificate_chain
527
- # The root certificate authority (CA) that signed the signing key
528
- # certificate in PEM format (base64 encoded).
529
- # @return [String]
547
+ # @!attribute [rw] parameters_valid_until_timestamp
548
+ # The validity period of the export token.
549
+ # @return [Time]
530
550
  #
531
551
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/GetParametersForExportOutput AWS API Documentation
532
552
  #
533
553
  class GetParametersForExportOutput < Struct.new(
534
- :export_token,
535
- :parameters_valid_until_timestamp,
536
- :signing_key_algorithm,
537
554
  :signing_key_certificate,
538
- :signing_key_certificate_chain)
555
+ :signing_key_certificate_chain,
556
+ :signing_key_algorithm,
557
+ :export_token,
558
+ :parameters_valid_until_timestamp)
539
559
  SENSITIVE = [:signing_key_certificate, :signing_key_certificate_chain]
540
560
  include Aws::Structure
541
561
  end
@@ -568,22 +588,6 @@ module Aws::PaymentCryptography
568
588
  include Aws::Structure
569
589
  end
570
590
 
571
- # @!attribute [rw] import_token
572
- # The import token to initiate key import into Amazon Web Services
573
- # Payment Cryptography. The import token expires after 7 days. You can
574
- # use the same import token to import multiple keys to the same
575
- # service account.
576
- # @return [String]
577
- #
578
- # @!attribute [rw] parameters_valid_until_timestamp
579
- # The validity period of the import token.
580
- # @return [Time]
581
- #
582
- # @!attribute [rw] wrapping_key_algorithm
583
- # The algorithm of the wrapping key for use within TR-34
584
- # WrappedKeyBlock or RSA WrappedKeyCryptogram.
585
- # @return [String]
586
- #
587
591
  # @!attribute [rw] wrapping_key_certificate
588
592
  # The wrapping key certificate in PEM format (base64 encoded) of the
589
593
  # wrapping key for use within the TR-34 key block. The certificate
@@ -596,14 +600,30 @@ module Aws::PaymentCryptography
596
600
  # format (base64 encoded).
597
601
  # @return [String]
598
602
  #
603
+ # @!attribute [rw] wrapping_key_algorithm
604
+ # The algorithm of the wrapping key for use within TR-34
605
+ # WrappedKeyBlock or RSA WrappedKeyCryptogram.
606
+ # @return [String]
607
+ #
608
+ # @!attribute [rw] import_token
609
+ # The import token to initiate key import into Amazon Web Services
610
+ # Payment Cryptography. The import token expires after 7 days. You can
611
+ # use the same import token to import multiple keys to the same
612
+ # service account.
613
+ # @return [String]
614
+ #
615
+ # @!attribute [rw] parameters_valid_until_timestamp
616
+ # The validity period of the import token.
617
+ # @return [Time]
618
+ #
599
619
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/GetParametersForImportOutput AWS API Documentation
600
620
  #
601
621
  class GetParametersForImportOutput < Struct.new(
602
- :import_token,
603
- :parameters_valid_until_timestamp,
604
- :wrapping_key_algorithm,
605
622
  :wrapping_key_certificate,
606
- :wrapping_key_certificate_chain)
623
+ :wrapping_key_certificate_chain,
624
+ :wrapping_key_algorithm,
625
+ :import_token,
626
+ :parameters_valid_until_timestamp)
607
627
  SENSITIVE = [:wrapping_key_certificate, :wrapping_key_certificate_chain]
608
628
  include Aws::Structure
609
629
  end
@@ -644,10 +664,20 @@ module Aws::PaymentCryptography
644
664
  # Parameter information for key material import using asymmetric RSA
645
665
  # wrap and unwrap key exchange method.
646
666
  #
667
+ # @!attribute [rw] key_attributes
668
+ # The role of the key, the algorithm it supports, and the
669
+ # cryptographic operations allowed with the key. This data is
670
+ # immutable after the key is created.
671
+ # @return [Types::KeyAttributes]
672
+ #
647
673
  # @!attribute [rw] exportable
648
674
  # Specifies whether the key is exportable from the service.
649
675
  # @return [Boolean]
650
676
  #
677
+ # @!attribute [rw] wrapped_key_cryptogram
678
+ # The RSA wrapped key cryptogram under import.
679
+ # @return [String]
680
+ #
651
681
  # @!attribute [rw] import_token
652
682
  # The import token that initiates key import using the asymmetric RSA
653
683
  # wrap and unwrap key exchange method into AWS Payment Cryptography.
@@ -655,16 +685,6 @@ module Aws::PaymentCryptography
655
685
  # multiple keys to the same service account.
656
686
  # @return [String]
657
687
  #
658
- # @!attribute [rw] key_attributes
659
- # The role of the key, the algorithm it supports, and the
660
- # cryptographic operations allowed with the key. This data is
661
- # immutable after the key is created.
662
- # @return [Types::KeyAttributes]
663
- #
664
- # @!attribute [rw] wrapped_key_cryptogram
665
- # The RSA wrapped key cryptogram under import.
666
- # @return [String]
667
- #
668
688
  # @!attribute [rw] wrapping_spec
669
689
  # The wrapping spec for the wrapped key cryptogram.
670
690
  # @return [String]
@@ -672,18 +692,19 @@ module Aws::PaymentCryptography
672
692
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ImportKeyCryptogram AWS API Documentation
673
693
  #
674
694
  class ImportKeyCryptogram < Struct.new(
675
- :exportable,
676
- :import_token,
677
695
  :key_attributes,
696
+ :exportable,
678
697
  :wrapped_key_cryptogram,
698
+ :import_token,
679
699
  :wrapping_spec)
680
700
  SENSITIVE = []
681
701
  include Aws::Structure
682
702
  end
683
703
 
684
- # @!attribute [rw] enabled
685
- # Specifies whether import key is enabled.
686
- # @return [Boolean]
704
+ # @!attribute [rw] key_material
705
+ # The key or public key certificate type to use during key material
706
+ # import, for example TR-34 or RootCertificatePublicKey.
707
+ # @return [Types::ImportKeyMaterial]
687
708
  #
688
709
  # @!attribute [rw] key_check_value_algorithm
689
710
  # The algorithm that Amazon Web Services Payment Cryptography uses to
@@ -698,16 +719,15 @@ module Aws::PaymentCryptography
698
719
  # result.
699
720
  # @return [String]
700
721
  #
701
- # @!attribute [rw] key_material
702
- # The key or public key certificate type to use during key material
703
- # import, for example TR-34 or RootCertificatePublicKey.
704
- # @return [Types::ImportKeyMaterial]
722
+ # @!attribute [rw] enabled
723
+ # Specifies whether import key is enabled.
724
+ # @return [Boolean]
705
725
  #
706
726
  # @!attribute [rw] tags
707
727
  # Assigns one or more tags to the Amazon Web Services Payment
708
728
  # Cryptography key. Use this parameter to tag a key when it is
709
729
  # imported. To tag an existing Amazon Web Services Payment
710
- # Cryptography key, use the TagResource operation.
730
+ # Cryptography key, use the [TagResource][1] operation.
711
731
  #
712
732
  # Each tag consists of a tag key and a tag value. Both the tag key and
713
733
  # the tag value are required, but the tag value can be an empty (null)
@@ -725,14 +745,18 @@ module Aws::PaymentCryptography
725
745
  # can allow or deny permission to the key.
726
746
  #
727
747
  # </note>
748
+ #
749
+ #
750
+ #
751
+ # [1]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html
728
752
  # @return [Array<Types::Tag>]
729
753
  #
730
754
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ImportKeyInput AWS API Documentation
731
755
  #
732
756
  class ImportKeyInput < Struct.new(
733
- :enabled,
734
- :key_check_value_algorithm,
735
757
  :key_material,
758
+ :key_check_value_algorithm,
759
+ :enabled,
736
760
  :tags)
737
761
  SENSITIVE = []
738
762
  include Aws::Structure
@@ -744,15 +768,14 @@ module Aws::PaymentCryptography
744
768
  #
745
769
  # @note ImportKeyMaterial is a union - when making an API calls you must set exactly one of the members.
746
770
  #
747
- # @!attribute [rw] key_cryptogram
748
- # Parameter information for key material import using asymmetric RSA
749
- # wrap and unwrap key exchange method.
750
- # @return [Types::ImportKeyCryptogram]
751
- #
752
771
  # @!attribute [rw] root_certificate_public_key
753
772
  # Parameter information for root public key certificate import.
754
773
  # @return [Types::RootCertificatePublicKey]
755
774
  #
775
+ # @!attribute [rw] trusted_certificate_public_key
776
+ # Parameter information for trusted public key certificate import.
777
+ # @return [Types::TrustedCertificatePublicKey]
778
+ #
756
779
  # @!attribute [rw] tr_31_key_block
757
780
  # Parameter information for key material import using symmetric TR-31
758
781
  # key exchange method.
@@ -763,28 +786,29 @@ module Aws::PaymentCryptography
763
786
  # TR-34 key exchange method.
764
787
  # @return [Types::ImportTr34KeyBlock]
765
788
  #
766
- # @!attribute [rw] trusted_certificate_public_key
767
- # Parameter information for trusted public key certificate import.
768
- # @return [Types::TrustedCertificatePublicKey]
789
+ # @!attribute [rw] key_cryptogram
790
+ # Parameter information for key material import using asymmetric RSA
791
+ # wrap and unwrap key exchange method.
792
+ # @return [Types::ImportKeyCryptogram]
769
793
  #
770
794
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ImportKeyMaterial AWS API Documentation
771
795
  #
772
796
  class ImportKeyMaterial < Struct.new(
773
- :key_cryptogram,
774
797
  :root_certificate_public_key,
798
+ :trusted_certificate_public_key,
775
799
  :tr_31_key_block,
776
800
  :tr_34_key_block,
777
- :trusted_certificate_public_key,
801
+ :key_cryptogram,
778
802
  :unknown)
779
803
  SENSITIVE = []
780
804
  include Aws::Structure
781
805
  include Aws::Structure::Union
782
806
 
783
- class KeyCryptogram < ImportKeyMaterial; end
784
807
  class RootCertificatePublicKey < ImportKeyMaterial; end
808
+ class TrustedCertificatePublicKey < ImportKeyMaterial; end
785
809
  class Tr31KeyBlock < ImportKeyMaterial; end
786
810
  class Tr34KeyBlock < ImportKeyMaterial; end
787
- class TrustedCertificatePublicKey < ImportKeyMaterial; end
811
+ class KeyCryptogram < ImportKeyMaterial; end
788
812
  class Unknown < ImportKeyMaterial; end
789
813
  end
790
814
 
@@ -804,20 +828,20 @@ module Aws::PaymentCryptography
804
828
  # Parameter information for key material import using symmetric TR-31
805
829
  # key exchange method.
806
830
  #
807
- # @!attribute [rw] wrapped_key_block
808
- # The TR-31 wrapped key block to import.
809
- # @return [String]
810
- #
811
831
  # @!attribute [rw] wrapping_key_identifier
812
832
  # The `KeyARN` of the key that will decrypt or unwrap a TR-31 key
813
833
  # block during import.
814
834
  # @return [String]
815
835
  #
836
+ # @!attribute [rw] wrapped_key_block
837
+ # The TR-31 wrapped key block to import.
838
+ # @return [String]
839
+ #
816
840
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ImportTr31KeyBlock AWS API Documentation
817
841
  #
818
842
  class ImportTr31KeyBlock < Struct.new(
819
- :wrapped_key_block,
820
- :wrapping_key_identifier)
843
+ :wrapping_key_identifier,
844
+ :wrapped_key_block)
821
845
  SENSITIVE = []
822
846
  include Aws::Structure
823
847
  end
@@ -830,6 +854,11 @@ module Aws::PaymentCryptography
830
854
  # certificate during TR-34 key import.
831
855
  # @return [String]
832
856
  #
857
+ # @!attribute [rw] signing_key_certificate
858
+ # The public key component in PEM certificate format of the private
859
+ # key that signs the KDH TR-34 WrappedKeyBlock.
860
+ # @return [String]
861
+ #
833
862
  # @!attribute [rw] import_token
834
863
  # The import token that initiates key import using the asymmetric
835
864
  # TR-34 key exchange method into Amazon Web Services Payment
@@ -837,6 +866,10 @@ module Aws::PaymentCryptography
837
866
  # token to import multiple keys to the same service account.
838
867
  # @return [String]
839
868
  #
869
+ # @!attribute [rw] wrapped_key_block
870
+ # The TR-34 wrapped key block to import.
871
+ # @return [String]
872
+ #
840
873
  # @!attribute [rw] key_block_format
841
874
  # The key block format to use during key import. The only value
842
875
  # allowed is `X9_TR34_2012`.
@@ -848,24 +881,15 @@ module Aws::PaymentCryptography
848
881
  # value is not provided for a TR-34 key block generated using 2 pass.
849
882
  # @return [String]
850
883
  #
851
- # @!attribute [rw] signing_key_certificate
852
- # The public key component in PEM certificate format of the private
853
- # key that signs the KDH TR-34 WrappedKeyBlock.
854
- # @return [String]
855
- #
856
- # @!attribute [rw] wrapped_key_block
857
- # The TR-34 wrapped key block to import.
858
- # @return [String]
859
- #
860
884
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ImportTr34KeyBlock AWS API Documentation
861
885
  #
862
886
  class ImportTr34KeyBlock < Struct.new(
863
887
  :certificate_authority_public_key_identifier,
888
+ :signing_key_certificate,
864
889
  :import_token,
890
+ :wrapped_key_block,
865
891
  :key_block_format,
866
- :random_nonce,
867
- :signing_key_certificate,
868
- :wrapped_key_block)
892
+ :random_nonce)
869
893
  SENSITIVE = [:signing_key_certificate]
870
894
  include Aws::Structure
871
895
  end
@@ -886,33 +910,6 @@ module Aws::PaymentCryptography
886
910
 
887
911
  # Metadata about an Amazon Web Services Payment Cryptography key.
888
912
  #
889
- # @!attribute [rw] create_timestamp
890
- # The date and time when the key was created.
891
- # @return [Time]
892
- #
893
- # @!attribute [rw] delete_pending_timestamp
894
- # The date and time after which Amazon Web Services Payment
895
- # Cryptography will delete the key. This value is present only when
896
- # `KeyState` is `DELETE_PENDING` and the key is scheduled for
897
- # deletion.
898
- # @return [Time]
899
- #
900
- # @!attribute [rw] delete_timestamp
901
- # The date and time after which Amazon Web Services Payment
902
- # Cryptography will delete the key. This value is present only when
903
- # when the `KeyState` is `DELETE_COMPLETE` and the Amazon Web Services
904
- # Payment Cryptography key is deleted.
905
- # @return [Time]
906
- #
907
- # @!attribute [rw] enabled
908
- # Specifies whether the key is enabled.
909
- # @return [Boolean]
910
- #
911
- # @!attribute [rw] exportable
912
- # Specifies whether the key is exportable. This data is immutable
913
- # after the key is created.
914
- # @return [Boolean]
915
- #
916
913
  # @!attribute [rw] key_arn
917
914
  # The Amazon Resource Name (ARN) of the key.
918
915
  # @return [String]
@@ -941,6 +938,19 @@ module Aws::PaymentCryptography
941
938
  # result.
942
939
  # @return [String]
943
940
  #
941
+ # @!attribute [rw] enabled
942
+ # Specifies whether the key is enabled.
943
+ # @return [Boolean]
944
+ #
945
+ # @!attribute [rw] exportable
946
+ # Specifies whether the key is exportable. This data is immutable
947
+ # after the key is created.
948
+ # @return [Boolean]
949
+ #
950
+ # @!attribute [rw] key_state
951
+ # The state of key that is being created or deleted.
952
+ # @return [String]
953
+ #
944
954
  # @!attribute [rw] key_origin
945
955
  # The source of the key material. For keys created within Amazon Web
946
956
  # Services Payment Cryptography, the value is
@@ -948,9 +958,9 @@ module Aws::PaymentCryptography
948
958
  # Services Payment Cryptography, the value is `EXTERNAL`.
949
959
  # @return [String]
950
960
  #
951
- # @!attribute [rw] key_state
952
- # The state of key that is being created or deleted.
953
- # @return [String]
961
+ # @!attribute [rw] create_timestamp
962
+ # The date and time when the key was created.
963
+ # @return [Time]
954
964
  #
955
965
  # @!attribute [rw] usage_start_timestamp
956
966
  # The date and time after which Amazon Web Services Payment
@@ -964,22 +974,36 @@ module Aws::PaymentCryptography
964
974
  # operations.
965
975
  # @return [Time]
966
976
  #
977
+ # @!attribute [rw] delete_pending_timestamp
978
+ # The date and time after which Amazon Web Services Payment
979
+ # Cryptography will delete the key. This value is present only when
980
+ # `KeyState` is `DELETE_PENDING` and the key is scheduled for
981
+ # deletion.
982
+ # @return [Time]
983
+ #
984
+ # @!attribute [rw] delete_timestamp
985
+ # The date and time after which Amazon Web Services Payment
986
+ # Cryptography will delete the key. This value is present only when
987
+ # when the `KeyState` is `DELETE_COMPLETE` and the Amazon Web Services
988
+ # Payment Cryptography key is deleted.
989
+ # @return [Time]
990
+ #
967
991
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/Key AWS API Documentation
968
992
  #
969
993
  class Key < Struct.new(
970
- :create_timestamp,
971
- :delete_pending_timestamp,
972
- :delete_timestamp,
973
- :enabled,
974
- :exportable,
975
994
  :key_arn,
976
995
  :key_attributes,
977
996
  :key_check_value,
978
997
  :key_check_value_algorithm,
979
- :key_origin,
998
+ :enabled,
999
+ :exportable,
980
1000
  :key_state,
1001
+ :key_origin,
1002
+ :create_timestamp,
981
1003
  :usage_start_timestamp,
982
- :usage_stop_timestamp)
1004
+ :usage_stop_timestamp,
1005
+ :delete_pending_timestamp,
1006
+ :delete_timestamp)
983
1007
  SENSITIVE = []
984
1008
  include Aws::Structure
985
1009
  end
@@ -988,6 +1012,18 @@ module Aws::PaymentCryptography
988
1012
  # operations allowed with the key. This data is immutable after the key
989
1013
  # is created.
990
1014
  #
1015
+ # @!attribute [rw] key_usage
1016
+ # The cryptographic usage of an Amazon Web Services Payment
1017
+ # Cryptography key as defined in section A.5.2 of the TR-31 spec.
1018
+ # @return [String]
1019
+ #
1020
+ # @!attribute [rw] key_class
1021
+ # The type of Amazon Web Services Payment Cryptography key to create,
1022
+ # which determines the classification of the cryptographic method and
1023
+ # whether Amazon Web Services Payment Cryptography key contains a
1024
+ # symmetric key or an asymmetric key pair.
1025
+ # @return [String]
1026
+ #
991
1027
  # @!attribute [rw] key_algorithm
992
1028
  # The key algorithm to be use during creation of an Amazon Web
993
1029
  # Services Payment Cryptography key.
@@ -998,30 +1034,78 @@ module Aws::PaymentCryptography
998
1034
  # algorithms.
999
1035
  # @return [String]
1000
1036
  #
1001
- # @!attribute [rw] key_class
1002
- # The type of Amazon Web Services Payment Cryptography key to create,
1003
- # which determines the classification of the cryptographic method and
1004
- # whether Amazon Web Services Payment Cryptography key contains a
1005
- # symmetric key or an asymmetric key pair.
1006
- # @return [String]
1007
- #
1008
1037
  # @!attribute [rw] key_modes_of_use
1009
1038
  # The list of cryptographic operations that you can perform using the
1010
1039
  # key.
1011
1040
  # @return [Types::KeyModesOfUse]
1012
1041
  #
1013
- # @!attribute [rw] key_usage
1014
- # The cryptographic usage of an Amazon Web Services Payment
1015
- # Cryptography key as defined in section A.5.2 of the TR-31 spec.
1016
- # @return [String]
1017
- #
1018
1042
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/KeyAttributes AWS API Documentation
1019
1043
  #
1020
1044
  class KeyAttributes < Struct.new(
1021
- :key_algorithm,
1045
+ :key_usage,
1022
1046
  :key_class,
1047
+ :key_algorithm,
1048
+ :key_modes_of_use)
1049
+ SENSITIVE = []
1050
+ include Aws::Structure
1051
+ end
1052
+
1053
+ # Optional metadata for export associated with the key material. This
1054
+ # data is signed but transmitted in clear text.
1055
+ #
1056
+ # @!attribute [rw] key_modes_of_use
1057
+ # The list of cryptographic operations that you can perform using the
1058
+ # key. The modes of use are defined in section A.5.3 of the TR-31 spec.
1059
+ # @return [Types::KeyModesOfUse]
1060
+ #
1061
+ # @!attribute [rw] key_exportability
1062
+ # Specifies subsequent exportability of the key within the key block
1063
+ # after it is received by the receiving party. It can be used to
1064
+ # further restrict exportability of the key after export from Amazon
1065
+ # Web Services Payment Cryptography.
1066
+ #
1067
+ # When set to `EXPORTABLE`, the key can be subsequently exported by
1068
+ # the receiver under a KEK using TR-31 or TR-34 key block export only.
1069
+ # When set to `NON_EXPORTABLE`, the key cannot be subsequently
1070
+ # exported by the receiver. When set to `SENSITIVE`, the key can be
1071
+ # exported by the receiver under a KEK using TR-31, TR-34, RSA wrap
1072
+ # and unwrap cryptogram or using a symmetric cryptogram key export
1073
+ # method. For further information refer to [ANSI X9.143-2022][1].
1074
+ #
1075
+ #
1076
+ #
1077
+ # [1]: https://webstore.ansi.org/standards/ascx9/ansix91432022
1078
+ # @return [String]
1079
+ #
1080
+ # @!attribute [rw] key_version
1081
+ # Parameter used to indicate the version of the key carried in the key
1082
+ # block or indicate the value carried in the key block is a component
1083
+ # of a key.
1084
+ # @return [String]
1085
+ #
1086
+ # @!attribute [rw] optional_blocks
1087
+ # Parameter used to indicate the type of optional data in key block
1088
+ # headers. Refer to [ANSI X9.143-2022][1] for information on allowed
1089
+ # data type for optional blocks.
1090
+ #
1091
+ # Optional block character limit is 112 characters. For each optional
1092
+ # block, 2 characters are reserved for optional block ID and 2
1093
+ # characters reserved for optional block length. More than one
1094
+ # optional blocks can be included as long as the combined length does
1095
+ # not increase 112 characters.
1096
+ #
1097
+ #
1098
+ #
1099
+ # [1]: https://webstore.ansi.org/standards/ascx9/ansix91432022
1100
+ # @return [Hash<String,String>]
1101
+ #
1102
+ # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/KeyBlockHeaders AWS API Documentation
1103
+ #
1104
+ class KeyBlockHeaders < Struct.new(
1023
1105
  :key_modes_of_use,
1024
- :key_usage)
1106
+ :key_exportability,
1107
+ :key_version,
1108
+ :optional_blocks)
1025
1109
  SENSITIVE = []
1026
1110
  include Aws::Structure
1027
1111
  end
@@ -1029,19 +1113,24 @@ module Aws::PaymentCryptography
1029
1113
  # The list of cryptographic operations that you can perform using the
1030
1114
  # key. The modes of use are defined in section A.5.3 of the TR-31 spec.
1031
1115
  #
1116
+ # @!attribute [rw] encrypt
1117
+ # Specifies whether an Amazon Web Services Payment Cryptography key can
1118
+ # be used to encrypt data.
1119
+ # @return [Boolean]
1120
+ #
1032
1121
  # @!attribute [rw] decrypt
1033
1122
  # Specifies whether an Amazon Web Services Payment Cryptography key can
1034
1123
  # be used to decrypt data.
1035
1124
  # @return [Boolean]
1036
1125
  #
1037
- # @!attribute [rw] derive_key
1126
+ # @!attribute [rw] wrap
1038
1127
  # Specifies whether an Amazon Web Services Payment Cryptography key can
1039
- # be used to derive new keys.
1128
+ # be used to wrap other keys.
1040
1129
  # @return [Boolean]
1041
1130
  #
1042
- # @!attribute [rw] encrypt
1131
+ # @!attribute [rw] unwrap
1043
1132
  # Specifies whether an Amazon Web Services Payment Cryptography key can
1044
- # be used to encrypt data.
1133
+ # be used to unwrap other keys.
1045
1134
  # @return [Boolean]
1046
1135
  #
1047
1136
  # @!attribute [rw] generate
@@ -1049,63 +1138,54 @@ module Aws::PaymentCryptography
1049
1138
  # be used to generate and verify other card and PIN verification keys.
1050
1139
  # @return [Boolean]
1051
1140
  #
1052
- # @!attribute [rw] no_restrictions
1053
- # Specifies whether an Amazon Web Services Payment Cryptography key has
1054
- # no special restrictions other than the restrictions implied by
1055
- # `KeyUsage`.
1056
- # @return [Boolean]
1057
- #
1058
1141
  # @!attribute [rw] sign
1059
1142
  # Specifies whether an Amazon Web Services Payment Cryptography key can
1060
1143
  # be used for signing.
1061
1144
  # @return [Boolean]
1062
1145
  #
1063
- # @!attribute [rw] unwrap
1064
- # Specifies whether an Amazon Web Services Payment Cryptography key can
1065
- # be used to unwrap other keys.
1066
- # @return [Boolean]
1067
- #
1068
1146
  # @!attribute [rw] verify
1069
1147
  # Specifies whether an Amazon Web Services Payment Cryptography key can
1070
1148
  # be used to verify signatures.
1071
1149
  # @return [Boolean]
1072
1150
  #
1073
- # @!attribute [rw] wrap
1151
+ # @!attribute [rw] derive_key
1074
1152
  # Specifies whether an Amazon Web Services Payment Cryptography key can
1075
- # be used to wrap other keys.
1153
+ # be used to derive new keys.
1154
+ # @return [Boolean]
1155
+ #
1156
+ # @!attribute [rw] no_restrictions
1157
+ # Specifies whether an Amazon Web Services Payment Cryptography key has
1158
+ # no special restrictions other than the restrictions implied by
1159
+ # `KeyUsage`.
1076
1160
  # @return [Boolean]
1077
1161
  #
1078
1162
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/KeyModesOfUse AWS API Documentation
1079
1163
  #
1080
1164
  class KeyModesOfUse < Struct.new(
1081
- :decrypt,
1082
- :derive_key,
1083
1165
  :encrypt,
1166
+ :decrypt,
1167
+ :wrap,
1168
+ :unwrap,
1084
1169
  :generate,
1085
- :no_restrictions,
1086
1170
  :sign,
1087
- :unwrap,
1088
1171
  :verify,
1089
- :wrap)
1172
+ :derive_key,
1173
+ :no_restrictions)
1090
1174
  SENSITIVE = []
1091
1175
  include Aws::Structure
1092
1176
  end
1093
1177
 
1094
1178
  # Metadata about an Amazon Web Services Payment Cryptography key.
1095
1179
  #
1096
- # @!attribute [rw] enabled
1097
- # Specifies whether the key is enabled.
1098
- # @return [Boolean]
1099
- #
1100
- # @!attribute [rw] exportable
1101
- # Specifies whether the key is exportable. This data is immutable
1102
- # after the key is created.
1103
- # @return [Boolean]
1104
- #
1105
1180
  # @!attribute [rw] key_arn
1106
1181
  # The Amazon Resource Name (ARN) of the key.
1107
1182
  # @return [String]
1108
1183
  #
1184
+ # @!attribute [rw] key_state
1185
+ # The state of an Amazon Web Services Payment Cryptography that is
1186
+ # being created or deleted.
1187
+ # @return [String]
1188
+ #
1109
1189
  # @!attribute [rw] key_attributes
1110
1190
  # The role of the key, the algorithm it supports, and the
1111
1191
  # cryptographic operations allowed with the key. This data is
@@ -1117,24 +1197,34 @@ module Aws::PaymentCryptography
1117
1197
  # given key have the same key or to detect that a key has changed.
1118
1198
  # @return [String]
1119
1199
  #
1120
- # @!attribute [rw] key_state
1121
- # The state of an Amazon Web Services Payment Cryptography that is
1122
- # being created or deleted.
1123
- # @return [String]
1200
+ # @!attribute [rw] exportable
1201
+ # Specifies whether the key is exportable. This data is immutable
1202
+ # after the key is created.
1203
+ # @return [Boolean]
1204
+ #
1205
+ # @!attribute [rw] enabled
1206
+ # Specifies whether the key is enabled.
1207
+ # @return [Boolean]
1124
1208
  #
1125
1209
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/KeySummary AWS API Documentation
1126
1210
  #
1127
1211
  class KeySummary < Struct.new(
1128
- :enabled,
1129
- :exportable,
1130
1212
  :key_arn,
1213
+ :key_state,
1131
1214
  :key_attributes,
1132
1215
  :key_check_value,
1133
- :key_state)
1216
+ :exportable,
1217
+ :enabled)
1134
1218
  SENSITIVE = []
1135
1219
  include Aws::Structure
1136
1220
  end
1137
1221
 
1222
+ # @!attribute [rw] next_token
1223
+ # Use this parameter in a subsequent request after you receive a
1224
+ # response with truncated results. Set it to the value of `NextToken`
1225
+ # from the truncated response you just received.
1226
+ # @return [String]
1227
+ #
1138
1228
  # @!attribute [rw] max_results
1139
1229
  # Use this parameter to specify the maximum number of items to return.
1140
1230
  # When this value is present, Amazon Web Services Payment Cryptography
@@ -1146,17 +1236,11 @@ module Aws::PaymentCryptography
1146
1236
  # 50.
1147
1237
  # @return [Integer]
1148
1238
  #
1149
- # @!attribute [rw] next_token
1150
- # Use this parameter in a subsequent request after you receive a
1151
- # response with truncated results. Set it to the value of `NextToken`
1152
- # from the truncated response you just received.
1153
- # @return [String]
1154
- #
1155
1239
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ListAliasesInput AWS API Documentation
1156
1240
  #
1157
1241
  class ListAliasesInput < Struct.new(
1158
- :max_results,
1159
- :next_token)
1242
+ :next_token,
1243
+ :max_results)
1160
1244
  SENSITIVE = []
1161
1245
  include Aws::Structure
1162
1246
  end
@@ -1184,6 +1268,12 @@ module Aws::PaymentCryptography
1184
1268
  # The key state of the keys you want to list.
1185
1269
  # @return [String]
1186
1270
  #
1271
+ # @!attribute [rw] next_token
1272
+ # Use this parameter in a subsequent request after you receive a
1273
+ # response with truncated results. Set it to the value of `NextToken`
1274
+ # from the truncated response you just received.
1275
+ # @return [String]
1276
+ #
1187
1277
  # @!attribute [rw] max_results
1188
1278
  # Use this parameter to specify the maximum number of items to return.
1189
1279
  # When this value is present, Amazon Web Services Payment Cryptography
@@ -1195,18 +1285,12 @@ module Aws::PaymentCryptography
1195
1285
  # 50.
1196
1286
  # @return [Integer]
1197
1287
  #
1198
- # @!attribute [rw] next_token
1199
- # Use this parameter in a subsequent request after you receive a
1200
- # response with truncated results. Set it to the value of `NextToken`
1201
- # from the truncated response you just received.
1202
- # @return [String]
1203
- #
1204
1288
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ListKeysInput AWS API Documentation
1205
1289
  #
1206
1290
  class ListKeysInput < Struct.new(
1207
1291
  :key_state,
1208
- :max_results,
1209
- :next_token)
1292
+ :next_token,
1293
+ :max_results)
1210
1294
  SENSITIVE = []
1211
1295
  include Aws::Structure
1212
1296
  end
@@ -1230,6 +1314,16 @@ module Aws::PaymentCryptography
1230
1314
  include Aws::Structure
1231
1315
  end
1232
1316
 
1317
+ # @!attribute [rw] resource_arn
1318
+ # The `KeyARN` of the key whose tags you are getting.
1319
+ # @return [String]
1320
+ #
1321
+ # @!attribute [rw] next_token
1322
+ # Use this parameter in a subsequent request after you receive a
1323
+ # response with truncated results. Set it to the value of `NextToken`
1324
+ # from the truncated response you just received.
1325
+ # @return [String]
1326
+ #
1233
1327
  # @!attribute [rw] max_results
1234
1328
  # Use this parameter to specify the maximum number of items to return.
1235
1329
  # When this value is present, Amazon Web Services Payment Cryptography
@@ -1241,41 +1335,31 @@ module Aws::PaymentCryptography
1241
1335
  # 50.
1242
1336
  # @return [Integer]
1243
1337
  #
1244
- # @!attribute [rw] next_token
1245
- # Use this parameter in a subsequent request after you receive a
1246
- # response with truncated results. Set it to the value of `NextToken`
1247
- # from the truncated response you just received.
1248
- # @return [String]
1249
- #
1250
- # @!attribute [rw] resource_arn
1251
- # The `KeyARN` of the key whose tags you are getting.
1252
- # @return [String]
1253
- #
1254
1338
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ListTagsForResourceInput AWS API Documentation
1255
1339
  #
1256
1340
  class ListTagsForResourceInput < Struct.new(
1257
- :max_results,
1341
+ :resource_arn,
1258
1342
  :next_token,
1259
- :resource_arn)
1343
+ :max_results)
1260
1344
  SENSITIVE = []
1261
1345
  include Aws::Structure
1262
1346
  end
1263
1347
 
1264
- # @!attribute [rw] next_token
1265
- # The token for the next set of results, or an empty or null value if
1266
- # there are no more results.
1267
- # @return [String]
1268
- #
1269
1348
  # @!attribute [rw] tags
1270
1349
  # The list of tags associated with a `ResourceArn`. Each tag will list
1271
1350
  # the key-value pair contained within that tag.
1272
1351
  # @return [Array<Types::Tag>]
1273
1352
  #
1353
+ # @!attribute [rw] next_token
1354
+ # The token for the next set of results, or an empty or null value if
1355
+ # there are no more results.
1356
+ # @return [String]
1357
+ #
1274
1358
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ListTagsForResourceOutput AWS API Documentation
1275
1359
  #
1276
1360
  class ListTagsForResourceOutput < Struct.new(
1277
- :next_token,
1278
- :tags)
1361
+ :tags,
1362
+ :next_token)
1279
1363
  SENSITIVE = []
1280
1364
  include Aws::Structure
1281
1365
  end
@@ -1452,12 +1536,16 @@ module Aws::PaymentCryptography
1452
1536
  # this field. This field may be displayed in plaintext in CloudTrail
1453
1537
  # logs and other output.
1454
1538
  #
1455
- # To use this parameter, you must have TagResource permission in an
1456
- # IAM policy.
1539
+ # To use this parameter, you must have [TagResource][1] permission in
1540
+ # an IAM policy.
1457
1541
  #
1458
1542
  # Don't include personal, confidential or sensitive information in
1459
1543
  # this field. This field may be displayed in plaintext in CloudTrail
1460
1544
  # logs and other output.
1545
+ #
1546
+ #
1547
+ #
1548
+ # [1]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html
1461
1549
  # @return [Array<Types::Tag>]
1462
1550
  #
1463
1551
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/TagResourceInput AWS API Documentation
@@ -1488,11 +1576,6 @@ module Aws::PaymentCryptography
1488
1576
 
1489
1577
  # Parameter information for trusted public key certificate import.
1490
1578
  #
1491
- # @!attribute [rw] certificate_authority_public_key_identifier
1492
- # The `KeyARN` of the root public key certificate or certificate chain
1493
- # that signs the trusted public key certificate import.
1494
- # @return [String]
1495
- #
1496
1579
  # @!attribute [rw] key_attributes
1497
1580
  # The role of the key, the algorithm it supports, and the
1498
1581
  # cryptographic operations allowed with the key. This data is
@@ -1503,12 +1586,17 @@ module Aws::PaymentCryptography
1503
1586
  # Parameter information for trusted public key certificate import.
1504
1587
  # @return [String]
1505
1588
  #
1589
+ # @!attribute [rw] certificate_authority_public_key_identifier
1590
+ # The `KeyARN` of the root public key certificate or certificate chain
1591
+ # that signs the trusted public key certificate import.
1592
+ # @return [String]
1593
+ #
1506
1594
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/TrustedCertificatePublicKey AWS API Documentation
1507
1595
  #
1508
1596
  class TrustedCertificatePublicKey < Struct.new(
1509
- :certificate_authority_public_key_identifier,
1510
1597
  :key_attributes,
1511
- :public_key_certificate)
1598
+ :public_key_certificate,
1599
+ :certificate_authority_public_key_identifier)
1512
1600
  SENSITIVE = [:public_key_certificate]
1513
1601
  include Aws::Structure
1514
1602
  end
@@ -1523,7 +1611,11 @@ module Aws::PaymentCryptography
1523
1611
  # If the Amazon Web Services Payment Cryptography key doesn't have
1524
1612
  # the specified tag key, Amazon Web Services Payment Cryptography
1525
1613
  # doesn't throw an exception or return a response. To confirm that
1526
- # the operation succeeded, use the ListTagsForResource operation.
1614
+ # the operation succeeded, use the [ListTagsForResource][1] operation.
1615
+ #
1616
+ #
1617
+ #
1618
+ # [1]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html
1527
1619
  # @return [Array<String>]
1528
1620
  #
1529
1621
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/UntagResourceInput AWS API Documentation
@@ -1585,6 +1677,19 @@ module Aws::PaymentCryptography
1585
1677
  # Parameter information for generating a WrappedKeyBlock for key
1586
1678
  # exchange.
1587
1679
  #
1680
+ # @!attribute [rw] wrapping_key_arn
1681
+ # The `KeyARN` of the wrapped key.
1682
+ # @return [String]
1683
+ #
1684
+ # @!attribute [rw] wrapped_key_material_format
1685
+ # The key block format of a wrapped key.
1686
+ # @return [String]
1687
+ #
1688
+ # @!attribute [rw] key_material
1689
+ # Parameter information for generating a wrapped key using TR-31 or
1690
+ # TR-34 skey exchange method.
1691
+ # @return [String]
1692
+ #
1588
1693
  # @!attribute [rw] key_check_value
1589
1694
  # The key check value (KCV) is used to check if all parties holding a
1590
1695
  # given key have the same key or to detect that a key has changed.
@@ -1603,27 +1708,14 @@ module Aws::PaymentCryptography
1603
1708
  # result.
1604
1709
  # @return [String]
1605
1710
  #
1606
- # @!attribute [rw] key_material
1607
- # Parameter information for generating a wrapped key using TR-31 or
1608
- # TR-34 skey exchange method.
1609
- # @return [String]
1610
- #
1611
- # @!attribute [rw] wrapped_key_material_format
1612
- # The key block format of a wrapped key.
1613
- # @return [String]
1614
- #
1615
- # @!attribute [rw] wrapping_key_arn
1616
- # The `KeyARN` of the wrapped key.
1617
- # @return [String]
1618
- #
1619
1711
  # @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/WrappedKey AWS API Documentation
1620
1712
  #
1621
1713
  class WrappedKey < Struct.new(
1622
- :key_check_value,
1623
- :key_check_value_algorithm,
1624
- :key_material,
1714
+ :wrapping_key_arn,
1625
1715
  :wrapped_key_material_format,
1626
- :wrapping_key_arn)
1716
+ :key_material,
1717
+ :key_check_value,
1718
+ :key_check_value_algorithm)
1627
1719
  SENSITIVE = [:key_material]
1628
1720
  include Aws::Structure
1629
1721
  end