aws-sdk-paymentcryptography 1.41.0 → 1.43.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-paymentcryptography/client.rb +481 -17
- data/lib/aws-sdk-paymentcryptography/client_api.rb +188 -2
- data/lib/aws-sdk-paymentcryptography/types.rb +472 -18
- data/lib/aws-sdk-paymentcryptography.rb +2 -2
- data/sig/client.rbs +84 -7
- data/sig/types.rbs +106 -15
- metadata +1 -1
@@ -12,6 +12,11 @@ module Aws::PaymentCryptography
|
|
12
12
|
|
13
13
|
# You do not have sufficient access to perform this action.
|
14
14
|
#
|
15
|
+
# This exception is thrown when the caller lacks the necessary IAM
|
16
|
+
# permissions to perform the requested operation. Verify that your IAM
|
17
|
+
# policy includes the required permissions for the specific Amazon Web
|
18
|
+
# Services Payment Cryptography action you're attempting.
|
19
|
+
#
|
15
20
|
# @!attribute [rw] message
|
16
21
|
# @return [String]
|
17
22
|
#
|
@@ -23,6 +28,52 @@ module Aws::PaymentCryptography
|
|
23
28
|
include Aws::Structure
|
24
29
|
end
|
25
30
|
|
31
|
+
# Input parameters for adding replication regions to a specific key.
|
32
|
+
#
|
33
|
+
# @!attribute [rw] key_identifier
|
34
|
+
# The key identifier (ARN or alias) of the key for which to add
|
35
|
+
# replication regions.
|
36
|
+
#
|
37
|
+
# This key must exist and be in a valid state for replication
|
38
|
+
# operations.
|
39
|
+
# @return [String]
|
40
|
+
#
|
41
|
+
# @!attribute [rw] replication_regions
|
42
|
+
# The list of Amazon Web Services Regions to add to the key's
|
43
|
+
# replication configuration.
|
44
|
+
#
|
45
|
+
# Each region must be a valid Amazon Web Services Region where Amazon
|
46
|
+
# Web Services Payment Cryptography is available. The key will be
|
47
|
+
# replicated to these regions, allowing cryptographic operations to be
|
48
|
+
# performed closer to your applications.
|
49
|
+
# @return [Array<String>]
|
50
|
+
#
|
51
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/AddKeyReplicationRegionsInput AWS API Documentation
|
52
|
+
#
|
53
|
+
class AddKeyReplicationRegionsInput < Struct.new(
|
54
|
+
:key_identifier,
|
55
|
+
:replication_regions)
|
56
|
+
SENSITIVE = []
|
57
|
+
include Aws::Structure
|
58
|
+
end
|
59
|
+
|
60
|
+
# Output from adding replication regions to a key.
|
61
|
+
#
|
62
|
+
# @!attribute [rw] key
|
63
|
+
# The updated key metadata after adding the replication regions.
|
64
|
+
#
|
65
|
+
# This includes the current state of the key and its replication
|
66
|
+
# configuration.
|
67
|
+
# @return [Types::Key]
|
68
|
+
#
|
69
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/AddKeyReplicationRegionsOutput AWS API Documentation
|
70
|
+
#
|
71
|
+
class AddKeyReplicationRegionsOutput < Struct.new(
|
72
|
+
:key)
|
73
|
+
SENSITIVE = []
|
74
|
+
include Aws::Structure
|
75
|
+
end
|
76
|
+
|
26
77
|
# Contains information about an alias.
|
27
78
|
#
|
28
79
|
# @!attribute [rw] alias_name
|
@@ -47,8 +98,56 @@ module Aws::PaymentCryptography
|
|
47
98
|
include Aws::Structure
|
48
99
|
end
|
49
100
|
|
101
|
+
# Metadata used in generating the CSR
|
102
|
+
#
|
103
|
+
# @!attribute [rw] common_name
|
104
|
+
# Common Name to be used in the certificate signing request
|
105
|
+
# @return [String]
|
106
|
+
#
|
107
|
+
# @!attribute [rw] organization_unit
|
108
|
+
# Organization Unit to be used in the certificate signing request
|
109
|
+
# @return [String]
|
110
|
+
#
|
111
|
+
# @!attribute [rw] organization
|
112
|
+
# Organization to be used in the certificate signing request
|
113
|
+
# @return [String]
|
114
|
+
#
|
115
|
+
# @!attribute [rw] city
|
116
|
+
# City to be used in the certificate signing request
|
117
|
+
# @return [String]
|
118
|
+
#
|
119
|
+
# @!attribute [rw] country
|
120
|
+
# Country to be used in the certificate signing request
|
121
|
+
# @return [String]
|
122
|
+
#
|
123
|
+
# @!attribute [rw] state_or_province
|
124
|
+
# State Or Province to be used in the certificate signing request
|
125
|
+
# @return [String]
|
126
|
+
#
|
127
|
+
# @!attribute [rw] email_address
|
128
|
+
# Email to be used in the certificate signing request
|
129
|
+
# @return [String]
|
130
|
+
#
|
131
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/CertificateSubjectType AWS API Documentation
|
132
|
+
#
|
133
|
+
class CertificateSubjectType < Struct.new(
|
134
|
+
:common_name,
|
135
|
+
:organization_unit,
|
136
|
+
:organization,
|
137
|
+
:city,
|
138
|
+
:country,
|
139
|
+
:state_or_province,
|
140
|
+
:email_address)
|
141
|
+
SENSITIVE = []
|
142
|
+
include Aws::Structure
|
143
|
+
end
|
144
|
+
|
50
145
|
# This request can cause an inconsistent state for the resource.
|
51
146
|
#
|
147
|
+
# The requested operation conflicts with the current state of the
|
148
|
+
# resource. For example, attempting to delete a key that is currently
|
149
|
+
# being used, or trying to create a resource that already exists.
|
150
|
+
#
|
52
151
|
# @!attribute [rw] message
|
53
152
|
# @return [String]
|
54
153
|
#
|
@@ -158,6 +257,16 @@ module Aws::PaymentCryptography
|
|
158
257
|
# cryptographic usage of keys derived from it using ECDH.
|
159
258
|
# @return [String]
|
160
259
|
#
|
260
|
+
# @!attribute [rw] replication_regions
|
261
|
+
# A list of Amazon Web Services Regions for key replication
|
262
|
+
# operations.
|
263
|
+
#
|
264
|
+
# Each region in the list must be a valid Amazon Web Services Region
|
265
|
+
# identifier where Amazon Web Services Payment Cryptography is
|
266
|
+
# available. This list is used to specify which regions should be
|
267
|
+
# added to or removed from a key's replication configuration.
|
268
|
+
# @return [Array<String>]
|
269
|
+
#
|
161
270
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/CreateKeyInput AWS API Documentation
|
162
271
|
#
|
163
272
|
class CreateKeyInput < Struct.new(
|
@@ -166,7 +275,8 @@ module Aws::PaymentCryptography
|
|
166
275
|
:exportable,
|
167
276
|
:enabled,
|
168
277
|
:tags,
|
169
|
-
:derive_key_usage
|
278
|
+
:derive_key_usage,
|
279
|
+
:replication_regions)
|
170
280
|
SENSITIVE = []
|
171
281
|
include Aws::Structure
|
172
282
|
end
|
@@ -260,6 +370,81 @@ module Aws::PaymentCryptography
|
|
260
370
|
class Unknown < DiffieHellmanDerivationData; end
|
261
371
|
end
|
262
372
|
|
373
|
+
# Input parameters for disabling default key replication regions for the
|
374
|
+
# account.
|
375
|
+
#
|
376
|
+
# @!attribute [rw] replication_regions
|
377
|
+
# The list of Amazon Web Services Regions to remove from the
|
378
|
+
# account's default replication regions.
|
379
|
+
#
|
380
|
+
# New keys created after this operation will not automatically be
|
381
|
+
# replicated to these regions, though existing keys with replication
|
382
|
+
# to these regions will be unaffected.
|
383
|
+
# @return [Array<String>]
|
384
|
+
#
|
385
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/DisableDefaultKeyReplicationRegionsInput AWS API Documentation
|
386
|
+
#
|
387
|
+
class DisableDefaultKeyReplicationRegionsInput < Struct.new(
|
388
|
+
:replication_regions)
|
389
|
+
SENSITIVE = []
|
390
|
+
include Aws::Structure
|
391
|
+
end
|
392
|
+
|
393
|
+
# Output from disabling default key replication regions for the account.
|
394
|
+
#
|
395
|
+
# @!attribute [rw] enabled_replication_regions
|
396
|
+
# The remaining list of regions where default key replication is still
|
397
|
+
# enabled for the account.
|
398
|
+
#
|
399
|
+
# This reflects the account's default replication configuration after
|
400
|
+
# removing the specified regions.
|
401
|
+
# @return [Array<String>]
|
402
|
+
#
|
403
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/DisableDefaultKeyReplicationRegionsOutput AWS API Documentation
|
404
|
+
#
|
405
|
+
class DisableDefaultKeyReplicationRegionsOutput < Struct.new(
|
406
|
+
:enabled_replication_regions)
|
407
|
+
SENSITIVE = []
|
408
|
+
include Aws::Structure
|
409
|
+
end
|
410
|
+
|
411
|
+
# Input parameters for enabling default key replication regions for the
|
412
|
+
# account.
|
413
|
+
#
|
414
|
+
# @!attribute [rw] replication_regions
|
415
|
+
# The list of Amazon Web Services Regions to enable as default
|
416
|
+
# replication regions for the account.
|
417
|
+
#
|
418
|
+
# New keys created in this account will automatically be replicated to
|
419
|
+
# these regions unless explicitly overridden during key creation.
|
420
|
+
# @return [Array<String>]
|
421
|
+
#
|
422
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/EnableDefaultKeyReplicationRegionsInput AWS API Documentation
|
423
|
+
#
|
424
|
+
class EnableDefaultKeyReplicationRegionsInput < Struct.new(
|
425
|
+
:replication_regions)
|
426
|
+
SENSITIVE = []
|
427
|
+
include Aws::Structure
|
428
|
+
end
|
429
|
+
|
430
|
+
# Output from enabling default key replication regions for the account.
|
431
|
+
#
|
432
|
+
# @!attribute [rw] enabled_replication_regions
|
433
|
+
# The complete list of regions where default key replication is now
|
434
|
+
# enabled for the account.
|
435
|
+
#
|
436
|
+
# This includes both previously enabled regions and the newly added
|
437
|
+
# regions from this operation.
|
438
|
+
# @return [Array<String>]
|
439
|
+
#
|
440
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/EnableDefaultKeyReplicationRegionsOutput AWS API Documentation
|
441
|
+
#
|
442
|
+
class EnableDefaultKeyReplicationRegionsOutput < Struct.new(
|
443
|
+
:enabled_replication_regions)
|
444
|
+
SENSITIVE = []
|
445
|
+
include Aws::Structure
|
446
|
+
end
|
447
|
+
|
263
448
|
# The attributes for IPEK generation during export.
|
264
449
|
#
|
265
450
|
# @!attribute [rw] export_dukpt_initial_key
|
@@ -338,7 +523,7 @@ module Aws::PaymentCryptography
|
|
338
523
|
:key_derivation_hash_algorithm,
|
339
524
|
:derivation_data,
|
340
525
|
:key_block_headers)
|
341
|
-
SENSITIVE = [
|
526
|
+
SENSITIVE = []
|
342
527
|
include Aws::Structure
|
343
528
|
end
|
344
529
|
|
@@ -384,7 +569,7 @@ module Aws::PaymentCryptography
|
|
384
569
|
:certificate_authority_public_key_identifier,
|
385
570
|
:wrapping_key_certificate,
|
386
571
|
:wrapping_spec)
|
387
|
-
SENSITIVE = [
|
572
|
+
SENSITIVE = []
|
388
573
|
include Aws::Structure
|
389
574
|
end
|
390
575
|
|
@@ -519,6 +704,14 @@ module Aws::PaymentCryptography
|
|
519
704
|
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForExport.html
|
520
705
|
# @return [String]
|
521
706
|
#
|
707
|
+
# @!attribute [rw] signing_key_identifier
|
708
|
+
# Key Identifier used for signing the export key
|
709
|
+
# @return [String]
|
710
|
+
#
|
711
|
+
# @!attribute [rw] signing_key_certificate
|
712
|
+
# Certificate used for signing the export key
|
713
|
+
# @return [String]
|
714
|
+
#
|
522
715
|
# @!attribute [rw] key_block_format
|
523
716
|
# The format of key block that Amazon Web Services Payment
|
524
717
|
# Cryptography will use during key export.
|
@@ -541,10 +734,12 @@ module Aws::PaymentCryptography
|
|
541
734
|
:certificate_authority_public_key_identifier,
|
542
735
|
:wrapping_key_certificate,
|
543
736
|
:export_token,
|
737
|
+
:signing_key_identifier,
|
738
|
+
:signing_key_certificate,
|
544
739
|
:key_block_format,
|
545
740
|
:random_nonce,
|
546
741
|
:key_block_headers)
|
547
|
-
SENSITIVE = [
|
742
|
+
SENSITIVE = []
|
548
743
|
include Aws::Structure
|
549
744
|
end
|
550
745
|
|
@@ -572,6 +767,69 @@ module Aws::PaymentCryptography
|
|
572
767
|
include Aws::Structure
|
573
768
|
end
|
574
769
|
|
770
|
+
# @!attribute [rw] key_identifier
|
771
|
+
# Asymmetric key used for generating the certificate signing request
|
772
|
+
# @return [String]
|
773
|
+
#
|
774
|
+
# @!attribute [rw] signing_algorithm
|
775
|
+
# Algorithm used to generate the certificate signing request
|
776
|
+
# @return [String]
|
777
|
+
#
|
778
|
+
# @!attribute [rw] certificate_subject
|
779
|
+
# Certificate subject data
|
780
|
+
# @return [Types::CertificateSubjectType]
|
781
|
+
#
|
782
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/GetCertificateSigningRequestInput AWS API Documentation
|
783
|
+
#
|
784
|
+
class GetCertificateSigningRequestInput < Struct.new(
|
785
|
+
:key_identifier,
|
786
|
+
:signing_algorithm,
|
787
|
+
:certificate_subject)
|
788
|
+
SENSITIVE = []
|
789
|
+
include Aws::Structure
|
790
|
+
end
|
791
|
+
|
792
|
+
# @!attribute [rw] certificate_signing_request
|
793
|
+
# Certificate signing request
|
794
|
+
# @return [String]
|
795
|
+
#
|
796
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/GetCertificateSigningRequestOutput AWS API Documentation
|
797
|
+
#
|
798
|
+
class GetCertificateSigningRequestOutput < Struct.new(
|
799
|
+
:certificate_signing_request)
|
800
|
+
SENSITIVE = [:certificate_signing_request]
|
801
|
+
include Aws::Structure
|
802
|
+
end
|
803
|
+
|
804
|
+
# Input parameters for retrieving the account's default key replication
|
805
|
+
# regions. This operation requires no input parameters.
|
806
|
+
#
|
807
|
+
# @api private
|
808
|
+
#
|
809
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/GetDefaultKeyReplicationRegionsInput AWS API Documentation
|
810
|
+
#
|
811
|
+
class GetDefaultKeyReplicationRegionsInput < Aws::EmptyStructure; end
|
812
|
+
|
813
|
+
# Output containing the account's current default key replication
|
814
|
+
# configuration.
|
815
|
+
#
|
816
|
+
# @!attribute [rw] enabled_replication_regions
|
817
|
+
# The list of regions where default key replication is currently
|
818
|
+
# enabled for the account.
|
819
|
+
#
|
820
|
+
# New keys created in this account will automatically be replicated to
|
821
|
+
# these regions unless explicitly configured otherwise during key
|
822
|
+
# creation.
|
823
|
+
# @return [Array<String>]
|
824
|
+
#
|
825
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/GetDefaultKeyReplicationRegionsOutput AWS API Documentation
|
826
|
+
#
|
827
|
+
class GetDefaultKeyReplicationRegionsOutput < Struct.new(
|
828
|
+
:enabled_replication_regions)
|
829
|
+
SENSITIVE = []
|
830
|
+
include Aws::Structure
|
831
|
+
end
|
832
|
+
|
575
833
|
# @!attribute [rw] key_identifier
|
576
834
|
# The `KeyARN` of the Amazon Web Services Payment Cryptography key.
|
577
835
|
# @return [String]
|
@@ -585,8 +843,9 @@ module Aws::PaymentCryptography
|
|
585
843
|
end
|
586
844
|
|
587
845
|
# @!attribute [rw] key
|
588
|
-
#
|
589
|
-
# key
|
846
|
+
# Contains the key metadata, including both immutable and mutable
|
847
|
+
# attributes for the key, but does not include actual cryptographic
|
848
|
+
# key material.
|
590
849
|
# @return [Types::Key]
|
591
850
|
#
|
592
851
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/GetKeyOutput AWS API Documentation
|
@@ -655,7 +914,7 @@ module Aws::PaymentCryptography
|
|
655
914
|
:signing_key_algorithm,
|
656
915
|
:export_token,
|
657
916
|
:parameters_valid_until_timestamp)
|
658
|
-
SENSITIVE = [
|
917
|
+
SENSITIVE = []
|
659
918
|
include Aws::Structure
|
660
919
|
end
|
661
920
|
|
@@ -723,7 +982,7 @@ module Aws::PaymentCryptography
|
|
723
982
|
:wrapping_key_algorithm,
|
724
983
|
:import_token,
|
725
984
|
:parameters_valid_until_timestamp)
|
726
|
-
SENSITIVE = [
|
985
|
+
SENSITIVE = []
|
727
986
|
include Aws::Structure
|
728
987
|
end
|
729
988
|
|
@@ -756,7 +1015,7 @@ module Aws::PaymentCryptography
|
|
756
1015
|
class GetPublicKeyCertificateOutput < Struct.new(
|
757
1016
|
:key_certificate,
|
758
1017
|
:key_certificate_chain)
|
759
|
-
SENSITIVE = [
|
1018
|
+
SENSITIVE = []
|
760
1019
|
include Aws::Structure
|
761
1020
|
end
|
762
1021
|
|
@@ -809,7 +1068,7 @@ module Aws::PaymentCryptography
|
|
809
1068
|
:key_derivation_hash_algorithm,
|
810
1069
|
:derivation_data,
|
811
1070
|
:wrapped_key_block)
|
812
|
-
SENSITIVE = [:
|
1071
|
+
SENSITIVE = [:wrapped_key_block]
|
813
1072
|
include Aws::Structure
|
814
1073
|
end
|
815
1074
|
|
@@ -903,13 +1162,24 @@ module Aws::PaymentCryptography
|
|
903
1162
|
# [1]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html
|
904
1163
|
# @return [Array<Types::Tag>]
|
905
1164
|
#
|
1165
|
+
# @!attribute [rw] replication_regions
|
1166
|
+
# A list of Amazon Web Services Regions for key replication
|
1167
|
+
# operations.
|
1168
|
+
#
|
1169
|
+
# Each region in the list must be a valid Amazon Web Services Region
|
1170
|
+
# identifier where Amazon Web Services Payment Cryptography is
|
1171
|
+
# available. This list is used to specify which regions should be
|
1172
|
+
# added to or removed from a key's replication configuration.
|
1173
|
+
# @return [Array<String>]
|
1174
|
+
#
|
906
1175
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ImportKeyInput AWS API Documentation
|
907
1176
|
#
|
908
1177
|
class ImportKeyInput < Struct.new(
|
909
1178
|
:key_material,
|
910
1179
|
:key_check_value_algorithm,
|
911
1180
|
:enabled,
|
912
|
-
:tags
|
1181
|
+
:tags,
|
1182
|
+
:replication_regions)
|
913
1183
|
SENSITIVE = []
|
914
1184
|
include Aws::Structure
|
915
1185
|
end
|
@@ -1025,6 +1295,14 @@ module Aws::PaymentCryptography
|
|
1025
1295
|
# token to import multiple keys to the same service account.
|
1026
1296
|
# @return [String]
|
1027
1297
|
#
|
1298
|
+
# @!attribute [rw] wrapping_key_identifier
|
1299
|
+
# Key Identifier used for unwrapping the import key
|
1300
|
+
# @return [String]
|
1301
|
+
#
|
1302
|
+
# @!attribute [rw] wrapping_key_certificate
|
1303
|
+
# Key Identifier used for unwrapping the import key
|
1304
|
+
# @return [String]
|
1305
|
+
#
|
1028
1306
|
# @!attribute [rw] wrapped_key_block
|
1029
1307
|
# The TR-34 wrapped key block to import.
|
1030
1308
|
# @return [String]
|
@@ -1046,16 +1324,22 @@ module Aws::PaymentCryptography
|
|
1046
1324
|
:certificate_authority_public_key_identifier,
|
1047
1325
|
:signing_key_certificate,
|
1048
1326
|
:import_token,
|
1327
|
+
:wrapping_key_identifier,
|
1328
|
+
:wrapping_key_certificate,
|
1049
1329
|
:wrapped_key_block,
|
1050
1330
|
:key_block_format,
|
1051
1331
|
:random_nonce)
|
1052
|
-
SENSITIVE = [:
|
1332
|
+
SENSITIVE = [:wrapped_key_block]
|
1053
1333
|
include Aws::Structure
|
1054
1334
|
end
|
1055
1335
|
|
1056
1336
|
# The request processing has failed because of an unknown error,
|
1057
1337
|
# exception, or failure.
|
1058
1338
|
#
|
1339
|
+
# This indicates a server-side error within the Amazon Web Services
|
1340
|
+
# Payment Cryptography service. If this error persists, contact support
|
1341
|
+
# for assistance.
|
1342
|
+
#
|
1059
1343
|
# @!attribute [rw] message
|
1060
1344
|
# @return [String]
|
1061
1345
|
#
|
@@ -1152,6 +1436,46 @@ module Aws::PaymentCryptography
|
|
1152
1436
|
# A.5.2 of the TR-31 spec.
|
1153
1437
|
# @return [String]
|
1154
1438
|
#
|
1439
|
+
# @!attribute [rw] multi_region_key_type
|
1440
|
+
# Indicates whether this key is a multi-region key and its role in the
|
1441
|
+
# multi-region key hierarchy.
|
1442
|
+
#
|
1443
|
+
# Multi-region keys allow the same key material to be used across
|
1444
|
+
# multiple Amazon Web Services Regions. This field specifies whether
|
1445
|
+
# the key is a primary key (which can be replicated to other regions)
|
1446
|
+
# or a replica key (which is a copy of a primary key in another
|
1447
|
+
# region).
|
1448
|
+
# @return [String]
|
1449
|
+
#
|
1450
|
+
# @!attribute [rw] primary_region
|
1451
|
+
# An Amazon Web Services Region identifier in the standard format
|
1452
|
+
# (e.g., `us-east-1`, `eu-west-1`).
|
1453
|
+
#
|
1454
|
+
# Used to specify regions for key replication operations. The region
|
1455
|
+
# must be a valid Amazon Web Services Region where Amazon Web Services
|
1456
|
+
# Payment Cryptography is available.
|
1457
|
+
# @return [String]
|
1458
|
+
#
|
1459
|
+
# @!attribute [rw] replication_status
|
1460
|
+
# Information about the replication status of the key across different
|
1461
|
+
# regions.
|
1462
|
+
#
|
1463
|
+
# This field provides details about the current state of key
|
1464
|
+
# replication, including any status messages or operational
|
1465
|
+
# information. It helps track the progress and health of key
|
1466
|
+
# replication operations.
|
1467
|
+
# @return [Hash<String,Types::ReplicationStatusType>]
|
1468
|
+
#
|
1469
|
+
# @!attribute [rw] using_default_replication_regions
|
1470
|
+
# Indicates whether this key is using the account's default
|
1471
|
+
# replication regions configuration.
|
1472
|
+
#
|
1473
|
+
# When set to `true`, the key automatically replicates to the regions
|
1474
|
+
# specified in the account's default replication settings. When set
|
1475
|
+
# to `false`, the key has a custom replication configuration that
|
1476
|
+
# overrides the account defaults.
|
1477
|
+
# @return [Boolean]
|
1478
|
+
#
|
1155
1479
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/Key AWS API Documentation
|
1156
1480
|
#
|
1157
1481
|
class Key < Struct.new(
|
@@ -1168,7 +1492,11 @@ module Aws::PaymentCryptography
|
|
1168
1492
|
:usage_stop_timestamp,
|
1169
1493
|
:delete_pending_timestamp,
|
1170
1494
|
:delete_timestamp,
|
1171
|
-
:derive_key_usage
|
1495
|
+
:derive_key_usage,
|
1496
|
+
:multi_region_key_type,
|
1497
|
+
:primary_region,
|
1498
|
+
:replication_status,
|
1499
|
+
:using_default_replication_regions)
|
1172
1500
|
SENSITIVE = []
|
1173
1501
|
include Aws::Structure
|
1174
1502
|
end
|
@@ -1371,6 +1699,26 @@ module Aws::PaymentCryptography
|
|
1371
1699
|
# Specifies whether the key is enabled.
|
1372
1700
|
# @return [Boolean]
|
1373
1701
|
#
|
1702
|
+
# @!attribute [rw] multi_region_key_type
|
1703
|
+
# Indicates whether this key is a multi-region key and its role in the
|
1704
|
+
# multi-region key hierarchy.
|
1705
|
+
#
|
1706
|
+
# Multi-region keys allow the same key material to be used across
|
1707
|
+
# multiple Amazon Web Services Regions. This field specifies whether
|
1708
|
+
# the key is a primary key (which can be replicated to other regions)
|
1709
|
+
# or a replica key (which is a copy of a primary key in another
|
1710
|
+
# region).
|
1711
|
+
# @return [String]
|
1712
|
+
#
|
1713
|
+
# @!attribute [rw] primary_region
|
1714
|
+
# An Amazon Web Services Region identifier in the standard format
|
1715
|
+
# (e.g., `us-east-1`, `eu-west-1`).
|
1716
|
+
#
|
1717
|
+
# Used to specify regions for key replication operations. The region
|
1718
|
+
# must be a valid Amazon Web Services Region where Amazon Web Services
|
1719
|
+
# Payment Cryptography is available.
|
1720
|
+
# @return [String]
|
1721
|
+
#
|
1374
1722
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/KeySummary AWS API Documentation
|
1375
1723
|
#
|
1376
1724
|
class KeySummary < Struct.new(
|
@@ -1379,7 +1727,9 @@ module Aws::PaymentCryptography
|
|
1379
1727
|
:key_attributes,
|
1380
1728
|
:key_check_value,
|
1381
1729
|
:exportable,
|
1382
|
-
:enabled
|
1730
|
+
:enabled,
|
1731
|
+
:multi_region_key_type,
|
1732
|
+
:primary_region)
|
1383
1733
|
SENSITIVE = []
|
1384
1734
|
include Aws::Structure
|
1385
1735
|
end
|
@@ -1534,10 +1884,98 @@ module Aws::PaymentCryptography
|
|
1534
1884
|
include Aws::Structure
|
1535
1885
|
end
|
1536
1886
|
|
1537
|
-
#
|
1887
|
+
# Input parameters for removing replication regions from a specific key.
|
1888
|
+
#
|
1889
|
+
# @!attribute [rw] key_identifier
|
1890
|
+
# The key identifier (ARN or alias) of the key from which to remove
|
1891
|
+
# replication regions.
|
1892
|
+
#
|
1893
|
+
# This key must exist and have replication enabled in the specified
|
1894
|
+
# regions.
|
1895
|
+
# @return [String]
|
1896
|
+
#
|
1897
|
+
# @!attribute [rw] replication_regions
|
1898
|
+
# The list of Amazon Web Services Regions to remove from the key's
|
1899
|
+
# replication configuration.
|
1900
|
+
#
|
1901
|
+
# The key will no longer be available for cryptographic operations in
|
1902
|
+
# these regions after removal. Ensure no active operations depend on
|
1903
|
+
# the key in these regions before removal.
|
1904
|
+
# @return [Array<String>]
|
1905
|
+
#
|
1906
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/RemoveKeyReplicationRegionsInput AWS API Documentation
|
1907
|
+
#
|
1908
|
+
class RemoveKeyReplicationRegionsInput < Struct.new(
|
1909
|
+
:key_identifier,
|
1910
|
+
:replication_regions)
|
1911
|
+
SENSITIVE = []
|
1912
|
+
include Aws::Structure
|
1913
|
+
end
|
1914
|
+
|
1915
|
+
# Output from removing replication regions from a key.
|
1916
|
+
#
|
1917
|
+
# @!attribute [rw] key
|
1918
|
+
# The updated key metadata after removing the replication regions.
|
1919
|
+
#
|
1920
|
+
# This reflects the current state of the key and its updated
|
1921
|
+
# replication configuration.
|
1922
|
+
# @return [Types::Key]
|
1923
|
+
#
|
1924
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/RemoveKeyReplicationRegionsOutput AWS API Documentation
|
1925
|
+
#
|
1926
|
+
class RemoveKeyReplicationRegionsOutput < Struct.new(
|
1927
|
+
:key)
|
1928
|
+
SENSITIVE = []
|
1929
|
+
include Aws::Structure
|
1930
|
+
end
|
1931
|
+
|
1932
|
+
# Represents the replication status information for a key in a
|
1933
|
+
# replication region.
|
1934
|
+
#
|
1935
|
+
# This structure contains details about the current state of key
|
1936
|
+
# replication, including any status messages and operational information
|
1937
|
+
# about the replication process.
|
1938
|
+
#
|
1939
|
+
# @!attribute [rw] status
|
1940
|
+
# The current status of key replication in this region.
|
1941
|
+
#
|
1942
|
+
# This field indicates whether the key replication is in progress,
|
1943
|
+
# completed successfully, or has encountered an error. Possible values
|
1944
|
+
# include states such as SYNCRHONIZED, IN\_PROGRESS,
|
1945
|
+
# DELETE\_IN\_PROGRESS, or FAILED. This provides visibility into the
|
1946
|
+
# replication process for monitoring and troubleshooting purposes.
|
1947
|
+
# @return [String]
|
1948
|
+
#
|
1949
|
+
# @!attribute [rw] status_message
|
1950
|
+
# A message that provides additional information about the current
|
1951
|
+
# replication status of the key.
|
1952
|
+
#
|
1953
|
+
# This field contains details about any issues or progress updates
|
1954
|
+
# related to key replication operations. It may include information
|
1955
|
+
# about replication failures, synchronization status, or other
|
1956
|
+
# operational details.
|
1957
|
+
# @return [String]
|
1958
|
+
#
|
1959
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ReplicationStatusType AWS API Documentation
|
1960
|
+
#
|
1961
|
+
class ReplicationStatusType < Struct.new(
|
1962
|
+
:status,
|
1963
|
+
:status_message)
|
1964
|
+
SENSITIVE = []
|
1965
|
+
include Aws::Structure
|
1966
|
+
end
|
1967
|
+
|
1968
|
+
# The request was denied due to resource not found.
|
1969
|
+
#
|
1970
|
+
# The specified key, alias, or other resource does not exist in your
|
1971
|
+
# account or region. Verify that the resource identifier is correct and
|
1972
|
+
# that the resource exists in the expected region.
|
1538
1973
|
#
|
1539
1974
|
# @!attribute [rw] resource_id
|
1540
|
-
# The
|
1975
|
+
# The identifier of the resource that was not found.
|
1976
|
+
#
|
1977
|
+
# This field contains the specific resource identifier (such as a key
|
1978
|
+
# ARN or alias name) that could not be located.
|
1541
1979
|
# @return [String]
|
1542
1980
|
#
|
1543
1981
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ResourceNotFoundException AWS API Documentation
|
@@ -1592,12 +2030,16 @@ module Aws::PaymentCryptography
|
|
1592
2030
|
class RootCertificatePublicKey < Struct.new(
|
1593
2031
|
:key_attributes,
|
1594
2032
|
:public_key_certificate)
|
1595
|
-
SENSITIVE = [
|
2033
|
+
SENSITIVE = []
|
1596
2034
|
include Aws::Structure
|
1597
2035
|
end
|
1598
2036
|
|
1599
2037
|
# This request would cause a service quota to be exceeded.
|
1600
2038
|
#
|
2039
|
+
# You have reached the maximum number of keys, aliases, or other
|
2040
|
+
# resources allowed in your account. Review your current usage and
|
2041
|
+
# consider deleting unused resources or requesting a quota increase.
|
2042
|
+
#
|
1601
2043
|
# @!attribute [rw] message
|
1602
2044
|
# @return [String]
|
1603
2045
|
#
|
@@ -1611,6 +2053,10 @@ module Aws::PaymentCryptography
|
|
1611
2053
|
|
1612
2054
|
# The service cannot complete the request.
|
1613
2055
|
#
|
2056
|
+
# The Amazon Web Services Payment Cryptography service is temporarily
|
2057
|
+
# unavailable. This is typically a temporary condition - retry your
|
2058
|
+
# request after a brief delay.
|
2059
|
+
#
|
1614
2060
|
# @!attribute [rw] message
|
1615
2061
|
# @return [String]
|
1616
2062
|
#
|
@@ -1733,6 +2179,10 @@ module Aws::PaymentCryptography
|
|
1733
2179
|
|
1734
2180
|
# The request was denied due to request throttling.
|
1735
2181
|
#
|
2182
|
+
# You have exceeded the rate limits for Amazon Web Services Payment
|
2183
|
+
# Cryptography API calls. Implement exponential backoff and retry logic
|
2184
|
+
# in your application to handle throttling gracefully.
|
2185
|
+
#
|
1736
2186
|
# @!attribute [rw] message
|
1737
2187
|
# @return [String]
|
1738
2188
|
#
|
@@ -1767,7 +2217,7 @@ module Aws::PaymentCryptography
|
|
1767
2217
|
:key_attributes,
|
1768
2218
|
:public_key_certificate,
|
1769
2219
|
:certificate_authority_public_key_identifier)
|
1770
|
-
SENSITIVE = [
|
2220
|
+
SENSITIVE = []
|
1771
2221
|
include Aws::Structure
|
1772
2222
|
end
|
1773
2223
|
|
@@ -1833,6 +2283,10 @@ module Aws::PaymentCryptography
|
|
1833
2283
|
|
1834
2284
|
# The request was denied due to an invalid request error.
|
1835
2285
|
#
|
2286
|
+
# One or more parameters in your request are invalid. Check the
|
2287
|
+
# parameter values, formats, and constraints specified in the API
|
2288
|
+
# documentation.
|
2289
|
+
#
|
1836
2290
|
# @!attribute [rw] message
|
1837
2291
|
# @return [String]
|
1838
2292
|
#
|