aws-sdk-paymentcryptography 1.9.0 → 1.11.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 +120 -38
- data/lib/aws-sdk-paymentcryptography/client_api.rb +20 -0
- data/lib/aws-sdk-paymentcryptography/plugins/endpoints.rb +1 -0
- data/lib/aws-sdk-paymentcryptography/types.rb +94 -7
- data/lib/aws-sdk-paymentcryptography.rb +1 -1
- data/sig/client.rbs +433 -0
- data/sig/errors.rbs +40 -0
- data/sig/resource.rbs +80 -0
- data/sig/types.rbs +457 -0
- data/sig/waiters.rbs +13 -0
- metadata +13 -8
@@ -264,6 +264,34 @@ module Aws::PaymentCryptography
|
|
264
264
|
include Aws::Structure
|
265
265
|
end
|
266
266
|
|
267
|
+
# Parameter information for key material export using asymmetric RSA
|
268
|
+
# wrap and unwrap key exchange method.
|
269
|
+
#
|
270
|
+
# @!attribute [rw] certificate_authority_public_key_identifier
|
271
|
+
# The `KeyARN` of the certificate chain that signs the wrapping key
|
272
|
+
# certificate during RSA wrap and unwrap key export.
|
273
|
+
# @return [String]
|
274
|
+
#
|
275
|
+
# @!attribute [rw] wrapping_key_certificate
|
276
|
+
# The wrapping key certificate in PEM format (base64 encoded). Amazon
|
277
|
+
# Web Services Payment Cryptography uses this certificate to wrap the
|
278
|
+
# key under export.
|
279
|
+
# @return [String]
|
280
|
+
#
|
281
|
+
# @!attribute [rw] wrapping_spec
|
282
|
+
# The wrapping spec for the key under export.
|
283
|
+
# @return [String]
|
284
|
+
#
|
285
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ExportKeyCryptogram AWS API Documentation
|
286
|
+
#
|
287
|
+
class ExportKeyCryptogram < Struct.new(
|
288
|
+
:certificate_authority_public_key_identifier,
|
289
|
+
:wrapping_key_certificate,
|
290
|
+
:wrapping_spec)
|
291
|
+
SENSITIVE = [:wrapping_key_certificate]
|
292
|
+
include Aws::Structure
|
293
|
+
end
|
294
|
+
|
267
295
|
# @!attribute [rw] export_attributes
|
268
296
|
# The attributes for IPEK generation during export.
|
269
297
|
# @return [Types::ExportAttributes]
|
@@ -289,10 +317,16 @@ module Aws::PaymentCryptography
|
|
289
317
|
end
|
290
318
|
|
291
319
|
# Parameter information for key material export from Amazon Web Services
|
292
|
-
# Payment Cryptography using TR-31 or TR-34
|
320
|
+
# Payment Cryptography using TR-31 or TR-34 or RSA wrap and unwrap key
|
321
|
+
# exchange method.
|
293
322
|
#
|
294
323
|
# @note ExportKeyMaterial is a union - when making an API calls you must set exactly one of the members.
|
295
324
|
#
|
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
|
+
#
|
296
330
|
# @!attribute [rw] tr_31_key_block
|
297
331
|
# Parameter information for key material export using symmetric TR-31
|
298
332
|
# key exchange method.
|
@@ -306,6 +340,7 @@ module Aws::PaymentCryptography
|
|
306
340
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ExportKeyMaterial AWS API Documentation
|
307
341
|
#
|
308
342
|
class ExportKeyMaterial < Struct.new(
|
343
|
+
:key_cryptogram,
|
309
344
|
:tr_31_key_block,
|
310
345
|
:tr_34_key_block,
|
311
346
|
:unknown)
|
@@ -313,6 +348,7 @@ module Aws::PaymentCryptography
|
|
313
348
|
include Aws::Structure
|
314
349
|
include Aws::Structure::Union
|
315
350
|
|
351
|
+
class KeyCryptogram < ExportKeyMaterial; end
|
316
352
|
class Tr31KeyBlock < ExportKeyMaterial; end
|
317
353
|
class Tr34KeyBlock < ExportKeyMaterial; end
|
318
354
|
class Unknown < ExportKeyMaterial; end
|
@@ -320,7 +356,7 @@ module Aws::PaymentCryptography
|
|
320
356
|
|
321
357
|
# @!attribute [rw] wrapped_key
|
322
358
|
# The key material under export as a TR-34 WrappedKeyBlock or a TR-31
|
323
|
-
# WrappedKeyBlock.
|
359
|
+
# WrappedKeyBlock. or a RSA WrappedKeyCryptogram.
|
324
360
|
# @return [Types::WrappedKey]
|
325
361
|
#
|
326
362
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ExportKeyOutput AWS API Documentation
|
@@ -506,7 +542,8 @@ module Aws::PaymentCryptography
|
|
506
542
|
|
507
543
|
# @!attribute [rw] key_material_type
|
508
544
|
# The method to use for key material import. Import token is only
|
509
|
-
# required for TR-34 WrappedKeyBlock (`TR34_KEY_BLOCK`)
|
545
|
+
# required for TR-34 WrappedKeyBlock (`TR34_KEY_BLOCK`) and RSA
|
546
|
+
# WrappedKeyCryptogram (`KEY_CRYPTOGRAM`).
|
510
547
|
#
|
511
548
|
# Import token is not required for TR-31, root public key cerificate
|
512
549
|
# or trusted public key certificate.
|
@@ -516,8 +553,10 @@ module Aws::PaymentCryptography
|
|
516
553
|
# The wrapping key algorithm to generate a wrapping key certificate.
|
517
554
|
# This certificate wraps the key under import.
|
518
555
|
#
|
519
|
-
# At this time, `RSA_2048
|
520
|
-
#
|
556
|
+
# At this time, `RSA_2048` is the allowed algorithm for TR-34
|
557
|
+
# WrappedKeyBlock import. Additionally, `RSA_2048`, `RSA_3072`,
|
558
|
+
# `RSA_4096` are the allowed algorithms for RSA WrappedKeyCryptogram
|
559
|
+
# import.
|
521
560
|
# @return [String]
|
522
561
|
#
|
523
562
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/GetParametersForImportInput AWS API Documentation
|
@@ -542,7 +581,7 @@ module Aws::PaymentCryptography
|
|
542
581
|
#
|
543
582
|
# @!attribute [rw] wrapping_key_algorithm
|
544
583
|
# The algorithm of the wrapping key for use within TR-34
|
545
|
-
# WrappedKeyBlock.
|
584
|
+
# WrappedKeyBlock or RSA WrappedKeyCryptogram.
|
546
585
|
# @return [String]
|
547
586
|
#
|
548
587
|
# @!attribute [rw] wrapping_key_certificate
|
@@ -602,6 +641,46 @@ module Aws::PaymentCryptography
|
|
602
641
|
include Aws::Structure
|
603
642
|
end
|
604
643
|
|
644
|
+
# Parameter information for key material import using asymmetric RSA
|
645
|
+
# wrap and unwrap key exchange method.
|
646
|
+
#
|
647
|
+
# @!attribute [rw] exportable
|
648
|
+
# Specifies whether the key is exportable from the service.
|
649
|
+
# @return [Boolean]
|
650
|
+
#
|
651
|
+
# @!attribute [rw] import_token
|
652
|
+
# The import token that initiates key import using the asymmetric RSA
|
653
|
+
# wrap and unwrap key exchange method into AWS Payment Cryptography.
|
654
|
+
# It expires after 7 days. You can use the same import token to import
|
655
|
+
# multiple keys to the same service account.
|
656
|
+
# @return [String]
|
657
|
+
#
|
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
|
+
# @!attribute [rw] wrapping_spec
|
669
|
+
# The wrapping spec for the wrapped key cryptogram.
|
670
|
+
# @return [String]
|
671
|
+
#
|
672
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ImportKeyCryptogram AWS API Documentation
|
673
|
+
#
|
674
|
+
class ImportKeyCryptogram < Struct.new(
|
675
|
+
:exportable,
|
676
|
+
:import_token,
|
677
|
+
:key_attributes,
|
678
|
+
:wrapped_key_cryptogram,
|
679
|
+
:wrapping_spec)
|
680
|
+
SENSITIVE = []
|
681
|
+
include Aws::Structure
|
682
|
+
end
|
683
|
+
|
605
684
|
# @!attribute [rw] enabled
|
606
685
|
# Specifies whether import key is enabled.
|
607
686
|
# @return [Boolean]
|
@@ -660,10 +739,16 @@ module Aws::PaymentCryptography
|
|
660
739
|
end
|
661
740
|
|
662
741
|
# Parameter information for key material import into Amazon Web Services
|
663
|
-
# Payment Cryptography using TR-31 or TR-34
|
742
|
+
# Payment Cryptography using TR-31 or TR-34 or RSA wrap and unwrap key
|
743
|
+
# exchange method.
|
664
744
|
#
|
665
745
|
# @note ImportKeyMaterial is a union - when making an API calls you must set exactly one of the members.
|
666
746
|
#
|
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
|
+
#
|
667
752
|
# @!attribute [rw] root_certificate_public_key
|
668
753
|
# Parameter information for root public key certificate import.
|
669
754
|
# @return [Types::RootCertificatePublicKey]
|
@@ -685,6 +770,7 @@ module Aws::PaymentCryptography
|
|
685
770
|
# @see http://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ImportKeyMaterial AWS API Documentation
|
686
771
|
#
|
687
772
|
class ImportKeyMaterial < Struct.new(
|
773
|
+
:key_cryptogram,
|
688
774
|
:root_certificate_public_key,
|
689
775
|
:tr_31_key_block,
|
690
776
|
:tr_34_key_block,
|
@@ -694,6 +780,7 @@ module Aws::PaymentCryptography
|
|
694
780
|
include Aws::Structure
|
695
781
|
include Aws::Structure::Union
|
696
782
|
|
783
|
+
class KeyCryptogram < ImportKeyMaterial; end
|
697
784
|
class RootCertificatePublicKey < ImportKeyMaterial; end
|
698
785
|
class Tr31KeyBlock < ImportKeyMaterial; end
|
699
786
|
class Tr34KeyBlock < ImportKeyMaterial; end
|
data/sig/client.rbs
ADDED
@@ -0,0 +1,433 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module PaymentCryptography
|
10
|
+
class Client < ::Seahorse::Client::Base
|
11
|
+
include ::Aws::ClientStubs
|
12
|
+
|
13
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#initialize-instance_method
|
14
|
+
def self.new: (
|
15
|
+
?credentials: untyped,
|
16
|
+
?region: String,
|
17
|
+
?access_key_id: String,
|
18
|
+
?active_endpoint_cache: bool,
|
19
|
+
?adaptive_retry_wait_to_fill: bool,
|
20
|
+
?client_side_monitoring: bool,
|
21
|
+
?client_side_monitoring_client_id: String,
|
22
|
+
?client_side_monitoring_host: String,
|
23
|
+
?client_side_monitoring_port: Integer,
|
24
|
+
?client_side_monitoring_publisher: untyped,
|
25
|
+
?convert_params: bool,
|
26
|
+
?correct_clock_skew: bool,
|
27
|
+
?defaults_mode: String,
|
28
|
+
?disable_host_prefix_injection: bool,
|
29
|
+
?disable_request_compression: bool,
|
30
|
+
?endpoint: String,
|
31
|
+
?endpoint_cache_max_entries: Integer,
|
32
|
+
?endpoint_cache_max_threads: Integer,
|
33
|
+
?endpoint_cache_poll_interval: Integer,
|
34
|
+
?endpoint_discovery: bool,
|
35
|
+
?ignore_configured_endpoint_urls: bool,
|
36
|
+
?log_formatter: untyped,
|
37
|
+
?log_level: Symbol,
|
38
|
+
?logger: untyped,
|
39
|
+
?max_attempts: Integer,
|
40
|
+
?profile: String,
|
41
|
+
?request_min_compression_size_bytes: Integer,
|
42
|
+
?retry_backoff: Proc,
|
43
|
+
?retry_base_delay: Float,
|
44
|
+
?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
|
45
|
+
?retry_limit: Integer,
|
46
|
+
?retry_max_delay: Integer,
|
47
|
+
?retry_mode: ("legacy" | "standard" | "adaptive"),
|
48
|
+
?sdk_ua_app_id: String,
|
49
|
+
?secret_access_key: String,
|
50
|
+
?session_token: String,
|
51
|
+
?simple_json: bool,
|
52
|
+
?stub_responses: untyped,
|
53
|
+
?token_provider: untyped,
|
54
|
+
?use_dualstack_endpoint: bool,
|
55
|
+
?use_fips_endpoint: bool,
|
56
|
+
?validate_params: bool,
|
57
|
+
?endpoint_provider: untyped,
|
58
|
+
?http_proxy: String,
|
59
|
+
?http_open_timeout: (Float | Integer),
|
60
|
+
?http_read_timeout: (Float | Integer),
|
61
|
+
?http_idle_timeout: (Float | Integer),
|
62
|
+
?http_continue_timeout: (Float | Integer),
|
63
|
+
?ssl_timeout: (Float | Integer | nil),
|
64
|
+
?http_wire_trace: bool,
|
65
|
+
?ssl_verify_peer: bool,
|
66
|
+
?ssl_ca_bundle: String,
|
67
|
+
?ssl_ca_directory: String,
|
68
|
+
?ssl_ca_store: String,
|
69
|
+
?on_chunk_received: Proc,
|
70
|
+
?on_chunk_sent: Proc,
|
71
|
+
?raise_response_errors: bool
|
72
|
+
) -> instance
|
73
|
+
| (?Hash[Symbol, untyped]) -> instance
|
74
|
+
|
75
|
+
|
76
|
+
interface _CreateAliasResponseSuccess
|
77
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateAliasOutput]
|
78
|
+
def alias: () -> Types::Alias
|
79
|
+
end
|
80
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#create_alias-instance_method
|
81
|
+
def create_alias: (
|
82
|
+
alias_name: ::String,
|
83
|
+
?key_arn: ::String
|
84
|
+
) -> _CreateAliasResponseSuccess
|
85
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAliasResponseSuccess
|
86
|
+
|
87
|
+
interface _CreateKeyResponseSuccess
|
88
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateKeyOutput]
|
89
|
+
def key: () -> Types::Key
|
90
|
+
end
|
91
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#create_key-instance_method
|
92
|
+
def create_key: (
|
93
|
+
?enabled: bool,
|
94
|
+
exportable: bool,
|
95
|
+
key_attributes: {
|
96
|
+
key_algorithm: ("TDES_2KEY" | "TDES_3KEY" | "AES_128" | "AES_192" | "AES_256" | "RSA_2048" | "RSA_3072" | "RSA_4096"),
|
97
|
+
key_class: ("SYMMETRIC_KEY" | "ASYMMETRIC_KEY_PAIR" | "PRIVATE_KEY" | "PUBLIC_KEY"),
|
98
|
+
key_modes_of_use: {
|
99
|
+
decrypt: bool?,
|
100
|
+
derive_key: bool?,
|
101
|
+
encrypt: bool?,
|
102
|
+
generate: bool?,
|
103
|
+
no_restrictions: bool?,
|
104
|
+
sign: bool?,
|
105
|
+
unwrap: bool?,
|
106
|
+
verify: bool?,
|
107
|
+
wrap: bool?
|
108
|
+
},
|
109
|
+
key_usage: ("TR31_B0_BASE_DERIVATION_KEY" | "TR31_C0_CARD_VERIFICATION_KEY" | "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY" | "TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION" | "TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS" | "TR31_E1_EMV_MKEY_CONFIDENTIALITY" | "TR31_E2_EMV_MKEY_INTEGRITY" | "TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS" | "TR31_E5_EMV_MKEY_CARD_PERSONALIZATION" | "TR31_E6_EMV_MKEY_OTHER" | "TR31_K0_KEY_ENCRYPTION_KEY" | "TR31_K1_KEY_BLOCK_PROTECTION_KEY" | "TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT" | "TR31_M3_ISO_9797_3_MAC_KEY" | "TR31_M1_ISO_9797_1_MAC_KEY" | "TR31_M6_ISO_9797_5_CMAC_KEY" | "TR31_M7_HMAC_KEY" | "TR31_P0_PIN_ENCRYPTION_KEY" | "TR31_P1_PIN_GENERATION_KEY" | "TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE" | "TR31_V1_IBM3624_PIN_VERIFICATION_KEY" | "TR31_V2_VISA_PIN_VERIFICATION_KEY" | "TR31_K2_TR34_ASYMMETRIC_KEY")
|
110
|
+
},
|
111
|
+
?key_check_value_algorithm: ("CMAC" | "ANSI_X9_24"),
|
112
|
+
?tags: Array[
|
113
|
+
{
|
114
|
+
key: ::String,
|
115
|
+
value: ::String?
|
116
|
+
},
|
117
|
+
]
|
118
|
+
) -> _CreateKeyResponseSuccess
|
119
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateKeyResponseSuccess
|
120
|
+
|
121
|
+
interface _DeleteAliasResponseSuccess
|
122
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteAliasOutput]
|
123
|
+
end
|
124
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#delete_alias-instance_method
|
125
|
+
def delete_alias: (
|
126
|
+
alias_name: ::String
|
127
|
+
) -> _DeleteAliasResponseSuccess
|
128
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteAliasResponseSuccess
|
129
|
+
|
130
|
+
interface _DeleteKeyResponseSuccess
|
131
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteKeyOutput]
|
132
|
+
def key: () -> Types::Key
|
133
|
+
end
|
134
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#delete_key-instance_method
|
135
|
+
def delete_key: (
|
136
|
+
?delete_key_in_days: ::Integer,
|
137
|
+
key_identifier: ::String
|
138
|
+
) -> _DeleteKeyResponseSuccess
|
139
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteKeyResponseSuccess
|
140
|
+
|
141
|
+
interface _ExportKeyResponseSuccess
|
142
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ExportKeyOutput]
|
143
|
+
def wrapped_key: () -> Types::WrappedKey
|
144
|
+
end
|
145
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#export_key-instance_method
|
146
|
+
def export_key: (
|
147
|
+
?export_attributes: {
|
148
|
+
export_dukpt_initial_key: {
|
149
|
+
key_serial_number: ::String
|
150
|
+
}?,
|
151
|
+
key_check_value_algorithm: ("CMAC" | "ANSI_X9_24")?
|
152
|
+
},
|
153
|
+
export_key_identifier: ::String,
|
154
|
+
key_material: {
|
155
|
+
key_cryptogram: {
|
156
|
+
certificate_authority_public_key_identifier: ::String,
|
157
|
+
wrapping_key_certificate: ::String,
|
158
|
+
wrapping_spec: ("RSA_OAEP_SHA_256" | "RSA_OAEP_SHA_512")?
|
159
|
+
}?,
|
160
|
+
tr_31_key_block: {
|
161
|
+
wrapping_key_identifier: ::String
|
162
|
+
}?,
|
163
|
+
tr_34_key_block: {
|
164
|
+
certificate_authority_public_key_identifier: ::String,
|
165
|
+
export_token: ::String,
|
166
|
+
key_block_format: ("X9_TR34_2012"),
|
167
|
+
random_nonce: ::String?,
|
168
|
+
wrapping_key_certificate: ::String
|
169
|
+
}?
|
170
|
+
}
|
171
|
+
) -> _ExportKeyResponseSuccess
|
172
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ExportKeyResponseSuccess
|
173
|
+
|
174
|
+
interface _GetAliasResponseSuccess
|
175
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetAliasOutput]
|
176
|
+
def alias: () -> Types::Alias
|
177
|
+
end
|
178
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#get_alias-instance_method
|
179
|
+
def get_alias: (
|
180
|
+
alias_name: ::String
|
181
|
+
) -> _GetAliasResponseSuccess
|
182
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAliasResponseSuccess
|
183
|
+
|
184
|
+
interface _GetKeyResponseSuccess
|
185
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetKeyOutput]
|
186
|
+
def key: () -> Types::Key
|
187
|
+
end
|
188
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#get_key-instance_method
|
189
|
+
def get_key: (
|
190
|
+
key_identifier: ::String
|
191
|
+
) -> _GetKeyResponseSuccess
|
192
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetKeyResponseSuccess
|
193
|
+
|
194
|
+
interface _GetParametersForExportResponseSuccess
|
195
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetParametersForExportOutput]
|
196
|
+
def export_token: () -> ::String
|
197
|
+
def parameters_valid_until_timestamp: () -> ::Time
|
198
|
+
def signing_key_algorithm: () -> ("TDES_2KEY" | "TDES_3KEY" | "AES_128" | "AES_192" | "AES_256" | "RSA_2048" | "RSA_3072" | "RSA_4096")
|
199
|
+
def signing_key_certificate: () -> ::String
|
200
|
+
def signing_key_certificate_chain: () -> ::String
|
201
|
+
end
|
202
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#get_parameters_for_export-instance_method
|
203
|
+
def get_parameters_for_export: (
|
204
|
+
key_material_type: ("TR34_KEY_BLOCK" | "TR31_KEY_BLOCK" | "ROOT_PUBLIC_KEY_CERTIFICATE" | "TRUSTED_PUBLIC_KEY_CERTIFICATE" | "KEY_CRYPTOGRAM"),
|
205
|
+
signing_key_algorithm: ("TDES_2KEY" | "TDES_3KEY" | "AES_128" | "AES_192" | "AES_256" | "RSA_2048" | "RSA_3072" | "RSA_4096")
|
206
|
+
) -> _GetParametersForExportResponseSuccess
|
207
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetParametersForExportResponseSuccess
|
208
|
+
|
209
|
+
interface _GetParametersForImportResponseSuccess
|
210
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetParametersForImportOutput]
|
211
|
+
def import_token: () -> ::String
|
212
|
+
def parameters_valid_until_timestamp: () -> ::Time
|
213
|
+
def wrapping_key_algorithm: () -> ("TDES_2KEY" | "TDES_3KEY" | "AES_128" | "AES_192" | "AES_256" | "RSA_2048" | "RSA_3072" | "RSA_4096")
|
214
|
+
def wrapping_key_certificate: () -> ::String
|
215
|
+
def wrapping_key_certificate_chain: () -> ::String
|
216
|
+
end
|
217
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#get_parameters_for_import-instance_method
|
218
|
+
def get_parameters_for_import: (
|
219
|
+
key_material_type: ("TR34_KEY_BLOCK" | "TR31_KEY_BLOCK" | "ROOT_PUBLIC_KEY_CERTIFICATE" | "TRUSTED_PUBLIC_KEY_CERTIFICATE" | "KEY_CRYPTOGRAM"),
|
220
|
+
wrapping_key_algorithm: ("TDES_2KEY" | "TDES_3KEY" | "AES_128" | "AES_192" | "AES_256" | "RSA_2048" | "RSA_3072" | "RSA_4096")
|
221
|
+
) -> _GetParametersForImportResponseSuccess
|
222
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetParametersForImportResponseSuccess
|
223
|
+
|
224
|
+
interface _GetPublicKeyCertificateResponseSuccess
|
225
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetPublicKeyCertificateOutput]
|
226
|
+
def key_certificate: () -> ::String
|
227
|
+
def key_certificate_chain: () -> ::String
|
228
|
+
end
|
229
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#get_public_key_certificate-instance_method
|
230
|
+
def get_public_key_certificate: (
|
231
|
+
key_identifier: ::String
|
232
|
+
) -> _GetPublicKeyCertificateResponseSuccess
|
233
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetPublicKeyCertificateResponseSuccess
|
234
|
+
|
235
|
+
interface _ImportKeyResponseSuccess
|
236
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ImportKeyOutput]
|
237
|
+
def key: () -> Types::Key
|
238
|
+
end
|
239
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#import_key-instance_method
|
240
|
+
def import_key: (
|
241
|
+
?enabled: bool,
|
242
|
+
?key_check_value_algorithm: ("CMAC" | "ANSI_X9_24"),
|
243
|
+
key_material: {
|
244
|
+
key_cryptogram: {
|
245
|
+
exportable: bool,
|
246
|
+
import_token: ::String,
|
247
|
+
key_attributes: {
|
248
|
+
key_algorithm: ("TDES_2KEY" | "TDES_3KEY" | "AES_128" | "AES_192" | "AES_256" | "RSA_2048" | "RSA_3072" | "RSA_4096"),
|
249
|
+
key_class: ("SYMMETRIC_KEY" | "ASYMMETRIC_KEY_PAIR" | "PRIVATE_KEY" | "PUBLIC_KEY"),
|
250
|
+
key_modes_of_use: {
|
251
|
+
decrypt: bool?,
|
252
|
+
derive_key: bool?,
|
253
|
+
encrypt: bool?,
|
254
|
+
generate: bool?,
|
255
|
+
no_restrictions: bool?,
|
256
|
+
sign: bool?,
|
257
|
+
unwrap: bool?,
|
258
|
+
verify: bool?,
|
259
|
+
wrap: bool?
|
260
|
+
},
|
261
|
+
key_usage: ("TR31_B0_BASE_DERIVATION_KEY" | "TR31_C0_CARD_VERIFICATION_KEY" | "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY" | "TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION" | "TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS" | "TR31_E1_EMV_MKEY_CONFIDENTIALITY" | "TR31_E2_EMV_MKEY_INTEGRITY" | "TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS" | "TR31_E5_EMV_MKEY_CARD_PERSONALIZATION" | "TR31_E6_EMV_MKEY_OTHER" | "TR31_K0_KEY_ENCRYPTION_KEY" | "TR31_K1_KEY_BLOCK_PROTECTION_KEY" | "TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT" | "TR31_M3_ISO_9797_3_MAC_KEY" | "TR31_M1_ISO_9797_1_MAC_KEY" | "TR31_M6_ISO_9797_5_CMAC_KEY" | "TR31_M7_HMAC_KEY" | "TR31_P0_PIN_ENCRYPTION_KEY" | "TR31_P1_PIN_GENERATION_KEY" | "TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE" | "TR31_V1_IBM3624_PIN_VERIFICATION_KEY" | "TR31_V2_VISA_PIN_VERIFICATION_KEY" | "TR31_K2_TR34_ASYMMETRIC_KEY")
|
262
|
+
},
|
263
|
+
wrapped_key_cryptogram: ::String,
|
264
|
+
wrapping_spec: ("RSA_OAEP_SHA_256" | "RSA_OAEP_SHA_512")?
|
265
|
+
}?,
|
266
|
+
root_certificate_public_key: {
|
267
|
+
key_attributes: {
|
268
|
+
key_algorithm: ("TDES_2KEY" | "TDES_3KEY" | "AES_128" | "AES_192" | "AES_256" | "RSA_2048" | "RSA_3072" | "RSA_4096"),
|
269
|
+
key_class: ("SYMMETRIC_KEY" | "ASYMMETRIC_KEY_PAIR" | "PRIVATE_KEY" | "PUBLIC_KEY"),
|
270
|
+
key_modes_of_use: {
|
271
|
+
decrypt: bool?,
|
272
|
+
derive_key: bool?,
|
273
|
+
encrypt: bool?,
|
274
|
+
generate: bool?,
|
275
|
+
no_restrictions: bool?,
|
276
|
+
sign: bool?,
|
277
|
+
unwrap: bool?,
|
278
|
+
verify: bool?,
|
279
|
+
wrap: bool?
|
280
|
+
},
|
281
|
+
key_usage: ("TR31_B0_BASE_DERIVATION_KEY" | "TR31_C0_CARD_VERIFICATION_KEY" | "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY" | "TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION" | "TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS" | "TR31_E1_EMV_MKEY_CONFIDENTIALITY" | "TR31_E2_EMV_MKEY_INTEGRITY" | "TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS" | "TR31_E5_EMV_MKEY_CARD_PERSONALIZATION" | "TR31_E6_EMV_MKEY_OTHER" | "TR31_K0_KEY_ENCRYPTION_KEY" | "TR31_K1_KEY_BLOCK_PROTECTION_KEY" | "TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT" | "TR31_M3_ISO_9797_3_MAC_KEY" | "TR31_M1_ISO_9797_1_MAC_KEY" | "TR31_M6_ISO_9797_5_CMAC_KEY" | "TR31_M7_HMAC_KEY" | "TR31_P0_PIN_ENCRYPTION_KEY" | "TR31_P1_PIN_GENERATION_KEY" | "TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE" | "TR31_V1_IBM3624_PIN_VERIFICATION_KEY" | "TR31_V2_VISA_PIN_VERIFICATION_KEY" | "TR31_K2_TR34_ASYMMETRIC_KEY")
|
282
|
+
},
|
283
|
+
public_key_certificate: ::String
|
284
|
+
}?,
|
285
|
+
tr_31_key_block: {
|
286
|
+
wrapped_key_block: ::String,
|
287
|
+
wrapping_key_identifier: ::String
|
288
|
+
}?,
|
289
|
+
tr_34_key_block: {
|
290
|
+
certificate_authority_public_key_identifier: ::String,
|
291
|
+
import_token: ::String,
|
292
|
+
key_block_format: ("X9_TR34_2012"),
|
293
|
+
random_nonce: ::String?,
|
294
|
+
signing_key_certificate: ::String,
|
295
|
+
wrapped_key_block: ::String
|
296
|
+
}?,
|
297
|
+
trusted_certificate_public_key: {
|
298
|
+
certificate_authority_public_key_identifier: ::String,
|
299
|
+
key_attributes: {
|
300
|
+
key_algorithm: ("TDES_2KEY" | "TDES_3KEY" | "AES_128" | "AES_192" | "AES_256" | "RSA_2048" | "RSA_3072" | "RSA_4096"),
|
301
|
+
key_class: ("SYMMETRIC_KEY" | "ASYMMETRIC_KEY_PAIR" | "PRIVATE_KEY" | "PUBLIC_KEY"),
|
302
|
+
key_modes_of_use: {
|
303
|
+
decrypt: bool?,
|
304
|
+
derive_key: bool?,
|
305
|
+
encrypt: bool?,
|
306
|
+
generate: bool?,
|
307
|
+
no_restrictions: bool?,
|
308
|
+
sign: bool?,
|
309
|
+
unwrap: bool?,
|
310
|
+
verify: bool?,
|
311
|
+
wrap: bool?
|
312
|
+
},
|
313
|
+
key_usage: ("TR31_B0_BASE_DERIVATION_KEY" | "TR31_C0_CARD_VERIFICATION_KEY" | "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY" | "TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION" | "TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS" | "TR31_E1_EMV_MKEY_CONFIDENTIALITY" | "TR31_E2_EMV_MKEY_INTEGRITY" | "TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS" | "TR31_E5_EMV_MKEY_CARD_PERSONALIZATION" | "TR31_E6_EMV_MKEY_OTHER" | "TR31_K0_KEY_ENCRYPTION_KEY" | "TR31_K1_KEY_BLOCK_PROTECTION_KEY" | "TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT" | "TR31_M3_ISO_9797_3_MAC_KEY" | "TR31_M1_ISO_9797_1_MAC_KEY" | "TR31_M6_ISO_9797_5_CMAC_KEY" | "TR31_M7_HMAC_KEY" | "TR31_P0_PIN_ENCRYPTION_KEY" | "TR31_P1_PIN_GENERATION_KEY" | "TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE" | "TR31_V1_IBM3624_PIN_VERIFICATION_KEY" | "TR31_V2_VISA_PIN_VERIFICATION_KEY" | "TR31_K2_TR34_ASYMMETRIC_KEY")
|
314
|
+
},
|
315
|
+
public_key_certificate: ::String
|
316
|
+
}?
|
317
|
+
},
|
318
|
+
?tags: Array[
|
319
|
+
{
|
320
|
+
key: ::String,
|
321
|
+
value: ::String?
|
322
|
+
},
|
323
|
+
]
|
324
|
+
) -> _ImportKeyResponseSuccess
|
325
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ImportKeyResponseSuccess
|
326
|
+
|
327
|
+
interface _ListAliasesResponseSuccess
|
328
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListAliasesOutput]
|
329
|
+
def aliases: () -> ::Array[Types::Alias]
|
330
|
+
def next_token: () -> ::String
|
331
|
+
end
|
332
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#list_aliases-instance_method
|
333
|
+
def list_aliases: (
|
334
|
+
?max_results: ::Integer,
|
335
|
+
?next_token: ::String
|
336
|
+
) -> _ListAliasesResponseSuccess
|
337
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAliasesResponseSuccess
|
338
|
+
|
339
|
+
interface _ListKeysResponseSuccess
|
340
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListKeysOutput]
|
341
|
+
def keys: () -> ::Array[Types::KeySummary]
|
342
|
+
def next_token: () -> ::String
|
343
|
+
end
|
344
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#list_keys-instance_method
|
345
|
+
def list_keys: (
|
346
|
+
?key_state: ("CREATE_IN_PROGRESS" | "CREATE_COMPLETE" | "DELETE_PENDING" | "DELETE_COMPLETE"),
|
347
|
+
?max_results: ::Integer,
|
348
|
+
?next_token: ::String
|
349
|
+
) -> _ListKeysResponseSuccess
|
350
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListKeysResponseSuccess
|
351
|
+
|
352
|
+
interface _ListTagsForResourceResponseSuccess
|
353
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceOutput]
|
354
|
+
def next_token: () -> ::String
|
355
|
+
def tags: () -> ::Array[Types::Tag]
|
356
|
+
end
|
357
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#list_tags_for_resource-instance_method
|
358
|
+
def list_tags_for_resource: (
|
359
|
+
?max_results: ::Integer,
|
360
|
+
?next_token: ::String,
|
361
|
+
resource_arn: ::String
|
362
|
+
) -> _ListTagsForResourceResponseSuccess
|
363
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
|
364
|
+
|
365
|
+
interface _RestoreKeyResponseSuccess
|
366
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::RestoreKeyOutput]
|
367
|
+
def key: () -> Types::Key
|
368
|
+
end
|
369
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#restore_key-instance_method
|
370
|
+
def restore_key: (
|
371
|
+
key_identifier: ::String
|
372
|
+
) -> _RestoreKeyResponseSuccess
|
373
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RestoreKeyResponseSuccess
|
374
|
+
|
375
|
+
interface _StartKeyUsageResponseSuccess
|
376
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartKeyUsageOutput]
|
377
|
+
def key: () -> Types::Key
|
378
|
+
end
|
379
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#start_key_usage-instance_method
|
380
|
+
def start_key_usage: (
|
381
|
+
key_identifier: ::String
|
382
|
+
) -> _StartKeyUsageResponseSuccess
|
383
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartKeyUsageResponseSuccess
|
384
|
+
|
385
|
+
interface _StopKeyUsageResponseSuccess
|
386
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StopKeyUsageOutput]
|
387
|
+
def key: () -> Types::Key
|
388
|
+
end
|
389
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#stop_key_usage-instance_method
|
390
|
+
def stop_key_usage: (
|
391
|
+
key_identifier: ::String
|
392
|
+
) -> _StopKeyUsageResponseSuccess
|
393
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StopKeyUsageResponseSuccess
|
394
|
+
|
395
|
+
interface _TagResourceResponseSuccess
|
396
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceOutput]
|
397
|
+
end
|
398
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#tag_resource-instance_method
|
399
|
+
def tag_resource: (
|
400
|
+
resource_arn: ::String,
|
401
|
+
tags: Array[
|
402
|
+
{
|
403
|
+
key: ::String,
|
404
|
+
value: ::String?
|
405
|
+
},
|
406
|
+
]
|
407
|
+
) -> _TagResourceResponseSuccess
|
408
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
|
409
|
+
|
410
|
+
interface _UntagResourceResponseSuccess
|
411
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceOutput]
|
412
|
+
end
|
413
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#untag_resource-instance_method
|
414
|
+
def untag_resource: (
|
415
|
+
resource_arn: ::String,
|
416
|
+
tag_keys: Array[::String]
|
417
|
+
) -> _UntagResourceResponseSuccess
|
418
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
|
419
|
+
|
420
|
+
interface _UpdateAliasResponseSuccess
|
421
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateAliasOutput]
|
422
|
+
def alias: () -> Types::Alias
|
423
|
+
end
|
424
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PaymentCryptography/Client.html#update_alias-instance_method
|
425
|
+
def update_alias: (
|
426
|
+
alias_name: ::String,
|
427
|
+
?key_arn: ::String
|
428
|
+
) -> _UpdateAliasResponseSuccess
|
429
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateAliasResponseSuccess
|
430
|
+
end
|
431
|
+
end
|
432
|
+
end
|
433
|
+
|