tencentcloud-sdk-python-intl-en 3.0.1075__py2.py3-none-any.whl → 3.0.1076__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.

Files changed (122) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/advisor/v20200721/models.py +120 -0
  3. tencentcloud/aiart/v20221229/models.py +95 -0
  4. tencentcloud/ams/v20201229/models.py +432 -0
  5. tencentcloud/antiddos/v20200309/models.py +2806 -0
  6. tencentcloud/apigateway/v20180808/models.py +3945 -0
  7. tencentcloud/autoscaling/v20180419/models.py +2449 -5
  8. tencentcloud/batch/v20170312/models.py +1566 -0
  9. tencentcloud/billing/v20180709/models.py +2418 -0
  10. tencentcloud/cam/v20190116/models.py +1697 -0
  11. tencentcloud/captcha/v20190722/models.py +70 -0
  12. tencentcloud/car/v20220110/models.py +803 -0
  13. tencentcloud/cbs/v20170312/models.py +1245 -0
  14. tencentcloud/ccc/v20200210/models.py +1949 -1
  15. tencentcloud/cdb/v20170320/models.py +4821 -0
  16. tencentcloud/cdn/v20180606/models.py +4870 -8
  17. tencentcloud/cdwdoris/v20211228/models.py +3337 -0
  18. tencentcloud/cfg/v20210820/models.py +1194 -0
  19. tencentcloud/cfs/v20190719/models.py +1178 -0
  20. tencentcloud/cfw/v20190904/models.py +2378 -0
  21. tencentcloud/chdfs/v20201112/models.py +513 -0
  22. tencentcloud/ciam/v20210420/models.py +49 -0
  23. tencentcloud/ciam/v20220331/models.py +789 -0
  24. tencentcloud/ckafka/v20190819/models.py +2576 -0
  25. tencentcloud/clb/v20180317/models.py +3220 -1
  26. tencentcloud/cloudaudit/v20190319/models.py +519 -0
  27. tencentcloud/cls/v20201016/models.py +3652 -1
  28. tencentcloud/cmq/v20190304/models.py +571 -0
  29. tencentcloud/controlcenter/v20230110/models.py +15 -0
  30. tencentcloud/csip/v20221121/models.py +2881 -2
  31. tencentcloud/cvm/v20170312/models.py +2827 -0
  32. tencentcloud/cwp/v20180228/models.py +16412 -0
  33. tencentcloud/cynosdb/v20190107/models.py +4263 -0
  34. tencentcloud/dataintegration/v20220613/models.py +18 -0
  35. tencentcloud/dayu/v20180709/models.py +3541 -12
  36. tencentcloud/dbbrain/v20191016/models.py +1056 -0
  37. tencentcloud/dbbrain/v20210527/models.py +1763 -0
  38. tencentcloud/dc/v20180410/models.py +767 -0
  39. tencentcloud/dcdb/v20180411/models.py +2335 -0
  40. tencentcloud/dlc/v20210125/models.py +3985 -5
  41. tencentcloud/dms/v20200819/models.py +51 -0
  42. tencentcloud/dnspod/v20210323/models.py +1286 -0
  43. tencentcloud/domain/v20180808/models.py +855 -0
  44. tencentcloud/dts/v20180330/models.py +791 -0
  45. tencentcloud/dts/v20211206/models.py +2317 -1
  46. tencentcloud/eb/v20210416/models.py +858 -0
  47. tencentcloud/ecdn/v20191012/models.py +811 -0
  48. tencentcloud/ecm/v20190719/models.py +3972 -1
  49. tencentcloud/eiam/v20210420/models.py +1265 -0
  50. tencentcloud/emr/v20190103/models.py +2926 -7
  51. tencentcloud/es/v20180416/models.py +1523 -0
  52. tencentcloud/facefusion/v20220927/models.py +211 -0
  53. tencentcloud/faceid/v20180301/models.py +2071 -0
  54. tencentcloud/gaap/v20180529/models.py +3103 -8
  55. tencentcloud/gme/v20180711/models.py +388 -0
  56. tencentcloud/gpm/v20200820/models.py +674 -0
  57. tencentcloud/gse/v20191112/models.py +972 -0
  58. tencentcloud/iai/v20200303/models.py +1430 -0
  59. tencentcloud/ims/v20201229/models.py +329 -0
  60. tencentcloud/intlpartnersmgt/v20220928/models.py +988 -0
  61. tencentcloud/iotcloud/v20210408/models.py +585 -0
  62. tencentcloud/ip/v20210409/models.py +178 -0
  63. tencentcloud/kms/v20190118/models.py +869 -0
  64. tencentcloud/lcic/v20220817/models.py +1658 -0
  65. tencentcloud/lighthouse/v20200324/models.py +2088 -0
  66. tencentcloud/live/v20180801/models.py +4287 -0
  67. tencentcloud/mariadb/v20170312/models.py +1905 -0
  68. tencentcloud/mdc/v20200828/models.py +1104 -0
  69. tencentcloud/mdl/v20200326/models.py +1911 -1
  70. tencentcloud/mdp/v20200527/models.py +452 -0
  71. tencentcloud/mongodb/v20190725/models.py +1234 -0
  72. tencentcloud/monitor/v20180724/models.py +5798 -2
  73. tencentcloud/mps/v20190612/models.py +8135 -0
  74. tencentcloud/msp/v20180319/models.py +183 -0
  75. tencentcloud/ocr/v20181119/models.py +3160 -1
  76. tencentcloud/omics/v20221128/models.py +1086 -0
  77. tencentcloud/organization/v20181225/models.py +285 -0
  78. tencentcloud/organization/v20210331/models.py +2267 -0
  79. tencentcloud/postgres/v20170312/models.py +3248 -0
  80. tencentcloud/privatedns/v20201028/errorcodes.py +34 -1
  81. tencentcloud/privatedns/v20201028/models.py +1700 -0
  82. tencentcloud/privatedns/v20201028/privatedns_client.py +115 -0
  83. tencentcloud/redis/v20180412/models.py +3298 -3
  84. tencentcloud/rum/v20210622/models.py +2114 -0
  85. tencentcloud/scf/v20180416/models.py +1561 -0
  86. tencentcloud/ses/v20201002/models.py +649 -0
  87. tencentcloud/sms/v20190711/models.py +575 -0
  88. tencentcloud/sms/v20210111/models.py +593 -0
  89. tencentcloud/sqlserver/v20180328/models.py +2780 -0
  90. tencentcloud/ssl/v20191205/models.py +2267 -0
  91. tencentcloud/ssm/v20190923/models.py +678 -0
  92. tencentcloud/sts/v20180813/models.py +161 -0
  93. tencentcloud/tag/v20180813/models.py +784 -0
  94. tencentcloud/tat/v20201028/models.py +806 -0
  95. tencentcloud/tcaplusdb/v20190823/models.py +1860 -0
  96. tencentcloud/tchd/v20230306/models.py +41 -0
  97. tencentcloud/tcmpp/v20240801/models.py +3761 -1
  98. tencentcloud/tcr/v20190924/models.py +1851 -0
  99. tencentcloud/tcss/v20201101/models.py +12523 -0
  100. tencentcloud/tdid/v20210519/models.py +1258 -0
  101. tencentcloud/tdmq/v20200217/models.py +3495 -0
  102. tencentcloud/tem/v20201221/models.py +803 -0
  103. tencentcloud/tem/v20210701/models.py +2551 -1
  104. tencentcloud/teo/v20220106/models.py +4731 -0
  105. tencentcloud/teo/v20220901/models.py +6066 -0
  106. tencentcloud/tiw/v20190919/models.py +1678 -1
  107. tencentcloud/tke/v20180525/models.py +3662 -0
  108. tencentcloud/tms/v20201229/models.py +176 -0
  109. tencentcloud/tmt/v20180321/models.py +65 -0
  110. tencentcloud/trtc/v20190722/models.py +1698 -8
  111. tencentcloud/tts/v20190823/models.py +72 -0
  112. tencentcloud/vm/v20201229/models.py +568 -0
  113. tencentcloud/vm/v20210922/models.py +636 -0
  114. tencentcloud/vod/v20180717/models.py +13490 -1
  115. tencentcloud/vpc/v20170312/models.py +6543 -1
  116. tencentcloud/waf/v20180125/models.py +4814 -0
  117. tencentcloud/wedata/v20210820/models.py +12594 -0
  118. tencentcloud/yunjing/v20180228/models.py +1867 -0
  119. {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/METADATA +1 -1
  120. {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/RECORD +122 -122
  121. {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/WHEEL +0 -0
  122. {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/top_level.txt +0 -0
@@ -77,6 +77,9 @@ If this parameter is not specified, `False` will be used by default.
77
77
 
78
78
  @property
79
79
  def SecretName(self):
80
+ """Credential name, which must be unique in the same region. It can contain 128 bytes of letters, digits, hyphens, and underscores and must begin with a letter or digit.
81
+ :rtype: str
82
+ """
80
83
  return self._SecretName
81
84
 
82
85
  @SecretName.setter
@@ -85,6 +88,15 @@ If this parameter is not specified, `False` will be used by default.
85
88
 
86
89
  @property
87
90
  def UserNamePrefix(self):
91
+ """Prefix of the user account name, which is specified by you and can contain up to 8 characters.
92
+ Supported character sets include:
93
+ Digits: [0, 9].
94
+ Lowercase letters: [a, z].
95
+ Uppercase letters: [A, Z].
96
+ Special symbols: underscore.
97
+ The prefix must begin with a letter.
98
+ :rtype: str
99
+ """
88
100
  return self._UserNamePrefix
89
101
 
90
102
  @UserNamePrefix.setter
@@ -93,6 +105,9 @@ If this parameter is not specified, `False` will be used by default.
93
105
 
94
106
  @property
95
107
  def ProductName(self):
108
+ """Name of the Tencent Cloud service bound to the credential, such as `Mysql`. The `DescribeSupportedProducts` API can be used to get the names of the supported Tencent Cloud services.
109
+ :rtype: str
110
+ """
96
111
  return self._ProductName
97
112
 
98
113
  @ProductName.setter
@@ -101,6 +116,9 @@ If this parameter is not specified, `False` will be used by default.
101
116
 
102
117
  @property
103
118
  def InstanceID(self):
119
+ """Tencent Cloud service instance ID.
120
+ :rtype: str
121
+ """
104
122
  return self._InstanceID
105
123
 
106
124
  @InstanceID.setter
@@ -109,6 +127,9 @@ If this parameter is not specified, `False` will be used by default.
109
127
 
110
128
  @property
111
129
  def Domains(self):
130
+ """Domain name of the account in the form of IP. You can enter `%`.
131
+ :rtype: list of str
132
+ """
112
133
  return self._Domains
113
134
 
114
135
  @Domains.setter
@@ -117,6 +138,9 @@ If this parameter is not specified, `False` will be used by default.
117
138
 
118
139
  @property
119
140
  def PrivilegesList(self):
141
+ """List of permissions that need to be granted when the credential is bound to a Tencent Cloud service.
142
+ :rtype: list of ProductPrivilegeUnit
143
+ """
120
144
  return self._PrivilegesList
121
145
 
122
146
  @PrivilegesList.setter
@@ -125,6 +149,9 @@ If this parameter is not specified, `False` will be used by default.
125
149
 
126
150
  @property
127
151
  def Description(self):
152
+ """Description, which is used to describe the purpose in detail and can contain up to 2,048 bytes.
153
+ :rtype: str
154
+ """
128
155
  return self._Description
129
156
 
130
157
  @Description.setter
@@ -133,6 +160,11 @@ If this parameter is not specified, `False` will be used by default.
133
160
 
134
161
  @property
135
162
  def KmsKeyId(self):
163
+ """Specifies the KMS CMK that encrypts the credential.
164
+ If this parameter is left empty, the CMK created by Secrets Manager by default will be used for encryption.
165
+ You can also specify a custom KMS CMK created in the same region for encryption.
166
+ :rtype: str
167
+ """
136
168
  return self._KmsKeyId
137
169
 
138
170
  @KmsKeyId.setter
@@ -141,6 +173,9 @@ If this parameter is not specified, `False` will be used by default.
141
173
 
142
174
  @property
143
175
  def Tags(self):
176
+ """List of tags.
177
+ :rtype: list of Tag
178
+ """
144
179
  return self._Tags
145
180
 
146
181
  @Tags.setter
@@ -149,6 +184,10 @@ If this parameter is not specified, `False` will be used by default.
149
184
 
150
185
  @property
151
186
  def RotationBeginTime(self):
187
+ """User-Defined rotation start time in the format of 2006-01-02 15:04:05.
188
+ When `EnableRotation` is `True`, this parameter is required.
189
+ :rtype: str
190
+ """
152
191
  return self._RotationBeginTime
153
192
 
154
193
  @RotationBeginTime.setter
@@ -157,6 +196,12 @@ If this parameter is not specified, `False` will be used by default.
157
196
 
158
197
  @property
159
198
  def EnableRotation(self):
199
+ """Specifies whether to enable rotation
200
+ True - enable
201
+ False - do not enable
202
+ If this parameter is not specified, `False` will be used by default.
203
+ :rtype: bool
204
+ """
160
205
  return self._EnableRotation
161
206
 
162
207
  @EnableRotation.setter
@@ -165,6 +210,9 @@ If this parameter is not specified, `False` will be used by default.
165
210
 
166
211
  @property
167
212
  def RotationFrequency(self):
213
+ """Rotation frequency in days. Default value: 1 day.
214
+ :rtype: int
215
+ """
168
216
  return self._RotationFrequency
169
217
 
170
218
  @RotationFrequency.setter
@@ -234,6 +282,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
234
282
 
235
283
  @property
236
284
  def SecretName(self):
285
+ """Name of the created credential.
286
+ :rtype: str
287
+ """
237
288
  return self._SecretName
238
289
 
239
290
  @SecretName.setter
@@ -242,6 +293,11 @@ Note: this field may return null, indicating that no valid values can be obtaine
242
293
 
243
294
  @property
244
295
  def TagCode(self):
296
+ """Tag operation return code. 0: success; 1: internal error; 2: business processing error.
297
+ Note: this field may return null, indicating that no valid values can be obtained.
298
+ Note: this field may return null, indicating that no valid values can be obtained.
299
+ :rtype: int
300
+ """
245
301
  return self._TagCode
246
302
 
247
303
  @TagCode.setter
@@ -250,6 +306,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
250
306
 
251
307
  @property
252
308
  def TagMsg(self):
309
+ """Tag operation return message.
310
+ Note: this field may return null, indicating that no valid values can be obtained.
311
+ :rtype: str
312
+ """
253
313
  return self._TagMsg
254
314
 
255
315
  @TagMsg.setter
@@ -258,6 +318,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
258
318
 
259
319
  @property
260
320
  def FlowID(self):
321
+ """ID of the created Tencent Cloud service credential async task.
322
+ :rtype: int
323
+ """
261
324
  return self._FlowID
262
325
 
263
326
  @FlowID.setter
@@ -266,6 +329,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
266
329
 
267
330
  @property
268
331
  def RequestId(self):
332
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
333
+ :rtype: str
334
+ """
269
335
  return self._RequestId
270
336
 
271
337
  @RequestId.setter
@@ -312,6 +378,9 @@ You can also specify a custom KMS CMK created in the same region for encryption.
312
378
 
313
379
  @property
314
380
  def SecretName(self):
381
+ """Secret name, which must be unique in the same region. It can contain 128 bytes of letters, digits, hyphens and underscores and must begin with a letter or digit.
382
+ :rtype: str
383
+ """
315
384
  return self._SecretName
316
385
 
317
386
  @SecretName.setter
@@ -320,6 +389,9 @@ You can also specify a custom KMS CMK created in the same region for encryption.
320
389
 
321
390
  @property
322
391
  def ProjectId(self):
392
+ """ID of the project to which the created SSH key belongs.
393
+ :rtype: int
394
+ """
323
395
  return self._ProjectId
324
396
 
325
397
  @ProjectId.setter
@@ -328,6 +400,9 @@ You can also specify a custom KMS CMK created in the same region for encryption.
328
400
 
329
401
  @property
330
402
  def Description(self):
403
+ """Description, such as what it is used for. It contains up to 2,048 bytes.
404
+ :rtype: str
405
+ """
331
406
  return self._Description
332
407
 
333
408
  @Description.setter
@@ -336,6 +411,11 @@ You can also specify a custom KMS CMK created in the same region for encryption.
336
411
 
337
412
  @property
338
413
  def KmsKeyId(self):
414
+ """Specifies a KMS CMK to encrypt the secret.
415
+ If this parameter is left empty, the CMK created by Secrets Manager by default will be used for encryption.
416
+ You can also specify a custom KMS CMK created in the same region for encryption.
417
+ :rtype: str
418
+ """
339
419
  return self._KmsKeyId
340
420
 
341
421
  @KmsKeyId.setter
@@ -344,6 +424,9 @@ You can also specify a custom KMS CMK created in the same region for encryption.
344
424
 
345
425
  @property
346
426
  def Tags(self):
427
+ """List of tags.
428
+ :rtype: list of Tag
429
+ """
347
430
  return self._Tags
348
431
 
349
432
  @Tags.setter
@@ -352,6 +435,9 @@ You can also specify a custom KMS CMK created in the same region for encryption.
352
435
 
353
436
  @property
354
437
  def SSHKeyName(self):
438
+ """Name of the SSH key pair, which only contains digits, letters and underscores and must start with a digit or letter. The maximum length is 25 characters.
439
+ :rtype: str
440
+ """
355
441
  return self._SSHKeyName
356
442
 
357
443
  @SSHKeyName.setter
@@ -412,6 +498,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
412
498
 
413
499
  @property
414
500
  def SecretName(self):
501
+ """Name of the created secret.
502
+ :rtype: str
503
+ """
415
504
  return self._SecretName
416
505
 
417
506
  @SecretName.setter
@@ -420,6 +509,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
420
509
 
421
510
  @property
422
511
  def SSHKeyID(self):
512
+ """ID of the created SSH key.
513
+ :rtype: str
514
+ """
423
515
  return self._SSHKeyID
424
516
 
425
517
  @SSHKeyID.setter
@@ -428,6 +520,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
428
520
 
429
521
  @property
430
522
  def SSHKeyName(self):
523
+ """Name of the created SSH key.
524
+ :rtype: str
525
+ """
431
526
  return self._SSHKeyName
432
527
 
433
528
  @SSHKeyName.setter
@@ -436,6 +531,10 @@ Note: this field may return `null`, indicating that no valid values can be obtai
436
531
 
437
532
  @property
438
533
  def TagCode(self):
534
+ """Tag return code. `0`: success; `1`: internal error; `2`: business processing error.
535
+ Note: this field may return `null`, indicating that no valid values can be obtained.
536
+ :rtype: int
537
+ """
439
538
  return self._TagCode
440
539
 
441
540
  @TagCode.setter
@@ -444,6 +543,10 @@ Note: this field may return `null`, indicating that no valid values can be obtai
444
543
 
445
544
  @property
446
545
  def TagMsg(self):
546
+ """Tag return message.
547
+ Note: this field may return `null`, indicating that no valid values can be obtained.
548
+ :rtype: str
549
+ """
447
550
  return self._TagMsg
448
551
 
449
552
  @TagMsg.setter
@@ -452,6 +555,9 @@ Note: this field may return `null`, indicating that no valid values can be obtai
452
555
 
453
556
  @property
454
557
  def RequestId(self):
558
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
559
+ :rtype: str
560
+ """
455
561
  return self._RequestId
456
562
 
457
563
  @RequestId.setter
@@ -506,6 +612,9 @@ class CreateSecretRequest(AbstractModel):
506
612
 
507
613
  @property
508
614
  def SecretName(self):
615
+ """Secret name, which must be unique in the same region. It can contain 128 bytes ([a-z], [A-Z], [0-9], [-_]). It must begin with a letter or digit. Note that it cannot be modified once created.
616
+ :rtype: str
617
+ """
509
618
  return self._SecretName
510
619
 
511
620
  @SecretName.setter
@@ -514,6 +623,9 @@ class CreateSecretRequest(AbstractModel):
514
623
 
515
624
  @property
516
625
  def VersionId(self):
626
+ """Secret version. It can contain up to 64 bytes ([a-z], [A-Z], [0-9], [-_.]). It must begin with a letter or digit. `SecretName` and `VersionId` are used to query the Secret information. If it is left empty, the initial Secret version number is used by default.
627
+ :rtype: str
628
+ """
517
629
  return self._VersionId
518
630
 
519
631
  @VersionId.setter
@@ -522,6 +634,9 @@ class CreateSecretRequest(AbstractModel):
522
634
 
523
635
  @property
524
636
  def Description(self):
637
+ """Description information, such as the detailed use cases. It can be up to 2048 bytes.
638
+ :rtype: str
639
+ """
525
640
  return self._Description
526
641
 
527
642
  @Description.setter
@@ -530,6 +645,9 @@ class CreateSecretRequest(AbstractModel):
530
645
 
531
646
  @property
532
647
  def KmsKeyId(self):
648
+ """KMS CMK used for Secret encryption. If this parameter is left empty, SecretsManager will create a CMK by default. You can also specify a KMS CMK that is created in the same region.
649
+ :rtype: str
650
+ """
533
651
  return self._KmsKeyId
534
652
 
535
653
  @KmsKeyId.setter
@@ -538,6 +656,9 @@ class CreateSecretRequest(AbstractModel):
538
656
 
539
657
  @property
540
658
  def SecretType(self):
659
+ """Secret type. It defaults to `custom`.
660
+ :rtype: int
661
+ """
541
662
  return self._SecretType
542
663
 
543
664
  @SecretType.setter
@@ -546,6 +667,9 @@ class CreateSecretRequest(AbstractModel):
546
667
 
547
668
  @property
548
669
  def SecretBinary(self):
670
+ """Base64-encoded plaintext of a binary Secret. Either `SecretBinary` or `SecretString` must be set. A maximum of 4096 bytes is supported.
671
+ :rtype: str
672
+ """
549
673
  return self._SecretBinary
550
674
 
551
675
  @SecretBinary.setter
@@ -554,6 +678,9 @@ class CreateSecretRequest(AbstractModel):
554
678
 
555
679
  @property
556
680
  def SecretString(self):
681
+ """Plaintext of a Secret, in text format. Base64 encoding is not required. Either `SecretBinary` or `SecretString` must be set. A maximum of 4096 bytes is supported.
682
+ :rtype: str
683
+ """
557
684
  return self._SecretString
558
685
 
559
686
  @SecretString.setter
@@ -562,6 +689,9 @@ class CreateSecretRequest(AbstractModel):
562
689
 
563
690
  @property
564
691
  def AdditionalConfig(self):
692
+ """Additional configuration of the Secret in JSON format
693
+ :rtype: str
694
+ """
565
695
  return self._AdditionalConfig
566
696
 
567
697
  @AdditionalConfig.setter
@@ -570,6 +700,9 @@ class CreateSecretRequest(AbstractModel):
570
700
 
571
701
  @property
572
702
  def Tags(self):
703
+ """List of tags.
704
+ :rtype: list of Tag
705
+ """
573
706
  return self._Tags
574
707
 
575
708
  @Tags.setter
@@ -630,6 +763,9 @@ Note: This field may return `null`, indicating that no valid value was found.
630
763
 
631
764
  @property
632
765
  def SecretName(self):
766
+ """Name of the new Secret.
767
+ :rtype: str
768
+ """
633
769
  return self._SecretName
634
770
 
635
771
  @SecretName.setter
@@ -638,6 +774,9 @@ Note: This field may return `null`, indicating that no valid value was found.
638
774
 
639
775
  @property
640
776
  def VersionId(self):
777
+ """ID of the new Secret version.
778
+ :rtype: str
779
+ """
641
780
  return self._VersionId
642
781
 
643
782
  @VersionId.setter
@@ -646,6 +785,10 @@ Note: This field may return `null`, indicating that no valid value was found.
646
785
 
647
786
  @property
648
787
  def TagCode(self):
788
+ """Return code of tag operation. `0`: success; `1`: internal error; `2`: business processing error
789
+ Note: This field may return `null`, indicating that no valid value was found.
790
+ :rtype: int
791
+ """
649
792
  return self._TagCode
650
793
 
651
794
  @TagCode.setter
@@ -654,6 +797,10 @@ Note: This field may return `null`, indicating that no valid value was found.
654
797
 
655
798
  @property
656
799
  def TagMsg(self):
800
+ """Return message of tag operation.
801
+ Note: This field may return `null`, indicating that no valid value was found.
802
+ :rtype: str
803
+ """
657
804
  return self._TagMsg
658
805
 
659
806
  @TagMsg.setter
@@ -662,6 +809,9 @@ Note: This field may return `null`, indicating that no valid value was found.
662
809
 
663
810
  @property
664
811
  def RequestId(self):
812
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
813
+ :rtype: str
814
+ """
665
815
  return self._RequestId
666
816
 
667
817
  @RequestId.setter
@@ -700,6 +850,9 @@ For an SSH key secret, this field can only be `0`.
700
850
 
701
851
  @property
702
852
  def SecretName(self):
853
+ """Name of the Secret to be deleted.
854
+ :rtype: str
855
+ """
703
856
  return self._SecretName
704
857
 
705
858
  @SecretName.setter
@@ -708,6 +861,10 @@ For an SSH key secret, this field can only be `0`.
708
861
 
709
862
  @property
710
863
  def RecoveryWindowInDays(self):
864
+ """Scheduled deletion time (in days), indicating the number of retention days for the secret. Value range: 0-30. If it is `0`, the secret is deleted immediately.
865
+ For an SSH key secret, this field can only be `0`.
866
+ :rtype: int
867
+ """
711
868
  return self._RecoveryWindowInDays
712
869
 
713
870
  @RecoveryWindowInDays.setter
@@ -716,6 +873,11 @@ For an SSH key secret, this field can only be `0`.
716
873
 
717
874
  @property
718
875
  def CleanSSHKey(self):
876
+ """Specifies whether to delete the SSH key from both the secret and the SSH key list in the CVM console. This field is only valid for SSH key secrets. Valid values:
877
+ `True`: deletes SSH key from both the secret and SSH key list in the CVM console. Note that the deletion will fail if the SSH key is already bound to a CVM instance.
878
+ `False`: only deletes the SSH key information in the secret.
879
+ :rtype: bool
880
+ """
719
881
  return self._CleanSSHKey
720
882
 
721
883
  @CleanSSHKey.setter
@@ -757,6 +919,9 @@ class DeleteSecretResponse(AbstractModel):
757
919
 
758
920
  @property
759
921
  def SecretName(self):
922
+ """Name of deleted Secret.
923
+ :rtype: str
924
+ """
760
925
  return self._SecretName
761
926
 
762
927
  @SecretName.setter
@@ -765,6 +930,9 @@ class DeleteSecretResponse(AbstractModel):
765
930
 
766
931
  @property
767
932
  def DeleteTime(self):
933
+ """Secret deletion time, formatted as a Unix timestamp.
934
+ :rtype: int
935
+ """
768
936
  return self._DeleteTime
769
937
 
770
938
  @DeleteTime.setter
@@ -773,6 +941,9 @@ class DeleteSecretResponse(AbstractModel):
773
941
 
774
942
  @property
775
943
  def RequestId(self):
944
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
945
+ :rtype: str
946
+ """
776
947
  return self._RequestId
777
948
 
778
949
  @RequestId.setter
@@ -803,6 +974,9 @@ class DeleteSecretVersionRequest(AbstractModel):
803
974
 
804
975
  @property
805
976
  def SecretName(self):
977
+ """Name of the Secret.
978
+ :rtype: str
979
+ """
806
980
  return self._SecretName
807
981
 
808
982
  @SecretName.setter
@@ -811,6 +985,9 @@ class DeleteSecretVersionRequest(AbstractModel):
811
985
 
812
986
  @property
813
987
  def VersionId(self):
988
+ """ID of the Secret version to be deleted.
989
+ :rtype: str
990
+ """
814
991
  return self._VersionId
815
992
 
816
993
  @VersionId.setter
@@ -851,6 +1028,9 @@ class DeleteSecretVersionResponse(AbstractModel):
851
1028
 
852
1029
  @property
853
1030
  def SecretName(self):
1031
+ """Name of the Secret.
1032
+ :rtype: str
1033
+ """
854
1034
  return self._SecretName
855
1035
 
856
1036
  @SecretName.setter
@@ -859,6 +1039,9 @@ class DeleteSecretVersionResponse(AbstractModel):
859
1039
 
860
1040
  @property
861
1041
  def VersionId(self):
1042
+ """Version ID of the Secret.
1043
+ :rtype: str
1044
+ """
862
1045
  return self._VersionId
863
1046
 
864
1047
  @VersionId.setter
@@ -867,6 +1050,9 @@ class DeleteSecretVersionResponse(AbstractModel):
867
1050
 
868
1051
  @property
869
1052
  def RequestId(self):
1053
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1054
+ :rtype: str
1055
+ """
870
1056
  return self._RequestId
871
1057
 
872
1058
  @RequestId.setter
@@ -894,6 +1080,9 @@ class DescribeAsyncRequestInfoRequest(AbstractModel):
894
1080
 
895
1081
  @property
896
1082
  def FlowID(self):
1083
+ """Async task ID.
1084
+ :rtype: int
1085
+ """
897
1086
  return self._FlowID
898
1087
 
899
1088
  @FlowID.setter
@@ -933,6 +1122,9 @@ class DescribeAsyncRequestInfoResponse(AbstractModel):
933
1122
 
934
1123
  @property
935
1124
  def TaskStatus(self):
1125
+ """0: processing, 1: processing succeeded, 2: processing failed
1126
+ :rtype: int
1127
+ """
936
1128
  return self._TaskStatus
937
1129
 
938
1130
  @TaskStatus.setter
@@ -941,6 +1133,9 @@ class DescribeAsyncRequestInfoResponse(AbstractModel):
941
1133
 
942
1134
  @property
943
1135
  def Description(self):
1136
+ """Task description.
1137
+ :rtype: str
1138
+ """
944
1139
  return self._Description
945
1140
 
946
1141
  @Description.setter
@@ -949,6 +1144,9 @@ class DescribeAsyncRequestInfoResponse(AbstractModel):
949
1144
 
950
1145
  @property
951
1146
  def RequestId(self):
1147
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1148
+ :rtype: str
1149
+ """
952
1150
  return self._RequestId
953
1151
 
954
1152
  @RequestId.setter
@@ -976,6 +1174,9 @@ class DescribeRotationDetailRequest(AbstractModel):
976
1174
 
977
1175
  @property
978
1176
  def SecretName(self):
1177
+ """Specifies the name of the credential for which to get the credential rotation details.
1178
+ :rtype: str
1179
+ """
979
1180
  return self._SecretName
980
1181
 
981
1182
  @SecretName.setter
@@ -1024,6 +1225,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
1024
1225
 
1025
1226
  @property
1026
1227
  def EnableRotation(self):
1228
+ """Whether to enable rotation. `true`: enabled; `false`: disabled.
1229
+ :rtype: bool
1230
+ """
1027
1231
  return self._EnableRotation
1028
1232
 
1029
1233
  @EnableRotation.setter
@@ -1032,6 +1236,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1032
1236
 
1033
1237
  @property
1034
1238
  def Frequency(self):
1239
+ """Rotation frequency in days. Default value: 1 day.
1240
+ Note: this field may return null, indicating that no valid values can be obtained.
1241
+ :rtype: int
1242
+ """
1035
1243
  return self._Frequency
1036
1244
 
1037
1245
  @Frequency.setter
@@ -1040,6 +1248,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1040
1248
 
1041
1249
  @property
1042
1250
  def LatestRotateTime(self):
1251
+ """Last rotation time, which is an explicitly visible time string in the format of 2006-01-02 15:04:05.
1252
+ Note: this field may return null, indicating that no valid values can be obtained.
1253
+ :rtype: str
1254
+ """
1043
1255
  return self._LatestRotateTime
1044
1256
 
1045
1257
  @LatestRotateTime.setter
@@ -1048,6 +1260,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
1048
1260
 
1049
1261
  @property
1050
1262
  def NextRotateBeginTime(self):
1263
+ """Next rotation start time, which is an explicitly visible time string in the format of 2006-01-02 15:04:05.
1264
+ Note: this field may return null, indicating that no valid values can be obtained.
1265
+ :rtype: str
1266
+ """
1051
1267
  return self._NextRotateBeginTime
1052
1268
 
1053
1269
  @NextRotateBeginTime.setter
@@ -1056,6 +1272,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
1056
1272
 
1057
1273
  @property
1058
1274
  def RequestId(self):
1275
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1276
+ :rtype: str
1277
+ """
1059
1278
  return self._RequestId
1060
1279
 
1061
1280
  @RequestId.setter
@@ -1085,6 +1304,9 @@ class DescribeRotationHistoryRequest(AbstractModel):
1085
1304
 
1086
1305
  @property
1087
1306
  def SecretName(self):
1307
+ """Specifies the name of the credential for which to get the credential rotation records.
1308
+ :rtype: str
1309
+ """
1088
1310
  return self._SecretName
1089
1311
 
1090
1312
  @SecretName.setter
@@ -1124,6 +1346,9 @@ class DescribeRotationHistoryResponse(AbstractModel):
1124
1346
 
1125
1347
  @property
1126
1348
  def VersionIDs(self):
1349
+ """List of version numbers.
1350
+ :rtype: list of str
1351
+ """
1127
1352
  return self._VersionIDs
1128
1353
 
1129
1354
  @VersionIDs.setter
@@ -1132,6 +1357,9 @@ class DescribeRotationHistoryResponse(AbstractModel):
1132
1357
 
1133
1358
  @property
1134
1359
  def TotalCount(self):
1360
+ """Number of version numbers. The maximum number of version numbers that can be shown to users is 10.
1361
+ :rtype: int
1362
+ """
1135
1363
  return self._TotalCount
1136
1364
 
1137
1365
  @TotalCount.setter
@@ -1140,6 +1368,9 @@ class DescribeRotationHistoryResponse(AbstractModel):
1140
1368
 
1141
1369
  @property
1142
1370
  def RequestId(self):
1371
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1372
+ :rtype: str
1373
+ """
1143
1374
  return self._RequestId
1144
1375
 
1145
1376
  @RequestId.setter
@@ -1167,6 +1398,9 @@ class DescribeSecretRequest(AbstractModel):
1167
1398
 
1168
1399
  @property
1169
1400
  def SecretName(self):
1401
+ """Name of a Secret whose detailed information is to be obtained.
1402
+ :rtype: str
1403
+ """
1170
1404
  return self._SecretName
1171
1405
 
1172
1406
  @SecretName.setter
@@ -1261,6 +1495,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
1261
1495
 
1262
1496
  @property
1263
1497
  def SecretName(self):
1498
+ """Name of the Secret.
1499
+ :rtype: str
1500
+ """
1264
1501
  return self._SecretName
1265
1502
 
1266
1503
  @SecretName.setter
@@ -1269,6 +1506,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
1269
1506
 
1270
1507
  @property
1271
1508
  def Description(self):
1509
+ """Description of the Secret.
1510
+ :rtype: str
1511
+ """
1272
1512
  return self._Description
1273
1513
 
1274
1514
  @Description.setter
@@ -1277,6 +1517,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
1277
1517
 
1278
1518
  @property
1279
1519
  def KmsKeyId(self):
1520
+ """ID of the KMS CMK used for encryption.
1521
+ :rtype: str
1522
+ """
1280
1523
  return self._KmsKeyId
1281
1524
 
1282
1525
  @KmsKeyId.setter
@@ -1285,6 +1528,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
1285
1528
 
1286
1529
  @property
1287
1530
  def CreateUin(self):
1531
+ """Creator UIN.
1532
+ :rtype: int
1533
+ """
1288
1534
  return self._CreateUin
1289
1535
 
1290
1536
  @CreateUin.setter
@@ -1293,6 +1539,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
1293
1539
 
1294
1540
  @property
1295
1541
  def Status(self):
1542
+ """Credential status: Enabled, Disabled, PendingDelete, Creating, Failed.
1543
+ :rtype: str
1544
+ """
1296
1545
  return self._Status
1297
1546
 
1298
1547
  @Status.setter
@@ -1301,6 +1550,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
1301
1550
 
1302
1551
  @property
1303
1552
  def DeleteTime(self):
1553
+ """Deletion time, formatted as a Unix timestamp. For a Secret that is not in `PendingDelete` status, this value is 0.
1554
+ :rtype: int
1555
+ """
1304
1556
  return self._DeleteTime
1305
1557
 
1306
1558
  @DeleteTime.setter
@@ -1309,6 +1561,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
1309
1561
 
1310
1562
  @property
1311
1563
  def CreateTime(self):
1564
+ """Creation time.
1565
+ :rtype: int
1566
+ """
1312
1567
  return self._CreateTime
1313
1568
 
1314
1569
  @CreateTime.setter
@@ -1317,6 +1572,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
1317
1572
 
1318
1573
  @property
1319
1574
  def SecretType(self):
1575
+ """`0`: user-defined secret; `1`: database credential; `2`: SSH key secret.
1576
+ Note: this field may return `null`, indicating that no valid values can be obtained.
1577
+ :rtype: int
1578
+ """
1320
1579
  return self._SecretType
1321
1580
 
1322
1581
  @SecretType.setter
@@ -1325,6 +1584,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
1325
1584
 
1326
1585
  @property
1327
1586
  def ProductName(self):
1587
+ """Tencent Cloud service name.
1588
+ Note: this field may return null, indicating that no valid values can be obtained.
1589
+ :rtype: str
1590
+ """
1328
1591
  return self._ProductName
1329
1592
 
1330
1593
  @ProductName.setter
@@ -1333,6 +1596,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
1333
1596
 
1334
1597
  @property
1335
1598
  def ResourceID(self):
1599
+ """Tencent Cloud service instance ID.
1600
+ Note: this field may return null, indicating that no valid values can be obtained.
1601
+ :rtype: str
1602
+ """
1336
1603
  return self._ResourceID
1337
1604
 
1338
1605
  @ResourceID.setter
@@ -1341,6 +1608,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
1341
1608
 
1342
1609
  @property
1343
1610
  def RotationStatus(self):
1611
+ """Whether to enable rotation. `True`: enable rotation; `False`: disable rotation.
1612
+ Note: this field may return `null`, indicating that no valid values can be obtained.
1613
+ :rtype: bool
1614
+ """
1344
1615
  return self._RotationStatus
1345
1616
 
1346
1617
  @RotationStatus.setter
@@ -1349,6 +1620,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
1349
1620
 
1350
1621
  @property
1351
1622
  def RotationFrequency(self):
1623
+ """Rotation frequency in days by default.
1624
+ Note: this field may return null, indicating that no valid values can be obtained.
1625
+ :rtype: int
1626
+ """
1352
1627
  return self._RotationFrequency
1353
1628
 
1354
1629
  @RotationFrequency.setter
@@ -1357,6 +1632,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
1357
1632
 
1358
1633
  @property
1359
1634
  def ResourceName(self):
1635
+ """Secret name. This field is only valid when the `SecretType` is set to `2` (SSH key secret).
1636
+ Note: this field may return null, indicating that no valid values can be obtained.
1637
+ :rtype: str
1638
+ """
1360
1639
  return self._ResourceName
1361
1640
 
1362
1641
  @ResourceName.setter
@@ -1365,6 +1644,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
1365
1644
 
1366
1645
  @property
1367
1646
  def ProjectID(self):
1647
+ """Project ID. This field is only valid when the `SecretType` is set to `2` (SSH key secret).
1648
+ Note: this field may return null, indicating that no valid values can be obtained.
1649
+ :rtype: int
1650
+ """
1368
1651
  return self._ProjectID
1369
1652
 
1370
1653
  @ProjectID.setter
@@ -1373,6 +1656,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
1373
1656
 
1374
1657
  @property
1375
1658
  def AssociatedInstanceIDs(self):
1659
+ """ID of the CVM instance associated with the SSH key. ID. This field is only valid when the `SecretType` is set to `2` (SSH key secret).
1660
+ Note: this field may return null, indicating that no valid values can be obtained.
1661
+ :rtype: list of str
1662
+ """
1376
1663
  return self._AssociatedInstanceIDs
1377
1664
 
1378
1665
  @AssociatedInstanceIDs.setter
@@ -1381,6 +1668,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
1381
1668
 
1382
1669
  @property
1383
1670
  def TargetUin(self):
1671
+ """UIN of the Tencent Cloud API key. This field is valid when the secret type is Tencent Cloud API key secret.
1672
+ Note: this field may return null, indicating that no valid values can be obtained.
1673
+ :rtype: int
1674
+ """
1384
1675
  return self._TargetUin
1385
1676
 
1386
1677
  @TargetUin.setter
@@ -1389,6 +1680,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
1389
1680
 
1390
1681
  @property
1391
1682
  def AdditionalConfig(self):
1683
+ """Additional configuration of the Secret
1684
+ Note: This field may return null, indicating that no valid values can be obtained.
1685
+ :rtype: str
1686
+ """
1392
1687
  return self._AdditionalConfig
1393
1688
 
1394
1689
  @AdditionalConfig.setter
@@ -1397,6 +1692,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
1397
1692
 
1398
1693
  @property
1399
1694
  def RequestId(self):
1695
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1696
+ :rtype: str
1697
+ """
1400
1698
  return self._RequestId
1401
1699
 
1402
1700
  @RequestId.setter
@@ -1451,6 +1749,9 @@ class DescribeSupportedProductsResponse(AbstractModel):
1451
1749
 
1452
1750
  @property
1453
1751
  def Products(self):
1752
+ """List of supported services.
1753
+ :rtype: list of str
1754
+ """
1454
1755
  return self._Products
1455
1756
 
1456
1757
  @Products.setter
@@ -1459,6 +1760,9 @@ class DescribeSupportedProductsResponse(AbstractModel):
1459
1760
 
1460
1761
  @property
1461
1762
  def TotalCount(self):
1763
+ """Number of supported services
1764
+ :rtype: int
1765
+ """
1462
1766
  return self._TotalCount
1463
1767
 
1464
1768
  @TotalCount.setter
@@ -1467,6 +1771,9 @@ class DescribeSupportedProductsResponse(AbstractModel):
1467
1771
 
1468
1772
  @property
1469
1773
  def RequestId(self):
1774
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1775
+ :rtype: str
1776
+ """
1470
1777
  return self._RequestId
1471
1778
 
1472
1779
  @RequestId.setter
@@ -1494,6 +1801,9 @@ class DisableSecretRequest(AbstractModel):
1494
1801
 
1495
1802
  @property
1496
1803
  def SecretName(self):
1804
+ """Name of the Secret to be disabled.
1805
+ :rtype: str
1806
+ """
1497
1807
  return self._SecretName
1498
1808
 
1499
1809
  @SecretName.setter
@@ -1530,6 +1840,9 @@ class DisableSecretResponse(AbstractModel):
1530
1840
 
1531
1841
  @property
1532
1842
  def SecretName(self):
1843
+ """Name of the disabled Secret.
1844
+ :rtype: str
1845
+ """
1533
1846
  return self._SecretName
1534
1847
 
1535
1848
  @SecretName.setter
@@ -1538,6 +1851,9 @@ class DisableSecretResponse(AbstractModel):
1538
1851
 
1539
1852
  @property
1540
1853
  def RequestId(self):
1854
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1855
+ :rtype: str
1856
+ """
1541
1857
  return self._RequestId
1542
1858
 
1543
1859
  @RequestId.setter
@@ -1564,6 +1880,9 @@ class EnableSecretRequest(AbstractModel):
1564
1880
 
1565
1881
  @property
1566
1882
  def SecretName(self):
1883
+ """Name of the Secret to be enabled.
1884
+ :rtype: str
1885
+ """
1567
1886
  return self._SecretName
1568
1887
 
1569
1888
  @SecretName.setter
@@ -1600,6 +1919,9 @@ class EnableSecretResponse(AbstractModel):
1600
1919
 
1601
1920
  @property
1602
1921
  def SecretName(self):
1922
+ """Name of the enabled Secret.
1923
+ :rtype: str
1924
+ """
1603
1925
  return self._SecretName
1604
1926
 
1605
1927
  @SecretName.setter
@@ -1608,6 +1930,9 @@ class EnableSecretResponse(AbstractModel):
1608
1930
 
1609
1931
  @property
1610
1932
  def RequestId(self):
1933
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1934
+ :rtype: str
1935
+ """
1611
1936
  return self._RequestId
1612
1937
 
1613
1938
  @RequestId.setter
@@ -1643,6 +1968,9 @@ class GetRegionsResponse(AbstractModel):
1643
1968
 
1644
1969
  @property
1645
1970
  def Regions(self):
1971
+ """List of regions.
1972
+ :rtype: list of str
1973
+ """
1646
1974
  return self._Regions
1647
1975
 
1648
1976
  @Regions.setter
@@ -1651,6 +1979,9 @@ class GetRegionsResponse(AbstractModel):
1651
1979
 
1652
1980
  @property
1653
1981
  def RequestId(self):
1982
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1983
+ :rtype: str
1984
+ """
1654
1985
  return self._RequestId
1655
1986
 
1656
1987
  @RequestId.setter
@@ -1680,6 +2011,9 @@ class GetSSHKeyPairValueRequest(AbstractModel):
1680
2011
 
1681
2012
  @property
1682
2013
  def SecretName(self):
2014
+ """Secret name. This field is only valid for SSH key secrets.
2015
+ :rtype: str
2016
+ """
1683
2017
  return self._SecretName
1684
2018
 
1685
2019
  @SecretName.setter
@@ -1688,6 +2022,9 @@ class GetSSHKeyPairValueRequest(AbstractModel):
1688
2022
 
1689
2023
  @property
1690
2024
  def SSHKeyId(self):
2025
+ """ID of the key pair, which is the unique identifier of the key pair in the CVM.
2026
+ :rtype: str
2027
+ """
1691
2028
  return self._SSHKeyId
1692
2029
 
1693
2030
  @SSHKeyId.setter
@@ -1742,6 +2079,9 @@ The name can be modified in the CVM console.
1742
2079
 
1743
2080
  @property
1744
2081
  def SSHKeyID(self):
2082
+ """ID of the SSH key.
2083
+ :rtype: str
2084
+ """
1745
2085
  return self._SSHKeyID
1746
2086
 
1747
2087
  @SSHKeyID.setter
@@ -1750,6 +2090,9 @@ The name can be modified in the CVM console.
1750
2090
 
1751
2091
  @property
1752
2092
  def PublicKey(self):
2093
+ """Plaintext value of the Base64-encoded public key.
2094
+ :rtype: str
2095
+ """
1753
2096
  return self._PublicKey
1754
2097
 
1755
2098
  @PublicKey.setter
@@ -1758,6 +2101,9 @@ The name can be modified in the CVM console.
1758
2101
 
1759
2102
  @property
1760
2103
  def PrivateKey(self):
2104
+ """Plaintext value of the Base64-encoded private key.
2105
+ :rtype: str
2106
+ """
1761
2107
  return self._PrivateKey
1762
2108
 
1763
2109
  @PrivateKey.setter
@@ -1766,6 +2112,9 @@ The name can be modified in the CVM console.
1766
2112
 
1767
2113
  @property
1768
2114
  def ProjectID(self):
2115
+ """ID of the project to which the SSH key belongs.
2116
+ :rtype: int
2117
+ """
1769
2118
  return self._ProjectID
1770
2119
 
1771
2120
  @ProjectID.setter
@@ -1774,6 +2123,10 @@ The name can be modified in the CVM console.
1774
2123
 
1775
2124
  @property
1776
2125
  def SSHKeyDescription(self):
2126
+ """Description of the SSH key.
2127
+ The description can be modified in the CVM console.
2128
+ :rtype: str
2129
+ """
1777
2130
  return self._SSHKeyDescription
1778
2131
 
1779
2132
  @SSHKeyDescription.setter
@@ -1782,6 +2135,10 @@ The name can be modified in the CVM console.
1782
2135
 
1783
2136
  @property
1784
2137
  def SSHKeyName(self):
2138
+ """Name of the SSH key.
2139
+ The name can be modified in the CVM console.
2140
+ :rtype: str
2141
+ """
1785
2142
  return self._SSHKeyName
1786
2143
 
1787
2144
  @SSHKeyName.setter
@@ -1790,6 +2147,9 @@ The name can be modified in the CVM console.
1790
2147
 
1791
2148
  @property
1792
2149
  def RequestId(self):
2150
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
2151
+ :rtype: str
2152
+ """
1793
2153
  return self._RequestId
1794
2154
 
1795
2155
  @RequestId.setter
@@ -1825,6 +2185,9 @@ For Tencent Cloud service credentials such as MySQL credentials, this API is use
1825
2185
 
1826
2186
  @property
1827
2187
  def SecretName(self):
2188
+ """Name of a Secret.
2189
+ :rtype: str
2190
+ """
1828
2191
  return self._SecretName
1829
2192
 
1830
2193
  @SecretName.setter
@@ -1833,6 +2196,10 @@ For Tencent Cloud service credentials such as MySQL credentials, this API is use
1833
2196
 
1834
2197
  @property
1835
2198
  def VersionId(self):
2199
+ """Specifies the version number of the corresponding credential.
2200
+ For Tencent Cloud service credentials such as MySQL credentials, this API is used to get the plaintext information of a previously rotated credential by specifying the credential name and historical version number. If you want to get the plaintext of the credential version currently in use, you need to specify the version number as `SSM_Current`.
2201
+ :rtype: str
2202
+ """
1836
2203
  return self._VersionId
1837
2204
 
1838
2205
  @VersionId.setter
@@ -1881,6 +2248,9 @@ Either `SecretBinary` or `SecretString` cannot be empty.
1881
2248
 
1882
2249
  @property
1883
2250
  def SecretName(self):
2251
+ """Name of the Secret.
2252
+ :rtype: str
2253
+ """
1884
2254
  return self._SecretName
1885
2255
 
1886
2256
  @SecretName.setter
@@ -1889,6 +2259,9 @@ Either `SecretBinary` or `SecretString` cannot be empty.
1889
2259
 
1890
2260
  @property
1891
2261
  def VersionId(self):
2262
+ """ID of the Secret version.
2263
+ :rtype: str
2264
+ """
1892
2265
  return self._VersionId
1893
2266
 
1894
2267
  @VersionId.setter
@@ -1897,6 +2270,10 @@ Either `SecretBinary` or `SecretString` cannot be empty.
1897
2270
 
1898
2271
  @property
1899
2272
  def SecretBinary(self):
2273
+ """When creating a credential (CreateSecret), if you specify binary data, this field will be the Base64-encoded returned result. The application needs to Base64-decode the result to get the original data.
2274
+ Either `SecretBinary` or `SecretString` cannot be empty.
2275
+ :rtype: str
2276
+ """
1900
2277
  return self._SecretBinary
1901
2278
 
1902
2279
  @SecretBinary.setter
@@ -1905,6 +2282,10 @@ Either `SecretBinary` or `SecretString` cannot be empty.
1905
2282
 
1906
2283
  @property
1907
2284
  def SecretString(self):
2285
+ """When creating a credential (CreateSecret), if you specify general text data, this field will be the returned result.
2286
+ Either `SecretBinary` or `SecretString` cannot be empty.
2287
+ :rtype: str
2288
+ """
1908
2289
  return self._SecretString
1909
2290
 
1910
2291
  @SecretString.setter
@@ -1913,6 +2294,9 @@ Either `SecretBinary` or `SecretString` cannot be empty.
1913
2294
 
1914
2295
  @property
1915
2296
  def RequestId(self):
2297
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
2298
+ :rtype: str
2299
+ """
1916
2300
  return self._RequestId
1917
2301
 
1918
2302
  @RequestId.setter
@@ -1958,6 +2342,9 @@ class GetServiceStatusResponse(AbstractModel):
1958
2342
 
1959
2343
  @property
1960
2344
  def ServiceEnabled(self):
2345
+ """`true`: The service is activated; `false`: The service is not activated.
2346
+ :rtype: bool
2347
+ """
1961
2348
  return self._ServiceEnabled
1962
2349
 
1963
2350
  @ServiceEnabled.setter
@@ -1966,6 +2353,9 @@ class GetServiceStatusResponse(AbstractModel):
1966
2353
 
1967
2354
  @property
1968
2355
  def InvalidType(self):
2356
+ """Invalid service type. `0`: not purchased; `1`: normal; `2`: suspended due to arrears; `3`: resource released
2357
+ :rtype: int
2358
+ """
1969
2359
  return self._InvalidType
1970
2360
 
1971
2361
  @InvalidType.setter
@@ -1974,6 +2364,10 @@ class GetServiceStatusResponse(AbstractModel):
1974
2364
 
1975
2365
  @property
1976
2366
  def AccessKeyEscrowEnabled(self):
2367
+ """`true`: Allow SSM to manage Tencent Cloud API key secrets.
2368
+ `false`: Forbid SSM to manage Tencent Cloud API key secrets.
2369
+ :rtype: bool
2370
+ """
1977
2371
  return self._AccessKeyEscrowEnabled
1978
2372
 
1979
2373
  @AccessKeyEscrowEnabled.setter
@@ -1982,6 +2376,9 @@ class GetServiceStatusResponse(AbstractModel):
1982
2376
 
1983
2377
  @property
1984
2378
  def RequestId(self):
2379
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
2380
+ :rtype: str
2381
+ """
1985
2382
  return self._RequestId
1986
2383
 
1987
2384
  @RequestId.setter
@@ -2010,6 +2407,9 @@ class ListSecretVersionIdsRequest(AbstractModel):
2010
2407
 
2011
2408
  @property
2012
2409
  def SecretName(self):
2410
+ """Name of the Secret.
2411
+ :rtype: str
2412
+ """
2013
2413
  return self._SecretName
2014
2414
 
2015
2415
  @SecretName.setter
@@ -2050,6 +2450,9 @@ Note: This field may return `null`, indicating that no valid value was found.
2050
2450
 
2051
2451
  @property
2052
2452
  def SecretName(self):
2453
+ """Name of the Secret.
2454
+ :rtype: str
2455
+ """
2053
2456
  return self._SecretName
2054
2457
 
2055
2458
  @SecretName.setter
@@ -2058,6 +2461,10 @@ Note: This field may return `null`, indicating that no valid value was found.
2058
2461
 
2059
2462
  @property
2060
2463
  def Versions(self):
2464
+ """`VersionId` list.
2465
+ Note: This field may return `null`, indicating that no valid value was found.
2466
+ :rtype: list of VersionInfo
2467
+ """
2061
2468
  return self._Versions
2062
2469
 
2063
2470
  @Versions.setter
@@ -2066,6 +2473,9 @@ Note: This field may return `null`, indicating that no valid value was found.
2066
2473
 
2067
2474
  @property
2068
2475
  def RequestId(self):
2476
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
2477
+ :rtype: str
2478
+ """
2069
2479
  return self._RequestId
2070
2480
 
2071
2481
  @RequestId.setter
@@ -2133,6 +2543,9 @@ An empty value indicates querying all types of Tencent Cloud service secrets.
2133
2543
 
2134
2544
  @property
2135
2545
  def Offset(self):
2546
+ """Starting position of the list, starting at 0. If not specified, 0 is used by default.
2547
+ :rtype: int
2548
+ """
2136
2549
  return self._Offset
2137
2550
 
2138
2551
  @Offset.setter
@@ -2141,6 +2554,9 @@ An empty value indicates querying all types of Tencent Cloud service secrets.
2141
2554
 
2142
2555
  @property
2143
2556
  def Limit(self):
2557
+ """Maximum number of returned Secrets in a query. If not set or set to 0, 20 is used by default.
2558
+ :rtype: int
2559
+ """
2144
2560
  return self._Limit
2145
2561
 
2146
2562
  @Limit.setter
@@ -2149,6 +2565,9 @@ An empty value indicates querying all types of Tencent Cloud service secrets.
2149
2565
 
2150
2566
  @property
2151
2567
  def OrderType(self):
2568
+ """Sorting order according to the creation time. If not set or set to 0, descending order is used; if set to 1, ascending order is used.
2569
+ :rtype: int
2570
+ """
2152
2571
  return self._OrderType
2153
2572
 
2154
2573
  @OrderType.setter
@@ -2157,6 +2576,16 @@ An empty value indicates querying all types of Tencent Cloud service secrets.
2157
2576
 
2158
2577
  @property
2159
2578
  def State(self):
2579
+ """Filter based on credential status.
2580
+ The default value is 0, indicating to query all.
2581
+ 1: query the list of credentials in `Enabled` status.
2582
+ 2: query the list of credentials in `Disabled` status.
2583
+ 3: query the list of credentials in `PendingDelete` status.
2584
+ 4: query the list of credentials in `PendingCreate` status.
2585
+ 5: query the list of credentials in `CreateFailed` status.
2586
+ The `PendingCreate` and `CreateFailed` status only take effect when `SecretType` is Tencent Cloud service credential
2587
+ :rtype: int
2588
+ """
2160
2589
  return self._State
2161
2590
 
2162
2591
  @State.setter
@@ -2165,6 +2594,9 @@ An empty value indicates querying all types of Tencent Cloud service secrets.
2165
2594
 
2166
2595
  @property
2167
2596
  def SearchSecretName(self):
2597
+ """Filter according to Secret names. If left empty, this filter is not applied.
2598
+ :rtype: str
2599
+ """
2168
2600
  return self._SearchSecretName
2169
2601
 
2170
2602
  @SearchSecretName.setter
@@ -2173,6 +2605,9 @@ An empty value indicates querying all types of Tencent Cloud service secrets.
2173
2605
 
2174
2606
  @property
2175
2607
  def TagFilters(self):
2608
+ """Tag filter.
2609
+ :rtype: list of TagFilter
2610
+ """
2176
2611
  return self._TagFilters
2177
2612
 
2178
2613
  @TagFilters.setter
@@ -2181,6 +2616,12 @@ An empty value indicates querying all types of Tencent Cloud service secrets.
2181
2616
 
2182
2617
  @property
2183
2618
  def SecretType(self):
2619
+ """`0` (default): user-defined secret.
2620
+ `1`: Tencent Cloud services secret.
2621
+ `2`: SSH key secret.
2622
+ `3`: Tencent Cloud API key secret.
2623
+ :rtype: int
2624
+ """
2184
2625
  return self._SecretType
2185
2626
 
2186
2627
  @SecretType.setter
@@ -2189,6 +2630,13 @@ An empty value indicates querying all types of Tencent Cloud service secrets.
2189
2630
 
2190
2631
  @property
2191
2632
  def ProductName(self):
2633
+ """This parameter is valid only when SecretType is `1`.
2634
+
2635
+ An empty value indicates querying all types of Tencent Cloud service secrets.
2636
+ `Mysql`: queries MySQL database credentials.
2637
+ `Tdsql-mysql`: queries TDSQL MySQL database credentials.
2638
+ :rtype: str
2639
+ """
2192
2640
  return self._ProductName
2193
2641
 
2194
2642
  @ProductName.setter
@@ -2240,6 +2688,9 @@ class ListSecretsResponse(AbstractModel):
2240
2688
 
2241
2689
  @property
2242
2690
  def TotalCount(self):
2691
+ """Number of filtered Secrets according to `State` and `SearchSecretName`.
2692
+ :rtype: int
2693
+ """
2243
2694
  return self._TotalCount
2244
2695
 
2245
2696
  @TotalCount.setter
@@ -2248,6 +2699,9 @@ class ListSecretsResponse(AbstractModel):
2248
2699
 
2249
2700
  @property
2250
2701
  def SecretMetadatas(self):
2702
+ """List of Secret information.
2703
+ :rtype: list of SecretMetadata
2704
+ """
2251
2705
  return self._SecretMetadatas
2252
2706
 
2253
2707
  @SecretMetadatas.setter
@@ -2256,6 +2710,9 @@ class ListSecretsResponse(AbstractModel):
2256
2710
 
2257
2711
  @property
2258
2712
  def RequestId(self):
2713
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
2714
+ :rtype: str
2715
+ """
2259
2716
  return self._RequestId
2260
2717
 
2261
2718
  @RequestId.setter
@@ -2325,6 +2782,19 @@ TableName: explicitly indicate the table
2325
2782
 
2326
2783
  @property
2327
2784
  def PrivilegeName(self):
2785
+ """Permission name. Valid values:
2786
+ GlobalPrivileges
2787
+ DatabasePrivileges
2788
+ TablePrivileges
2789
+ ColumnPrivileges
2790
+
2791
+ When the permission is `DatabasePrivileges`, the database name must be specified by the `Database` parameter;
2792
+
2793
+ When the permission is `TablePrivileges`, the database name and the table name in the database must be specified by the `Database` and `TableName` parameters;
2794
+
2795
+ When the permission is `ColumnPrivileges`, the database name, table name in the database, and column name in the table must be specified by the `Database`, `TableName`, and `ColumnName` parameters.
2796
+ :rtype: str
2797
+ """
2328
2798
  return self._PrivilegeName
2329
2799
 
2330
2800
  @PrivilegeName.setter
@@ -2333,6 +2803,22 @@ TableName: explicitly indicate the table
2333
2803
 
2334
2804
  @property
2335
2805
  def Privileges(self):
2806
+ """Permission list.
2807
+ For the `Mysql` service, optional permission values are:
2808
+
2809
+ 1. Valid values of `GlobalPrivileges`: "SELECT","INSERT","UPDATE","DELETE","CREATE", "PROCESS", "DROP","REFERENCES","INDEX","ALTER","SHOW DATABASES","CREATE TEMPORARY TABLES","LOCK TABLES","EXECUTE","CREATE VIEW","SHOW VIEW","CREATE ROUTINE","ALTER ROUTINE","EVENT","TRIGGER".
2810
+ Note: if this parameter is not passed in, it means to clear the permission.
2811
+
2812
+ 2. Valid values of `DatabasePrivileges`: "SELECT","INSERT","UPDATE","DELETE","CREATE", "DROP","REFERENCES","INDEX","ALTER","CREATE TEMPORARY TABLES","LOCK TABLES","EXECUTE","CREATE VIEW","SHOW VIEW","CREATE ROUTINE","ALTER ROUTINE","EVENT","TRIGGER".
2813
+ Note: if this parameter is not passed in, it means to clear the permission.
2814
+
2815
+ 3. Valid values of `TablePrivileges`: "SELECT","INSERT","UPDATE","DELETE","CREATE", "DROP","REFERENCES","INDEX","ALTER","CREATE VIEW","SHOW VIEW", "TRIGGER".
2816
+ Note: if this parameter is not passed in, it means to clear the permission.
2817
+
2818
+ 4. Valid values of `ColumnPrivileges`: "SELECT","INSERT","UPDATE","REFERENCES".
2819
+ Note: if this parameter is not passed in, it means to clear the permission.
2820
+ :rtype: list of str
2821
+ """
2336
2822
  return self._Privileges
2337
2823
 
2338
2824
  @Privileges.setter
@@ -2341,6 +2827,9 @@ TableName: explicitly indicate the table
2341
2827
 
2342
2828
  @property
2343
2829
  def Database(self):
2830
+ """This value takes effect only when `PrivilegeName` is `DatabasePrivileges`.
2831
+ :rtype: str
2832
+ """
2344
2833
  return self._Database
2345
2834
 
2346
2835
  @Database.setter
@@ -2349,6 +2838,9 @@ TableName: explicitly indicate the table
2349
2838
 
2350
2839
  @property
2351
2840
  def TableName(self):
2841
+ """This value takes effect only when `PrivilegeName` is `TablePrivileges`, and the `Database` parameter is required in this case to explicitly indicate the database instance.
2842
+ :rtype: str
2843
+ """
2352
2844
  return self._TableName
2353
2845
 
2354
2846
  @TableName.setter
@@ -2357,6 +2849,11 @@ TableName: explicitly indicate the table
2357
2849
 
2358
2850
  @property
2359
2851
  def ColumnName(self):
2852
+ """This value takes effect only when `PrivilegeName` is `ColumnPrivileges`, and the following parameters are required in this case:
2853
+ Database: explicitly indicate the database instance.
2854
+ TableName: explicitly indicate the table
2855
+ :rtype: str
2856
+ """
2360
2857
  return self._ColumnName
2361
2858
 
2362
2859
  @ColumnName.setter
@@ -2404,6 +2901,9 @@ Either `SecretBinary` or `SecretString` must be set.
2404
2901
 
2405
2902
  @property
2406
2903
  def SecretName(self):
2904
+ """Name of a Secret where the version is added to.
2905
+ :rtype: str
2906
+ """
2407
2907
  return self._SecretName
2408
2908
 
2409
2909
  @SecretName.setter
@@ -2412,6 +2912,9 @@ Either `SecretBinary` or `SecretString` must be set.
2412
2912
 
2413
2913
  @property
2414
2914
  def VersionId(self):
2915
+ """ID of the new Secret version. It can be up to 64 bytes, contain letters, digits, hyphens (-), and underscores (_), and must begin with a letter or digit.
2916
+ :rtype: str
2917
+ """
2415
2918
  return self._VersionId
2416
2919
 
2417
2920
  @VersionId.setter
@@ -2420,6 +2923,10 @@ Either `SecretBinary` or `SecretString` must be set.
2420
2923
 
2421
2924
  @property
2422
2925
  def SecretBinary(self):
2926
+ """Base64-encoded binary credential information.
2927
+ Either `SecretBinary` or `SecretString` must be set.
2928
+ :rtype: str
2929
+ """
2423
2930
  return self._SecretBinary
2424
2931
 
2425
2932
  @SecretBinary.setter
@@ -2428,6 +2935,9 @@ Either `SecretBinary` or `SecretString` must be set.
2428
2935
 
2429
2936
  @property
2430
2937
  def SecretString(self):
2938
+ """Secret information plaintext in text format, base64 encoding is not needed. Either `SecretBinary` or `SecretString` must be set.
2939
+ :rtype: str
2940
+ """
2431
2941
  return self._SecretString
2432
2942
 
2433
2943
  @SecretString.setter
@@ -2470,6 +2980,9 @@ class PutSecretValueResponse(AbstractModel):
2470
2980
 
2471
2981
  @property
2472
2982
  def SecretName(self):
2983
+ """Name of the Secret.
2984
+ :rtype: str
2985
+ """
2473
2986
  return self._SecretName
2474
2987
 
2475
2988
  @SecretName.setter
@@ -2478,6 +2991,9 @@ class PutSecretValueResponse(AbstractModel):
2478
2991
 
2479
2992
  @property
2480
2993
  def VersionId(self):
2994
+ """Version ID that is newly added.
2995
+ :rtype: str
2996
+ """
2481
2997
  return self._VersionId
2482
2998
 
2483
2999
  @VersionId.setter
@@ -2486,6 +3002,9 @@ class PutSecretValueResponse(AbstractModel):
2486
3002
 
2487
3003
  @property
2488
3004
  def RequestId(self):
3005
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
3006
+ :rtype: str
3007
+ """
2489
3008
  return self._RequestId
2490
3009
 
2491
3010
  @RequestId.setter
@@ -2513,6 +3032,9 @@ class RestoreSecretRequest(AbstractModel):
2513
3032
 
2514
3033
  @property
2515
3034
  def SecretName(self):
3035
+ """Name of the Secret to be restored.
3036
+ :rtype: str
3037
+ """
2516
3038
  return self._SecretName
2517
3039
 
2518
3040
  @SecretName.setter
@@ -2549,6 +3071,9 @@ class RestoreSecretResponse(AbstractModel):
2549
3071
 
2550
3072
  @property
2551
3073
  def SecretName(self):
3074
+ """Name of the Secret.
3075
+ :rtype: str
3076
+ """
2552
3077
  return self._SecretName
2553
3078
 
2554
3079
  @SecretName.setter
@@ -2557,6 +3082,9 @@ class RestoreSecretResponse(AbstractModel):
2557
3082
 
2558
3083
  @property
2559
3084
  def RequestId(self):
3085
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
3086
+ :rtype: str
3087
+ """
2560
3088
  return self._RequestId
2561
3089
 
2562
3090
  @RequestId.setter
@@ -2583,6 +3111,9 @@ class RotateProductSecretRequest(AbstractModel):
2583
3111
 
2584
3112
  @property
2585
3113
  def SecretName(self):
3114
+ """Name of the credential to be rotated.
3115
+ :rtype: str
3116
+ """
2586
3117
  return self._SecretName
2587
3118
 
2588
3119
  @SecretName.setter
@@ -2619,6 +3150,9 @@ class RotateProductSecretResponse(AbstractModel):
2619
3150
 
2620
3151
  @property
2621
3152
  def FlowID(self):
3153
+ """Asynchronous rotation task ID. This field is valid when `SecretType` is `1` (i.e., the secret type is Tencent Cloud services secret, such as MySQL/TDSQL credentials).
3154
+ :rtype: int
3155
+ """
2622
3156
  return self._FlowID
2623
3157
 
2624
3158
  @FlowID.setter
@@ -2627,6 +3161,9 @@ class RotateProductSecretResponse(AbstractModel):
2627
3161
 
2628
3162
  @property
2629
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
+ """
2630
3167
  return self._RequestId
2631
3168
 
2632
3169
  @RequestId.setter
@@ -2721,6 +3258,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
2721
3258
 
2722
3259
  @property
2723
3260
  def SecretName(self):
3261
+ """Credential name
3262
+ :rtype: str
3263
+ """
2724
3264
  return self._SecretName
2725
3265
 
2726
3266
  @SecretName.setter
@@ -2729,6 +3269,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
2729
3269
 
2730
3270
  @property
2731
3271
  def Description(self):
3272
+ """Credential description
3273
+ :rtype: str
3274
+ """
2732
3275
  return self._Description
2733
3276
 
2734
3277
  @Description.setter
@@ -2737,6 +3280,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
2737
3280
 
2738
3281
  @property
2739
3282
  def KmsKeyId(self):
3283
+ """KMS `KeyId` used to encrypt the credential
3284
+ :rtype: str
3285
+ """
2740
3286
  return self._KmsKeyId
2741
3287
 
2742
3288
  @KmsKeyId.setter
@@ -2745,6 +3291,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
2745
3291
 
2746
3292
  @property
2747
3293
  def CreateUin(self):
3294
+ """Creator UIN
3295
+ :rtype: int
3296
+ """
2748
3297
  return self._CreateUin
2749
3298
 
2750
3299
  @CreateUin.setter
@@ -2753,6 +3302,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
2753
3302
 
2754
3303
  @property
2755
3304
  def Status(self):
3305
+ """Credential status: Enabled, Disabled, PendingDelete, Creating, Failed.
3306
+ :rtype: str
3307
+ """
2756
3308
  return self._Status
2757
3309
 
2758
3310
  @Status.setter
@@ -2761,6 +3313,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
2761
3313
 
2762
3314
  @property
2763
3315
  def DeleteTime(self):
3316
+ """Credential deletion date, which takes effect for credentials in `PendingDelete` status and is in UNIX timestamp format
3317
+ :rtype: int
3318
+ """
2764
3319
  return self._DeleteTime
2765
3320
 
2766
3321
  @DeleteTime.setter
@@ -2769,6 +3324,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
2769
3324
 
2770
3325
  @property
2771
3326
  def CreateTime(self):
3327
+ """Credential creation time in UNIX timestamp format
3328
+ :rtype: int
3329
+ """
2772
3330
  return self._CreateTime
2773
3331
 
2774
3332
  @CreateTime.setter
@@ -2777,6 +3335,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
2777
3335
 
2778
3336
  @property
2779
3337
  def KmsKeyType(self):
3338
+ """Type of the KMS CMK used to encrypt the credential. `DEFAULT` represents the default key created by Secrets Manager, and `CUSTOMER` represents the user-specified key
3339
+ :rtype: str
3340
+ """
2780
3341
  return self._KmsKeyType
2781
3342
 
2782
3343
  @KmsKeyType.setter
@@ -2785,6 +3346,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2785
3346
 
2786
3347
  @property
2787
3348
  def RotationStatus(self):
3349
+ """1: enable rotation; 0: disable rotation
3350
+ Note: this field may return null, indicating that no valid values can be obtained.
3351
+ :rtype: int
3352
+ """
2788
3353
  return self._RotationStatus
2789
3354
 
2790
3355
  @RotationStatus.setter
@@ -2793,6 +3358,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2793
3358
 
2794
3359
  @property
2795
3360
  def NextRotationTime(self):
3361
+ """Start time of the next rotation in UNIX timestamp format
3362
+ Note: this field may return null, indicating that no valid values can be obtained.
3363
+ :rtype: int
3364
+ """
2796
3365
  return self._NextRotationTime
2797
3366
 
2798
3367
  @NextRotationTime.setter
@@ -2801,6 +3370,13 @@ Note: This field may return null, indicating that no valid values can be obtaine
2801
3370
 
2802
3371
  @property
2803
3372
  def SecretType(self):
3373
+ """`0`: user-defined secret.
3374
+ `1`: Tencent Cloud services secret.
3375
+ `2`: SSH key secret.
3376
+ `3`: Tencent Cloud API key secret.
3377
+ Note: this field may return `null`, indicating that no valid values can be obtained.
3378
+ :rtype: int
3379
+ """
2804
3380
  return self._SecretType
2805
3381
 
2806
3382
  @SecretType.setter
@@ -2809,6 +3385,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2809
3385
 
2810
3386
  @property
2811
3387
  def ProductName(self):
3388
+ """Tencent Cloud service name, which takes effect only when `SecretType` is 1 (Tencent Cloud service credential)
3389
+ Note: this field may return null, indicating that no valid values can be obtained.
3390
+ :rtype: str
3391
+ """
2812
3392
  return self._ProductName
2813
3393
 
2814
3394
  @ProductName.setter
@@ -2817,6 +3397,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2817
3397
 
2818
3398
  @property
2819
3399
  def ResourceName(self):
3400
+ """Secret name. This field is only valid when the `SecretType` is set to `2` (SSH key secret).
3401
+ Note: this field may return `null`, indicating that no valid values can be obtained.
3402
+ :rtype: str
3403
+ """
2820
3404
  return self._ResourceName
2821
3405
 
2822
3406
  @ResourceName.setter
@@ -2825,6 +3409,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2825
3409
 
2826
3410
  @property
2827
3411
  def ProjectID(self):
3412
+ """Project ID. This field is only valid when the `SecretType` is set to `2` (SSH key secret).
3413
+ Note: this field may return `null`, indicating that no valid values can be obtained.
3414
+ :rtype: int
3415
+ """
2828
3416
  return self._ProjectID
2829
3417
 
2830
3418
  @ProjectID.setter
@@ -2833,6 +3421,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2833
3421
 
2834
3422
  @property
2835
3423
  def AssociatedInstanceIDs(self):
3424
+ """ID of the CVM instance associated with the SSH key. ID. This field is only valid when the `SecretType` is set to `2` (SSH key secret).
3425
+ Note: this field may return `null`, indicating that no valid values can be obtained.
3426
+ :rtype: list of str
3427
+ """
2836
3428
  return self._AssociatedInstanceIDs
2837
3429
 
2838
3430
  @AssociatedInstanceIDs.setter
@@ -2841,6 +3433,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2841
3433
 
2842
3434
  @property
2843
3435
  def TargetUin(self):
3436
+ """UIN of the Tencent Cloud API key. This field is valid when the secret type is Tencent Cloud API key secret.
3437
+ Note: this field may return `null`, indicating that no valid values can be obtained.
3438
+ :rtype: int
3439
+ """
2844
3440
  return self._TargetUin
2845
3441
 
2846
3442
  @TargetUin.setter
@@ -2849,6 +3445,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2849
3445
 
2850
3446
  @property
2851
3447
  def RotationFrequency(self):
3448
+ """Rotation frequency in days. It takes effect when the rotation feature is enabled.
3449
+ Note: This field may return null, indicating that no valid values can be obtained.
3450
+ :rtype: int
3451
+ """
2852
3452
  return self._RotationFrequency
2853
3453
 
2854
3454
  @RotationFrequency.setter
@@ -2857,6 +3457,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2857
3457
 
2858
3458
  @property
2859
3459
  def ResourceID(self):
3460
+ """ID of Tencent Cloud resource corresponding with the Secret.
3461
+ Note: This field may return null, indicating that no valid values can be obtained.
3462
+ :rtype: str
3463
+ """
2860
3464
  return self._ResourceID
2861
3465
 
2862
3466
  @ResourceID.setter
@@ -2865,6 +3469,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2865
3469
 
2866
3470
  @property
2867
3471
  def RotationBeginTime(self):
3472
+ """The rotation start time.
3473
+ Note: This field may return null, indicating that no valid values can be obtained.
3474
+ :rtype: str
3475
+ """
2868
3476
  return self._RotationBeginTime
2869
3477
 
2870
3478
  @RotationBeginTime.setter
@@ -2919,6 +3527,9 @@ class Tag(AbstractModel):
2919
3527
 
2920
3528
  @property
2921
3529
  def TagKey(self):
3530
+ """Tag key
3531
+ :rtype: str
3532
+ """
2922
3533
  return self._TagKey
2923
3534
 
2924
3535
  @TagKey.setter
@@ -2927,6 +3538,9 @@ class Tag(AbstractModel):
2927
3538
 
2928
3539
  @property
2929
3540
  def TagValue(self):
3541
+ """Tag value
3542
+ :rtype: str
3543
+ """
2930
3544
  return self._TagValue
2931
3545
 
2932
3546
  @TagValue.setter
@@ -2964,6 +3578,9 @@ class TagFilter(AbstractModel):
2964
3578
 
2965
3579
  @property
2966
3580
  def TagKey(self):
3581
+ """Tag key
3582
+ :rtype: str
3583
+ """
2967
3584
  return self._TagKey
2968
3585
 
2969
3586
  @TagKey.setter
@@ -2972,6 +3589,9 @@ class TagFilter(AbstractModel):
2972
3589
 
2973
3590
  @property
2974
3591
  def TagValue(self):
3592
+ """Tag value
3593
+ :rtype: list of str
3594
+ """
2975
3595
  return self._TagValue
2976
3596
 
2977
3597
  @TagValue.setter
@@ -3009,6 +3629,9 @@ class UpdateDescriptionRequest(AbstractModel):
3009
3629
 
3010
3630
  @property
3011
3631
  def SecretName(self):
3632
+ """Name of a Secret whose description is to be updated.
3633
+ :rtype: str
3634
+ """
3012
3635
  return self._SecretName
3013
3636
 
3014
3637
  @SecretName.setter
@@ -3017,6 +3640,9 @@ class UpdateDescriptionRequest(AbstractModel):
3017
3640
 
3018
3641
  @property
3019
3642
  def Description(self):
3643
+ """New description information, which can be up to 2048 bytes.
3644
+ :rtype: str
3645
+ """
3020
3646
  return self._Description
3021
3647
 
3022
3648
  @Description.setter
@@ -3054,6 +3680,9 @@ class UpdateDescriptionResponse(AbstractModel):
3054
3680
 
3055
3681
  @property
3056
3682
  def SecretName(self):
3683
+ """Name of the Secret.
3684
+ :rtype: str
3685
+ """
3057
3686
  return self._SecretName
3058
3687
 
3059
3688
  @SecretName.setter
@@ -3062,6 +3691,9 @@ class UpdateDescriptionResponse(AbstractModel):
3062
3691
 
3063
3692
  @property
3064
3693
  def RequestId(self):
3694
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
3695
+ :rtype: str
3696
+ """
3065
3697
  return self._RequestId
3066
3698
 
3067
3699
  @RequestId.setter
@@ -3100,6 +3732,9 @@ When `EnableRotation` is `true` and `RotationBeginTime` is left empty, the curre
3100
3732
 
3101
3733
  @property
3102
3734
  def SecretName(self):
3735
+ """Tencent Cloud service credential name.
3736
+ :rtype: str
3737
+ """
3103
3738
  return self._SecretName
3104
3739
 
3105
3740
  @SecretName.setter
@@ -3108,6 +3743,11 @@ When `EnableRotation` is `true` and `RotationBeginTime` is left empty, the curre
3108
3743
 
3109
3744
  @property
3110
3745
  def EnableRotation(self):
3746
+ """Specifies whether to enable rotation.
3747
+ `true`: enables rotation.
3748
+ `false`: disables rotation.
3749
+ :rtype: bool
3750
+ """
3111
3751
  return self._EnableRotation
3112
3752
 
3113
3753
  @EnableRotation.setter
@@ -3116,6 +3756,9 @@ When `EnableRotation` is `true` and `RotationBeginTime` is left empty, the curre
3116
3756
 
3117
3757
  @property
3118
3758
  def Frequency(self):
3759
+ """Rotation frequency in days. Value range: 30–365.
3760
+ :rtype: int
3761
+ """
3119
3762
  return self._Frequency
3120
3763
 
3121
3764
  @Frequency.setter
@@ -3124,6 +3767,10 @@ When `EnableRotation` is `true` and `RotationBeginTime` is left empty, the curre
3124
3767
 
3125
3768
  @property
3126
3769
  def RotationBeginTime(self):
3770
+ """User-defined rotation start time in the format of 2006-01-02 15:04:05.
3771
+ When `EnableRotation` is `true` and `RotationBeginTime` is left empty, the current time will be entered by default.
3772
+ :rtype: str
3773
+ """
3127
3774
  return self._RotationBeginTime
3128
3775
 
3129
3776
  @RotationBeginTime.setter
@@ -3160,6 +3807,9 @@ class UpdateRotationStatusResponse(AbstractModel):
3160
3807
 
3161
3808
  @property
3162
3809
  def RequestId(self):
3810
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
3811
+ :rtype: str
3812
+ """
3163
3813
  return self._RequestId
3164
3814
 
3165
3815
  @RequestId.setter
@@ -3195,6 +3845,9 @@ Either `SecretBinary` or `SecretString` cannot be empty.
3195
3845
 
3196
3846
  @property
3197
3847
  def SecretName(self):
3848
+ """Name of a Secret whose content is to be updated.
3849
+ :rtype: str
3850
+ """
3198
3851
  return self._SecretName
3199
3852
 
3200
3853
  @SecretName.setter
@@ -3203,6 +3856,9 @@ Either `SecretBinary` or `SecretString` cannot be empty.
3203
3856
 
3204
3857
  @property
3205
3858
  def VersionId(self):
3859
+ """ID of the Secret version whose content is to be updated.
3860
+ :rtype: str
3861
+ """
3206
3862
  return self._VersionId
3207
3863
 
3208
3864
  @VersionId.setter
@@ -3211,6 +3867,10 @@ Either `SecretBinary` or `SecretString` cannot be empty.
3211
3867
 
3212
3868
  @property
3213
3869
  def SecretBinary(self):
3870
+ """This field should be used and Base64-encoded if the content of the new credential is binary.
3871
+ Either `SecretBinary` or `SecretString` cannot be empty.
3872
+ :rtype: str
3873
+ """
3214
3874
  return self._SecretBinary
3215
3875
 
3216
3876
  @SecretBinary.setter
@@ -3219,6 +3879,9 @@ Either `SecretBinary` or `SecretString` cannot be empty.
3219
3879
 
3220
3880
  @property
3221
3881
  def SecretString(self):
3882
+ """This field should be used without being Base64-encoded if the content of the new credential is text. Either `SecretBinary` or `SecretString` cannot be empty.
3883
+ :rtype: str
3884
+ """
3222
3885
  return self._SecretString
3223
3886
 
3224
3887
  @SecretString.setter
@@ -3261,6 +3924,9 @@ class UpdateSecretResponse(AbstractModel):
3261
3924
 
3262
3925
  @property
3263
3926
  def SecretName(self):
3927
+ """Name of the Secret.
3928
+ :rtype: str
3929
+ """
3264
3930
  return self._SecretName
3265
3931
 
3266
3932
  @SecretName.setter
@@ -3269,6 +3935,9 @@ class UpdateSecretResponse(AbstractModel):
3269
3935
 
3270
3936
  @property
3271
3937
  def VersionId(self):
3938
+ """Version ID of the Secret.
3939
+ :rtype: str
3940
+ """
3272
3941
  return self._VersionId
3273
3942
 
3274
3943
  @VersionId.setter
@@ -3277,6 +3946,9 @@ class UpdateSecretResponse(AbstractModel):
3277
3946
 
3278
3947
  @property
3279
3948
  def RequestId(self):
3949
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
3950
+ :rtype: str
3951
+ """
3280
3952
  return self._RequestId
3281
3953
 
3282
3954
  @RequestId.setter
@@ -3307,6 +3979,9 @@ class VersionInfo(AbstractModel):
3307
3979
 
3308
3980
  @property
3309
3981
  def VersionId(self):
3982
+ """Version ID.
3983
+ :rtype: str
3984
+ """
3310
3985
  return self._VersionId
3311
3986
 
3312
3987
  @VersionId.setter
@@ -3315,6 +3990,9 @@ class VersionInfo(AbstractModel):
3315
3990
 
3316
3991
  @property
3317
3992
  def CreateTime(self):
3993
+ """Creation time, formatted as a Unix timestamp.
3994
+ :rtype: int
3995
+ """
3318
3996
  return self._CreateTime
3319
3997
 
3320
3998
  @CreateTime.setter