tencentcloud-sdk-python-intl-en 3.0.1075__py2.py3-none-any.whl → 3.0.1077__py2.py3-none-any.whl
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.
Potentially problematic release.
This version of tencentcloud-sdk-python-intl-en might be problematic. Click here for more details.
- tencentcloud/__init__.py +1 -1
- tencentcloud/advisor/v20200721/models.py +120 -0
- tencentcloud/aiart/v20221229/models.py +95 -0
- tencentcloud/ams/v20201229/models.py +432 -0
- tencentcloud/antiddos/v20200309/models.py +2806 -0
- tencentcloud/apigateway/v20180808/models.py +3945 -0
- tencentcloud/autoscaling/v20180419/autoscaling_client.py +16 -10
- tencentcloud/autoscaling/v20180419/errorcodes.py +3 -0
- tencentcloud/autoscaling/v20180419/models.py +2472 -7
- tencentcloud/batch/v20170312/models.py +1566 -0
- tencentcloud/billing/v20180709/models.py +2418 -0
- tencentcloud/cam/v20190116/models.py +1697 -0
- tencentcloud/captcha/v20190722/models.py +70 -0
- tencentcloud/car/v20220110/models.py +803 -0
- tencentcloud/cbs/v20170312/models.py +1245 -0
- tencentcloud/ccc/v20200210/models.py +1949 -1
- tencentcloud/cdb/v20170320/models.py +4821 -0
- tencentcloud/cdn/v20180606/models.py +4870 -8
- tencentcloud/cdwdoris/v20211228/models.py +3337 -0
- tencentcloud/cfg/v20210820/models.py +1194 -0
- tencentcloud/cfs/v20190719/models.py +1178 -0
- tencentcloud/cfw/v20190904/models.py +2378 -0
- tencentcloud/chdfs/v20201112/models.py +513 -0
- tencentcloud/ciam/v20210420/models.py +49 -0
- tencentcloud/ciam/v20220331/models.py +789 -0
- tencentcloud/ckafka/v20190819/models.py +2576 -0
- tencentcloud/clb/v20180317/models.py +3220 -1
- tencentcloud/cloudaudit/v20190319/models.py +519 -0
- tencentcloud/cls/v20201016/models.py +3652 -1
- tencentcloud/cmq/v20190304/models.py +571 -0
- tencentcloud/controlcenter/v20230110/models.py +15 -0
- tencentcloud/csip/v20221121/models.py +2881 -2
- tencentcloud/cvm/v20170312/models.py +2827 -0
- tencentcloud/cwp/v20180228/models.py +16412 -0
- tencentcloud/cynosdb/v20190107/models.py +4263 -0
- tencentcloud/dataintegration/v20220613/models.py +18 -0
- tencentcloud/dayu/v20180709/models.py +3541 -12
- tencentcloud/dbbrain/v20191016/models.py +1056 -0
- tencentcloud/dbbrain/v20210527/models.py +1763 -0
- tencentcloud/dc/v20180410/models.py +767 -0
- tencentcloud/dcdb/v20180411/models.py +2335 -0
- tencentcloud/dlc/v20210125/models.py +3985 -5
- tencentcloud/dms/v20200819/models.py +51 -0
- tencentcloud/dnspod/v20210323/models.py +1286 -0
- tencentcloud/domain/v20180808/models.py +855 -0
- tencentcloud/dts/v20180330/models.py +791 -0
- tencentcloud/dts/v20211206/models.py +2317 -1
- tencentcloud/eb/v20210416/models.py +858 -0
- tencentcloud/ecdn/v20191012/models.py +811 -0
- tencentcloud/ecm/v20190719/models.py +3972 -1
- tencentcloud/eiam/v20210420/models.py +1265 -0
- tencentcloud/emr/v20190103/models.py +2926 -7
- tencentcloud/es/v20180416/models.py +1523 -0
- tencentcloud/facefusion/v20220927/models.py +211 -0
- tencentcloud/faceid/v20180301/models.py +2071 -0
- tencentcloud/gaap/v20180529/models.py +3103 -8
- tencentcloud/gme/v20180711/models.py +388 -0
- tencentcloud/gpm/v20200820/models.py +674 -0
- tencentcloud/gse/v20191112/models.py +972 -0
- tencentcloud/iai/v20200303/models.py +1430 -0
- tencentcloud/ims/v20201229/models.py +329 -0
- tencentcloud/intlpartnersmgt/v20220928/models.py +988 -0
- tencentcloud/iotcloud/v20210408/models.py +585 -0
- tencentcloud/ip/v20210409/models.py +178 -0
- tencentcloud/kms/v20190118/models.py +869 -0
- tencentcloud/lcic/v20220817/models.py +1658 -0
- tencentcloud/lighthouse/v20200324/models.py +2088 -0
- tencentcloud/live/v20180801/models.py +4287 -0
- tencentcloud/mariadb/v20170312/models.py +1905 -0
- tencentcloud/mdc/v20200828/models.py +1104 -0
- tencentcloud/mdl/v20200326/models.py +1911 -1
- tencentcloud/mdp/v20200527/models.py +452 -0
- tencentcloud/mongodb/v20190725/models.py +1234 -0
- tencentcloud/monitor/v20180724/models.py +5798 -2
- tencentcloud/mps/v20190612/models.py +8135 -0
- tencentcloud/msp/v20180319/models.py +183 -0
- tencentcloud/ocr/v20181119/models.py +3160 -1
- tencentcloud/omics/v20221128/models.py +1086 -0
- tencentcloud/organization/v20181225/models.py +285 -0
- tencentcloud/organization/v20210331/models.py +2267 -0
- tencentcloud/postgres/v20170312/models.py +3248 -0
- tencentcloud/privatedns/v20201028/errorcodes.py +34 -1
- tencentcloud/privatedns/v20201028/models.py +1700 -0
- tencentcloud/privatedns/v20201028/privatedns_client.py +115 -0
- tencentcloud/redis/v20180412/models.py +3298 -3
- tencentcloud/rum/v20210622/models.py +2114 -0
- tencentcloud/scf/v20180416/models.py +1561 -0
- tencentcloud/ses/v20201002/models.py +649 -0
- tencentcloud/sms/v20190711/models.py +575 -0
- tencentcloud/sms/v20210111/models.py +593 -0
- tencentcloud/sqlserver/v20180328/models.py +2780 -0
- tencentcloud/ssl/v20191205/models.py +2267 -0
- tencentcloud/ssm/v20190923/models.py +675 -11
- tencentcloud/sts/v20180813/models.py +161 -0
- tencentcloud/tag/v20180813/models.py +784 -0
- tencentcloud/tat/v20201028/models.py +806 -0
- tencentcloud/tcaplusdb/v20190823/models.py +1860 -0
- tencentcloud/tchd/v20230306/models.py +41 -0
- tencentcloud/tcmpp/v20240801/models.py +3761 -1
- tencentcloud/tcr/v20190924/models.py +1851 -0
- tencentcloud/tcss/v20201101/models.py +12523 -0
- tencentcloud/tdid/v20210519/models.py +1258 -0
- tencentcloud/tdmq/v20200217/models.py +3495 -0
- tencentcloud/tem/v20201221/models.py +803 -0
- tencentcloud/tem/v20210701/models.py +2551 -1
- tencentcloud/teo/v20220106/models.py +4731 -0
- tencentcloud/teo/v20220901/models.py +6066 -0
- tencentcloud/tiw/v20190919/models.py +1678 -1
- tencentcloud/tke/v20180525/models.py +3662 -0
- tencentcloud/tms/v20201229/models.py +176 -0
- tencentcloud/tmt/v20180321/models.py +65 -0
- tencentcloud/trtc/v20190722/models.py +1698 -8
- tencentcloud/tts/v20190823/models.py +72 -0
- tencentcloud/vm/v20201229/models.py +568 -0
- tencentcloud/vm/v20210922/models.py +636 -0
- tencentcloud/vod/v20180717/models.py +13490 -1
- tencentcloud/vpc/v20170312/errorcodes.py +3 -0
- tencentcloud/vpc/v20170312/models.py +6622 -1
- tencentcloud/vpc/v20170312/vpc_client.py +23 -0
- tencentcloud/waf/v20180125/models.py +4814 -0
- tencentcloud/wedata/v20210820/models.py +12594 -0
- tencentcloud/yunjing/v20180228/models.py +1867 -0
- {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1077.dist-info}/METADATA +1 -1
- {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1077.dist-info}/RECORD +126 -126
- {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1077.dist-info}/WHEEL +0 -0
- {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1077.dist-info}/top_level.txt +0 -0
|
@@ -35,6 +35,9 @@ class AlgorithmInfo(AbstractModel):
|
|
|
35
35
|
|
|
36
36
|
@property
|
|
37
37
|
def KeyUsage(self):
|
|
38
|
+
"""Algorithm ID
|
|
39
|
+
:rtype: str
|
|
40
|
+
"""
|
|
38
41
|
return self._KeyUsage
|
|
39
42
|
|
|
40
43
|
@KeyUsage.setter
|
|
@@ -43,6 +46,9 @@ class AlgorithmInfo(AbstractModel):
|
|
|
43
46
|
|
|
44
47
|
@property
|
|
45
48
|
def Algorithm(self):
|
|
49
|
+
"""Algorithm name
|
|
50
|
+
:rtype: str
|
|
51
|
+
"""
|
|
46
52
|
return self._Algorithm
|
|
47
53
|
|
|
48
54
|
@Algorithm.setter
|
|
@@ -77,6 +83,9 @@ class ArchiveKeyRequest(AbstractModel):
|
|
|
77
83
|
|
|
78
84
|
@property
|
|
79
85
|
def KeyId(self):
|
|
86
|
+
"""Unique CMK ID
|
|
87
|
+
:rtype: str
|
|
88
|
+
"""
|
|
80
89
|
return self._KeyId
|
|
81
90
|
|
|
82
91
|
@KeyId.setter
|
|
@@ -110,6 +119,9 @@ class ArchiveKeyResponse(AbstractModel):
|
|
|
110
119
|
|
|
111
120
|
@property
|
|
112
121
|
def RequestId(self):
|
|
122
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
123
|
+
:rtype: str
|
|
124
|
+
"""
|
|
113
125
|
return self._RequestId
|
|
114
126
|
|
|
115
127
|
@RequestId.setter
|
|
@@ -141,6 +153,9 @@ class AsymmetricRsaDecryptRequest(AbstractModel):
|
|
|
141
153
|
|
|
142
154
|
@property
|
|
143
155
|
def KeyId(self):
|
|
156
|
+
"""Unique CMK ID
|
|
157
|
+
:rtype: str
|
|
158
|
+
"""
|
|
144
159
|
return self._KeyId
|
|
145
160
|
|
|
146
161
|
@KeyId.setter
|
|
@@ -149,6 +164,9 @@ class AsymmetricRsaDecryptRequest(AbstractModel):
|
|
|
149
164
|
|
|
150
165
|
@property
|
|
151
166
|
def Ciphertext(self):
|
|
167
|
+
"""Base64-encoded ciphertext encrypted with `PublicKey`
|
|
168
|
+
:rtype: str
|
|
169
|
+
"""
|
|
152
170
|
return self._Ciphertext
|
|
153
171
|
|
|
154
172
|
@Ciphertext.setter
|
|
@@ -157,6 +175,9 @@ class AsymmetricRsaDecryptRequest(AbstractModel):
|
|
|
157
175
|
|
|
158
176
|
@property
|
|
159
177
|
def Algorithm(self):
|
|
178
|
+
"""Corresponding algorithm when a public key is used for encryption. Valid values: RSAES_PKCS1_V1_5, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256
|
|
179
|
+
:rtype: str
|
|
180
|
+
"""
|
|
160
181
|
return self._Algorithm
|
|
161
182
|
|
|
162
183
|
@Algorithm.setter
|
|
@@ -198,6 +219,9 @@ class AsymmetricRsaDecryptResponse(AbstractModel):
|
|
|
198
219
|
|
|
199
220
|
@property
|
|
200
221
|
def KeyId(self):
|
|
222
|
+
"""Unique CMK ID
|
|
223
|
+
:rtype: str
|
|
224
|
+
"""
|
|
201
225
|
return self._KeyId
|
|
202
226
|
|
|
203
227
|
@KeyId.setter
|
|
@@ -206,6 +230,9 @@ class AsymmetricRsaDecryptResponse(AbstractModel):
|
|
|
206
230
|
|
|
207
231
|
@property
|
|
208
232
|
def Plaintext(self):
|
|
233
|
+
"""Base64-encoded plaintext after decryption
|
|
234
|
+
:rtype: str
|
|
235
|
+
"""
|
|
209
236
|
return self._Plaintext
|
|
210
237
|
|
|
211
238
|
@Plaintext.setter
|
|
@@ -214,6 +241,9 @@ class AsymmetricRsaDecryptResponse(AbstractModel):
|
|
|
214
241
|
|
|
215
242
|
@property
|
|
216
243
|
def RequestId(self):
|
|
244
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
245
|
+
:rtype: str
|
|
246
|
+
"""
|
|
217
247
|
return self._RequestId
|
|
218
248
|
|
|
219
249
|
@RequestId.setter
|
|
@@ -244,6 +274,9 @@ class AsymmetricSm2DecryptRequest(AbstractModel):
|
|
|
244
274
|
|
|
245
275
|
@property
|
|
246
276
|
def KeyId(self):
|
|
277
|
+
"""Unique CMK ID
|
|
278
|
+
:rtype: str
|
|
279
|
+
"""
|
|
247
280
|
return self._KeyId
|
|
248
281
|
|
|
249
282
|
@KeyId.setter
|
|
@@ -252,6 +285,9 @@ class AsymmetricSm2DecryptRequest(AbstractModel):
|
|
|
252
285
|
|
|
253
286
|
@property
|
|
254
287
|
def Ciphertext(self):
|
|
288
|
+
"""Base64-encoded ciphertext encrypted with `PublicKey`, whose length cannot exceed 256 bytes.
|
|
289
|
+
:rtype: str
|
|
290
|
+
"""
|
|
255
291
|
return self._Ciphertext
|
|
256
292
|
|
|
257
293
|
@Ciphertext.setter
|
|
@@ -292,6 +328,9 @@ class AsymmetricSm2DecryptResponse(AbstractModel):
|
|
|
292
328
|
|
|
293
329
|
@property
|
|
294
330
|
def KeyId(self):
|
|
331
|
+
"""Unique CMK ID
|
|
332
|
+
:rtype: str
|
|
333
|
+
"""
|
|
295
334
|
return self._KeyId
|
|
296
335
|
|
|
297
336
|
@KeyId.setter
|
|
@@ -300,6 +339,9 @@ class AsymmetricSm2DecryptResponse(AbstractModel):
|
|
|
300
339
|
|
|
301
340
|
@property
|
|
302
341
|
def Plaintext(self):
|
|
342
|
+
"""Base64-encoded plaintext after decryption
|
|
343
|
+
:rtype: str
|
|
344
|
+
"""
|
|
303
345
|
return self._Plaintext
|
|
304
346
|
|
|
305
347
|
@Plaintext.setter
|
|
@@ -308,6 +350,9 @@ class AsymmetricSm2DecryptResponse(AbstractModel):
|
|
|
308
350
|
|
|
309
351
|
@property
|
|
310
352
|
def RequestId(self):
|
|
353
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
354
|
+
:rtype: str
|
|
355
|
+
"""
|
|
311
356
|
return self._RequestId
|
|
312
357
|
|
|
313
358
|
@RequestId.setter
|
|
@@ -341,6 +386,9 @@ class BindCloudResourceRequest(AbstractModel):
|
|
|
341
386
|
|
|
342
387
|
@property
|
|
343
388
|
def KeyId(self):
|
|
389
|
+
"""CMK ID
|
|
390
|
+
:rtype: str
|
|
391
|
+
"""
|
|
344
392
|
return self._KeyId
|
|
345
393
|
|
|
346
394
|
@KeyId.setter
|
|
@@ -349,6 +397,9 @@ class BindCloudResourceRequest(AbstractModel):
|
|
|
349
397
|
|
|
350
398
|
@property
|
|
351
399
|
def ProductId(self):
|
|
400
|
+
"""Unique ID of a Tencent Cloud service
|
|
401
|
+
:rtype: str
|
|
402
|
+
"""
|
|
352
403
|
return self._ProductId
|
|
353
404
|
|
|
354
405
|
@ProductId.setter
|
|
@@ -357,6 +408,9 @@ class BindCloudResourceRequest(AbstractModel):
|
|
|
357
408
|
|
|
358
409
|
@property
|
|
359
410
|
def ResourceId(self):
|
|
411
|
+
"""Resource/instance ID, which is stored as a string and defined by the caller based on the Tencent Cloud service’s features.
|
|
412
|
+
:rtype: str
|
|
413
|
+
"""
|
|
360
414
|
return self._ResourceId
|
|
361
415
|
|
|
362
416
|
@ResourceId.setter
|
|
@@ -392,6 +446,9 @@ class BindCloudResourceResponse(AbstractModel):
|
|
|
392
446
|
|
|
393
447
|
@property
|
|
394
448
|
def RequestId(self):
|
|
449
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
450
|
+
:rtype: str
|
|
451
|
+
"""
|
|
395
452
|
return self._RequestId
|
|
396
453
|
|
|
397
454
|
@RequestId.setter
|
|
@@ -417,6 +474,9 @@ class CancelKeyArchiveRequest(AbstractModel):
|
|
|
417
474
|
|
|
418
475
|
@property
|
|
419
476
|
def KeyId(self):
|
|
477
|
+
"""Unique CMK ID
|
|
478
|
+
:rtype: str
|
|
479
|
+
"""
|
|
420
480
|
return self._KeyId
|
|
421
481
|
|
|
422
482
|
@KeyId.setter
|
|
@@ -450,6 +510,9 @@ class CancelKeyArchiveResponse(AbstractModel):
|
|
|
450
510
|
|
|
451
511
|
@property
|
|
452
512
|
def RequestId(self):
|
|
513
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
514
|
+
:rtype: str
|
|
515
|
+
"""
|
|
453
516
|
return self._RequestId
|
|
454
517
|
|
|
455
518
|
@RequestId.setter
|
|
@@ -475,6 +538,9 @@ class CancelKeyDeletionRequest(AbstractModel):
|
|
|
475
538
|
|
|
476
539
|
@property
|
|
477
540
|
def KeyId(self):
|
|
541
|
+
"""Unique ID of the CMK for which to cancel schedule deletion
|
|
542
|
+
:rtype: str
|
|
543
|
+
"""
|
|
478
544
|
return self._KeyId
|
|
479
545
|
|
|
480
546
|
@KeyId.setter
|
|
@@ -511,6 +577,9 @@ class CancelKeyDeletionResponse(AbstractModel):
|
|
|
511
577
|
|
|
512
578
|
@property
|
|
513
579
|
def KeyId(self):
|
|
580
|
+
"""Unique ID of the CMK for which the schedule deletion is canceled
|
|
581
|
+
:rtype: str
|
|
582
|
+
"""
|
|
514
583
|
return self._KeyId
|
|
515
584
|
|
|
516
585
|
@KeyId.setter
|
|
@@ -519,6 +588,9 @@ class CancelKeyDeletionResponse(AbstractModel):
|
|
|
519
588
|
|
|
520
589
|
@property
|
|
521
590
|
def RequestId(self):
|
|
591
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
592
|
+
:rtype: str
|
|
593
|
+
"""
|
|
522
594
|
return self._RequestId
|
|
523
595
|
|
|
524
596
|
@RequestId.setter
|
|
@@ -560,6 +632,9 @@ class CreateKeyRequest(AbstractModel):
|
|
|
560
632
|
|
|
561
633
|
@property
|
|
562
634
|
def Alias(self):
|
|
635
|
+
"""Unique alias that makes a key more recognizable and understandable. This parameter cannot be empty, can contain 1-60 letters, digits, `-`, and `_`, and must begin with a letter or digit. The `kms-` prefix is used for Tencent Cloud products.
|
|
636
|
+
:rtype: str
|
|
637
|
+
"""
|
|
563
638
|
return self._Alias
|
|
564
639
|
|
|
565
640
|
@Alias.setter
|
|
@@ -568,6 +643,9 @@ class CreateKeyRequest(AbstractModel):
|
|
|
568
643
|
|
|
569
644
|
@property
|
|
570
645
|
def Description(self):
|
|
646
|
+
"""CMK description of up to 1,024 bytes in length
|
|
647
|
+
:rtype: str
|
|
648
|
+
"""
|
|
571
649
|
return self._Description
|
|
572
650
|
|
|
573
651
|
@Description.setter
|
|
@@ -576,6 +654,9 @@ class CreateKeyRequest(AbstractModel):
|
|
|
576
654
|
|
|
577
655
|
@property
|
|
578
656
|
def KeyUsage(self):
|
|
657
|
+
"""Defines the purpose of the key. The valid values are as follows: `ENCRYPT_DECRYPT` (default): creates a symmetric encryption/decryption key; `ASYMMETRIC_DECRYPT_RSA_2048`: creates an asymmetric encryption/decryption 2048-bit RSA key; `ASYMMETRIC_DECRYPT_SM2`: creates an asymmetric encryption/decryption SM2 key; `ASYMMETRIC_SIGN_VERIFY_SM2`: creates an asymmetric SM2 key for signature verification; `ASYMMETRIC_SIGN_VERIFY_ECC`: creates an asymmetric 2048-bit RSA key for signature verification; `ASYMMETRIC_SIGN_VERIFY_ECDSA384`: creates an asymmetric ECDSA384 key for signature verification. You can get a full list of supported key purposes and algorithms using the ListAlgorithms API.
|
|
658
|
+
:rtype: str
|
|
659
|
+
"""
|
|
579
660
|
return self._KeyUsage
|
|
580
661
|
|
|
581
662
|
@KeyUsage.setter
|
|
@@ -584,6 +665,9 @@ class CreateKeyRequest(AbstractModel):
|
|
|
584
665
|
|
|
585
666
|
@property
|
|
586
667
|
def Type(self):
|
|
668
|
+
"""Specifies the key type. Default value: 1. Valid value: 1 - default type, indicating that the CMK is created by KMS; 2 - EXTERNAL type, indicating that you need to import key material. For more information, please see the `GetParametersForImport` and `ImportKeyMaterial` API documents.
|
|
669
|
+
:rtype: int
|
|
670
|
+
"""
|
|
587
671
|
return self._Type
|
|
588
672
|
|
|
589
673
|
@Type.setter
|
|
@@ -592,6 +676,9 @@ class CreateKeyRequest(AbstractModel):
|
|
|
592
676
|
|
|
593
677
|
@property
|
|
594
678
|
def Tags(self):
|
|
679
|
+
"""Tag list
|
|
680
|
+
:rtype: list of Tag
|
|
681
|
+
"""
|
|
595
682
|
return self._Tags
|
|
596
683
|
|
|
597
684
|
@Tags.setter
|
|
@@ -600,6 +687,9 @@ class CreateKeyRequest(AbstractModel):
|
|
|
600
687
|
|
|
601
688
|
@property
|
|
602
689
|
def HsmClusterId(self):
|
|
690
|
+
"""ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.
|
|
691
|
+
:rtype: str
|
|
692
|
+
"""
|
|
603
693
|
return self._HsmClusterId
|
|
604
694
|
|
|
605
695
|
@HsmClusterId.setter
|
|
@@ -671,6 +761,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
671
761
|
|
|
672
762
|
@property
|
|
673
763
|
def KeyId(self):
|
|
764
|
+
"""Globally unique CMK ID
|
|
765
|
+
:rtype: str
|
|
766
|
+
"""
|
|
674
767
|
return self._KeyId
|
|
675
768
|
|
|
676
769
|
@KeyId.setter
|
|
@@ -679,6 +772,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
679
772
|
|
|
680
773
|
@property
|
|
681
774
|
def Alias(self):
|
|
775
|
+
"""Alias that makes a key more recognizable and understandable
|
|
776
|
+
:rtype: str
|
|
777
|
+
"""
|
|
682
778
|
return self._Alias
|
|
683
779
|
|
|
684
780
|
@Alias.setter
|
|
@@ -687,6 +783,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
687
783
|
|
|
688
784
|
@property
|
|
689
785
|
def CreateTime(self):
|
|
786
|
+
"""Key creation time in UNIX timestamp format
|
|
787
|
+
:rtype: int
|
|
788
|
+
"""
|
|
690
789
|
return self._CreateTime
|
|
691
790
|
|
|
692
791
|
@CreateTime.setter
|
|
@@ -695,6 +794,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
695
794
|
|
|
696
795
|
@property
|
|
697
796
|
def Description(self):
|
|
797
|
+
"""CMK description
|
|
798
|
+
:rtype: str
|
|
799
|
+
"""
|
|
698
800
|
return self._Description
|
|
699
801
|
|
|
700
802
|
@Description.setter
|
|
@@ -703,6 +805,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
703
805
|
|
|
704
806
|
@property
|
|
705
807
|
def KeyState(self):
|
|
808
|
+
"""CMK status
|
|
809
|
+
:rtype: str
|
|
810
|
+
"""
|
|
706
811
|
return self._KeyState
|
|
707
812
|
|
|
708
813
|
@KeyState.setter
|
|
@@ -711,6 +816,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
711
816
|
|
|
712
817
|
@property
|
|
713
818
|
def KeyUsage(self):
|
|
819
|
+
"""CMK usage
|
|
820
|
+
:rtype: str
|
|
821
|
+
"""
|
|
714
822
|
return self._KeyUsage
|
|
715
823
|
|
|
716
824
|
@KeyUsage.setter
|
|
@@ -719,6 +827,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
719
827
|
|
|
720
828
|
@property
|
|
721
829
|
def TagCode(self):
|
|
830
|
+
"""Tag operation return code. 0: success; 1: internal error; 2: business processing error
|
|
831
|
+
:rtype: int
|
|
832
|
+
"""
|
|
722
833
|
return self._TagCode
|
|
723
834
|
|
|
724
835
|
@TagCode.setter
|
|
@@ -727,6 +838,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
727
838
|
|
|
728
839
|
@property
|
|
729
840
|
def TagMsg(self):
|
|
841
|
+
"""Tag operation return information
|
|
842
|
+
:rtype: str
|
|
843
|
+
"""
|
|
730
844
|
return self._TagMsg
|
|
731
845
|
|
|
732
846
|
@TagMsg.setter
|
|
@@ -735,6 +849,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
735
849
|
|
|
736
850
|
@property
|
|
737
851
|
def HsmClusterId(self):
|
|
852
|
+
"""ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.
|
|
853
|
+
Note: This field may return `null`, indicating that no valid value can be obtained.
|
|
854
|
+
:rtype: str
|
|
855
|
+
"""
|
|
738
856
|
return self._HsmClusterId
|
|
739
857
|
|
|
740
858
|
@HsmClusterId.setter
|
|
@@ -743,6 +861,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
743
861
|
|
|
744
862
|
@property
|
|
745
863
|
def RequestId(self):
|
|
864
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
865
|
+
:rtype: str
|
|
866
|
+
"""
|
|
746
867
|
return self._RequestId
|
|
747
868
|
|
|
748
869
|
@RequestId.setter
|
|
@@ -786,6 +907,9 @@ class CreateWhiteBoxKeyRequest(AbstractModel):
|
|
|
786
907
|
|
|
787
908
|
@property
|
|
788
909
|
def Alias(self):
|
|
910
|
+
"""Unique alias that makes a key more recognizable and understandable. This parameter should be 1 to 60 letters, digits, `-`, and `_`; it must begin with a letter or digit and cannot be left empty.
|
|
911
|
+
:rtype: str
|
|
912
|
+
"""
|
|
789
913
|
return self._Alias
|
|
790
914
|
|
|
791
915
|
@Alias.setter
|
|
@@ -794,6 +918,9 @@ class CreateWhiteBoxKeyRequest(AbstractModel):
|
|
|
794
918
|
|
|
795
919
|
@property
|
|
796
920
|
def Algorithm(self):
|
|
921
|
+
"""All algorithm types for creating keys. Valid values: AES_256, SM4
|
|
922
|
+
:rtype: str
|
|
923
|
+
"""
|
|
797
924
|
return self._Algorithm
|
|
798
925
|
|
|
799
926
|
@Algorithm.setter
|
|
@@ -802,6 +929,9 @@ class CreateWhiteBoxKeyRequest(AbstractModel):
|
|
|
802
929
|
|
|
803
930
|
@property
|
|
804
931
|
def Description(self):
|
|
932
|
+
"""Key description of up to 1024 bytes
|
|
933
|
+
:rtype: str
|
|
934
|
+
"""
|
|
805
935
|
return self._Description
|
|
806
936
|
|
|
807
937
|
@Description.setter
|
|
@@ -810,6 +940,9 @@ class CreateWhiteBoxKeyRequest(AbstractModel):
|
|
|
810
940
|
|
|
811
941
|
@property
|
|
812
942
|
def Tags(self):
|
|
943
|
+
"""Tag list
|
|
944
|
+
:rtype: list of Tag
|
|
945
|
+
"""
|
|
813
946
|
return self._Tags
|
|
814
947
|
|
|
815
948
|
@Tags.setter
|
|
@@ -866,6 +999,9 @@ class CreateWhiteBoxKeyResponse(AbstractModel):
|
|
|
866
999
|
|
|
867
1000
|
@property
|
|
868
1001
|
def EncryptKey(self):
|
|
1002
|
+
"""Base64-encoded encryption key
|
|
1003
|
+
:rtype: str
|
|
1004
|
+
"""
|
|
869
1005
|
return self._EncryptKey
|
|
870
1006
|
|
|
871
1007
|
@EncryptKey.setter
|
|
@@ -874,6 +1010,9 @@ class CreateWhiteBoxKeyResponse(AbstractModel):
|
|
|
874
1010
|
|
|
875
1011
|
@property
|
|
876
1012
|
def DecryptKey(self):
|
|
1013
|
+
"""Base64-encoded decryption key
|
|
1014
|
+
:rtype: str
|
|
1015
|
+
"""
|
|
877
1016
|
return self._DecryptKey
|
|
878
1017
|
|
|
879
1018
|
@DecryptKey.setter
|
|
@@ -882,6 +1021,9 @@ class CreateWhiteBoxKeyResponse(AbstractModel):
|
|
|
882
1021
|
|
|
883
1022
|
@property
|
|
884
1023
|
def KeyId(self):
|
|
1024
|
+
"""Globally unique white-box key ID
|
|
1025
|
+
:rtype: str
|
|
1026
|
+
"""
|
|
885
1027
|
return self._KeyId
|
|
886
1028
|
|
|
887
1029
|
@KeyId.setter
|
|
@@ -890,6 +1032,9 @@ class CreateWhiteBoxKeyResponse(AbstractModel):
|
|
|
890
1032
|
|
|
891
1033
|
@property
|
|
892
1034
|
def TagCode(self):
|
|
1035
|
+
"""Tag operation return code. 0: success; 1: internal error; 2: business processing error
|
|
1036
|
+
:rtype: int
|
|
1037
|
+
"""
|
|
893
1038
|
return self._TagCode
|
|
894
1039
|
|
|
895
1040
|
@TagCode.setter
|
|
@@ -898,6 +1043,9 @@ class CreateWhiteBoxKeyResponse(AbstractModel):
|
|
|
898
1043
|
|
|
899
1044
|
@property
|
|
900
1045
|
def TagMsg(self):
|
|
1046
|
+
"""Tag operation return message
|
|
1047
|
+
:rtype: str
|
|
1048
|
+
"""
|
|
901
1049
|
return self._TagMsg
|
|
902
1050
|
|
|
903
1051
|
@TagMsg.setter
|
|
@@ -906,6 +1054,9 @@ class CreateWhiteBoxKeyResponse(AbstractModel):
|
|
|
906
1054
|
|
|
907
1055
|
@property
|
|
908
1056
|
def RequestId(self):
|
|
1057
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1058
|
+
:rtype: str
|
|
1059
|
+
"""
|
|
909
1060
|
return self._RequestId
|
|
910
1061
|
|
|
911
1062
|
@RequestId.setter
|
|
@@ -945,6 +1096,9 @@ class DecryptRequest(AbstractModel):
|
|
|
945
1096
|
|
|
946
1097
|
@property
|
|
947
1098
|
def CiphertextBlob(self):
|
|
1099
|
+
"""The ciphertext data to be decrypted.
|
|
1100
|
+
:rtype: str
|
|
1101
|
+
"""
|
|
948
1102
|
return self._CiphertextBlob
|
|
949
1103
|
|
|
950
1104
|
@CiphertextBlob.setter
|
|
@@ -953,6 +1107,9 @@ class DecryptRequest(AbstractModel):
|
|
|
953
1107
|
|
|
954
1108
|
@property
|
|
955
1109
|
def EncryptionContext(self):
|
|
1110
|
+
"""JSON string of key-value pair. If this parameter is specified for `Encrypt`, the same parameter needs to be provided when the `Decrypt` API is called. The maximum length is 1,024 bytes.
|
|
1111
|
+
:rtype: str
|
|
1112
|
+
"""
|
|
956
1113
|
return self._EncryptionContext
|
|
957
1114
|
|
|
958
1115
|
@EncryptionContext.setter
|
|
@@ -961,6 +1118,9 @@ class DecryptRequest(AbstractModel):
|
|
|
961
1118
|
|
|
962
1119
|
@property
|
|
963
1120
|
def EncryptionPublicKey(self):
|
|
1121
|
+
"""PEM-encoded public key (2048-bit RSA/SM2 key), which can be used to encrypt the `Plaintext` returned. If this field is left empty, the `Plaintext` will not be encrypted.
|
|
1122
|
+
:rtype: str
|
|
1123
|
+
"""
|
|
964
1124
|
return self._EncryptionPublicKey
|
|
965
1125
|
|
|
966
1126
|
@EncryptionPublicKey.setter
|
|
@@ -969,6 +1129,9 @@ class DecryptRequest(AbstractModel):
|
|
|
969
1129
|
|
|
970
1130
|
@property
|
|
971
1131
|
def EncryptionAlgorithm(self):
|
|
1132
|
+
"""Asymmetric encryption algorithm. Valid values: `SM2` (C1C3C2 ciphertext is returned), `SM2_C1C3C2_ASN1` (C1C3C2 ASN1 ciphertext is returned), `RSAES_PKCS1_V1_5`, `RSAES_OAEP_SHA_1`, and `RSAES_OAEP_SHA_256`. This field is used in combination with `EncryptionPublicKey` for encryption. If it is left empty, an SM2 public key will be used by default.
|
|
1133
|
+
:rtype: str
|
|
1134
|
+
"""
|
|
972
1135
|
return self._EncryptionAlgorithm
|
|
973
1136
|
|
|
974
1137
|
@EncryptionAlgorithm.setter
|
|
@@ -1012,6 +1175,9 @@ If `EncryptionPublicKey` is specified, this field will return the Base64-encoded
|
|
|
1012
1175
|
|
|
1013
1176
|
@property
|
|
1014
1177
|
def KeyId(self):
|
|
1178
|
+
"""Globally unique CMK ID
|
|
1179
|
+
:rtype: str
|
|
1180
|
+
"""
|
|
1015
1181
|
return self._KeyId
|
|
1016
1182
|
|
|
1017
1183
|
@KeyId.setter
|
|
@@ -1020,6 +1186,10 @@ If `EncryptionPublicKey` is specified, this field will return the Base64-encoded
|
|
|
1020
1186
|
|
|
1021
1187
|
@property
|
|
1022
1188
|
def Plaintext(self):
|
|
1189
|
+
"""If `EncryptionPublicKey` is left empty, a Base64-encoded ciphertext will be returned. To get the plaintext, you need to decode the ciphertext first.
|
|
1190
|
+
If `EncryptionPublicKey` is specified, this field will return the Base64-encoded ciphertext encrypted with the specified public key. To get the plaintext, you need to decode the ciphertext and upload the corresponding private key.
|
|
1191
|
+
:rtype: str
|
|
1192
|
+
"""
|
|
1023
1193
|
return self._Plaintext
|
|
1024
1194
|
|
|
1025
1195
|
@Plaintext.setter
|
|
@@ -1028,6 +1198,9 @@ If `EncryptionPublicKey` is specified, this field will return the Base64-encoded
|
|
|
1028
1198
|
|
|
1029
1199
|
@property
|
|
1030
1200
|
def RequestId(self):
|
|
1201
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1202
|
+
:rtype: str
|
|
1203
|
+
"""
|
|
1031
1204
|
return self._RequestId
|
|
1032
1205
|
|
|
1033
1206
|
@RequestId.setter
|
|
@@ -1055,6 +1228,9 @@ class DeleteImportedKeyMaterialRequest(AbstractModel):
|
|
|
1055
1228
|
|
|
1056
1229
|
@property
|
|
1057
1230
|
def KeyId(self):
|
|
1231
|
+
"""Specifies the EXTERNAL CMK for which to delete the key material.
|
|
1232
|
+
:rtype: str
|
|
1233
|
+
"""
|
|
1058
1234
|
return self._KeyId
|
|
1059
1235
|
|
|
1060
1236
|
@KeyId.setter
|
|
@@ -1088,6 +1264,9 @@ class DeleteImportedKeyMaterialResponse(AbstractModel):
|
|
|
1088
1264
|
|
|
1089
1265
|
@property
|
|
1090
1266
|
def RequestId(self):
|
|
1267
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1268
|
+
:rtype: str
|
|
1269
|
+
"""
|
|
1091
1270
|
return self._RequestId
|
|
1092
1271
|
|
|
1093
1272
|
@RequestId.setter
|
|
@@ -1113,6 +1292,9 @@ class DeleteWhiteBoxKeyRequest(AbstractModel):
|
|
|
1113
1292
|
|
|
1114
1293
|
@property
|
|
1115
1294
|
def KeyId(self):
|
|
1295
|
+
"""Globally unique white-box key ID
|
|
1296
|
+
:rtype: str
|
|
1297
|
+
"""
|
|
1116
1298
|
return self._KeyId
|
|
1117
1299
|
|
|
1118
1300
|
@KeyId.setter
|
|
@@ -1146,6 +1328,9 @@ class DeleteWhiteBoxKeyResponse(AbstractModel):
|
|
|
1146
1328
|
|
|
1147
1329
|
@property
|
|
1148
1330
|
def RequestId(self):
|
|
1331
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1332
|
+
:rtype: str
|
|
1333
|
+
"""
|
|
1149
1334
|
return self._RequestId
|
|
1150
1335
|
|
|
1151
1336
|
@RequestId.setter
|
|
@@ -1171,6 +1356,9 @@ class DescribeKeyRequest(AbstractModel):
|
|
|
1171
1356
|
|
|
1172
1357
|
@property
|
|
1173
1358
|
def KeyId(self):
|
|
1359
|
+
"""Globally unique CMK ID
|
|
1360
|
+
:rtype: str
|
|
1361
|
+
"""
|
|
1174
1362
|
return self._KeyId
|
|
1175
1363
|
|
|
1176
1364
|
@KeyId.setter
|
|
@@ -1208,6 +1396,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
1208
1396
|
|
|
1209
1397
|
@property
|
|
1210
1398
|
def KeyMetadata(self):
|
|
1399
|
+
"""Key attribute information
|
|
1400
|
+
Note: this field may return null, indicating that no valid values can be obtained.
|
|
1401
|
+
:rtype: :class:`tencentcloud.kms.v20190118.models.KeyMetadata`
|
|
1402
|
+
"""
|
|
1211
1403
|
return self._KeyMetadata
|
|
1212
1404
|
|
|
1213
1405
|
@KeyMetadata.setter
|
|
@@ -1216,6 +1408,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
1216
1408
|
|
|
1217
1409
|
@property
|
|
1218
1410
|
def RequestId(self):
|
|
1411
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1412
|
+
:rtype: str
|
|
1413
|
+
"""
|
|
1219
1414
|
return self._RequestId
|
|
1220
1415
|
|
|
1221
1416
|
@RequestId.setter
|
|
@@ -1244,6 +1439,9 @@ class DescribeKeysRequest(AbstractModel):
|
|
|
1244
1439
|
|
|
1245
1440
|
@property
|
|
1246
1441
|
def KeyIds(self):
|
|
1442
|
+
"""List of IDs of the CMKs to be queried in batches. Up to 100 `KeyId` values are supported in one query.
|
|
1443
|
+
:rtype: list of str
|
|
1444
|
+
"""
|
|
1247
1445
|
return self._KeyIds
|
|
1248
1446
|
|
|
1249
1447
|
@KeyIds.setter
|
|
@@ -1281,6 +1479,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
1281
1479
|
|
|
1282
1480
|
@property
|
|
1283
1481
|
def KeyMetadatas(self):
|
|
1482
|
+
"""List of returned attribute information
|
|
1483
|
+
Note: this field may return null, indicating that no valid values can be obtained.
|
|
1484
|
+
:rtype: list of KeyMetadata
|
|
1485
|
+
"""
|
|
1284
1486
|
return self._KeyMetadatas
|
|
1285
1487
|
|
|
1286
1488
|
@KeyMetadatas.setter
|
|
@@ -1289,6 +1491,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
1289
1491
|
|
|
1290
1492
|
@property
|
|
1291
1493
|
def RequestId(self):
|
|
1494
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1495
|
+
:rtype: str
|
|
1496
|
+
"""
|
|
1292
1497
|
return self._RequestId
|
|
1293
1498
|
|
|
1294
1499
|
@RequestId.setter
|
|
@@ -1320,6 +1525,9 @@ class DescribeWhiteBoxDecryptKeyRequest(AbstractModel):
|
|
|
1320
1525
|
|
|
1321
1526
|
@property
|
|
1322
1527
|
def KeyId(self):
|
|
1528
|
+
"""Globally unique white-box key ID
|
|
1529
|
+
:rtype: str
|
|
1530
|
+
"""
|
|
1323
1531
|
return self._KeyId
|
|
1324
1532
|
|
|
1325
1533
|
@KeyId.setter
|
|
@@ -1356,6 +1564,9 @@ class DescribeWhiteBoxDecryptKeyResponse(AbstractModel):
|
|
|
1356
1564
|
|
|
1357
1565
|
@property
|
|
1358
1566
|
def DecryptKey(self):
|
|
1567
|
+
"""Base64-encoded white-box decryption key
|
|
1568
|
+
:rtype: str
|
|
1569
|
+
"""
|
|
1359
1570
|
return self._DecryptKey
|
|
1360
1571
|
|
|
1361
1572
|
@DecryptKey.setter
|
|
@@ -1364,6 +1575,9 @@ class DescribeWhiteBoxDecryptKeyResponse(AbstractModel):
|
|
|
1364
1575
|
|
|
1365
1576
|
@property
|
|
1366
1577
|
def RequestId(self):
|
|
1578
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1579
|
+
:rtype: str
|
|
1580
|
+
"""
|
|
1367
1581
|
return self._RequestId
|
|
1368
1582
|
|
|
1369
1583
|
@RequestId.setter
|
|
@@ -1390,6 +1604,9 @@ class DescribeWhiteBoxDeviceFingerprintsRequest(AbstractModel):
|
|
|
1390
1604
|
|
|
1391
1605
|
@property
|
|
1392
1606
|
def KeyId(self):
|
|
1607
|
+
"""White-box key ID
|
|
1608
|
+
:rtype: str
|
|
1609
|
+
"""
|
|
1393
1610
|
return self._KeyId
|
|
1394
1611
|
|
|
1395
1612
|
@KeyId.setter
|
|
@@ -1426,6 +1643,9 @@ class DescribeWhiteBoxDeviceFingerprintsResponse(AbstractModel):
|
|
|
1426
1643
|
|
|
1427
1644
|
@property
|
|
1428
1645
|
def DeviceFingerprints(self):
|
|
1646
|
+
"""Device fingerprint list
|
|
1647
|
+
:rtype: list of DeviceFingerprint
|
|
1648
|
+
"""
|
|
1429
1649
|
return self._DeviceFingerprints
|
|
1430
1650
|
|
|
1431
1651
|
@DeviceFingerprints.setter
|
|
@@ -1434,6 +1654,9 @@ class DescribeWhiteBoxDeviceFingerprintsResponse(AbstractModel):
|
|
|
1434
1654
|
|
|
1435
1655
|
@property
|
|
1436
1656
|
def RequestId(self):
|
|
1657
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1658
|
+
:rtype: str
|
|
1659
|
+
"""
|
|
1437
1660
|
return self._RequestId
|
|
1438
1661
|
|
|
1439
1662
|
@RequestId.setter
|
|
@@ -1474,6 +1697,9 @@ class DescribeWhiteBoxKeyDetailsRequest(AbstractModel):
|
|
|
1474
1697
|
|
|
1475
1698
|
@property
|
|
1476
1699
|
def KeyStatus(self):
|
|
1700
|
+
"""Filter: key status. 0: disabled, 1: enabled
|
|
1701
|
+
:rtype: int
|
|
1702
|
+
"""
|
|
1477
1703
|
return self._KeyStatus
|
|
1478
1704
|
|
|
1479
1705
|
@KeyStatus.setter
|
|
@@ -1482,6 +1708,9 @@ class DescribeWhiteBoxKeyDetailsRequest(AbstractModel):
|
|
|
1482
1708
|
|
|
1483
1709
|
@property
|
|
1484
1710
|
def Offset(self):
|
|
1711
|
+
"""This parameter has the same meaning of the `Offset` in an SQL query, indicating that this acquisition starts from the "No. Offset value" element of the array arranged in a certain order. The default value is 0.
|
|
1712
|
+
:rtype: int
|
|
1713
|
+
"""
|
|
1485
1714
|
return self._Offset
|
|
1486
1715
|
|
|
1487
1716
|
@Offset.setter
|
|
@@ -1490,6 +1719,9 @@ class DescribeWhiteBoxKeyDetailsRequest(AbstractModel):
|
|
|
1490
1719
|
|
|
1491
1720
|
@property
|
|
1492
1721
|
def Limit(self):
|
|
1722
|
+
"""This parameter has the same meaning of the `Limit` in an SQL query, indicating that up to `Limit` value elements can be obtained in this request. The default value is 0, indicating not to paginate.
|
|
1723
|
+
:rtype: int
|
|
1724
|
+
"""
|
|
1493
1725
|
return self._Limit
|
|
1494
1726
|
|
|
1495
1727
|
@Limit.setter
|
|
@@ -1498,6 +1730,9 @@ class DescribeWhiteBoxKeyDetailsRequest(AbstractModel):
|
|
|
1498
1730
|
|
|
1499
1731
|
@property
|
|
1500
1732
|
def TagFilters(self):
|
|
1733
|
+
"""Tag filter condition
|
|
1734
|
+
:rtype: list of TagFilter
|
|
1735
|
+
"""
|
|
1501
1736
|
return self._TagFilters
|
|
1502
1737
|
|
|
1503
1738
|
@TagFilters.setter
|
|
@@ -1546,6 +1781,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
1546
1781
|
|
|
1547
1782
|
@property
|
|
1548
1783
|
def KeyInfos(self):
|
|
1784
|
+
"""White-box key information list
|
|
1785
|
+
:rtype: list of WhiteboxKeyInfo
|
|
1786
|
+
"""
|
|
1549
1787
|
return self._KeyInfos
|
|
1550
1788
|
|
|
1551
1789
|
@KeyInfos.setter
|
|
@@ -1554,6 +1792,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
1554
1792
|
|
|
1555
1793
|
@property
|
|
1556
1794
|
def TotalCount(self):
|
|
1795
|
+
"""Total white-box keys.
|
|
1796
|
+
Note: This field may return null, indicating that no valid values can be obtained.
|
|
1797
|
+
:rtype: int
|
|
1798
|
+
"""
|
|
1557
1799
|
return self._TotalCount
|
|
1558
1800
|
|
|
1559
1801
|
@TotalCount.setter
|
|
@@ -1562,6 +1804,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
1562
1804
|
|
|
1563
1805
|
@property
|
|
1564
1806
|
def RequestId(self):
|
|
1807
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1808
|
+
:rtype: str
|
|
1809
|
+
"""
|
|
1565
1810
|
return self._RequestId
|
|
1566
1811
|
|
|
1567
1812
|
@RequestId.setter
|
|
@@ -1594,6 +1839,9 @@ class DescribeWhiteBoxKeyRequest(AbstractModel):
|
|
|
1594
1839
|
|
|
1595
1840
|
@property
|
|
1596
1841
|
def KeyId(self):
|
|
1842
|
+
"""Globally unique white-box key ID
|
|
1843
|
+
:rtype: str
|
|
1844
|
+
"""
|
|
1597
1845
|
return self._KeyId
|
|
1598
1846
|
|
|
1599
1847
|
@KeyId.setter
|
|
@@ -1630,6 +1878,9 @@ class DescribeWhiteBoxKeyResponse(AbstractModel):
|
|
|
1630
1878
|
|
|
1631
1879
|
@property
|
|
1632
1880
|
def KeyInfo(self):
|
|
1881
|
+
"""White-box key information
|
|
1882
|
+
:rtype: :class:`tencentcloud.kms.v20190118.models.WhiteboxKeyInfo`
|
|
1883
|
+
"""
|
|
1633
1884
|
return self._KeyInfo
|
|
1634
1885
|
|
|
1635
1886
|
@KeyInfo.setter
|
|
@@ -1638,6 +1889,9 @@ class DescribeWhiteBoxKeyResponse(AbstractModel):
|
|
|
1638
1889
|
|
|
1639
1890
|
@property
|
|
1640
1891
|
def RequestId(self):
|
|
1892
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1893
|
+
:rtype: str
|
|
1894
|
+
"""
|
|
1641
1895
|
return self._RequestId
|
|
1642
1896
|
|
|
1643
1897
|
@RequestId.setter
|
|
@@ -1675,6 +1929,9 @@ class DescribeWhiteBoxServiceStatusResponse(AbstractModel):
|
|
|
1675
1929
|
|
|
1676
1930
|
@property
|
|
1677
1931
|
def ServiceEnabled(self):
|
|
1932
|
+
"""Whether the user's white-box key service is available
|
|
1933
|
+
:rtype: bool
|
|
1934
|
+
"""
|
|
1678
1935
|
return self._ServiceEnabled
|
|
1679
1936
|
|
|
1680
1937
|
@ServiceEnabled.setter
|
|
@@ -1683,6 +1940,9 @@ class DescribeWhiteBoxServiceStatusResponse(AbstractModel):
|
|
|
1683
1940
|
|
|
1684
1941
|
@property
|
|
1685
1942
|
def RequestId(self):
|
|
1943
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
1944
|
+
:rtype: str
|
|
1945
|
+
"""
|
|
1686
1946
|
return self._RequestId
|
|
1687
1947
|
|
|
1688
1948
|
@RequestId.setter
|
|
@@ -1713,6 +1973,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
1713
1973
|
|
|
1714
1974
|
@property
|
|
1715
1975
|
def Identity(self):
|
|
1976
|
+
"""Fingerprint information collected by device fingerprint collector. Its format must be in the following regular expression: ^[0-9a-f]{8}[\-][0-9a-f]{14}[\-][0-9a-f]{14}[\-][0-9a-f]{14}[\-][0-9a-f]{16}$
|
|
1977
|
+
:rtype: str
|
|
1978
|
+
"""
|
|
1716
1979
|
return self._Identity
|
|
1717
1980
|
|
|
1718
1981
|
@Identity.setter
|
|
@@ -1721,6 +1984,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
1721
1984
|
|
|
1722
1985
|
@property
|
|
1723
1986
|
def Description(self):
|
|
1987
|
+
"""Description, such as IP and device name. Length limit: 1,024 bytes
|
|
1988
|
+
Note: this field may return null, indicating that no valid values can be obtained.
|
|
1989
|
+
:rtype: str
|
|
1990
|
+
"""
|
|
1724
1991
|
return self._Description
|
|
1725
1992
|
|
|
1726
1993
|
@Description.setter
|
|
@@ -1755,6 +2022,9 @@ class DisableKeyRequest(AbstractModel):
|
|
|
1755
2022
|
|
|
1756
2023
|
@property
|
|
1757
2024
|
def KeyId(self):
|
|
2025
|
+
"""Unique CMK ID
|
|
2026
|
+
:rtype: str
|
|
2027
|
+
"""
|
|
1758
2028
|
return self._KeyId
|
|
1759
2029
|
|
|
1760
2030
|
@KeyId.setter
|
|
@@ -1788,6 +2058,9 @@ class DisableKeyResponse(AbstractModel):
|
|
|
1788
2058
|
|
|
1789
2059
|
@property
|
|
1790
2060
|
def RequestId(self):
|
|
2061
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2062
|
+
:rtype: str
|
|
2063
|
+
"""
|
|
1791
2064
|
return self._RequestId
|
|
1792
2065
|
|
|
1793
2066
|
@RequestId.setter
|
|
@@ -1813,6 +2086,9 @@ class DisableKeyRotationRequest(AbstractModel):
|
|
|
1813
2086
|
|
|
1814
2087
|
@property
|
|
1815
2088
|
def KeyId(self):
|
|
2089
|
+
"""Unique CMK ID
|
|
2090
|
+
:rtype: str
|
|
2091
|
+
"""
|
|
1816
2092
|
return self._KeyId
|
|
1817
2093
|
|
|
1818
2094
|
@KeyId.setter
|
|
@@ -1846,6 +2122,9 @@ class DisableKeyRotationResponse(AbstractModel):
|
|
|
1846
2122
|
|
|
1847
2123
|
@property
|
|
1848
2124
|
def RequestId(self):
|
|
2125
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2126
|
+
:rtype: str
|
|
2127
|
+
"""
|
|
1849
2128
|
return self._RequestId
|
|
1850
2129
|
|
|
1851
2130
|
@RequestId.setter
|
|
@@ -1871,6 +2150,9 @@ class DisableKeysRequest(AbstractModel):
|
|
|
1871
2150
|
|
|
1872
2151
|
@property
|
|
1873
2152
|
def KeyIds(self):
|
|
2153
|
+
"""List of IDs of the CMKs to be disabled in batches. Up to 100 CMKs are supported at a time
|
|
2154
|
+
:rtype: list of str
|
|
2155
|
+
"""
|
|
1874
2156
|
return self._KeyIds
|
|
1875
2157
|
|
|
1876
2158
|
@KeyIds.setter
|
|
@@ -1904,6 +2186,9 @@ class DisableKeysResponse(AbstractModel):
|
|
|
1904
2186
|
|
|
1905
2187
|
@property
|
|
1906
2188
|
def RequestId(self):
|
|
2189
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2190
|
+
:rtype: str
|
|
2191
|
+
"""
|
|
1907
2192
|
return self._RequestId
|
|
1908
2193
|
|
|
1909
2194
|
@RequestId.setter
|
|
@@ -1929,6 +2214,9 @@ class DisableWhiteBoxKeyRequest(AbstractModel):
|
|
|
1929
2214
|
|
|
1930
2215
|
@property
|
|
1931
2216
|
def KeyId(self):
|
|
2217
|
+
"""Globally unique white-box key ID
|
|
2218
|
+
:rtype: str
|
|
2219
|
+
"""
|
|
1932
2220
|
return self._KeyId
|
|
1933
2221
|
|
|
1934
2222
|
@KeyId.setter
|
|
@@ -1962,6 +2250,9 @@ class DisableWhiteBoxKeyResponse(AbstractModel):
|
|
|
1962
2250
|
|
|
1963
2251
|
@property
|
|
1964
2252
|
def RequestId(self):
|
|
2253
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2254
|
+
:rtype: str
|
|
2255
|
+
"""
|
|
1965
2256
|
return self._RequestId
|
|
1966
2257
|
|
|
1967
2258
|
@RequestId.setter
|
|
@@ -1987,6 +2278,9 @@ class DisableWhiteBoxKeysRequest(AbstractModel):
|
|
|
1987
2278
|
|
|
1988
2279
|
@property
|
|
1989
2280
|
def KeyIds(self):
|
|
2281
|
+
"""List of globally unique white-box key IDs. Note: you should make sure that all provided `KeyId` values are in valid format, unique, and actually exist. Up to 50 ones are allowed.
|
|
2282
|
+
:rtype: list of str
|
|
2283
|
+
"""
|
|
1990
2284
|
return self._KeyIds
|
|
1991
2285
|
|
|
1992
2286
|
@KeyIds.setter
|
|
@@ -2020,6 +2314,9 @@ class DisableWhiteBoxKeysResponse(AbstractModel):
|
|
|
2020
2314
|
|
|
2021
2315
|
@property
|
|
2022
2316
|
def RequestId(self):
|
|
2317
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2318
|
+
:rtype: str
|
|
2319
|
+
"""
|
|
2023
2320
|
return self._RequestId
|
|
2024
2321
|
|
|
2025
2322
|
@RequestId.setter
|
|
@@ -2045,6 +2342,9 @@ class EnableKeyRequest(AbstractModel):
|
|
|
2045
2342
|
|
|
2046
2343
|
@property
|
|
2047
2344
|
def KeyId(self):
|
|
2345
|
+
"""Unique CMK ID
|
|
2346
|
+
:rtype: str
|
|
2347
|
+
"""
|
|
2048
2348
|
return self._KeyId
|
|
2049
2349
|
|
|
2050
2350
|
@KeyId.setter
|
|
@@ -2078,6 +2378,9 @@ class EnableKeyResponse(AbstractModel):
|
|
|
2078
2378
|
|
|
2079
2379
|
@property
|
|
2080
2380
|
def RequestId(self):
|
|
2381
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2382
|
+
:rtype: str
|
|
2383
|
+
"""
|
|
2081
2384
|
return self._RequestId
|
|
2082
2385
|
|
|
2083
2386
|
@RequestId.setter
|
|
@@ -2106,6 +2409,9 @@ class EnableKeyRotationRequest(AbstractModel):
|
|
|
2106
2409
|
|
|
2107
2410
|
@property
|
|
2108
2411
|
def KeyId(self):
|
|
2412
|
+
"""Unique CMK ID
|
|
2413
|
+
:rtype: str
|
|
2414
|
+
"""
|
|
2109
2415
|
return self._KeyId
|
|
2110
2416
|
|
|
2111
2417
|
@KeyId.setter
|
|
@@ -2114,6 +2420,9 @@ class EnableKeyRotationRequest(AbstractModel):
|
|
|
2114
2420
|
|
|
2115
2421
|
@property
|
|
2116
2422
|
def RotateDays(self):
|
|
2423
|
+
"""The interval between each key rotation in days. Value range: 7 - 365 (default).
|
|
2424
|
+
:rtype: int
|
|
2425
|
+
"""
|
|
2117
2426
|
return self._RotateDays
|
|
2118
2427
|
|
|
2119
2428
|
@RotateDays.setter
|
|
@@ -2148,6 +2457,9 @@ class EnableKeyRotationResponse(AbstractModel):
|
|
|
2148
2457
|
|
|
2149
2458
|
@property
|
|
2150
2459
|
def RequestId(self):
|
|
2460
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2461
|
+
:rtype: str
|
|
2462
|
+
"""
|
|
2151
2463
|
return self._RequestId
|
|
2152
2464
|
|
|
2153
2465
|
@RequestId.setter
|
|
@@ -2173,6 +2485,9 @@ class EnableKeysRequest(AbstractModel):
|
|
|
2173
2485
|
|
|
2174
2486
|
@property
|
|
2175
2487
|
def KeyIds(self):
|
|
2488
|
+
"""List of IDs of the CMKs to be enabled in batches. Up to 100 CMKs are supported at a time
|
|
2489
|
+
:rtype: list of str
|
|
2490
|
+
"""
|
|
2176
2491
|
return self._KeyIds
|
|
2177
2492
|
|
|
2178
2493
|
@KeyIds.setter
|
|
@@ -2206,6 +2521,9 @@ class EnableKeysResponse(AbstractModel):
|
|
|
2206
2521
|
|
|
2207
2522
|
@property
|
|
2208
2523
|
def RequestId(self):
|
|
2524
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2525
|
+
:rtype: str
|
|
2526
|
+
"""
|
|
2209
2527
|
return self._RequestId
|
|
2210
2528
|
|
|
2211
2529
|
@RequestId.setter
|
|
@@ -2231,6 +2549,9 @@ class EnableWhiteBoxKeyRequest(AbstractModel):
|
|
|
2231
2549
|
|
|
2232
2550
|
@property
|
|
2233
2551
|
def KeyId(self):
|
|
2552
|
+
"""Globally unique white-box key ID
|
|
2553
|
+
:rtype: str
|
|
2554
|
+
"""
|
|
2234
2555
|
return self._KeyId
|
|
2235
2556
|
|
|
2236
2557
|
@KeyId.setter
|
|
@@ -2264,6 +2585,9 @@ class EnableWhiteBoxKeyResponse(AbstractModel):
|
|
|
2264
2585
|
|
|
2265
2586
|
@property
|
|
2266
2587
|
def RequestId(self):
|
|
2588
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2589
|
+
:rtype: str
|
|
2590
|
+
"""
|
|
2267
2591
|
return self._RequestId
|
|
2268
2592
|
|
|
2269
2593
|
@RequestId.setter
|
|
@@ -2289,6 +2613,9 @@ class EnableWhiteBoxKeysRequest(AbstractModel):
|
|
|
2289
2613
|
|
|
2290
2614
|
@property
|
|
2291
2615
|
def KeyIds(self):
|
|
2616
|
+
"""List of globally unique white-box key IDs. Note: you should make sure that all provided `KeyId` values are in valid format, unique, and actually exist. Up to 50 ones are allowed.
|
|
2617
|
+
:rtype: list of str
|
|
2618
|
+
"""
|
|
2292
2619
|
return self._KeyIds
|
|
2293
2620
|
|
|
2294
2621
|
@KeyIds.setter
|
|
@@ -2322,6 +2649,9 @@ class EnableWhiteBoxKeysResponse(AbstractModel):
|
|
|
2322
2649
|
|
|
2323
2650
|
@property
|
|
2324
2651
|
def RequestId(self):
|
|
2652
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2653
|
+
:rtype: str
|
|
2654
|
+
"""
|
|
2325
2655
|
return self._RequestId
|
|
2326
2656
|
|
|
2327
2657
|
@RequestId.setter
|
|
@@ -2353,6 +2683,9 @@ class EncryptByWhiteBoxRequest(AbstractModel):
|
|
|
2353
2683
|
|
|
2354
2684
|
@property
|
|
2355
2685
|
def KeyId(self):
|
|
2686
|
+
"""Globally unique white-box key ID
|
|
2687
|
+
:rtype: str
|
|
2688
|
+
"""
|
|
2356
2689
|
return self._KeyId
|
|
2357
2690
|
|
|
2358
2691
|
@KeyId.setter
|
|
@@ -2361,6 +2694,9 @@ class EncryptByWhiteBoxRequest(AbstractModel):
|
|
|
2361
2694
|
|
|
2362
2695
|
@property
|
|
2363
2696
|
def PlainText(self):
|
|
2697
|
+
"""Base64-encoded text to be encrypted. The size of the original text cannot exceed 4 KB.
|
|
2698
|
+
:rtype: str
|
|
2699
|
+
"""
|
|
2364
2700
|
return self._PlainText
|
|
2365
2701
|
|
|
2366
2702
|
@PlainText.setter
|
|
@@ -2369,6 +2705,9 @@ class EncryptByWhiteBoxRequest(AbstractModel):
|
|
|
2369
2705
|
|
|
2370
2706
|
@property
|
|
2371
2707
|
def InitializationVector(self):
|
|
2708
|
+
"""Base64-encoded initialization vector of 16 bytes, which will be used by the encryption algorithm. If this parameter is not passed in, the backend service will generate a random one. You should save this value as a parameter for decryption.
|
|
2709
|
+
:rtype: str
|
|
2710
|
+
"""
|
|
2372
2711
|
return self._InitializationVector
|
|
2373
2712
|
|
|
2374
2713
|
@InitializationVector.setter
|
|
@@ -2410,6 +2749,9 @@ class EncryptByWhiteBoxResponse(AbstractModel):
|
|
|
2410
2749
|
|
|
2411
2750
|
@property
|
|
2412
2751
|
def InitializationVector(self):
|
|
2752
|
+
"""Base64-encoded initialization vector, which will be used by the encryption algorithm. If this parameter is passed in by the caller, it will be returned as-is; otherwise, the backend service will generate a random one and return it.
|
|
2753
|
+
:rtype: str
|
|
2754
|
+
"""
|
|
2413
2755
|
return self._InitializationVector
|
|
2414
2756
|
|
|
2415
2757
|
@InitializationVector.setter
|
|
@@ -2418,6 +2760,9 @@ class EncryptByWhiteBoxResponse(AbstractModel):
|
|
|
2418
2760
|
|
|
2419
2761
|
@property
|
|
2420
2762
|
def CipherText(self):
|
|
2763
|
+
"""Base64-encoded ciphertext after encryption
|
|
2764
|
+
:rtype: str
|
|
2765
|
+
"""
|
|
2421
2766
|
return self._CipherText
|
|
2422
2767
|
|
|
2423
2768
|
@CipherText.setter
|
|
@@ -2426,6 +2771,9 @@ class EncryptByWhiteBoxResponse(AbstractModel):
|
|
|
2426
2771
|
|
|
2427
2772
|
@property
|
|
2428
2773
|
def RequestId(self):
|
|
2774
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2775
|
+
:rtype: str
|
|
2776
|
+
"""
|
|
2429
2777
|
return self._RequestId
|
|
2430
2778
|
|
|
2431
2779
|
@RequestId.setter
|
|
@@ -2459,6 +2807,9 @@ class EncryptRequest(AbstractModel):
|
|
|
2459
2807
|
|
|
2460
2808
|
@property
|
|
2461
2809
|
def KeyId(self):
|
|
2810
|
+
"""Globally unique ID of the CMK generated by calling the `CreateKey` API
|
|
2811
|
+
:rtype: str
|
|
2812
|
+
"""
|
|
2462
2813
|
return self._KeyId
|
|
2463
2814
|
|
|
2464
2815
|
@KeyId.setter
|
|
@@ -2467,6 +2818,9 @@ class EncryptRequest(AbstractModel):
|
|
|
2467
2818
|
|
|
2468
2819
|
@property
|
|
2469
2820
|
def Plaintext(self):
|
|
2821
|
+
"""Encrypted plaintext data. This field must be Base64-encoded. The maximum size of the original data is 4 KB
|
|
2822
|
+
:rtype: str
|
|
2823
|
+
"""
|
|
2470
2824
|
return self._Plaintext
|
|
2471
2825
|
|
|
2472
2826
|
@Plaintext.setter
|
|
@@ -2475,6 +2829,9 @@ class EncryptRequest(AbstractModel):
|
|
|
2475
2829
|
|
|
2476
2830
|
@property
|
|
2477
2831
|
def EncryptionContext(self):
|
|
2832
|
+
"""JSON string of key-value pair. If this parameter is specified, the same parameter needs to be provided when the `Decrypt` API is called. It is up to 1,024 characters
|
|
2833
|
+
:rtype: str
|
|
2834
|
+
"""
|
|
2478
2835
|
return self._EncryptionContext
|
|
2479
2836
|
|
|
2480
2837
|
@EncryptionContext.setter
|
|
@@ -2516,6 +2873,9 @@ class EncryptResponse(AbstractModel):
|
|
|
2516
2873
|
|
|
2517
2874
|
@property
|
|
2518
2875
|
def CiphertextBlob(self):
|
|
2876
|
+
"""Base64-encoded ciphertext, which is the encrypted information of the ciphertext and key. To get the plaintext, you need to pass in this field to the Decrypt API.
|
|
2877
|
+
:rtype: str
|
|
2878
|
+
"""
|
|
2519
2879
|
return self._CiphertextBlob
|
|
2520
2880
|
|
|
2521
2881
|
@CiphertextBlob.setter
|
|
@@ -2524,6 +2884,9 @@ class EncryptResponse(AbstractModel):
|
|
|
2524
2884
|
|
|
2525
2885
|
@property
|
|
2526
2886
|
def KeyId(self):
|
|
2887
|
+
"""Globally unique ID of the CMK used for encryption
|
|
2888
|
+
:rtype: str
|
|
2889
|
+
"""
|
|
2527
2890
|
return self._KeyId
|
|
2528
2891
|
|
|
2529
2892
|
@KeyId.setter
|
|
@@ -2532,6 +2895,9 @@ class EncryptResponse(AbstractModel):
|
|
|
2532
2895
|
|
|
2533
2896
|
@property
|
|
2534
2897
|
def RequestId(self):
|
|
2898
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
2899
|
+
:rtype: str
|
|
2900
|
+
"""
|
|
2535
2901
|
return self._RequestId
|
|
2536
2902
|
|
|
2537
2903
|
@RequestId.setter
|
|
@@ -2574,6 +2940,9 @@ class GenerateDataKeyRequest(AbstractModel):
|
|
|
2574
2940
|
|
|
2575
2941
|
@property
|
|
2576
2942
|
def KeyId(self):
|
|
2943
|
+
"""Globally unique CMK ID
|
|
2944
|
+
:rtype: str
|
|
2945
|
+
"""
|
|
2577
2946
|
return self._KeyId
|
|
2578
2947
|
|
|
2579
2948
|
@KeyId.setter
|
|
@@ -2582,6 +2951,9 @@ class GenerateDataKeyRequest(AbstractModel):
|
|
|
2582
2951
|
|
|
2583
2952
|
@property
|
|
2584
2953
|
def KeySpec(self):
|
|
2954
|
+
"""Specifies the encryption algorithm and size of the `DataKey`. Valid values: AES_128, AES_256. Either `KeySpec` or `NumberOfBytes` must be specified.
|
|
2955
|
+
:rtype: str
|
|
2956
|
+
"""
|
|
2585
2957
|
return self._KeySpec
|
|
2586
2958
|
|
|
2587
2959
|
@KeySpec.setter
|
|
@@ -2590,6 +2962,9 @@ class GenerateDataKeyRequest(AbstractModel):
|
|
|
2590
2962
|
|
|
2591
2963
|
@property
|
|
2592
2964
|
def NumberOfBytes(self):
|
|
2965
|
+
"""Length of the `DataKey`. If both `NumberOfBytes` and `KeySpec` are specified, `NumberOfBytes` will prevail. Minimum value: 1; maximum value: 1024. Either `KeySpec` or `NumberOfBytes` must be specified.
|
|
2966
|
+
:rtype: int
|
|
2967
|
+
"""
|
|
2593
2968
|
return self._NumberOfBytes
|
|
2594
2969
|
|
|
2595
2970
|
@NumberOfBytes.setter
|
|
@@ -2598,6 +2973,9 @@ class GenerateDataKeyRequest(AbstractModel):
|
|
|
2598
2973
|
|
|
2599
2974
|
@property
|
|
2600
2975
|
def EncryptionContext(self):
|
|
2976
|
+
"""JSON string of key-value pair. If this field is used, the same string should be entered when the returned `DataKey` is decrypted.
|
|
2977
|
+
:rtype: str
|
|
2978
|
+
"""
|
|
2601
2979
|
return self._EncryptionContext
|
|
2602
2980
|
|
|
2603
2981
|
@EncryptionContext.setter
|
|
@@ -2606,6 +2984,9 @@ class GenerateDataKeyRequest(AbstractModel):
|
|
|
2606
2984
|
|
|
2607
2985
|
@property
|
|
2608
2986
|
def EncryptionPublicKey(self):
|
|
2987
|
+
"""PEM-encoded public key (2048-bit RSA/SM2 key), which can be used to encrypt the `Plaintext` returned. If this field is left empty, the `Plaintext` will not be encrypted.
|
|
2988
|
+
:rtype: str
|
|
2989
|
+
"""
|
|
2609
2990
|
return self._EncryptionPublicKey
|
|
2610
2991
|
|
|
2611
2992
|
@EncryptionPublicKey.setter
|
|
@@ -2614,6 +2995,9 @@ class GenerateDataKeyRequest(AbstractModel):
|
|
|
2614
2995
|
|
|
2615
2996
|
@property
|
|
2616
2997
|
def EncryptionAlgorithm(self):
|
|
2998
|
+
"""Asymmetric encryption algorithm. Valid values: `SM2` (C1C3C2 ciphertext is returned)`, `SM2_C1C3C2_ASN1` (C1C3C2 ASN1 ciphertext is returned), `RSAES_PKCS1_V1_5`, `RSAES_OAEP_SHA_1`, and `RSAES_OAEP_SHA_256`. This field is used in combination with `EncryptionPublicKey` for encryption. If it is left empty, an SM2 public key will be used by default.
|
|
2999
|
+
:rtype: str
|
|
3000
|
+
"""
|
|
2617
3001
|
return self._EncryptionAlgorithm
|
|
2618
3002
|
|
|
2619
3003
|
@EncryptionAlgorithm.setter
|
|
@@ -2662,6 +3046,9 @@ If `EncryptionPublicKey` is specified, this field will return the Base64-encoded
|
|
|
2662
3046
|
|
|
2663
3047
|
@property
|
|
2664
3048
|
def KeyId(self):
|
|
3049
|
+
"""Globally unique CMK ID
|
|
3050
|
+
:rtype: str
|
|
3051
|
+
"""
|
|
2665
3052
|
return self._KeyId
|
|
2666
3053
|
|
|
2667
3054
|
@KeyId.setter
|
|
@@ -2670,6 +3057,10 @@ If `EncryptionPublicKey` is specified, this field will return the Base64-encoded
|
|
|
2670
3057
|
|
|
2671
3058
|
@property
|
|
2672
3059
|
def Plaintext(self):
|
|
3060
|
+
"""If `EncryptionPublicKey` is left empty, a Base64-encoded ciphertext will be returned. To get the plaintext, you need to decode the ciphertext first.
|
|
3061
|
+
If `EncryptionPublicKey` is specified, this field will return the Base64-encoded ciphertext encrypted with the specified public key. To get the plaintext, you need to decode the ciphertext and upload the corresponding private key.
|
|
3062
|
+
:rtype: str
|
|
3063
|
+
"""
|
|
2673
3064
|
return self._Plaintext
|
|
2674
3065
|
|
|
2675
3066
|
@Plaintext.setter
|
|
@@ -2678,6 +3069,9 @@ If `EncryptionPublicKey` is specified, this field will return the Base64-encoded
|
|
|
2678
3069
|
|
|
2679
3070
|
@property
|
|
2680
3071
|
def CiphertextBlob(self):
|
|
3072
|
+
"""Ciphertext of the data key, which should be kept by yourself. KMS does not host user data keys. You can call the `Decrypt` API to get the plaintext of the data key from `CiphertextBlob`.
|
|
3073
|
+
:rtype: str
|
|
3074
|
+
"""
|
|
2681
3075
|
return self._CiphertextBlob
|
|
2682
3076
|
|
|
2683
3077
|
@CiphertextBlob.setter
|
|
@@ -2686,6 +3080,9 @@ If `EncryptionPublicKey` is specified, this field will return the Base64-encoded
|
|
|
2686
3080
|
|
|
2687
3081
|
@property
|
|
2688
3082
|
def RequestId(self):
|
|
3083
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
3084
|
+
:rtype: str
|
|
3085
|
+
"""
|
|
2689
3086
|
return self._RequestId
|
|
2690
3087
|
|
|
2691
3088
|
@RequestId.setter
|
|
@@ -2714,6 +3111,9 @@ class GenerateRandomRequest(AbstractModel):
|
|
|
2714
3111
|
|
|
2715
3112
|
@property
|
|
2716
3113
|
def NumberOfBytes(self):
|
|
3114
|
+
"""Length of the random number. Minimum value: 1. Maximum value: 1024
|
|
3115
|
+
:rtype: int
|
|
3116
|
+
"""
|
|
2717
3117
|
return self._NumberOfBytes
|
|
2718
3118
|
|
|
2719
3119
|
@NumberOfBytes.setter
|
|
@@ -2750,6 +3150,9 @@ class GenerateRandomResponse(AbstractModel):
|
|
|
2750
3150
|
|
|
2751
3151
|
@property
|
|
2752
3152
|
def Plaintext(self):
|
|
3153
|
+
"""Base64-encoded plaintext of the randomly generated number. You need to Base64-decode it to get the plaintext.
|
|
3154
|
+
:rtype: str
|
|
3155
|
+
"""
|
|
2753
3156
|
return self._Plaintext
|
|
2754
3157
|
|
|
2755
3158
|
@Plaintext.setter
|
|
@@ -2758,6 +3161,9 @@ class GenerateRandomResponse(AbstractModel):
|
|
|
2758
3161
|
|
|
2759
3162
|
@property
|
|
2760
3163
|
def RequestId(self):
|
|
3164
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
3165
|
+
:rtype: str
|
|
3166
|
+
"""
|
|
2761
3167
|
return self._RequestId
|
|
2762
3168
|
|
|
2763
3169
|
@RequestId.setter
|
|
@@ -2784,6 +3190,9 @@ class GetKeyRotationStatusRequest(AbstractModel):
|
|
|
2784
3190
|
|
|
2785
3191
|
@property
|
|
2786
3192
|
def KeyId(self):
|
|
3193
|
+
"""Unique CMK ID
|
|
3194
|
+
:rtype: str
|
|
3195
|
+
"""
|
|
2787
3196
|
return self._KeyId
|
|
2788
3197
|
|
|
2789
3198
|
@KeyId.setter
|
|
@@ -2820,6 +3229,9 @@ class GetKeyRotationStatusResponse(AbstractModel):
|
|
|
2820
3229
|
|
|
2821
3230
|
@property
|
|
2822
3231
|
def KeyRotationEnabled(self):
|
|
3232
|
+
"""Whether key rotation is enabled
|
|
3233
|
+
:rtype: bool
|
|
3234
|
+
"""
|
|
2823
3235
|
return self._KeyRotationEnabled
|
|
2824
3236
|
|
|
2825
3237
|
@KeyRotationEnabled.setter
|
|
@@ -2828,6 +3240,9 @@ class GetKeyRotationStatusResponse(AbstractModel):
|
|
|
2828
3240
|
|
|
2829
3241
|
@property
|
|
2830
3242
|
def RequestId(self):
|
|
3243
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
3244
|
+
:rtype: str
|
|
3245
|
+
"""
|
|
2831
3246
|
return self._RequestId
|
|
2832
3247
|
|
|
2833
3248
|
@RequestId.setter
|
|
@@ -2860,6 +3275,9 @@ class GetParametersForImportRequest(AbstractModel):
|
|
|
2860
3275
|
|
|
2861
3276
|
@property
|
|
2862
3277
|
def KeyId(self):
|
|
3278
|
+
"""Unique ID of a CMK. The CMK for which to get the key parameters must be of the `EXTERNAL` type, i.e., Type = 2 when the CMK is created by the `CreateKey` API.
|
|
3279
|
+
:rtype: str
|
|
3280
|
+
"""
|
|
2863
3281
|
return self._KeyId
|
|
2864
3282
|
|
|
2865
3283
|
@KeyId.setter
|
|
@@ -2868,6 +3286,9 @@ class GetParametersForImportRequest(AbstractModel):
|
|
|
2868
3286
|
|
|
2869
3287
|
@property
|
|
2870
3288
|
def WrappingAlgorithm(self):
|
|
3289
|
+
"""Specifies the algorithm for key material encryption. Currently, `RSAES_PKCS1_V1_5`, `RSAES_OAEP_SHA_1`, and `RSAES_OAEP_SHA_256` are supported.
|
|
3290
|
+
:rtype: str
|
|
3291
|
+
"""
|
|
2871
3292
|
return self._WrappingAlgorithm
|
|
2872
3293
|
|
|
2873
3294
|
@WrappingAlgorithm.setter
|
|
@@ -2876,6 +3297,9 @@ class GetParametersForImportRequest(AbstractModel):
|
|
|
2876
3297
|
|
|
2877
3298
|
@property
|
|
2878
3299
|
def WrappingKeySpec(self):
|
|
3300
|
+
"""Specifies the type of wrapping key. Currently, only `RSA_2048` is supported.
|
|
3301
|
+
:rtype: str
|
|
3302
|
+
"""
|
|
2879
3303
|
return self._WrappingKeySpec
|
|
2880
3304
|
|
|
2881
3305
|
@WrappingKeySpec.setter
|
|
@@ -2923,6 +3347,9 @@ class GetParametersForImportResponse(AbstractModel):
|
|
|
2923
3347
|
|
|
2924
3348
|
@property
|
|
2925
3349
|
def KeyId(self):
|
|
3350
|
+
"""Unique ID of a CMK, which is used to specify the CMK into which to import key material.
|
|
3351
|
+
:rtype: str
|
|
3352
|
+
"""
|
|
2926
3353
|
return self._KeyId
|
|
2927
3354
|
|
|
2928
3355
|
@KeyId.setter
|
|
@@ -2931,6 +3358,9 @@ class GetParametersForImportResponse(AbstractModel):
|
|
|
2931
3358
|
|
|
2932
3359
|
@property
|
|
2933
3360
|
def ImportToken(self):
|
|
3361
|
+
"""The token required for importing key material, which is used as a parameter for `ImportKeyMaterial`.
|
|
3362
|
+
:rtype: str
|
|
3363
|
+
"""
|
|
2934
3364
|
return self._ImportToken
|
|
2935
3365
|
|
|
2936
3366
|
@ImportToken.setter
|
|
@@ -2939,6 +3369,9 @@ class GetParametersForImportResponse(AbstractModel):
|
|
|
2939
3369
|
|
|
2940
3370
|
@property
|
|
2941
3371
|
def PublicKey(self):
|
|
3372
|
+
"""The Base64-encoded RSA public key used to encrypt key material before importing it with `ImportKeyMaterial`.
|
|
3373
|
+
:rtype: str
|
|
3374
|
+
"""
|
|
2942
3375
|
return self._PublicKey
|
|
2943
3376
|
|
|
2944
3377
|
@PublicKey.setter
|
|
@@ -2947,6 +3380,9 @@ class GetParametersForImportResponse(AbstractModel):
|
|
|
2947
3380
|
|
|
2948
3381
|
@property
|
|
2949
3382
|
def ParametersValidTo(self):
|
|
3383
|
+
"""Validity period of the token and public key. A token and public key can only be imported when they are valid. If they are expired, you will need to call the `GetParametersForImport` API again to get a new token and public key.
|
|
3384
|
+
:rtype: int
|
|
3385
|
+
"""
|
|
2950
3386
|
return self._ParametersValidTo
|
|
2951
3387
|
|
|
2952
3388
|
@ParametersValidTo.setter
|
|
@@ -2955,6 +3391,9 @@ class GetParametersForImportResponse(AbstractModel):
|
|
|
2955
3391
|
|
|
2956
3392
|
@property
|
|
2957
3393
|
def RequestId(self):
|
|
3394
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
3395
|
+
:rtype: str
|
|
3396
|
+
"""
|
|
2958
3397
|
return self._RequestId
|
|
2959
3398
|
|
|
2960
3399
|
@RequestId.setter
|
|
@@ -2984,6 +3423,9 @@ class GetPublicKeyRequest(AbstractModel):
|
|
|
2984
3423
|
|
|
2985
3424
|
@property
|
|
2986
3425
|
def KeyId(self):
|
|
3426
|
+
"""Unique CMK ID.
|
|
3427
|
+
:rtype: str
|
|
3428
|
+
"""
|
|
2987
3429
|
return self._KeyId
|
|
2988
3430
|
|
|
2989
3431
|
@KeyId.setter
|
|
@@ -3026,6 +3468,9 @@ class GetPublicKeyResponse(AbstractModel):
|
|
|
3026
3468
|
|
|
3027
3469
|
@property
|
|
3028
3470
|
def KeyId(self):
|
|
3471
|
+
"""Unique CMK ID.
|
|
3472
|
+
:rtype: str
|
|
3473
|
+
"""
|
|
3029
3474
|
return self._KeyId
|
|
3030
3475
|
|
|
3031
3476
|
@KeyId.setter
|
|
@@ -3034,6 +3479,9 @@ class GetPublicKeyResponse(AbstractModel):
|
|
|
3034
3479
|
|
|
3035
3480
|
@property
|
|
3036
3481
|
def PublicKey(self):
|
|
3482
|
+
"""Base64-encoded public key content.
|
|
3483
|
+
:rtype: str
|
|
3484
|
+
"""
|
|
3037
3485
|
return self._PublicKey
|
|
3038
3486
|
|
|
3039
3487
|
@PublicKey.setter
|
|
@@ -3042,6 +3490,9 @@ class GetPublicKeyResponse(AbstractModel):
|
|
|
3042
3490
|
|
|
3043
3491
|
@property
|
|
3044
3492
|
def PublicKeyPem(self):
|
|
3493
|
+
"""Public key content in PEM format.
|
|
3494
|
+
:rtype: str
|
|
3495
|
+
"""
|
|
3045
3496
|
return self._PublicKeyPem
|
|
3046
3497
|
|
|
3047
3498
|
@PublicKeyPem.setter
|
|
@@ -3050,6 +3501,9 @@ class GetPublicKeyResponse(AbstractModel):
|
|
|
3050
3501
|
|
|
3051
3502
|
@property
|
|
3052
3503
|
def RequestId(self):
|
|
3504
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
3505
|
+
:rtype: str
|
|
3506
|
+
"""
|
|
3053
3507
|
return self._RequestId
|
|
3054
3508
|
|
|
3055
3509
|
@RequestId.setter
|
|
@@ -3088,6 +3542,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
3088
3542
|
|
|
3089
3543
|
@property
|
|
3090
3544
|
def Regions(self):
|
|
3545
|
+
"""The list of supported regions
|
|
3546
|
+
Note: this field may return null, indicating that no valid values can be obtained.
|
|
3547
|
+
:rtype: list of str
|
|
3548
|
+
"""
|
|
3091
3549
|
return self._Regions
|
|
3092
3550
|
|
|
3093
3551
|
@Regions.setter
|
|
@@ -3096,6 +3554,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
3096
3554
|
|
|
3097
3555
|
@property
|
|
3098
3556
|
def RequestId(self):
|
|
3557
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
3558
|
+
:rtype: str
|
|
3559
|
+
"""
|
|
3099
3560
|
return self._RequestId
|
|
3100
3561
|
|
|
3101
3562
|
@RequestId.setter
|
|
@@ -3161,6 +3622,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
3161
3622
|
|
|
3162
3623
|
@property
|
|
3163
3624
|
def ServiceEnabled(self):
|
|
3625
|
+
"""Whether the KMS service has been activated. true: activated
|
|
3626
|
+
:rtype: bool
|
|
3627
|
+
"""
|
|
3164
3628
|
return self._ServiceEnabled
|
|
3165
3629
|
|
|
3166
3630
|
@ServiceEnabled.setter
|
|
@@ -3169,6 +3633,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
3169
3633
|
|
|
3170
3634
|
@property
|
|
3171
3635
|
def InvalidType(self):
|
|
3636
|
+
"""Service unavailability type. 0: not purchased; 1: normal; 2: suspended due to arrears; 3: resource released
|
|
3637
|
+
:rtype: int
|
|
3638
|
+
"""
|
|
3172
3639
|
return self._InvalidType
|
|
3173
3640
|
|
|
3174
3641
|
@InvalidType.setter
|
|
@@ -3177,6 +3644,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
3177
3644
|
|
|
3178
3645
|
@property
|
|
3179
3646
|
def UserLevel(self):
|
|
3647
|
+
"""0: Basic Edition, 1: Ultimate Edition
|
|
3648
|
+
:rtype: int
|
|
3649
|
+
"""
|
|
3180
3650
|
return self._UserLevel
|
|
3181
3651
|
|
|
3182
3652
|
@UserLevel.setter
|
|
@@ -3185,6 +3655,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
3185
3655
|
|
|
3186
3656
|
@property
|
|
3187
3657
|
def ProExpireTime(self):
|
|
3658
|
+
"""Expiration time of the KMS Ultimate edition. It’s represented in a Unix Epoch timestamp.
|
|
3659
|
+
Note: This field may return null, indicating that no valid values can be obtained.
|
|
3660
|
+
:rtype: int
|
|
3661
|
+
"""
|
|
3188
3662
|
return self._ProExpireTime
|
|
3189
3663
|
|
|
3190
3664
|
@ProExpireTime.setter
|
|
@@ -3193,6 +3667,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
3193
3667
|
|
|
3194
3668
|
@property
|
|
3195
3669
|
def ProRenewFlag(self):
|
|
3670
|
+
"""Whether to automatically renew Ultimate Edition. 0: no, 1: yes
|
|
3671
|
+
Note: this field may return null, indicating that no valid values can be obtained.
|
|
3672
|
+
:rtype: int
|
|
3673
|
+
"""
|
|
3196
3674
|
return self._ProRenewFlag
|
|
3197
3675
|
|
|
3198
3676
|
@ProRenewFlag.setter
|
|
@@ -3201,6 +3679,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
3201
3679
|
|
|
3202
3680
|
@property
|
|
3203
3681
|
def ProResourceId(self):
|
|
3682
|
+
"""Unique ID of the Ultimate Edition purchase record. If the Ultimate Edition is not activated, the returned value will be null.
|
|
3683
|
+
Note: this field may return null, indicating that no valid values can be obtained.
|
|
3684
|
+
:rtype: str
|
|
3685
|
+
"""
|
|
3204
3686
|
return self._ProResourceId
|
|
3205
3687
|
|
|
3206
3688
|
@ProResourceId.setter
|
|
@@ -3209,6 +3691,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
3209
3691
|
|
|
3210
3692
|
@property
|
|
3211
3693
|
def ExclusiveVSMEnabled(self):
|
|
3694
|
+
"""Whether to activate Managed KMS
|
|
3695
|
+
Note: This field may return `null`, indicating that no valid value can be obtained.
|
|
3696
|
+
:rtype: bool
|
|
3697
|
+
"""
|
|
3212
3698
|
return self._ExclusiveVSMEnabled
|
|
3213
3699
|
|
|
3214
3700
|
@ExclusiveVSMEnabled.setter
|
|
@@ -3217,6 +3703,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
3217
3703
|
|
|
3218
3704
|
@property
|
|
3219
3705
|
def ExclusiveHSMEnabled(self):
|
|
3706
|
+
"""Whether to activate Exclusive KMS
|
|
3707
|
+
Note: This field may return `null`, indicating that no valid value can be obtained.
|
|
3708
|
+
:rtype: bool
|
|
3709
|
+
"""
|
|
3220
3710
|
return self._ExclusiveHSMEnabled
|
|
3221
3711
|
|
|
3222
3712
|
@ExclusiveHSMEnabled.setter
|
|
@@ -3225,6 +3715,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
3225
3715
|
|
|
3226
3716
|
@property
|
|
3227
3717
|
def SubscriptionInfo(self):
|
|
3718
|
+
"""KMS subscription information.
|
|
3719
|
+
Note: This field may return null, indicating that no valid values can be obtained.
|
|
3720
|
+
:rtype: str
|
|
3721
|
+
"""
|
|
3228
3722
|
return self._SubscriptionInfo
|
|
3229
3723
|
|
|
3230
3724
|
@SubscriptionInfo.setter
|
|
@@ -3233,6 +3727,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
3233
3727
|
|
|
3234
3728
|
@property
|
|
3235
3729
|
def RequestId(self):
|
|
3730
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
3731
|
+
:rtype: str
|
|
3732
|
+
"""
|
|
3236
3733
|
return self._RequestId
|
|
3237
3734
|
|
|
3238
3735
|
@RequestId.setter
|
|
@@ -3276,6 +3773,9 @@ class ImportKeyMaterialRequest(AbstractModel):
|
|
|
3276
3773
|
|
|
3277
3774
|
@property
|
|
3278
3775
|
def EncryptedKeyMaterial(self):
|
|
3776
|
+
"""Base64-encoded key material that encrypted with the `PublicKey` returned by `GetParametersForImport`. For the KMS of SM-CRYPTO version, the length of the key material should be 128 bits, while for KMS of FIPS-compliant version, the length should be 256 bits.
|
|
3777
|
+
:rtype: str
|
|
3778
|
+
"""
|
|
3279
3779
|
return self._EncryptedKeyMaterial
|
|
3280
3780
|
|
|
3281
3781
|
@EncryptedKeyMaterial.setter
|
|
@@ -3284,6 +3784,9 @@ class ImportKeyMaterialRequest(AbstractModel):
|
|
|
3284
3784
|
|
|
3285
3785
|
@property
|
|
3286
3786
|
def ImportToken(self):
|
|
3787
|
+
"""Import token obtained by calling `GetParametersForImport`.
|
|
3788
|
+
:rtype: str
|
|
3789
|
+
"""
|
|
3287
3790
|
return self._ImportToken
|
|
3288
3791
|
|
|
3289
3792
|
@ImportToken.setter
|
|
@@ -3292,6 +3795,9 @@ class ImportKeyMaterialRequest(AbstractModel):
|
|
|
3292
3795
|
|
|
3293
3796
|
@property
|
|
3294
3797
|
def KeyId(self):
|
|
3798
|
+
"""Specifies the CMK into which to import key material, which must be the same as the one specified by `GetParametersForImport`.
|
|
3799
|
+
:rtype: str
|
|
3800
|
+
"""
|
|
3295
3801
|
return self._KeyId
|
|
3296
3802
|
|
|
3297
3803
|
@KeyId.setter
|
|
@@ -3300,6 +3806,9 @@ class ImportKeyMaterialRequest(AbstractModel):
|
|
|
3300
3806
|
|
|
3301
3807
|
@property
|
|
3302
3808
|
def ValidTo(self):
|
|
3809
|
+
"""Unix timestamp of the key material's expiration time. If this value is empty or 0, the key material will never expire. To specify the expiration time, it should be later than the current time. Maximum value: 2147443200.
|
|
3810
|
+
:rtype: int
|
|
3811
|
+
"""
|
|
3303
3812
|
return self._ValidTo
|
|
3304
3813
|
|
|
3305
3814
|
@ValidTo.setter
|
|
@@ -3336,6 +3845,9 @@ class ImportKeyMaterialResponse(AbstractModel):
|
|
|
3336
3845
|
|
|
3337
3846
|
@property
|
|
3338
3847
|
def RequestId(self):
|
|
3848
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
3849
|
+
:rtype: str
|
|
3850
|
+
"""
|
|
3339
3851
|
return self._RequestId
|
|
3340
3852
|
|
|
3341
3853
|
@RequestId.setter
|
|
@@ -3361,6 +3873,9 @@ class Key(AbstractModel):
|
|
|
3361
3873
|
|
|
3362
3874
|
@property
|
|
3363
3875
|
def KeyId(self):
|
|
3876
|
+
"""Globally unique CMK ID.
|
|
3877
|
+
:rtype: str
|
|
3878
|
+
"""
|
|
3364
3879
|
return self._KeyId
|
|
3365
3880
|
|
|
3366
3881
|
@KeyId.setter
|
|
@@ -3442,6 +3957,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
3442
3957
|
|
|
3443
3958
|
@property
|
|
3444
3959
|
def KeyId(self):
|
|
3960
|
+
"""Globally unique CMK ID
|
|
3961
|
+
:rtype: str
|
|
3962
|
+
"""
|
|
3445
3963
|
return self._KeyId
|
|
3446
3964
|
|
|
3447
3965
|
@KeyId.setter
|
|
@@ -3450,6 +3968,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
3450
3968
|
|
|
3451
3969
|
@property
|
|
3452
3970
|
def Alias(self):
|
|
3971
|
+
"""Alias that makes a key more recognizable and understandable
|
|
3972
|
+
:rtype: str
|
|
3973
|
+
"""
|
|
3453
3974
|
return self._Alias
|
|
3454
3975
|
|
|
3455
3976
|
@Alias.setter
|
|
@@ -3458,6 +3979,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
3458
3979
|
|
|
3459
3980
|
@property
|
|
3460
3981
|
def CreateTime(self):
|
|
3982
|
+
"""Key creation time
|
|
3983
|
+
:rtype: int
|
|
3984
|
+
"""
|
|
3461
3985
|
return self._CreateTime
|
|
3462
3986
|
|
|
3463
3987
|
@CreateTime.setter
|
|
@@ -3466,6 +3990,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
3466
3990
|
|
|
3467
3991
|
@property
|
|
3468
3992
|
def Description(self):
|
|
3993
|
+
"""CMK description
|
|
3994
|
+
:rtype: str
|
|
3995
|
+
"""
|
|
3469
3996
|
return self._Description
|
|
3470
3997
|
|
|
3471
3998
|
@Description.setter
|
|
@@ -3474,6 +4001,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
3474
4001
|
|
|
3475
4002
|
@property
|
|
3476
4003
|
def KeyState(self):
|
|
4004
|
+
"""CMK status. Valid values: Enabled, Disabled, PendingDelete, PendingImport, Archived.
|
|
4005
|
+
:rtype: str
|
|
4006
|
+
"""
|
|
3477
4007
|
return self._KeyState
|
|
3478
4008
|
|
|
3479
4009
|
@KeyState.setter
|
|
@@ -3482,6 +4012,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
3482
4012
|
|
|
3483
4013
|
@property
|
|
3484
4014
|
def KeyUsage(self):
|
|
4015
|
+
"""CMK purpose. Valid values: `ENCRYPT_DECRYPT`, `ASYMMETRIC_DECRYPT_RSA_2048`, `ASYMMETRIC_DECRYPT_SM2`, `ASYMMETRIC_SIGN_VERIFY_SM2`, `ASYMMETRIC_SIGN_VERIFY_RSA_2048`, and `ASYMMETRIC_SIGN_VERIFY_ECC`.
|
|
4016
|
+
:rtype: str
|
|
4017
|
+
"""
|
|
3485
4018
|
return self._KeyUsage
|
|
3486
4019
|
|
|
3487
4020
|
@KeyUsage.setter
|
|
@@ -3490,6 +4023,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
3490
4023
|
|
|
3491
4024
|
@property
|
|
3492
4025
|
def Type(self):
|
|
4026
|
+
"""CMK type. 2: FIPS-compliant; 4: SM-CRYPTO
|
|
4027
|
+
:rtype: int
|
|
4028
|
+
"""
|
|
3493
4029
|
return self._Type
|
|
3494
4030
|
|
|
3495
4031
|
@Type.setter
|
|
@@ -3498,6 +4034,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
3498
4034
|
|
|
3499
4035
|
@property
|
|
3500
4036
|
def CreatorUin(self):
|
|
4037
|
+
"""Creator
|
|
4038
|
+
:rtype: int
|
|
4039
|
+
"""
|
|
3501
4040
|
return self._CreatorUin
|
|
3502
4041
|
|
|
3503
4042
|
@CreatorUin.setter
|
|
@@ -3506,6 +4045,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
3506
4045
|
|
|
3507
4046
|
@property
|
|
3508
4047
|
def KeyRotationEnabled(self):
|
|
4048
|
+
"""Whether key rotation is enabled
|
|
4049
|
+
:rtype: bool
|
|
4050
|
+
"""
|
|
3509
4051
|
return self._KeyRotationEnabled
|
|
3510
4052
|
|
|
3511
4053
|
@KeyRotationEnabled.setter
|
|
@@ -3514,6 +4056,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
3514
4056
|
|
|
3515
4057
|
@property
|
|
3516
4058
|
def Owner(self):
|
|
4059
|
+
"""CMK creator. The value of this parameter is `user` if the CMK is created by the user, or the corresponding service name if it is created automatically by an authorized Tencent Cloud service.
|
|
4060
|
+
:rtype: str
|
|
4061
|
+
"""
|
|
3517
4062
|
return self._Owner
|
|
3518
4063
|
|
|
3519
4064
|
@Owner.setter
|
|
@@ -3522,6 +4067,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
3522
4067
|
|
|
3523
4068
|
@property
|
|
3524
4069
|
def NextRotateTime(self):
|
|
4070
|
+
"""Time of next rotation if key rotation is enabled
|
|
4071
|
+
:rtype: int
|
|
4072
|
+
"""
|
|
3525
4073
|
return self._NextRotateTime
|
|
3526
4074
|
|
|
3527
4075
|
@NextRotateTime.setter
|
|
@@ -3530,6 +4078,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
3530
4078
|
|
|
3531
4079
|
@property
|
|
3532
4080
|
def DeletionDate(self):
|
|
4081
|
+
"""Scheduled deletion time
|
|
4082
|
+
:rtype: int
|
|
4083
|
+
"""
|
|
3533
4084
|
return self._DeletionDate
|
|
3534
4085
|
|
|
3535
4086
|
@DeletionDate.setter
|
|
@@ -3538,6 +4089,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
3538
4089
|
|
|
3539
4090
|
@property
|
|
3540
4091
|
def Origin(self):
|
|
4092
|
+
"""CMK key material type. TENCENT_KMS: created by KMS; EXTERNAL: imported by user.
|
|
4093
|
+
Note: This field may return null, indicating that no valid values can be obtained.
|
|
4094
|
+
:rtype: str
|
|
4095
|
+
"""
|
|
3541
4096
|
return self._Origin
|
|
3542
4097
|
|
|
3543
4098
|
@Origin.setter
|
|
@@ -3546,6 +4101,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
3546
4101
|
|
|
3547
4102
|
@property
|
|
3548
4103
|
def ValidTo(self):
|
|
4104
|
+
"""It's valid when `Origin` is `EXTERNAL`, indicating the expiration date of key material. 0 means valid forever.
|
|
4105
|
+
Note: This field may return null, indicating that no valid values can be obtained.
|
|
4106
|
+
:rtype: int
|
|
4107
|
+
"""
|
|
3549
4108
|
return self._ValidTo
|
|
3550
4109
|
|
|
3551
4110
|
@ValidTo.setter
|
|
@@ -3554,6 +4113,9 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
3554
4113
|
|
|
3555
4114
|
@property
|
|
3556
4115
|
def ResourceId(self):
|
|
4116
|
+
"""Resource ID in the format of `creatorUin/$creatorUin/$keyId`.
|
|
4117
|
+
:rtype: str
|
|
4118
|
+
"""
|
|
3557
4119
|
return self._ResourceId
|
|
3558
4120
|
|
|
3559
4121
|
@ResourceId.setter
|
|
@@ -3562,6 +4124,10 @@ Note: This field may return `null`, indicating that no valid value can be obtain
|
|
|
3562
4124
|
|
|
3563
4125
|
@property
|
|
3564
4126
|
def HsmClusterId(self):
|
|
4127
|
+
"""ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.
|
|
4128
|
+
Note: This field may return `null`, indicating that no valid value can be obtained.
|
|
4129
|
+
:rtype: str
|
|
4130
|
+
"""
|
|
3565
4131
|
return self._HsmClusterId
|
|
3566
4132
|
|
|
3567
4133
|
@HsmClusterId.setter
|
|
@@ -3625,6 +4191,9 @@ class ListAlgorithmsResponse(AbstractModel):
|
|
|
3625
4191
|
|
|
3626
4192
|
@property
|
|
3627
4193
|
def SymmetricAlgorithms(self):
|
|
4194
|
+
"""Symmetric encryption algorithms supported in this region
|
|
4195
|
+
:rtype: list of AlgorithmInfo
|
|
4196
|
+
"""
|
|
3628
4197
|
return self._SymmetricAlgorithms
|
|
3629
4198
|
|
|
3630
4199
|
@SymmetricAlgorithms.setter
|
|
@@ -3633,6 +4202,9 @@ class ListAlgorithmsResponse(AbstractModel):
|
|
|
3633
4202
|
|
|
3634
4203
|
@property
|
|
3635
4204
|
def AsymmetricAlgorithms(self):
|
|
4205
|
+
"""Asymmetric encryption algorithms supported in this region
|
|
4206
|
+
:rtype: list of AlgorithmInfo
|
|
4207
|
+
"""
|
|
3636
4208
|
return self._AsymmetricAlgorithms
|
|
3637
4209
|
|
|
3638
4210
|
@AsymmetricAlgorithms.setter
|
|
@@ -3641,6 +4213,9 @@ class ListAlgorithmsResponse(AbstractModel):
|
|
|
3641
4213
|
|
|
3642
4214
|
@property
|
|
3643
4215
|
def AsymmetricSignVerifyAlgorithms(self):
|
|
4216
|
+
"""Asymmetric signature verification algorithms supported in the current region
|
|
4217
|
+
:rtype: list of AlgorithmInfo
|
|
4218
|
+
"""
|
|
3644
4219
|
return self._AsymmetricSignVerifyAlgorithms
|
|
3645
4220
|
|
|
3646
4221
|
@AsymmetricSignVerifyAlgorithms.setter
|
|
@@ -3649,6 +4224,9 @@ class ListAlgorithmsResponse(AbstractModel):
|
|
|
3649
4224
|
|
|
3650
4225
|
@property
|
|
3651
4226
|
def RequestId(self):
|
|
4227
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
4228
|
+
:rtype: str
|
|
4229
|
+
"""
|
|
3652
4230
|
return self._RequestId
|
|
3653
4231
|
|
|
3654
4232
|
@RequestId.setter
|
|
@@ -3719,6 +4297,9 @@ class ListKeyDetailRequest(AbstractModel):
|
|
|
3719
4297
|
|
|
3720
4298
|
@property
|
|
3721
4299
|
def Offset(self):
|
|
4300
|
+
"""This parameter has the same meaning of the `Offset` in an SQL query, indicating that this acquisition starts from the "No. Offset value" element of the array arranged in a certain order. The default value is 0.
|
|
4301
|
+
:rtype: int
|
|
4302
|
+
"""
|
|
3722
4303
|
return self._Offset
|
|
3723
4304
|
|
|
3724
4305
|
@Offset.setter
|
|
@@ -3727,6 +4308,9 @@ class ListKeyDetailRequest(AbstractModel):
|
|
|
3727
4308
|
|
|
3728
4309
|
@property
|
|
3729
4310
|
def Limit(self):
|
|
4311
|
+
"""This parameter has the same meaning of the `Limit` in an SQL query, indicating that up to `Limit` value elements can be obtained in this request. The default value is 10 and the maximum value is 200.
|
|
4312
|
+
:rtype: int
|
|
4313
|
+
"""
|
|
3730
4314
|
return self._Limit
|
|
3731
4315
|
|
|
3732
4316
|
@Limit.setter
|
|
@@ -3735,6 +4319,9 @@ class ListKeyDetailRequest(AbstractModel):
|
|
|
3735
4319
|
|
|
3736
4320
|
@property
|
|
3737
4321
|
def Role(self):
|
|
4322
|
+
"""Filters by creator role. 0 (default value): the CMK is created by the user; 1: the CMK is created automatically by an authorized Tencent Cloud service.
|
|
4323
|
+
:rtype: int
|
|
4324
|
+
"""
|
|
3738
4325
|
return self._Role
|
|
3739
4326
|
|
|
3740
4327
|
@Role.setter
|
|
@@ -3743,6 +4330,9 @@ class ListKeyDetailRequest(AbstractModel):
|
|
|
3743
4330
|
|
|
3744
4331
|
@property
|
|
3745
4332
|
def OrderType(self):
|
|
4333
|
+
"""Sorts by CMK creation time. 0: descending; 1: ascending
|
|
4334
|
+
:rtype: int
|
|
4335
|
+
"""
|
|
3746
4336
|
return self._OrderType
|
|
3747
4337
|
|
|
3748
4338
|
@OrderType.setter
|
|
@@ -3751,6 +4341,9 @@ class ListKeyDetailRequest(AbstractModel):
|
|
|
3751
4341
|
|
|
3752
4342
|
@property
|
|
3753
4343
|
def KeyState(self):
|
|
4344
|
+
"""Filters by CMK status. 0: all CMKs; 1: CMKs in `Enabled` status only; 2: CMKs in `Disabled` status only; 3: CMKs in `PendingDelete` status only (i.e., keys with schedule deletion enabled); 4: CMKs in `PendingImport` status only; 5: CMKs in `Archived` status only.
|
|
4345
|
+
:rtype: int
|
|
4346
|
+
"""
|
|
3754
4347
|
return self._KeyState
|
|
3755
4348
|
|
|
3756
4349
|
@KeyState.setter
|
|
@@ -3759,6 +4352,9 @@ class ListKeyDetailRequest(AbstractModel):
|
|
|
3759
4352
|
|
|
3760
4353
|
@property
|
|
3761
4354
|
def SearchKeyAlias(self):
|
|
4355
|
+
"""Performs a fuzzy query by `KeyId` or `Alias`
|
|
4356
|
+
:rtype: str
|
|
4357
|
+
"""
|
|
3762
4358
|
return self._SearchKeyAlias
|
|
3763
4359
|
|
|
3764
4360
|
@SearchKeyAlias.setter
|
|
@@ -3767,6 +4363,9 @@ class ListKeyDetailRequest(AbstractModel):
|
|
|
3767
4363
|
|
|
3768
4364
|
@property
|
|
3769
4365
|
def Origin(self):
|
|
4366
|
+
"""Filters by CMK type. "TENCENT_KMS" indicates to filter CMKs whose key materials are created by KMS; "EXTERNAL" indicates to filter CMKs of `EXTERNAL` type whose key materials are imported by users; "ALL" or empty indicates to filter CMKs of both types. This value is case-sensitive.
|
|
4367
|
+
:rtype: str
|
|
4368
|
+
"""
|
|
3770
4369
|
return self._Origin
|
|
3771
4370
|
|
|
3772
4371
|
@Origin.setter
|
|
@@ -3775,6 +4374,9 @@ class ListKeyDetailRequest(AbstractModel):
|
|
|
3775
4374
|
|
|
3776
4375
|
@property
|
|
3777
4376
|
def KeyUsage(self):
|
|
4377
|
+
"""Filters by the `KeyUsage` field value. Valid values: `ALL` (all CMKs), `ENCRYPT_DECRYPT` (used when this field is left empty), `ASYMMETRIC_DECRYPT_RSA_2048`, `ASYMMETRIC_DECRYPT_SM2`, `ASYMMETRIC_SIGN_VERIFY_SM2`, `ASYMMETRIC_SIGN_VERIFY_RSA_2048`, and `ASYMMETRIC_SIGN_VERIFY_ECC`.
|
|
4378
|
+
:rtype: str
|
|
4379
|
+
"""
|
|
3778
4380
|
return self._KeyUsage
|
|
3779
4381
|
|
|
3780
4382
|
@KeyUsage.setter
|
|
@@ -3783,6 +4385,9 @@ class ListKeyDetailRequest(AbstractModel):
|
|
|
3783
4385
|
|
|
3784
4386
|
@property
|
|
3785
4387
|
def TagFilters(self):
|
|
4388
|
+
"""Tag filter condition
|
|
4389
|
+
:rtype: list of TagFilter
|
|
4390
|
+
"""
|
|
3786
4391
|
return self._TagFilters
|
|
3787
4392
|
|
|
3788
4393
|
@TagFilters.setter
|
|
@@ -3791,6 +4396,9 @@ class ListKeyDetailRequest(AbstractModel):
|
|
|
3791
4396
|
|
|
3792
4397
|
@property
|
|
3793
4398
|
def HsmClusterId(self):
|
|
4399
|
+
"""ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.
|
|
4400
|
+
:rtype: str
|
|
4401
|
+
"""
|
|
3794
4402
|
return self._HsmClusterId
|
|
3795
4403
|
|
|
3796
4404
|
@HsmClusterId.setter
|
|
@@ -3845,6 +4453,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
3845
4453
|
|
|
3846
4454
|
@property
|
|
3847
4455
|
def TotalCount(self):
|
|
4456
|
+
"""Total number of CMKs
|
|
4457
|
+
:rtype: int
|
|
4458
|
+
"""
|
|
3848
4459
|
return self._TotalCount
|
|
3849
4460
|
|
|
3850
4461
|
@TotalCount.setter
|
|
@@ -3853,6 +4464,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
3853
4464
|
|
|
3854
4465
|
@property
|
|
3855
4466
|
def KeyMetadatas(self):
|
|
4467
|
+
"""List of returned attribute information.
|
|
4468
|
+
Note: this field may return null, indicating that no valid values can be obtained.
|
|
4469
|
+
:rtype: list of KeyMetadata
|
|
4470
|
+
"""
|
|
3856
4471
|
return self._KeyMetadatas
|
|
3857
4472
|
|
|
3858
4473
|
@KeyMetadatas.setter
|
|
@@ -3861,6 +4476,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
3861
4476
|
|
|
3862
4477
|
@property
|
|
3863
4478
|
def RequestId(self):
|
|
4479
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
4480
|
+
:rtype: str
|
|
4481
|
+
"""
|
|
3864
4482
|
return self._RequestId
|
|
3865
4483
|
|
|
3866
4484
|
@RequestId.setter
|
|
@@ -3902,6 +4520,9 @@ class ListKeysRequest(AbstractModel):
|
|
|
3902
4520
|
|
|
3903
4521
|
@property
|
|
3904
4522
|
def Offset(self):
|
|
4523
|
+
"""This parameter has the same meaning of the `Offset` in an SQL query, indicating that this acquisition starts from the "No. Offset value" element of the array arranged in a certain order. The default value is 0
|
|
4524
|
+
:rtype: int
|
|
4525
|
+
"""
|
|
3905
4526
|
return self._Offset
|
|
3906
4527
|
|
|
3907
4528
|
@Offset.setter
|
|
@@ -3910,6 +4531,9 @@ class ListKeysRequest(AbstractModel):
|
|
|
3910
4531
|
|
|
3911
4532
|
@property
|
|
3912
4533
|
def Limit(self):
|
|
4534
|
+
"""This parameter has the same meaning of the `Limit` in an SQL query, indicating that up to `Limit` value elements can be obtained in this request. The default value is 10 and the maximum value is 200
|
|
4535
|
+
:rtype: int
|
|
4536
|
+
"""
|
|
3913
4537
|
return self._Limit
|
|
3914
4538
|
|
|
3915
4539
|
@Limit.setter
|
|
@@ -3918,6 +4542,9 @@ class ListKeysRequest(AbstractModel):
|
|
|
3918
4542
|
|
|
3919
4543
|
@property
|
|
3920
4544
|
def Role(self):
|
|
4545
|
+
"""Filter by creator role. 0 (default value): the CMK is created by the user; 1: the CMK is created automatically by an authorized Tencent Cloud service
|
|
4546
|
+
:rtype: int
|
|
4547
|
+
"""
|
|
3921
4548
|
return self._Role
|
|
3922
4549
|
|
|
3923
4550
|
@Role.setter
|
|
@@ -3926,6 +4553,9 @@ class ListKeysRequest(AbstractModel):
|
|
|
3926
4553
|
|
|
3927
4554
|
@property
|
|
3928
4555
|
def HsmClusterId(self):
|
|
4556
|
+
"""ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.
|
|
4557
|
+
:rtype: str
|
|
4558
|
+
"""
|
|
3929
4559
|
return self._HsmClusterId
|
|
3930
4560
|
|
|
3931
4561
|
@HsmClusterId.setter
|
|
@@ -3968,6 +4598,9 @@ class ListKeysResponse(AbstractModel):
|
|
|
3968
4598
|
|
|
3969
4599
|
@property
|
|
3970
4600
|
def Keys(self):
|
|
4601
|
+
"""CMK list array
|
|
4602
|
+
:rtype: list of Key
|
|
4603
|
+
"""
|
|
3971
4604
|
return self._Keys
|
|
3972
4605
|
|
|
3973
4606
|
@Keys.setter
|
|
@@ -3976,6 +4609,9 @@ class ListKeysResponse(AbstractModel):
|
|
|
3976
4609
|
|
|
3977
4610
|
@property
|
|
3978
4611
|
def TotalCount(self):
|
|
4612
|
+
"""Total number of CMKs
|
|
4613
|
+
:rtype: int
|
|
4614
|
+
"""
|
|
3979
4615
|
return self._TotalCount
|
|
3980
4616
|
|
|
3981
4617
|
@TotalCount.setter
|
|
@@ -3984,6 +4620,9 @@ class ListKeysResponse(AbstractModel):
|
|
|
3984
4620
|
|
|
3985
4621
|
@property
|
|
3986
4622
|
def RequestId(self):
|
|
4623
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
4624
|
+
:rtype: str
|
|
4625
|
+
"""
|
|
3987
4626
|
return self._RequestId
|
|
3988
4627
|
|
|
3989
4628
|
@RequestId.setter
|
|
@@ -4019,6 +4658,9 @@ class OverwriteWhiteBoxDeviceFingerprintsRequest(AbstractModel):
|
|
|
4019
4658
|
|
|
4020
4659
|
@property
|
|
4021
4660
|
def KeyId(self):
|
|
4661
|
+
"""White-box key ID
|
|
4662
|
+
:rtype: str
|
|
4663
|
+
"""
|
|
4022
4664
|
return self._KeyId
|
|
4023
4665
|
|
|
4024
4666
|
@KeyId.setter
|
|
@@ -4027,6 +4669,9 @@ class OverwriteWhiteBoxDeviceFingerprintsRequest(AbstractModel):
|
|
|
4027
4669
|
|
|
4028
4670
|
@property
|
|
4029
4671
|
def DeviceFingerprints(self):
|
|
4672
|
+
"""Device fingerprint list. If the list is empty, it means to delete all fingerprint information corresponding to the key. There can be up to 200 entries in the list.
|
|
4673
|
+
:rtype: list of DeviceFingerprint
|
|
4674
|
+
"""
|
|
4030
4675
|
return self._DeviceFingerprints
|
|
4031
4676
|
|
|
4032
4677
|
@DeviceFingerprints.setter
|
|
@@ -4066,6 +4711,9 @@ class OverwriteWhiteBoxDeviceFingerprintsResponse(AbstractModel):
|
|
|
4066
4711
|
|
|
4067
4712
|
@property
|
|
4068
4713
|
def RequestId(self):
|
|
4714
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
4715
|
+
:rtype: str
|
|
4716
|
+
"""
|
|
4069
4717
|
return self._RequestId
|
|
4070
4718
|
|
|
4071
4719
|
@RequestId.setter
|
|
@@ -4097,6 +4745,9 @@ class PostQuantumCryptoDecryptRequest(AbstractModel):
|
|
|
4097
4745
|
|
|
4098
4746
|
@property
|
|
4099
4747
|
def CiphertextBlob(self):
|
|
4748
|
+
"""The ciphertext data to be decrypted.
|
|
4749
|
+
:rtype: str
|
|
4750
|
+
"""
|
|
4100
4751
|
return self._CiphertextBlob
|
|
4101
4752
|
|
|
4102
4753
|
@CiphertextBlob.setter
|
|
@@ -4105,6 +4756,9 @@ class PostQuantumCryptoDecryptRequest(AbstractModel):
|
|
|
4105
4756
|
|
|
4106
4757
|
@property
|
|
4107
4758
|
def EncryptionPublicKey(self):
|
|
4759
|
+
"""PEM-encoded public key (2048-bit RSA/SM2 key), which can be used to encrypt the `Plaintext` returned. If this field is left empty, the `Plaintext` will not be encrypted.
|
|
4760
|
+
:rtype: str
|
|
4761
|
+
"""
|
|
4108
4762
|
return self._EncryptionPublicKey
|
|
4109
4763
|
|
|
4110
4764
|
@EncryptionPublicKey.setter
|
|
@@ -4113,6 +4767,9 @@ class PostQuantumCryptoDecryptRequest(AbstractModel):
|
|
|
4113
4767
|
|
|
4114
4768
|
@property
|
|
4115
4769
|
def EncryptionAlgorithm(self):
|
|
4770
|
+
"""Asymmetric encryption algorithm. It is used in combination with `EncryptionPublicKey` to encrypt the returned data. Values: `SM2`(Return the ciphertext in the format of "C1C3C2"), `SM2_C1C3C2_ASN1` (Return the ciphertext in the format of "C1C3C2 ASN1"), `RSAES_PKCS1_V1_5`, `RSAES_OAEP_SHA_1`, `RSAES_OAEP_SHA_256`. It defaults to `SM2` if it's not specified.
|
|
4771
|
+
:rtype: str
|
|
4772
|
+
"""
|
|
4116
4773
|
return self._EncryptionAlgorithm
|
|
4117
4774
|
|
|
4118
4775
|
@EncryptionAlgorithm.setter
|
|
@@ -4155,6 +4812,9 @@ If `EncryptionPublicKey` is passed in, this field contains the Base64-encoded ci
|
|
|
4155
4812
|
|
|
4156
4813
|
@property
|
|
4157
4814
|
def KeyId(self):
|
|
4815
|
+
"""Globally unique CMK ID
|
|
4816
|
+
:rtype: str
|
|
4817
|
+
"""
|
|
4158
4818
|
return self._KeyId
|
|
4159
4819
|
|
|
4160
4820
|
@KeyId.setter
|
|
@@ -4163,6 +4823,10 @@ If `EncryptionPublicKey` is passed in, this field contains the Base64-encoded ci
|
|
|
4163
4823
|
|
|
4164
4824
|
@property
|
|
4165
4825
|
def PlainText(self):
|
|
4826
|
+
"""If `EncryptionPublicKey` is left empty, a Base64-encoded ciphertext will be returned. To get the plaintext, you need to decode the ciphertext first.
|
|
4827
|
+
If `EncryptionPublicKey` is passed in, this field contains the Base64-encoded ciphertext after asymmetric encryption by using the public key in `EncryptionPublicKey` To get the plaintext, you need to first decode the Base64 format, and then decrypwith the private key corresponding with the public key. The private key is uploaded by the user.
|
|
4828
|
+
:rtype: str
|
|
4829
|
+
"""
|
|
4166
4830
|
return self._PlainText
|
|
4167
4831
|
|
|
4168
4832
|
@PlainText.setter
|
|
@@ -4171,6 +4835,9 @@ If `EncryptionPublicKey` is passed in, this field contains the Base64-encoded ci
|
|
|
4171
4835
|
|
|
4172
4836
|
@property
|
|
4173
4837
|
def RequestId(self):
|
|
4838
|
+
"""The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
|
|
4839
|
+
:rtype: str
|
|
4840
|
+
"""
|
|
4174
4841
|
return self._RequestId
|
|
4175
4842
|
|
|
4176
4843
|
@RequestId.setter
|
|
@@ -4201,6 +4868,9 @@ class PostQuantumCryptoEncryptRequest(AbstractModel):
|
|
|
4201
4868
|
|
|
4202
4869
|
@property
|
|
4203
4870
|
def KeyId(self):
|
|
4871
|
+
"""Globally unique ID of the CMK generated by calling the `CreateKey` API
|
|
4872
|
+
:rtype: str
|
|
4873
|
+
"""
|
|
4204
4874
|
return self._KeyId
|
|
4205
4875
|
|
|
4206
4876
|
@KeyId.setter
|
|
@@ -4209,6 +4879,9 @@ class PostQuantumCryptoEncryptRequest(AbstractModel):
|
|
|
4209
4879
|
|
|
4210
4880
|
@property
|
|
4211
4881
|
def PlainText(self):
|
|
4882
|
+
"""Encrypted plaintext data. This field must be Base64-encoded. The maximum size of the original data is 4 KB.
|
|
4883
|
+
:rtype: str
|
|
4884
|
+
"""
|
|
4212
4885
|
return self._PlainText
|
|
4213
4886
|
|
|
4214
4887
|
@PlainText.setter
|
|
@@ -4249,6 +4922,9 @@ class PostQuantumCryptoEncryptResponse(AbstractModel):
|
|
|
4249
4922
|
|
|
4250
4923
|
@property
|
|
4251
4924
|
def CiphertextBlob(self):
|
|
4925
|
+
"""Base64-encoded ciphertext after encryption. This field contains the information of ciphertext and keys. It is not the result of encrypting the plaintext. To get the plaintext, you need to pass in this field to the PostQuantumCryptoDecrypt API.
|
|
4926
|
+
:rtype: str
|
|
4927
|
+
"""
|
|
4252
4928
|
return self._CiphertextBlob
|
|
4253
4929
|
|
|
4254
4930
|
@CiphertextBlob.setter
|
|
@@ -4257,6 +4933,9 @@ class PostQuantumCryptoEncryptResponse(AbstractModel):
|
|
|
4257
4933
|
|
|
4258
4934
|
@property
|
|
4259
4935
|
def KeyId(self):
|
|
4936
|
+
"""Globally unique ID of the CMK used for encryption
|
|
4937
|
+
:rtype: str
|
|
4938
|
+
"""
|
|
4260
4939
|
return self._KeyId
|
|
4261
4940
|
|
|
4262
4941
|
@KeyId.setter
|
|
@@ -4265,6 +4944,9 @@ class PostQuantumCryptoEncryptResponse(AbstractModel):
|
|
|
4265
4944
|
|
|
4266
4945
|
@property
|
|
4267
4946
|
def RequestId(self):
|
|
4947
|
+
"""The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
|
|
4948
|
+
:rtype: str
|
|
4949
|
+
"""
|
|
4268
4950
|
return self._RequestId
|
|
4269
4951
|
|
|
4270
4952
|
@RequestId.setter
|
|
@@ -4295,6 +4977,9 @@ class PostQuantumCryptoSignRequest(AbstractModel):
|
|
|
4295
4977
|
|
|
4296
4978
|
@property
|
|
4297
4979
|
def Message(self):
|
|
4980
|
+
"""Original message text before Base64 encoding. It cannot exceed 4096 bytes.
|
|
4981
|
+
:rtype: str
|
|
4982
|
+
"""
|
|
4298
4983
|
return self._Message
|
|
4299
4984
|
|
|
4300
4985
|
@Message.setter
|
|
@@ -4303,6 +4988,9 @@ class PostQuantumCryptoSignRequest(AbstractModel):
|
|
|
4303
4988
|
|
|
4304
4989
|
@property
|
|
4305
4990
|
def KeyId(self):
|
|
4991
|
+
"""Unique ID of a key
|
|
4992
|
+
:rtype: str
|
|
4993
|
+
"""
|
|
4306
4994
|
return self._KeyId
|
|
4307
4995
|
|
|
4308
4996
|
@KeyId.setter
|
|
@@ -4340,6 +5028,9 @@ class PostQuantumCryptoSignResponse(AbstractModel):
|
|
|
4340
5028
|
|
|
4341
5029
|
@property
|
|
4342
5030
|
def Signature(self):
|
|
5031
|
+
"""Base64-encoded signature You can use PostQuantumCryptoVerify to verify the signature value.
|
|
5032
|
+
:rtype: str
|
|
5033
|
+
"""
|
|
4343
5034
|
return self._Signature
|
|
4344
5035
|
|
|
4345
5036
|
@Signature.setter
|
|
@@ -4348,6 +5039,9 @@ class PostQuantumCryptoSignResponse(AbstractModel):
|
|
|
4348
5039
|
|
|
4349
5040
|
@property
|
|
4350
5041
|
def RequestId(self):
|
|
5042
|
+
"""The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
|
|
5043
|
+
:rtype: str
|
|
5044
|
+
"""
|
|
4351
5045
|
return self._RequestId
|
|
4352
5046
|
|
|
4353
5047
|
@RequestId.setter
|
|
@@ -4380,6 +5074,9 @@ class PostQuantumCryptoVerifyRequest(AbstractModel):
|
|
|
4380
5074
|
|
|
4381
5075
|
@property
|
|
4382
5076
|
def KeyId(self):
|
|
5077
|
+
"""Unique ID of a key
|
|
5078
|
+
:rtype: str
|
|
5079
|
+
"""
|
|
4383
5080
|
return self._KeyId
|
|
4384
5081
|
|
|
4385
5082
|
@KeyId.setter
|
|
@@ -4388,6 +5085,9 @@ class PostQuantumCryptoVerifyRequest(AbstractModel):
|
|
|
4388
5085
|
|
|
4389
5086
|
@property
|
|
4390
5087
|
def SignatureValue(self):
|
|
5088
|
+
"""Signature value, which is generated by calling the `PostQuantumCryptoSign` API.
|
|
5089
|
+
:rtype: str
|
|
5090
|
+
"""
|
|
4391
5091
|
return self._SignatureValue
|
|
4392
5092
|
|
|
4393
5093
|
@SignatureValue.setter
|
|
@@ -4396,6 +5096,9 @@ class PostQuantumCryptoVerifyRequest(AbstractModel):
|
|
|
4396
5096
|
|
|
4397
5097
|
@property
|
|
4398
5098
|
def Message(self):
|
|
5099
|
+
"""Original message text before Base64 encoding. It cannot exceed 4096 bytes.
|
|
5100
|
+
:rtype: str
|
|
5101
|
+
"""
|
|
4399
5102
|
return self._Message
|
|
4400
5103
|
|
|
4401
5104
|
@Message.setter
|
|
@@ -4434,6 +5137,9 @@ class PostQuantumCryptoVerifyResponse(AbstractModel):
|
|
|
4434
5137
|
|
|
4435
5138
|
@property
|
|
4436
5139
|
def SignatureValid(self):
|
|
5140
|
+
"""Verify whether the signature is valid. `true`: The signature is valid. `false`: The signature is invalid.
|
|
5141
|
+
:rtype: bool
|
|
5142
|
+
"""
|
|
4437
5143
|
return self._SignatureValid
|
|
4438
5144
|
|
|
4439
5145
|
@SignatureValid.setter
|
|
@@ -4442,6 +5148,9 @@ class PostQuantumCryptoVerifyResponse(AbstractModel):
|
|
|
4442
5148
|
|
|
4443
5149
|
@property
|
|
4444
5150
|
def RequestId(self):
|
|
5151
|
+
"""The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
|
|
5152
|
+
:rtype: str
|
|
5153
|
+
"""
|
|
4445
5154
|
return self._RequestId
|
|
4446
5155
|
|
|
4447
5156
|
@RequestId.setter
|
|
@@ -4477,6 +5186,9 @@ class ReEncryptRequest(AbstractModel):
|
|
|
4477
5186
|
|
|
4478
5187
|
@property
|
|
4479
5188
|
def CiphertextBlob(self):
|
|
5189
|
+
"""Ciphertext to be re-encrypted
|
|
5190
|
+
:rtype: str
|
|
5191
|
+
"""
|
|
4480
5192
|
return self._CiphertextBlob
|
|
4481
5193
|
|
|
4482
5194
|
@CiphertextBlob.setter
|
|
@@ -4485,6 +5197,9 @@ class ReEncryptRequest(AbstractModel):
|
|
|
4485
5197
|
|
|
4486
5198
|
@property
|
|
4487
5199
|
def DestinationKeyId(self):
|
|
5200
|
+
"""CMK used for re-encryption. If this parameter is empty, the ciphertext will be re-encrypted by using the original CMK (as long as the key is not rotated, the ciphertext will not be refreshed)
|
|
5201
|
+
:rtype: str
|
|
5202
|
+
"""
|
|
4488
5203
|
return self._DestinationKeyId
|
|
4489
5204
|
|
|
4490
5205
|
@DestinationKeyId.setter
|
|
@@ -4493,6 +5208,9 @@ class ReEncryptRequest(AbstractModel):
|
|
|
4493
5208
|
|
|
4494
5209
|
@property
|
|
4495
5210
|
def SourceEncryptionContext(self):
|
|
5211
|
+
"""JSON string of the key-value pair used during ciphertext encryption by `CiphertextBlob`. If not used during encryption, this parameter will be empty
|
|
5212
|
+
:rtype: str
|
|
5213
|
+
"""
|
|
4496
5214
|
return self._SourceEncryptionContext
|
|
4497
5215
|
|
|
4498
5216
|
@SourceEncryptionContext.setter
|
|
@@ -4501,6 +5219,9 @@ class ReEncryptRequest(AbstractModel):
|
|
|
4501
5219
|
|
|
4502
5220
|
@property
|
|
4503
5221
|
def DestinationEncryptionContext(self):
|
|
5222
|
+
"""JSON string of the key-value pair used during re-encryption. If this field is used, the same string should be entered when the returned new ciphertext is decrypted
|
|
5223
|
+
:rtype: str
|
|
5224
|
+
"""
|
|
4504
5225
|
return self._DestinationEncryptionContext
|
|
4505
5226
|
|
|
4506
5227
|
@DestinationEncryptionContext.setter
|
|
@@ -4549,6 +5270,9 @@ class ReEncryptResponse(AbstractModel):
|
|
|
4549
5270
|
|
|
4550
5271
|
@property
|
|
4551
5272
|
def CiphertextBlob(self):
|
|
5273
|
+
"""Re-encrypted ciphertext
|
|
5274
|
+
:rtype: str
|
|
5275
|
+
"""
|
|
4552
5276
|
return self._CiphertextBlob
|
|
4553
5277
|
|
|
4554
5278
|
@CiphertextBlob.setter
|
|
@@ -4557,6 +5281,9 @@ class ReEncryptResponse(AbstractModel):
|
|
|
4557
5281
|
|
|
4558
5282
|
@property
|
|
4559
5283
|
def KeyId(self):
|
|
5284
|
+
"""CMK used for re-encryption
|
|
5285
|
+
:rtype: str
|
|
5286
|
+
"""
|
|
4560
5287
|
return self._KeyId
|
|
4561
5288
|
|
|
4562
5289
|
@KeyId.setter
|
|
@@ -4565,6 +5292,9 @@ class ReEncryptResponse(AbstractModel):
|
|
|
4565
5292
|
|
|
4566
5293
|
@property
|
|
4567
5294
|
def SourceKeyId(self):
|
|
5295
|
+
"""CMK used by ciphertext before re-encryption
|
|
5296
|
+
:rtype: str
|
|
5297
|
+
"""
|
|
4568
5298
|
return self._SourceKeyId
|
|
4569
5299
|
|
|
4570
5300
|
@SourceKeyId.setter
|
|
@@ -4573,6 +5303,9 @@ class ReEncryptResponse(AbstractModel):
|
|
|
4573
5303
|
|
|
4574
5304
|
@property
|
|
4575
5305
|
def ReEncrypted(self):
|
|
5306
|
+
"""`true` indicates that the ciphertext has been re-encrypted. When re-encryption is initiated by using the same CMK, as long as the CMK is not rotated, no actual re-encryption will be performed, and the original ciphertext will be returned
|
|
5307
|
+
:rtype: bool
|
|
5308
|
+
"""
|
|
4576
5309
|
return self._ReEncrypted
|
|
4577
5310
|
|
|
4578
5311
|
@ReEncrypted.setter
|
|
@@ -4581,6 +5314,9 @@ class ReEncryptResponse(AbstractModel):
|
|
|
4581
5314
|
|
|
4582
5315
|
@property
|
|
4583
5316
|
def RequestId(self):
|
|
5317
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
5318
|
+
:rtype: str
|
|
5319
|
+
"""
|
|
4584
5320
|
return self._RequestId
|
|
4585
5321
|
|
|
4586
5322
|
@RequestId.setter
|
|
@@ -4613,6 +5349,9 @@ class ScheduleKeyDeletionRequest(AbstractModel):
|
|
|
4613
5349
|
|
|
4614
5350
|
@property
|
|
4615
5351
|
def KeyId(self):
|
|
5352
|
+
"""Unique CMK ID
|
|
5353
|
+
:rtype: str
|
|
5354
|
+
"""
|
|
4616
5355
|
return self._KeyId
|
|
4617
5356
|
|
|
4618
5357
|
@KeyId.setter
|
|
@@ -4621,6 +5360,9 @@ class ScheduleKeyDeletionRequest(AbstractModel):
|
|
|
4621
5360
|
|
|
4622
5361
|
@property
|
|
4623
5362
|
def PendingWindowInDays(self):
|
|
5363
|
+
"""Schedule deletion time range. Value range: [7,30]
|
|
5364
|
+
:rtype: int
|
|
5365
|
+
"""
|
|
4624
5366
|
return self._PendingWindowInDays
|
|
4625
5367
|
|
|
4626
5368
|
@PendingWindowInDays.setter
|
|
@@ -4661,6 +5403,9 @@ class ScheduleKeyDeletionResponse(AbstractModel):
|
|
|
4661
5403
|
|
|
4662
5404
|
@property
|
|
4663
5405
|
def DeletionDate(self):
|
|
5406
|
+
"""Schedule deletion execution time
|
|
5407
|
+
:rtype: int
|
|
5408
|
+
"""
|
|
4664
5409
|
return self._DeletionDate
|
|
4665
5410
|
|
|
4666
5411
|
@DeletionDate.setter
|
|
@@ -4669,6 +5414,9 @@ class ScheduleKeyDeletionResponse(AbstractModel):
|
|
|
4669
5414
|
|
|
4670
5415
|
@property
|
|
4671
5416
|
def KeyId(self):
|
|
5417
|
+
"""Unique ID of the CMK scheduled for deletion
|
|
5418
|
+
:rtype: str
|
|
5419
|
+
"""
|
|
4672
5420
|
return self._KeyId
|
|
4673
5421
|
|
|
4674
5422
|
@KeyId.setter
|
|
@@ -4677,6 +5425,9 @@ class ScheduleKeyDeletionResponse(AbstractModel):
|
|
|
4677
5425
|
|
|
4678
5426
|
@property
|
|
4679
5427
|
def RequestId(self):
|
|
5428
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
5429
|
+
:rtype: str
|
|
5430
|
+
"""
|
|
4680
5431
|
return self._RequestId
|
|
4681
5432
|
|
|
4682
5433
|
@RequestId.setter
|
|
@@ -4713,6 +5464,9 @@ class SignByAsymmetricKeyRequest(AbstractModel):
|
|
|
4713
5464
|
|
|
4714
5465
|
@property
|
|
4715
5466
|
def Algorithm(self):
|
|
5467
|
+
"""Signature algorithm. The valid values include `SM2DSA`, `ECC_P256_R1`, `RSA_PSS_SHA_256`, and `RSA_PKCS1_SHA_256`, etc. You can get a full list of supported algorithms using the ListAlgorithms API.
|
|
5468
|
+
:rtype: str
|
|
5469
|
+
"""
|
|
4716
5470
|
return self._Algorithm
|
|
4717
5471
|
|
|
4718
5472
|
@Algorithm.setter
|
|
@@ -4721,6 +5475,9 @@ class SignByAsymmetricKeyRequest(AbstractModel):
|
|
|
4721
5475
|
|
|
4722
5476
|
@property
|
|
4723
5477
|
def Message(self):
|
|
5478
|
+
"""Full message or message abstract. Before Base64 encoding, an original message can contain up to 4,096 bytes while a message abstract must be 32 bytes.
|
|
5479
|
+
:rtype: str
|
|
5480
|
+
"""
|
|
4724
5481
|
return self._Message
|
|
4725
5482
|
|
|
4726
5483
|
@Message.setter
|
|
@@ -4729,6 +5486,9 @@ class SignByAsymmetricKeyRequest(AbstractModel):
|
|
|
4729
5486
|
|
|
4730
5487
|
@property
|
|
4731
5488
|
def KeyId(self):
|
|
5489
|
+
"""Unique ID of a key
|
|
5490
|
+
:rtype: str
|
|
5491
|
+
"""
|
|
4732
5492
|
return self._KeyId
|
|
4733
5493
|
|
|
4734
5494
|
@KeyId.setter
|
|
@@ -4737,6 +5497,9 @@ class SignByAsymmetricKeyRequest(AbstractModel):
|
|
|
4737
5497
|
|
|
4738
5498
|
@property
|
|
4739
5499
|
def MessageType(self):
|
|
5500
|
+
"""Message type. Valid values: `RAW` (indicating an original message; used by default if the parameter is not passed in) and `DIGEST`.
|
|
5501
|
+
:rtype: str
|
|
5502
|
+
"""
|
|
4740
5503
|
return self._MessageType
|
|
4741
5504
|
|
|
4742
5505
|
@MessageType.setter
|
|
@@ -4776,6 +5539,9 @@ class SignByAsymmetricKeyResponse(AbstractModel):
|
|
|
4776
5539
|
|
|
4777
5540
|
@property
|
|
4778
5541
|
def Signature(self):
|
|
5542
|
+
"""Base64-encoded signature
|
|
5543
|
+
:rtype: str
|
|
5544
|
+
"""
|
|
4779
5545
|
return self._Signature
|
|
4780
5546
|
|
|
4781
5547
|
@Signature.setter
|
|
@@ -4784,6 +5550,9 @@ class SignByAsymmetricKeyResponse(AbstractModel):
|
|
|
4784
5550
|
|
|
4785
5551
|
@property
|
|
4786
5552
|
def RequestId(self):
|
|
5553
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
5554
|
+
:rtype: str
|
|
5555
|
+
"""
|
|
4787
5556
|
return self._RequestId
|
|
4788
5557
|
|
|
4789
5558
|
@RequestId.setter
|
|
@@ -4813,6 +5582,9 @@ class Tag(AbstractModel):
|
|
|
4813
5582
|
|
|
4814
5583
|
@property
|
|
4815
5584
|
def TagKey(self):
|
|
5585
|
+
"""Tag key
|
|
5586
|
+
:rtype: str
|
|
5587
|
+
"""
|
|
4816
5588
|
return self._TagKey
|
|
4817
5589
|
|
|
4818
5590
|
@TagKey.setter
|
|
@@ -4821,6 +5593,9 @@ class Tag(AbstractModel):
|
|
|
4821
5593
|
|
|
4822
5594
|
@property
|
|
4823
5595
|
def TagValue(self):
|
|
5596
|
+
"""Tag value
|
|
5597
|
+
:rtype: str
|
|
5598
|
+
"""
|
|
4824
5599
|
return self._TagValue
|
|
4825
5600
|
|
|
4826
5601
|
@TagValue.setter
|
|
@@ -4858,6 +5633,9 @@ class TagFilter(AbstractModel):
|
|
|
4858
5633
|
|
|
4859
5634
|
@property
|
|
4860
5635
|
def TagKey(self):
|
|
5636
|
+
"""Tag key
|
|
5637
|
+
:rtype: str
|
|
5638
|
+
"""
|
|
4861
5639
|
return self._TagKey
|
|
4862
5640
|
|
|
4863
5641
|
@TagKey.setter
|
|
@@ -4866,6 +5644,9 @@ class TagFilter(AbstractModel):
|
|
|
4866
5644
|
|
|
4867
5645
|
@property
|
|
4868
5646
|
def TagValue(self):
|
|
5647
|
+
"""Tag value
|
|
5648
|
+
:rtype: list of str
|
|
5649
|
+
"""
|
|
4869
5650
|
return self._TagValue
|
|
4870
5651
|
|
|
4871
5652
|
@TagValue.setter
|
|
@@ -4906,6 +5687,9 @@ class UnbindCloudResourceRequest(AbstractModel):
|
|
|
4906
5687
|
|
|
4907
5688
|
@property
|
|
4908
5689
|
def KeyId(self):
|
|
5690
|
+
"""CMK ID
|
|
5691
|
+
:rtype: str
|
|
5692
|
+
"""
|
|
4909
5693
|
return self._KeyId
|
|
4910
5694
|
|
|
4911
5695
|
@KeyId.setter
|
|
@@ -4914,6 +5698,9 @@ class UnbindCloudResourceRequest(AbstractModel):
|
|
|
4914
5698
|
|
|
4915
5699
|
@property
|
|
4916
5700
|
def ProductId(self):
|
|
5701
|
+
"""Unique ID of a Tencent Cloud service
|
|
5702
|
+
:rtype: str
|
|
5703
|
+
"""
|
|
4917
5704
|
return self._ProductId
|
|
4918
5705
|
|
|
4919
5706
|
@ProductId.setter
|
|
@@ -4922,6 +5709,9 @@ class UnbindCloudResourceRequest(AbstractModel):
|
|
|
4922
5709
|
|
|
4923
5710
|
@property
|
|
4924
5711
|
def ResourceId(self):
|
|
5712
|
+
"""Resource/instance ID, which is stored as a string and defined by the caller based on the Tencent Cloud service’s features.
|
|
5713
|
+
:rtype: str
|
|
5714
|
+
"""
|
|
4925
5715
|
return self._ResourceId
|
|
4926
5716
|
|
|
4927
5717
|
@ResourceId.setter
|
|
@@ -4957,6 +5747,9 @@ class UnbindCloudResourceResponse(AbstractModel):
|
|
|
4957
5747
|
|
|
4958
5748
|
@property
|
|
4959
5749
|
def RequestId(self):
|
|
5750
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
5751
|
+
:rtype: str
|
|
5752
|
+
"""
|
|
4960
5753
|
return self._RequestId
|
|
4961
5754
|
|
|
4962
5755
|
@RequestId.setter
|
|
@@ -4985,6 +5778,9 @@ class UpdateAliasRequest(AbstractModel):
|
|
|
4985
5778
|
|
|
4986
5779
|
@property
|
|
4987
5780
|
def Alias(self):
|
|
5781
|
+
"""New alias containing 1-60 characters or digits
|
|
5782
|
+
:rtype: str
|
|
5783
|
+
"""
|
|
4988
5784
|
return self._Alias
|
|
4989
5785
|
|
|
4990
5786
|
@Alias.setter
|
|
@@ -4993,6 +5789,9 @@ class UpdateAliasRequest(AbstractModel):
|
|
|
4993
5789
|
|
|
4994
5790
|
@property
|
|
4995
5791
|
def KeyId(self):
|
|
5792
|
+
"""Globally unique CMK ID
|
|
5793
|
+
:rtype: str
|
|
5794
|
+
"""
|
|
4996
5795
|
return self._KeyId
|
|
4997
5796
|
|
|
4998
5797
|
@KeyId.setter
|
|
@@ -5027,6 +5826,9 @@ class UpdateAliasResponse(AbstractModel):
|
|
|
5027
5826
|
|
|
5028
5827
|
@property
|
|
5029
5828
|
def RequestId(self):
|
|
5829
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
5830
|
+
:rtype: str
|
|
5831
|
+
"""
|
|
5030
5832
|
return self._RequestId
|
|
5031
5833
|
|
|
5032
5834
|
@RequestId.setter
|
|
@@ -5055,6 +5857,9 @@ class UpdateKeyDescriptionRequest(AbstractModel):
|
|
|
5055
5857
|
|
|
5056
5858
|
@property
|
|
5057
5859
|
def Description(self):
|
|
5860
|
+
"""New description of up to 1,024 bytes in length
|
|
5861
|
+
:rtype: str
|
|
5862
|
+
"""
|
|
5058
5863
|
return self._Description
|
|
5059
5864
|
|
|
5060
5865
|
@Description.setter
|
|
@@ -5063,6 +5868,9 @@ class UpdateKeyDescriptionRequest(AbstractModel):
|
|
|
5063
5868
|
|
|
5064
5869
|
@property
|
|
5065
5870
|
def KeyId(self):
|
|
5871
|
+
"""ID of the CMK for which to modify the description
|
|
5872
|
+
:rtype: str
|
|
5873
|
+
"""
|
|
5066
5874
|
return self._KeyId
|
|
5067
5875
|
|
|
5068
5876
|
@KeyId.setter
|
|
@@ -5097,6 +5905,9 @@ class UpdateKeyDescriptionResponse(AbstractModel):
|
|
|
5097
5905
|
|
|
5098
5906
|
@property
|
|
5099
5907
|
def RequestId(self):
|
|
5908
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
5909
|
+
:rtype: str
|
|
5910
|
+
"""
|
|
5100
5911
|
return self._RequestId
|
|
5101
5912
|
|
|
5102
5913
|
@RequestId.setter
|
|
@@ -5134,6 +5945,9 @@ class VerifyByAsymmetricKeyRequest(AbstractModel):
|
|
|
5134
5945
|
|
|
5135
5946
|
@property
|
|
5136
5947
|
def KeyId(self):
|
|
5948
|
+
"""Unique ID of a key
|
|
5949
|
+
:rtype: str
|
|
5950
|
+
"""
|
|
5137
5951
|
return self._KeyId
|
|
5138
5952
|
|
|
5139
5953
|
@KeyId.setter
|
|
@@ -5142,6 +5956,9 @@ class VerifyByAsymmetricKeyRequest(AbstractModel):
|
|
|
5142
5956
|
|
|
5143
5957
|
@property
|
|
5144
5958
|
def SignatureValue(self):
|
|
5959
|
+
"""Signature value, which is generated by calling the KMS signature API.
|
|
5960
|
+
:rtype: str
|
|
5961
|
+
"""
|
|
5145
5962
|
return self._SignatureValue
|
|
5146
5963
|
|
|
5147
5964
|
@SignatureValue.setter
|
|
@@ -5150,6 +5967,9 @@ class VerifyByAsymmetricKeyRequest(AbstractModel):
|
|
|
5150
5967
|
|
|
5151
5968
|
@property
|
|
5152
5969
|
def Message(self):
|
|
5970
|
+
"""Full message or message abstract. Before Base64 encoding, an original message can contain up to 4,096 bytes while a message abstract must be 32 bytes.
|
|
5971
|
+
:rtype: str
|
|
5972
|
+
"""
|
|
5153
5973
|
return self._Message
|
|
5154
5974
|
|
|
5155
5975
|
@Message.setter
|
|
@@ -5158,6 +5978,9 @@ class VerifyByAsymmetricKeyRequest(AbstractModel):
|
|
|
5158
5978
|
|
|
5159
5979
|
@property
|
|
5160
5980
|
def Algorithm(self):
|
|
5981
|
+
"""Signature algorithm. The valid values include `SM2DSA`, `ECC_P256_R1`, `RSA_PSS_SHA_256`, and `RSA_PKCS1_SHA_256`, etc. You can get a full list of supported algorithms using the ListAlgorithms API.
|
|
5982
|
+
:rtype: str
|
|
5983
|
+
"""
|
|
5161
5984
|
return self._Algorithm
|
|
5162
5985
|
|
|
5163
5986
|
@Algorithm.setter
|
|
@@ -5166,6 +5989,9 @@ class VerifyByAsymmetricKeyRequest(AbstractModel):
|
|
|
5166
5989
|
|
|
5167
5990
|
@property
|
|
5168
5991
|
def MessageType(self):
|
|
5992
|
+
"""Message type. Valid values: `RAW` (indicating an original message; used by default if the parameter is not passed in) and `DIGEST`.
|
|
5993
|
+
:rtype: str
|
|
5994
|
+
"""
|
|
5169
5995
|
return self._MessageType
|
|
5170
5996
|
|
|
5171
5997
|
@MessageType.setter
|
|
@@ -5206,6 +6032,9 @@ class VerifyByAsymmetricKeyResponse(AbstractModel):
|
|
|
5206
6032
|
|
|
5207
6033
|
@property
|
|
5208
6034
|
def SignatureValid(self):
|
|
6035
|
+
"""Whether the signature is valid. `true`: the signature is valid; `false`: the signature is invalid.
|
|
6036
|
+
:rtype: bool
|
|
6037
|
+
"""
|
|
5209
6038
|
return self._SignatureValid
|
|
5210
6039
|
|
|
5211
6040
|
@SignatureValid.setter
|
|
@@ -5214,6 +6043,9 @@ class VerifyByAsymmetricKeyResponse(AbstractModel):
|
|
|
5214
6043
|
|
|
5215
6044
|
@property
|
|
5216
6045
|
def RequestId(self):
|
|
6046
|
+
"""The unique request ID, which is returned for each request. RequestId is required for locating a problem.
|
|
6047
|
+
:rtype: str
|
|
6048
|
+
"""
|
|
5217
6049
|
return self._RequestId
|
|
5218
6050
|
|
|
5219
6051
|
@RequestId.setter
|
|
@@ -5274,6 +6106,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
5274
6106
|
|
|
5275
6107
|
@property
|
|
5276
6108
|
def KeyId(self):
|
|
6109
|
+
"""Globally unique white-box key ID
|
|
6110
|
+
:rtype: str
|
|
6111
|
+
"""
|
|
5277
6112
|
return self._KeyId
|
|
5278
6113
|
|
|
5279
6114
|
@KeyId.setter
|
|
@@ -5282,6 +6117,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
5282
6117
|
|
|
5283
6118
|
@property
|
|
5284
6119
|
def Alias(self):
|
|
6120
|
+
"""Unique alias that makes a key more recognizable and understandable. This parameter cannot be empty, can contain 1 to 60 letters, digits, hyphens (-), and underscores (_), and must begin with a letter or digit.
|
|
6121
|
+
:rtype: str
|
|
6122
|
+
"""
|
|
5285
6123
|
return self._Alias
|
|
5286
6124
|
|
|
5287
6125
|
@Alias.setter
|
|
@@ -5290,6 +6128,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
5290
6128
|
|
|
5291
6129
|
@property
|
|
5292
6130
|
def CreatorUin(self):
|
|
6131
|
+
"""Creator
|
|
6132
|
+
:rtype: int
|
|
6133
|
+
"""
|
|
5293
6134
|
return self._CreatorUin
|
|
5294
6135
|
|
|
5295
6136
|
@CreatorUin.setter
|
|
@@ -5298,6 +6139,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
5298
6139
|
|
|
5299
6140
|
@property
|
|
5300
6141
|
def Description(self):
|
|
6142
|
+
"""Key description information
|
|
6143
|
+
:rtype: str
|
|
6144
|
+
"""
|
|
5301
6145
|
return self._Description
|
|
5302
6146
|
|
|
5303
6147
|
@Description.setter
|
|
@@ -5306,6 +6150,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
5306
6150
|
|
|
5307
6151
|
@property
|
|
5308
6152
|
def CreateTime(self):
|
|
6153
|
+
"""Key creation time in Unix timestamp
|
|
6154
|
+
:rtype: int
|
|
6155
|
+
"""
|
|
5309
6156
|
return self._CreateTime
|
|
5310
6157
|
|
|
5311
6158
|
@CreateTime.setter
|
|
@@ -5314,6 +6161,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
5314
6161
|
|
|
5315
6162
|
@property
|
|
5316
6163
|
def Status(self):
|
|
6164
|
+
"""White-box key status. Valid values: Enabled, Disabled
|
|
6165
|
+
:rtype: str
|
|
6166
|
+
"""
|
|
5317
6167
|
return self._Status
|
|
5318
6168
|
|
|
5319
6169
|
@Status.setter
|
|
@@ -5322,6 +6172,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
5322
6172
|
|
|
5323
6173
|
@property
|
|
5324
6174
|
def OwnerUin(self):
|
|
6175
|
+
"""Creator
|
|
6176
|
+
:rtype: int
|
|
6177
|
+
"""
|
|
5325
6178
|
return self._OwnerUin
|
|
5326
6179
|
|
|
5327
6180
|
@OwnerUin.setter
|
|
@@ -5330,6 +6183,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
5330
6183
|
|
|
5331
6184
|
@property
|
|
5332
6185
|
def Algorithm(self):
|
|
6186
|
+
"""Key algorithm type
|
|
6187
|
+
:rtype: str
|
|
6188
|
+
"""
|
|
5333
6189
|
return self._Algorithm
|
|
5334
6190
|
|
|
5335
6191
|
@Algorithm.setter
|
|
@@ -5338,6 +6194,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
5338
6194
|
|
|
5339
6195
|
@property
|
|
5340
6196
|
def EncryptKey(self):
|
|
6197
|
+
"""Base64-encoded white-box encryption key
|
|
6198
|
+
:rtype: str
|
|
6199
|
+
"""
|
|
5341
6200
|
return self._EncryptKey
|
|
5342
6201
|
|
|
5343
6202
|
@EncryptKey.setter
|
|
@@ -5346,6 +6205,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
5346
6205
|
|
|
5347
6206
|
@property
|
|
5348
6207
|
def DecryptKey(self):
|
|
6208
|
+
"""Base64-encoded white-box decryption key
|
|
6209
|
+
:rtype: str
|
|
6210
|
+
"""
|
|
5349
6211
|
return self._DecryptKey
|
|
5350
6212
|
|
|
5351
6213
|
@DecryptKey.setter
|
|
@@ -5354,6 +6216,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
5354
6216
|
|
|
5355
6217
|
@property
|
|
5356
6218
|
def ResourceId(self):
|
|
6219
|
+
"""Resource ID in the format of `creatorUin/$creatorUin/$keyId`
|
|
6220
|
+
:rtype: str
|
|
6221
|
+
"""
|
|
5357
6222
|
return self._ResourceId
|
|
5358
6223
|
|
|
5359
6224
|
@ResourceId.setter
|
|
@@ -5362,6 +6227,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
5362
6227
|
|
|
5363
6228
|
@property
|
|
5364
6229
|
def DeviceFingerprintBind(self):
|
|
6230
|
+
"""Whether there is a device fingerprint bound to the current key
|
|
6231
|
+
Note: this field may return null, indicating that no valid values can be obtained.
|
|
6232
|
+
:rtype: bool
|
|
6233
|
+
"""
|
|
5365
6234
|
return self._DeviceFingerprintBind
|
|
5366
6235
|
|
|
5367
6236
|
@DeviceFingerprintBind.setter
|