aws-sdk-kms 1.76.0 → 1.88.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 +60 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kms/client.rb +771 -119
- data/lib/aws-sdk-kms/client_api.rb +130 -2
- data/lib/aws-sdk-kms/endpoints.rb +42 -0
- data/lib/aws-sdk-kms/errors.rb +16 -0
- data/lib/aws-sdk-kms/plugins/endpoints.rb +7 -0
- data/lib/aws-sdk-kms/types.rb +472 -36
- data/lib/aws-sdk-kms.rb +1 -1
- data/sig/client.rbs +802 -0
- data/sig/errors.rbs +160 -0
- data/sig/resource.rbs +81 -0
- data/sig/types.rbs +1036 -0
- data/sig/waiters.rbs +13 -0
- metadata +15 -10
data/sig/client.rbs
ADDED
@@ -0,0 +1,802 @@
|
|
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 KMS
|
10
|
+
class Client < ::Seahorse::Client::Base
|
11
|
+
include ::Aws::ClientStubs
|
12
|
+
|
13
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/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
|
+
?sigv4a_signing_region_set: Array[String],
|
52
|
+
?simple_json: bool,
|
53
|
+
?stub_responses: untyped,
|
54
|
+
?token_provider: untyped,
|
55
|
+
?use_dualstack_endpoint: bool,
|
56
|
+
?use_fips_endpoint: bool,
|
57
|
+
?validate_params: bool,
|
58
|
+
?endpoint_provider: untyped,
|
59
|
+
?http_proxy: String,
|
60
|
+
?http_open_timeout: (Float | Integer),
|
61
|
+
?http_read_timeout: (Float | Integer),
|
62
|
+
?http_idle_timeout: (Float | Integer),
|
63
|
+
?http_continue_timeout: (Float | Integer),
|
64
|
+
?ssl_timeout: (Float | Integer | nil),
|
65
|
+
?http_wire_trace: bool,
|
66
|
+
?ssl_verify_peer: bool,
|
67
|
+
?ssl_ca_bundle: String,
|
68
|
+
?ssl_ca_directory: String,
|
69
|
+
?ssl_ca_store: String,
|
70
|
+
?on_chunk_received: Proc,
|
71
|
+
?on_chunk_sent: Proc,
|
72
|
+
?raise_response_errors: bool
|
73
|
+
) -> instance
|
74
|
+
| (?Hash[Symbol, untyped]) -> instance
|
75
|
+
|
76
|
+
|
77
|
+
interface _CancelKeyDeletionResponseSuccess
|
78
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CancelKeyDeletionResponse]
|
79
|
+
def key_id: () -> ::String
|
80
|
+
end
|
81
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#cancel_key_deletion-instance_method
|
82
|
+
def cancel_key_deletion: (
|
83
|
+
key_id: ::String
|
84
|
+
) -> _CancelKeyDeletionResponseSuccess
|
85
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CancelKeyDeletionResponseSuccess
|
86
|
+
|
87
|
+
interface _ConnectCustomKeyStoreResponseSuccess
|
88
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ConnectCustomKeyStoreResponse]
|
89
|
+
end
|
90
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#connect_custom_key_store-instance_method
|
91
|
+
def connect_custom_key_store: (
|
92
|
+
custom_key_store_id: ::String
|
93
|
+
) -> _ConnectCustomKeyStoreResponseSuccess
|
94
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ConnectCustomKeyStoreResponseSuccess
|
95
|
+
|
96
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#create_alias-instance_method
|
97
|
+
def create_alias: (
|
98
|
+
alias_name: ::String,
|
99
|
+
target_key_id: ::String
|
100
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
101
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
102
|
+
|
103
|
+
interface _CreateCustomKeyStoreResponseSuccess
|
104
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateCustomKeyStoreResponse]
|
105
|
+
def custom_key_store_id: () -> ::String
|
106
|
+
end
|
107
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#create_custom_key_store-instance_method
|
108
|
+
def create_custom_key_store: (
|
109
|
+
custom_key_store_name: ::String,
|
110
|
+
?cloud_hsm_cluster_id: ::String,
|
111
|
+
?trust_anchor_certificate: ::String,
|
112
|
+
?key_store_password: ::String,
|
113
|
+
?custom_key_store_type: ("AWS_CLOUDHSM" | "EXTERNAL_KEY_STORE"),
|
114
|
+
?xks_proxy_uri_endpoint: ::String,
|
115
|
+
?xks_proxy_uri_path: ::String,
|
116
|
+
?xks_proxy_vpc_endpoint_service_name: ::String,
|
117
|
+
?xks_proxy_authentication_credential: {
|
118
|
+
access_key_id: ::String,
|
119
|
+
raw_secret_access_key: ::String
|
120
|
+
},
|
121
|
+
?xks_proxy_connectivity: ("PUBLIC_ENDPOINT" | "VPC_ENDPOINT_SERVICE")
|
122
|
+
) -> _CreateCustomKeyStoreResponseSuccess
|
123
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateCustomKeyStoreResponseSuccess
|
124
|
+
|
125
|
+
interface _CreateGrantResponseSuccess
|
126
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateGrantResponse]
|
127
|
+
def grant_token: () -> ::String
|
128
|
+
def grant_id: () -> ::String
|
129
|
+
end
|
130
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#create_grant-instance_method
|
131
|
+
def create_grant: (
|
132
|
+
key_id: ::String,
|
133
|
+
grantee_principal: ::String,
|
134
|
+
?retiring_principal: ::String,
|
135
|
+
operations: Array[("Decrypt" | "Encrypt" | "GenerateDataKey" | "GenerateDataKeyWithoutPlaintext" | "ReEncryptFrom" | "ReEncryptTo" | "Sign" | "Verify" | "GetPublicKey" | "CreateGrant" | "RetireGrant" | "DescribeKey" | "GenerateDataKeyPair" | "GenerateDataKeyPairWithoutPlaintext" | "GenerateMac" | "VerifyMac" | "DeriveSharedSecret")],
|
136
|
+
?constraints: {
|
137
|
+
encryption_context_subset: Hash[::String, ::String]?,
|
138
|
+
encryption_context_equals: Hash[::String, ::String]?
|
139
|
+
},
|
140
|
+
?grant_tokens: Array[::String],
|
141
|
+
?name: ::String,
|
142
|
+
?dry_run: bool
|
143
|
+
) -> _CreateGrantResponseSuccess
|
144
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateGrantResponseSuccess
|
145
|
+
|
146
|
+
interface _CreateKeyResponseSuccess
|
147
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateKeyResponse]
|
148
|
+
def key_metadata: () -> Types::KeyMetadata
|
149
|
+
end
|
150
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#create_key-instance_method
|
151
|
+
def create_key: (
|
152
|
+
?policy: ::String,
|
153
|
+
?description: ::String,
|
154
|
+
?key_usage: ("SIGN_VERIFY" | "ENCRYPT_DECRYPT" | "GENERATE_VERIFY_MAC" | "KEY_AGREEMENT"),
|
155
|
+
?customer_master_key_spec: ("RSA_2048" | "RSA_3072" | "RSA_4096" | "ECC_NIST_P256" | "ECC_NIST_P384" | "ECC_NIST_P521" | "ECC_SECG_P256K1" | "SYMMETRIC_DEFAULT" | "HMAC_224" | "HMAC_256" | "HMAC_384" | "HMAC_512" | "SM2"),
|
156
|
+
?key_spec: ("RSA_2048" | "RSA_3072" | "RSA_4096" | "ECC_NIST_P256" | "ECC_NIST_P384" | "ECC_NIST_P521" | "ECC_SECG_P256K1" | "SYMMETRIC_DEFAULT" | "HMAC_224" | "HMAC_256" | "HMAC_384" | "HMAC_512" | "SM2"),
|
157
|
+
?origin: ("AWS_KMS" | "EXTERNAL" | "AWS_CLOUDHSM" | "EXTERNAL_KEY_STORE"),
|
158
|
+
?custom_key_store_id: ::String,
|
159
|
+
?bypass_policy_lockout_safety_check: bool,
|
160
|
+
?tags: Array[
|
161
|
+
{
|
162
|
+
tag_key: ::String,
|
163
|
+
tag_value: ::String
|
164
|
+
},
|
165
|
+
],
|
166
|
+
?multi_region: bool,
|
167
|
+
?xks_key_id: ::String
|
168
|
+
) -> _CreateKeyResponseSuccess
|
169
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateKeyResponseSuccess
|
170
|
+
|
171
|
+
interface _DecryptResponseSuccess
|
172
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DecryptResponse]
|
173
|
+
def key_id: () -> ::String
|
174
|
+
def plaintext: () -> ::String
|
175
|
+
def encryption_algorithm: () -> ("SYMMETRIC_DEFAULT" | "RSAES_OAEP_SHA_1" | "RSAES_OAEP_SHA_256" | "SM2PKE")
|
176
|
+
def ciphertext_for_recipient: () -> ::String
|
177
|
+
end
|
178
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#decrypt-instance_method
|
179
|
+
def decrypt: (
|
180
|
+
ciphertext_blob: ::String,
|
181
|
+
?encryption_context: Hash[::String, ::String],
|
182
|
+
?grant_tokens: Array[::String],
|
183
|
+
?key_id: ::String,
|
184
|
+
?encryption_algorithm: ("SYMMETRIC_DEFAULT" | "RSAES_OAEP_SHA_1" | "RSAES_OAEP_SHA_256" | "SM2PKE"),
|
185
|
+
?recipient: {
|
186
|
+
key_encryption_algorithm: ("RSAES_OAEP_SHA_256")?,
|
187
|
+
attestation_document: ::String?
|
188
|
+
},
|
189
|
+
?dry_run: bool
|
190
|
+
) -> _DecryptResponseSuccess
|
191
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DecryptResponseSuccess
|
192
|
+
|
193
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#delete_alias-instance_method
|
194
|
+
def delete_alias: (
|
195
|
+
alias_name: ::String
|
196
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
197
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
198
|
+
|
199
|
+
interface _DeleteCustomKeyStoreResponseSuccess
|
200
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteCustomKeyStoreResponse]
|
201
|
+
end
|
202
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#delete_custom_key_store-instance_method
|
203
|
+
def delete_custom_key_store: (
|
204
|
+
custom_key_store_id: ::String
|
205
|
+
) -> _DeleteCustomKeyStoreResponseSuccess
|
206
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteCustomKeyStoreResponseSuccess
|
207
|
+
|
208
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#delete_imported_key_material-instance_method
|
209
|
+
def delete_imported_key_material: (
|
210
|
+
key_id: ::String
|
211
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
212
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
213
|
+
|
214
|
+
interface _DeriveSharedSecretResponseSuccess
|
215
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeriveSharedSecretResponse]
|
216
|
+
def key_id: () -> ::String
|
217
|
+
def shared_secret: () -> ::String
|
218
|
+
def ciphertext_for_recipient: () -> ::String
|
219
|
+
def key_agreement_algorithm: () -> ("ECDH")
|
220
|
+
def key_origin: () -> ("AWS_KMS" | "EXTERNAL" | "AWS_CLOUDHSM" | "EXTERNAL_KEY_STORE")
|
221
|
+
end
|
222
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#derive_shared_secret-instance_method
|
223
|
+
def derive_shared_secret: (
|
224
|
+
key_id: ::String,
|
225
|
+
key_agreement_algorithm: ("ECDH"),
|
226
|
+
public_key: ::String,
|
227
|
+
?grant_tokens: Array[::String],
|
228
|
+
?dry_run: bool,
|
229
|
+
?recipient: {
|
230
|
+
key_encryption_algorithm: ("RSAES_OAEP_SHA_256")?,
|
231
|
+
attestation_document: ::String?
|
232
|
+
}
|
233
|
+
) -> _DeriveSharedSecretResponseSuccess
|
234
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeriveSharedSecretResponseSuccess
|
235
|
+
|
236
|
+
interface _DescribeCustomKeyStoresResponseSuccess
|
237
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeCustomKeyStoresResponse]
|
238
|
+
def custom_key_stores: () -> ::Array[Types::CustomKeyStoresListEntry]
|
239
|
+
def next_marker: () -> ::String
|
240
|
+
def truncated: () -> bool
|
241
|
+
end
|
242
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#describe_custom_key_stores-instance_method
|
243
|
+
def describe_custom_key_stores: (
|
244
|
+
?custom_key_store_id: ::String,
|
245
|
+
?custom_key_store_name: ::String,
|
246
|
+
?limit: ::Integer,
|
247
|
+
?marker: ::String
|
248
|
+
) -> _DescribeCustomKeyStoresResponseSuccess
|
249
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeCustomKeyStoresResponseSuccess
|
250
|
+
|
251
|
+
interface _DescribeKeyResponseSuccess
|
252
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeKeyResponse]
|
253
|
+
def key_metadata: () -> Types::KeyMetadata
|
254
|
+
end
|
255
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#describe_key-instance_method
|
256
|
+
def describe_key: (
|
257
|
+
key_id: ::String,
|
258
|
+
?grant_tokens: Array[::String]
|
259
|
+
) -> _DescribeKeyResponseSuccess
|
260
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeKeyResponseSuccess
|
261
|
+
|
262
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#disable_key-instance_method
|
263
|
+
def disable_key: (
|
264
|
+
key_id: ::String
|
265
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
266
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
267
|
+
|
268
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#disable_key_rotation-instance_method
|
269
|
+
def disable_key_rotation: (
|
270
|
+
key_id: ::String
|
271
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
272
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
273
|
+
|
274
|
+
interface _DisconnectCustomKeyStoreResponseSuccess
|
275
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DisconnectCustomKeyStoreResponse]
|
276
|
+
end
|
277
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#disconnect_custom_key_store-instance_method
|
278
|
+
def disconnect_custom_key_store: (
|
279
|
+
custom_key_store_id: ::String
|
280
|
+
) -> _DisconnectCustomKeyStoreResponseSuccess
|
281
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DisconnectCustomKeyStoreResponseSuccess
|
282
|
+
|
283
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#enable_key-instance_method
|
284
|
+
def enable_key: (
|
285
|
+
key_id: ::String
|
286
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
287
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
288
|
+
|
289
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#enable_key_rotation-instance_method
|
290
|
+
def enable_key_rotation: (
|
291
|
+
key_id: ::String,
|
292
|
+
?rotation_period_in_days: ::Integer
|
293
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
294
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
295
|
+
|
296
|
+
interface _EncryptResponseSuccess
|
297
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::EncryptResponse]
|
298
|
+
def ciphertext_blob: () -> ::String
|
299
|
+
def key_id: () -> ::String
|
300
|
+
def encryption_algorithm: () -> ("SYMMETRIC_DEFAULT" | "RSAES_OAEP_SHA_1" | "RSAES_OAEP_SHA_256" | "SM2PKE")
|
301
|
+
end
|
302
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#encrypt-instance_method
|
303
|
+
def encrypt: (
|
304
|
+
key_id: ::String,
|
305
|
+
plaintext: ::String,
|
306
|
+
?encryption_context: Hash[::String, ::String],
|
307
|
+
?grant_tokens: Array[::String],
|
308
|
+
?encryption_algorithm: ("SYMMETRIC_DEFAULT" | "RSAES_OAEP_SHA_1" | "RSAES_OAEP_SHA_256" | "SM2PKE"),
|
309
|
+
?dry_run: bool
|
310
|
+
) -> _EncryptResponseSuccess
|
311
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _EncryptResponseSuccess
|
312
|
+
|
313
|
+
interface _GenerateDataKeyResponseSuccess
|
314
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GenerateDataKeyResponse]
|
315
|
+
def ciphertext_blob: () -> ::String
|
316
|
+
def plaintext: () -> ::String
|
317
|
+
def key_id: () -> ::String
|
318
|
+
def ciphertext_for_recipient: () -> ::String
|
319
|
+
end
|
320
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#generate_data_key-instance_method
|
321
|
+
def generate_data_key: (
|
322
|
+
key_id: ::String,
|
323
|
+
?encryption_context: Hash[::String, ::String],
|
324
|
+
?number_of_bytes: ::Integer,
|
325
|
+
?key_spec: ("AES_256" | "AES_128"),
|
326
|
+
?grant_tokens: Array[::String],
|
327
|
+
?recipient: {
|
328
|
+
key_encryption_algorithm: ("RSAES_OAEP_SHA_256")?,
|
329
|
+
attestation_document: ::String?
|
330
|
+
},
|
331
|
+
?dry_run: bool
|
332
|
+
) -> _GenerateDataKeyResponseSuccess
|
333
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GenerateDataKeyResponseSuccess
|
334
|
+
|
335
|
+
interface _GenerateDataKeyPairResponseSuccess
|
336
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GenerateDataKeyPairResponse]
|
337
|
+
def private_key_ciphertext_blob: () -> ::String
|
338
|
+
def private_key_plaintext: () -> ::String
|
339
|
+
def public_key: () -> ::String
|
340
|
+
def key_id: () -> ::String
|
341
|
+
def key_pair_spec: () -> ("RSA_2048" | "RSA_3072" | "RSA_4096" | "ECC_NIST_P256" | "ECC_NIST_P384" | "ECC_NIST_P521" | "ECC_SECG_P256K1" | "SM2")
|
342
|
+
def ciphertext_for_recipient: () -> ::String
|
343
|
+
end
|
344
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#generate_data_key_pair-instance_method
|
345
|
+
def generate_data_key_pair: (
|
346
|
+
?encryption_context: Hash[::String, ::String],
|
347
|
+
key_id: ::String,
|
348
|
+
key_pair_spec: ("RSA_2048" | "RSA_3072" | "RSA_4096" | "ECC_NIST_P256" | "ECC_NIST_P384" | "ECC_NIST_P521" | "ECC_SECG_P256K1" | "SM2"),
|
349
|
+
?grant_tokens: Array[::String],
|
350
|
+
?recipient: {
|
351
|
+
key_encryption_algorithm: ("RSAES_OAEP_SHA_256")?,
|
352
|
+
attestation_document: ::String?
|
353
|
+
},
|
354
|
+
?dry_run: bool
|
355
|
+
) -> _GenerateDataKeyPairResponseSuccess
|
356
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GenerateDataKeyPairResponseSuccess
|
357
|
+
|
358
|
+
interface _GenerateDataKeyPairWithoutPlaintextResponseSuccess
|
359
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GenerateDataKeyPairWithoutPlaintextResponse]
|
360
|
+
def private_key_ciphertext_blob: () -> ::String
|
361
|
+
def public_key: () -> ::String
|
362
|
+
def key_id: () -> ::String
|
363
|
+
def key_pair_spec: () -> ("RSA_2048" | "RSA_3072" | "RSA_4096" | "ECC_NIST_P256" | "ECC_NIST_P384" | "ECC_NIST_P521" | "ECC_SECG_P256K1" | "SM2")
|
364
|
+
end
|
365
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#generate_data_key_pair_without_plaintext-instance_method
|
366
|
+
def generate_data_key_pair_without_plaintext: (
|
367
|
+
?encryption_context: Hash[::String, ::String],
|
368
|
+
key_id: ::String,
|
369
|
+
key_pair_spec: ("RSA_2048" | "RSA_3072" | "RSA_4096" | "ECC_NIST_P256" | "ECC_NIST_P384" | "ECC_NIST_P521" | "ECC_SECG_P256K1" | "SM2"),
|
370
|
+
?grant_tokens: Array[::String],
|
371
|
+
?dry_run: bool
|
372
|
+
) -> _GenerateDataKeyPairWithoutPlaintextResponseSuccess
|
373
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GenerateDataKeyPairWithoutPlaintextResponseSuccess
|
374
|
+
|
375
|
+
interface _GenerateDataKeyWithoutPlaintextResponseSuccess
|
376
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GenerateDataKeyWithoutPlaintextResponse]
|
377
|
+
def ciphertext_blob: () -> ::String
|
378
|
+
def key_id: () -> ::String
|
379
|
+
end
|
380
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#generate_data_key_without_plaintext-instance_method
|
381
|
+
def generate_data_key_without_plaintext: (
|
382
|
+
key_id: ::String,
|
383
|
+
?encryption_context: Hash[::String, ::String],
|
384
|
+
?key_spec: ("AES_256" | "AES_128"),
|
385
|
+
?number_of_bytes: ::Integer,
|
386
|
+
?grant_tokens: Array[::String],
|
387
|
+
?dry_run: bool
|
388
|
+
) -> _GenerateDataKeyWithoutPlaintextResponseSuccess
|
389
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GenerateDataKeyWithoutPlaintextResponseSuccess
|
390
|
+
|
391
|
+
interface _GenerateMacResponseSuccess
|
392
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GenerateMacResponse]
|
393
|
+
def mac: () -> ::String
|
394
|
+
def mac_algorithm: () -> ("HMAC_SHA_224" | "HMAC_SHA_256" | "HMAC_SHA_384" | "HMAC_SHA_512")
|
395
|
+
def key_id: () -> ::String
|
396
|
+
end
|
397
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#generate_mac-instance_method
|
398
|
+
def generate_mac: (
|
399
|
+
message: ::String,
|
400
|
+
key_id: ::String,
|
401
|
+
mac_algorithm: ("HMAC_SHA_224" | "HMAC_SHA_256" | "HMAC_SHA_384" | "HMAC_SHA_512"),
|
402
|
+
?grant_tokens: Array[::String],
|
403
|
+
?dry_run: bool
|
404
|
+
) -> _GenerateMacResponseSuccess
|
405
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GenerateMacResponseSuccess
|
406
|
+
|
407
|
+
interface _GenerateRandomResponseSuccess
|
408
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GenerateRandomResponse]
|
409
|
+
def plaintext: () -> ::String
|
410
|
+
def ciphertext_for_recipient: () -> ::String
|
411
|
+
end
|
412
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#generate_random-instance_method
|
413
|
+
def generate_random: (
|
414
|
+
?number_of_bytes: ::Integer,
|
415
|
+
?custom_key_store_id: ::String,
|
416
|
+
?recipient: {
|
417
|
+
key_encryption_algorithm: ("RSAES_OAEP_SHA_256")?,
|
418
|
+
attestation_document: ::String?
|
419
|
+
}
|
420
|
+
) -> _GenerateRandomResponseSuccess
|
421
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GenerateRandomResponseSuccess
|
422
|
+
|
423
|
+
interface _GetKeyPolicyResponseSuccess
|
424
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetKeyPolicyResponse]
|
425
|
+
def policy: () -> ::String
|
426
|
+
def policy_name: () -> ::String
|
427
|
+
end
|
428
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#get_key_policy-instance_method
|
429
|
+
def get_key_policy: (
|
430
|
+
key_id: ::String,
|
431
|
+
?policy_name: ::String
|
432
|
+
) -> _GetKeyPolicyResponseSuccess
|
433
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetKeyPolicyResponseSuccess
|
434
|
+
|
435
|
+
interface _GetKeyRotationStatusResponseSuccess
|
436
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetKeyRotationStatusResponse]
|
437
|
+
def key_rotation_enabled: () -> bool
|
438
|
+
def key_id: () -> ::String
|
439
|
+
def rotation_period_in_days: () -> ::Integer
|
440
|
+
def next_rotation_date: () -> ::Time
|
441
|
+
def on_demand_rotation_start_date: () -> ::Time
|
442
|
+
end
|
443
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#get_key_rotation_status-instance_method
|
444
|
+
def get_key_rotation_status: (
|
445
|
+
key_id: ::String
|
446
|
+
) -> _GetKeyRotationStatusResponseSuccess
|
447
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetKeyRotationStatusResponseSuccess
|
448
|
+
|
449
|
+
interface _GetParametersForImportResponseSuccess
|
450
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetParametersForImportResponse]
|
451
|
+
def key_id: () -> ::String
|
452
|
+
def import_token: () -> ::String
|
453
|
+
def public_key: () -> ::String
|
454
|
+
def parameters_valid_to: () -> ::Time
|
455
|
+
end
|
456
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#get_parameters_for_import-instance_method
|
457
|
+
def get_parameters_for_import: (
|
458
|
+
key_id: ::String,
|
459
|
+
wrapping_algorithm: ("RSAES_PKCS1_V1_5" | "RSAES_OAEP_SHA_1" | "RSAES_OAEP_SHA_256" | "RSA_AES_KEY_WRAP_SHA_1" | "RSA_AES_KEY_WRAP_SHA_256" | "SM2PKE"),
|
460
|
+
wrapping_key_spec: ("RSA_2048" | "RSA_3072" | "RSA_4096" | "SM2")
|
461
|
+
) -> _GetParametersForImportResponseSuccess
|
462
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetParametersForImportResponseSuccess
|
463
|
+
|
464
|
+
interface _GetPublicKeyResponseSuccess
|
465
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetPublicKeyResponse]
|
466
|
+
def key_id: () -> ::String
|
467
|
+
def public_key: () -> ::String
|
468
|
+
def customer_master_key_spec: () -> ("RSA_2048" | "RSA_3072" | "RSA_4096" | "ECC_NIST_P256" | "ECC_NIST_P384" | "ECC_NIST_P521" | "ECC_SECG_P256K1" | "SYMMETRIC_DEFAULT" | "HMAC_224" | "HMAC_256" | "HMAC_384" | "HMAC_512" | "SM2")
|
469
|
+
def key_spec: () -> ("RSA_2048" | "RSA_3072" | "RSA_4096" | "ECC_NIST_P256" | "ECC_NIST_P384" | "ECC_NIST_P521" | "ECC_SECG_P256K1" | "SYMMETRIC_DEFAULT" | "HMAC_224" | "HMAC_256" | "HMAC_384" | "HMAC_512" | "SM2")
|
470
|
+
def key_usage: () -> ("SIGN_VERIFY" | "ENCRYPT_DECRYPT" | "GENERATE_VERIFY_MAC" | "KEY_AGREEMENT")
|
471
|
+
def encryption_algorithms: () -> ::Array[("SYMMETRIC_DEFAULT" | "RSAES_OAEP_SHA_1" | "RSAES_OAEP_SHA_256" | "SM2PKE")]
|
472
|
+
def signing_algorithms: () -> ::Array[("RSASSA_PSS_SHA_256" | "RSASSA_PSS_SHA_384" | "RSASSA_PSS_SHA_512" | "RSASSA_PKCS1_V1_5_SHA_256" | "RSASSA_PKCS1_V1_5_SHA_384" | "RSASSA_PKCS1_V1_5_SHA_512" | "ECDSA_SHA_256" | "ECDSA_SHA_384" | "ECDSA_SHA_512" | "SM2DSA")]
|
473
|
+
def key_agreement_algorithms: () -> ::Array[("ECDH")]
|
474
|
+
end
|
475
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#get_public_key-instance_method
|
476
|
+
def get_public_key: (
|
477
|
+
key_id: ::String,
|
478
|
+
?grant_tokens: Array[::String]
|
479
|
+
) -> _GetPublicKeyResponseSuccess
|
480
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetPublicKeyResponseSuccess
|
481
|
+
|
482
|
+
interface _ImportKeyMaterialResponseSuccess
|
483
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ImportKeyMaterialResponse]
|
484
|
+
end
|
485
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#import_key_material-instance_method
|
486
|
+
def import_key_material: (
|
487
|
+
key_id: ::String,
|
488
|
+
import_token: ::String,
|
489
|
+
encrypted_key_material: ::String,
|
490
|
+
?valid_to: ::Time,
|
491
|
+
?expiration_model: ("KEY_MATERIAL_EXPIRES" | "KEY_MATERIAL_DOES_NOT_EXPIRE")
|
492
|
+
) -> _ImportKeyMaterialResponseSuccess
|
493
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ImportKeyMaterialResponseSuccess
|
494
|
+
|
495
|
+
interface _ListAliasesResponseSuccess
|
496
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListAliasesResponse]
|
497
|
+
def aliases: () -> ::Array[Types::AliasListEntry]
|
498
|
+
def next_marker: () -> ::String
|
499
|
+
def truncated: () -> bool
|
500
|
+
end
|
501
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#list_aliases-instance_method
|
502
|
+
def list_aliases: (
|
503
|
+
?key_id: ::String,
|
504
|
+
?limit: ::Integer,
|
505
|
+
?marker: ::String
|
506
|
+
) -> _ListAliasesResponseSuccess
|
507
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAliasesResponseSuccess
|
508
|
+
|
509
|
+
interface _ListGrantsResponseSuccess
|
510
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListGrantsResponse]
|
511
|
+
def grants: () -> ::Array[Types::GrantListEntry]
|
512
|
+
def next_marker: () -> ::String
|
513
|
+
def truncated: () -> bool
|
514
|
+
end
|
515
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#list_grants-instance_method
|
516
|
+
def list_grants: (
|
517
|
+
?limit: ::Integer,
|
518
|
+
?marker: ::String,
|
519
|
+
key_id: ::String,
|
520
|
+
?grant_id: ::String,
|
521
|
+
?grantee_principal: ::String
|
522
|
+
) -> _ListGrantsResponseSuccess
|
523
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListGrantsResponseSuccess
|
524
|
+
|
525
|
+
interface _ListKeyPoliciesResponseSuccess
|
526
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListKeyPoliciesResponse]
|
527
|
+
def policy_names: () -> ::Array[::String]
|
528
|
+
def next_marker: () -> ::String
|
529
|
+
def truncated: () -> bool
|
530
|
+
end
|
531
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#list_key_policies-instance_method
|
532
|
+
def list_key_policies: (
|
533
|
+
key_id: ::String,
|
534
|
+
?limit: ::Integer,
|
535
|
+
?marker: ::String
|
536
|
+
) -> _ListKeyPoliciesResponseSuccess
|
537
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListKeyPoliciesResponseSuccess
|
538
|
+
|
539
|
+
interface _ListKeyRotationsResponseSuccess
|
540
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListKeyRotationsResponse]
|
541
|
+
def rotations: () -> ::Array[Types::RotationsListEntry]
|
542
|
+
def next_marker: () -> ::String
|
543
|
+
def truncated: () -> bool
|
544
|
+
end
|
545
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#list_key_rotations-instance_method
|
546
|
+
def list_key_rotations: (
|
547
|
+
key_id: ::String,
|
548
|
+
?limit: ::Integer,
|
549
|
+
?marker: ::String
|
550
|
+
) -> _ListKeyRotationsResponseSuccess
|
551
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListKeyRotationsResponseSuccess
|
552
|
+
|
553
|
+
interface _ListKeysResponseSuccess
|
554
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListKeysResponse]
|
555
|
+
def keys: () -> ::Array[Types::KeyListEntry]
|
556
|
+
def next_marker: () -> ::String
|
557
|
+
def truncated: () -> bool
|
558
|
+
end
|
559
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#list_keys-instance_method
|
560
|
+
def list_keys: (
|
561
|
+
?limit: ::Integer,
|
562
|
+
?marker: ::String
|
563
|
+
) -> _ListKeysResponseSuccess
|
564
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListKeysResponseSuccess
|
565
|
+
|
566
|
+
interface _ListResourceTagsResponseSuccess
|
567
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListResourceTagsResponse]
|
568
|
+
def tags: () -> ::Array[Types::Tag]
|
569
|
+
def next_marker: () -> ::String
|
570
|
+
def truncated: () -> bool
|
571
|
+
end
|
572
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#list_resource_tags-instance_method
|
573
|
+
def list_resource_tags: (
|
574
|
+
key_id: ::String,
|
575
|
+
?limit: ::Integer,
|
576
|
+
?marker: ::String
|
577
|
+
) -> _ListResourceTagsResponseSuccess
|
578
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListResourceTagsResponseSuccess
|
579
|
+
|
580
|
+
interface _ListRetirableGrantsResponseSuccess
|
581
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListGrantsResponse]
|
582
|
+
def grants: () -> ::Array[Types::GrantListEntry]
|
583
|
+
def next_marker: () -> ::String
|
584
|
+
def truncated: () -> bool
|
585
|
+
end
|
586
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#list_retirable_grants-instance_method
|
587
|
+
def list_retirable_grants: (
|
588
|
+
?limit: ::Integer,
|
589
|
+
?marker: ::String,
|
590
|
+
retiring_principal: ::String
|
591
|
+
) -> _ListRetirableGrantsResponseSuccess
|
592
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListRetirableGrantsResponseSuccess
|
593
|
+
|
594
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#put_key_policy-instance_method
|
595
|
+
def put_key_policy: (
|
596
|
+
key_id: ::String,
|
597
|
+
?policy_name: ::String,
|
598
|
+
policy: ::String,
|
599
|
+
?bypass_policy_lockout_safety_check: bool
|
600
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
601
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
602
|
+
|
603
|
+
interface _ReEncryptResponseSuccess
|
604
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ReEncryptResponse]
|
605
|
+
def ciphertext_blob: () -> ::String
|
606
|
+
def source_key_id: () -> ::String
|
607
|
+
def key_id: () -> ::String
|
608
|
+
def source_encryption_algorithm: () -> ("SYMMETRIC_DEFAULT" | "RSAES_OAEP_SHA_1" | "RSAES_OAEP_SHA_256" | "SM2PKE")
|
609
|
+
def destination_encryption_algorithm: () -> ("SYMMETRIC_DEFAULT" | "RSAES_OAEP_SHA_1" | "RSAES_OAEP_SHA_256" | "SM2PKE")
|
610
|
+
end
|
611
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#re_encrypt-instance_method
|
612
|
+
def re_encrypt: (
|
613
|
+
ciphertext_blob: ::String,
|
614
|
+
?source_encryption_context: Hash[::String, ::String],
|
615
|
+
?source_key_id: ::String,
|
616
|
+
destination_key_id: ::String,
|
617
|
+
?destination_encryption_context: Hash[::String, ::String],
|
618
|
+
?source_encryption_algorithm: ("SYMMETRIC_DEFAULT" | "RSAES_OAEP_SHA_1" | "RSAES_OAEP_SHA_256" | "SM2PKE"),
|
619
|
+
?destination_encryption_algorithm: ("SYMMETRIC_DEFAULT" | "RSAES_OAEP_SHA_1" | "RSAES_OAEP_SHA_256" | "SM2PKE"),
|
620
|
+
?grant_tokens: Array[::String],
|
621
|
+
?dry_run: bool
|
622
|
+
) -> _ReEncryptResponseSuccess
|
623
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ReEncryptResponseSuccess
|
624
|
+
|
625
|
+
interface _ReplicateKeyResponseSuccess
|
626
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ReplicateKeyResponse]
|
627
|
+
def replica_key_metadata: () -> Types::KeyMetadata
|
628
|
+
def replica_policy: () -> ::String
|
629
|
+
def replica_tags: () -> ::Array[Types::Tag]
|
630
|
+
end
|
631
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#replicate_key-instance_method
|
632
|
+
def replicate_key: (
|
633
|
+
key_id: ::String,
|
634
|
+
replica_region: ::String,
|
635
|
+
?policy: ::String,
|
636
|
+
?bypass_policy_lockout_safety_check: bool,
|
637
|
+
?description: ::String,
|
638
|
+
?tags: Array[
|
639
|
+
{
|
640
|
+
tag_key: ::String,
|
641
|
+
tag_value: ::String
|
642
|
+
},
|
643
|
+
]
|
644
|
+
) -> _ReplicateKeyResponseSuccess
|
645
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ReplicateKeyResponseSuccess
|
646
|
+
|
647
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#retire_grant-instance_method
|
648
|
+
def retire_grant: (
|
649
|
+
?grant_token: ::String,
|
650
|
+
?key_id: ::String,
|
651
|
+
?grant_id: ::String,
|
652
|
+
?dry_run: bool
|
653
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
654
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
655
|
+
|
656
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#revoke_grant-instance_method
|
657
|
+
def revoke_grant: (
|
658
|
+
key_id: ::String,
|
659
|
+
grant_id: ::String,
|
660
|
+
?dry_run: bool
|
661
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
662
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
663
|
+
|
664
|
+
interface _RotateKeyOnDemandResponseSuccess
|
665
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::RotateKeyOnDemandResponse]
|
666
|
+
def key_id: () -> ::String
|
667
|
+
end
|
668
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#rotate_key_on_demand-instance_method
|
669
|
+
def rotate_key_on_demand: (
|
670
|
+
key_id: ::String
|
671
|
+
) -> _RotateKeyOnDemandResponseSuccess
|
672
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RotateKeyOnDemandResponseSuccess
|
673
|
+
|
674
|
+
interface _ScheduleKeyDeletionResponseSuccess
|
675
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ScheduleKeyDeletionResponse]
|
676
|
+
def key_id: () -> ::String
|
677
|
+
def deletion_date: () -> ::Time
|
678
|
+
def key_state: () -> ("Creating" | "Enabled" | "Disabled" | "PendingDeletion" | "PendingImport" | "PendingReplicaDeletion" | "Unavailable" | "Updating")
|
679
|
+
def pending_window_in_days: () -> ::Integer
|
680
|
+
end
|
681
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#schedule_key_deletion-instance_method
|
682
|
+
def schedule_key_deletion: (
|
683
|
+
key_id: ::String,
|
684
|
+
?pending_window_in_days: ::Integer
|
685
|
+
) -> _ScheduleKeyDeletionResponseSuccess
|
686
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ScheduleKeyDeletionResponseSuccess
|
687
|
+
|
688
|
+
interface _SignResponseSuccess
|
689
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SignResponse]
|
690
|
+
def key_id: () -> ::String
|
691
|
+
def signature: () -> ::String
|
692
|
+
def signing_algorithm: () -> ("RSASSA_PSS_SHA_256" | "RSASSA_PSS_SHA_384" | "RSASSA_PSS_SHA_512" | "RSASSA_PKCS1_V1_5_SHA_256" | "RSASSA_PKCS1_V1_5_SHA_384" | "RSASSA_PKCS1_V1_5_SHA_512" | "ECDSA_SHA_256" | "ECDSA_SHA_384" | "ECDSA_SHA_512" | "SM2DSA")
|
693
|
+
end
|
694
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#sign-instance_method
|
695
|
+
def sign: (
|
696
|
+
key_id: ::String,
|
697
|
+
message: ::String,
|
698
|
+
?message_type: ("RAW" | "DIGEST"),
|
699
|
+
?grant_tokens: Array[::String],
|
700
|
+
signing_algorithm: ("RSASSA_PSS_SHA_256" | "RSASSA_PSS_SHA_384" | "RSASSA_PSS_SHA_512" | "RSASSA_PKCS1_V1_5_SHA_256" | "RSASSA_PKCS1_V1_5_SHA_384" | "RSASSA_PKCS1_V1_5_SHA_512" | "ECDSA_SHA_256" | "ECDSA_SHA_384" | "ECDSA_SHA_512" | "SM2DSA"),
|
701
|
+
?dry_run: bool
|
702
|
+
) -> _SignResponseSuccess
|
703
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SignResponseSuccess
|
704
|
+
|
705
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#tag_resource-instance_method
|
706
|
+
def tag_resource: (
|
707
|
+
key_id: ::String,
|
708
|
+
tags: Array[
|
709
|
+
{
|
710
|
+
tag_key: ::String,
|
711
|
+
tag_value: ::String
|
712
|
+
},
|
713
|
+
]
|
714
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
715
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
716
|
+
|
717
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#untag_resource-instance_method
|
718
|
+
def untag_resource: (
|
719
|
+
key_id: ::String,
|
720
|
+
tag_keys: Array[::String]
|
721
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
722
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
723
|
+
|
724
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#update_alias-instance_method
|
725
|
+
def update_alias: (
|
726
|
+
alias_name: ::String,
|
727
|
+
target_key_id: ::String
|
728
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
729
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
730
|
+
|
731
|
+
interface _UpdateCustomKeyStoreResponseSuccess
|
732
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateCustomKeyStoreResponse]
|
733
|
+
end
|
734
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#update_custom_key_store-instance_method
|
735
|
+
def update_custom_key_store: (
|
736
|
+
custom_key_store_id: ::String,
|
737
|
+
?new_custom_key_store_name: ::String,
|
738
|
+
?key_store_password: ::String,
|
739
|
+
?cloud_hsm_cluster_id: ::String,
|
740
|
+
?xks_proxy_uri_endpoint: ::String,
|
741
|
+
?xks_proxy_uri_path: ::String,
|
742
|
+
?xks_proxy_vpc_endpoint_service_name: ::String,
|
743
|
+
?xks_proxy_authentication_credential: {
|
744
|
+
access_key_id: ::String,
|
745
|
+
raw_secret_access_key: ::String
|
746
|
+
},
|
747
|
+
?xks_proxy_connectivity: ("PUBLIC_ENDPOINT" | "VPC_ENDPOINT_SERVICE")
|
748
|
+
) -> _UpdateCustomKeyStoreResponseSuccess
|
749
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateCustomKeyStoreResponseSuccess
|
750
|
+
|
751
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#update_key_description-instance_method
|
752
|
+
def update_key_description: (
|
753
|
+
key_id: ::String,
|
754
|
+
description: ::String
|
755
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
756
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
757
|
+
|
758
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#update_primary_region-instance_method
|
759
|
+
def update_primary_region: (
|
760
|
+
key_id: ::String,
|
761
|
+
primary_region: ::String
|
762
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
763
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
764
|
+
|
765
|
+
interface _VerifyResponseSuccess
|
766
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::VerifyResponse]
|
767
|
+
def key_id: () -> ::String
|
768
|
+
def signature_valid: () -> bool
|
769
|
+
def signing_algorithm: () -> ("RSASSA_PSS_SHA_256" | "RSASSA_PSS_SHA_384" | "RSASSA_PSS_SHA_512" | "RSASSA_PKCS1_V1_5_SHA_256" | "RSASSA_PKCS1_V1_5_SHA_384" | "RSASSA_PKCS1_V1_5_SHA_512" | "ECDSA_SHA_256" | "ECDSA_SHA_384" | "ECDSA_SHA_512" | "SM2DSA")
|
770
|
+
end
|
771
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#verify-instance_method
|
772
|
+
def verify: (
|
773
|
+
key_id: ::String,
|
774
|
+
message: ::String,
|
775
|
+
?message_type: ("RAW" | "DIGEST"),
|
776
|
+
signature: ::String,
|
777
|
+
signing_algorithm: ("RSASSA_PSS_SHA_256" | "RSASSA_PSS_SHA_384" | "RSASSA_PSS_SHA_512" | "RSASSA_PKCS1_V1_5_SHA_256" | "RSASSA_PKCS1_V1_5_SHA_384" | "RSASSA_PKCS1_V1_5_SHA_512" | "ECDSA_SHA_256" | "ECDSA_SHA_384" | "ECDSA_SHA_512" | "SM2DSA"),
|
778
|
+
?grant_tokens: Array[::String],
|
779
|
+
?dry_run: bool
|
780
|
+
) -> _VerifyResponseSuccess
|
781
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _VerifyResponseSuccess
|
782
|
+
|
783
|
+
interface _VerifyMacResponseSuccess
|
784
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::VerifyMacResponse]
|
785
|
+
def key_id: () -> ::String
|
786
|
+
def mac_valid: () -> bool
|
787
|
+
def mac_algorithm: () -> ("HMAC_SHA_224" | "HMAC_SHA_256" | "HMAC_SHA_384" | "HMAC_SHA_512")
|
788
|
+
end
|
789
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KMS/Client.html#verify_mac-instance_method
|
790
|
+
def verify_mac: (
|
791
|
+
message: ::String,
|
792
|
+
key_id: ::String,
|
793
|
+
mac_algorithm: ("HMAC_SHA_224" | "HMAC_SHA_256" | "HMAC_SHA_384" | "HMAC_SHA_512"),
|
794
|
+
mac: ::String,
|
795
|
+
?grant_tokens: Array[::String],
|
796
|
+
?dry_run: bool
|
797
|
+
) -> _VerifyMacResponseSuccess
|
798
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _VerifyMacResponseSuccess
|
799
|
+
end
|
800
|
+
end
|
801
|
+
end
|
802
|
+
|