tccli-intl-en 3.1.1.1__py2.py3-none-any.whl → 3.1.11.1__py2.py3-none-any.whl

tccli/services/faceid/v20180301/api.json

@@ -470,7 +470,7 @@
         },
         {
           "disabled": false,
-          "document": "ENHANCED: enhanced.\nBASIC: basic version (default).",
+          "document": "PLUS: Plus Version.\nENHANCED: Enhanced Version.\nBASIC: Basic Version (default).",
           "example": "ENHANCED",
           "member": "string",
           "name": "SdkVersion",
@@ -485,6 +485,15 @@
           "name": "ActionList",
           "required": false,
           "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Whether expired identity documents are permitted to proceed to the liveness detection process. This parameter only takes effect when the document type is Hong Kong Identity Card (HKID).\ntrue (default value): Expired HKID is allowed to enter the liveness process.\nfalse : Expired HKID is rejected and cannot enter the liveness process.",
+          "example": "true",
+          "member": "bool",
+          "name": "AllowExpiredDocument",
+          "required": false,
+          "type": "bool"
         }
       ],
       "type": "object"
@@ -2173,6 +2182,16 @@
           "type": "string",
           "value_allowed_null": false
         },
+        {
+          "disabled": false,
+          "document": "Describes the detailed reason for the current liveness detection failure. Output only when SdkVersion is PLUS. Details are as follows:\n01 - User kept eyes closed throughout the process.\n02 - User failed to complete the specified action.\n03 - Suspected photo replay attack.\n04 - Suspected synthetic image.\n05 - Suspected synthetic video.\n06 - Suspected synthetic action.\n07 - Suspected fraud template.\n08 - Suspected watermark existence.\n09 - Light verification failed.\n10 - Face verification failed.\n11 - Poor face quality.\n12 - Unqualified collection quality.\n13 - Suspected adversarial sample attack.",
+          "example": "[\"04\"]",
+          "member": "string",
+          "name": "LivenessInfoTag",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
+        },
         {
           "document": "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.",
           "member": "string",
@@ -2206,7 +2225,7 @@
         {
           "disabled": false,
           "document": "The photo (in Base64) to compare. This parameter is required when the value of `CheckMode` is `compare`.",
-          "example": "\t/9j/4AAQSkZJRg.....s97n//2Q==",
+          "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
           "member": "string",
           "name": "Image",
           "required": false,
@@ -2232,7 +2251,7 @@
         },
         {
           "disabled": false,
-          "document": "ENHANCED: Enhanced Version, BASIC: Basic Version (Default)",
+          "document": "PLUS: Plus Version.\nENHANCED: Enhanced Version.\nBASIC: Basic Version (Default).",
           "example": "BASIC",
           "member": "string",
           "name": "SdkVersion",
@@ -5748,6 +5767,15 @@
           "name": "SelectedWarningCodes",
           "required": false,
           "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Whether expired identity documents are permitted to proceed to the liveness detection process. This parameter only takes effect when the document type is Hong Kong Identity Card (HKID).\ntrue (default value): Expired HKID is allowed to enter the liveness process.\nfalse : Expired HKID is rejected and cannot enter the liveness process.",
+          "example": "true",
+          "member": "bool",
+          "name": "AllowExpiredDocument",
+          "required": false,
+          "type": "bool"
         }
       ],
       "usage": "in"

tccli/services/kms/v20190118/api.json

@@ -826,7 +826,7 @@
         },
         {
           "disabled": false,
-          "document": "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.",
+          "document": "Specifies the key purpose, defaults to \"ENCRYPT_DECRYPT\" indicating the creation of a symmetric encryption/decryption key. other supported purposes include \"ASYMMETRIC_DECRYPT_RSA_2048\" for RSA2048 ASYMMETRIC keys used to ENCRYPT and DECRYPT, \"ASYMMETRIC_DECRYPT_SM2\" for SM2 ASYMMETRIC keys used to ENCRYPT and DECRYPT, \"ASYMMETRIC_SIGN_VERIFY_SM2\" for SM2 ASYMMETRIC keys used for signature verification, \"ASYMMETRIC_SIGN_VERIFY_ECC\" for ECC ASYMMETRIC keys used for signature verification, \"ASYMMETRIC_SIGN_VERIFY_RSA_2048\" for RSA_2048 ASYMMETRIC keys used for signature verification, and \"ASYMMETRIC_SIGN_VERIFY_ECDSA384\" for ECDSA384 ASYMMETRIC keys used for signature verification. the complete list of key purposes and algorithm support can be obtained through the ListAlgorithms api.",
           "example": "ENCRYPT_DECRYPT",
           "member": "string",
           "name": "KeyUsage",
@@ -1109,6 +1109,16 @@
           "type": "string",
           "value_allowed_null": false
         },
+        {
+          "disabled": false,
+          "document": "CMK name.",
+          "example": "测试根密钥",
+          "member": "string",
+          "name": "KeyName",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
         {
           "disabled": false,
           "document": "Key name as a more recognizable and understandable data key.",
@@ -1514,8 +1524,8 @@
       "members": [
         {
           "disabled": false,
-          "document": "Specifies the attribute information of the key.",
-          "example": "{\"Alias\":\"test11lzc\",\"CreateTime\":1730357927,\"CreatorUin\":700001224419,\"DeletionDate\":0,\"Description\":\"倒入外部密钥\",\"HsmClusterId\":\"\",\"KeyId\":\"93866e69-9755-11ef-8e65-52540089bc41\",\"KeyRotationEnabled\":false}",
+          "document": "Specifies the key attribute information.",
+          "example": "无",
           "member": "KeyMetadata",
           "name": "KeyMetadata",
           "output_required": true,
@@ -2471,6 +2481,15 @@
           "name": "HsmClusterId",
           "required": false,
           "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Tag list. valid at that time when parameter IsHostedByKms=1 and the data key is hosted by kms.",
+          "example": "无",
+          "member": "Tag",
+          "name": "Tags",
+          "required": false,
+          "type": "list"
         }
       ],
       "type": "object"
@@ -2518,6 +2537,26 @@
           "type": "string",
           "value_allowed_null": false
         },
+        {
+          "disabled": false,
+          "document": "Response code of the Tag operation. 0: success; 1: internal error; 2: business processing error.",
+          "example": "0",
+          "member": "uint64",
+          "name": "TagCode",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Response of the Tag operation.",
+          "example": "ok",
+          "member": "string",
+          "name": "TagMsg",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
         {
           "document": "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.",
           "member": "string",
@@ -3115,6 +3154,15 @@
           "name": "HsmClusterId",
           "required": false,
           "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Tag list",
+          "example": "无",
+          "member": "Tag",
+          "name": "Tags",
+          "required": false,
+          "type": "list"
         }
       ],
       "type": "object"
@@ -3142,6 +3190,26 @@
           "type": "string",
           "value_allowed_null": false
         },
+        {
+          "disabled": false,
+          "document": "Response code of the Tag operation. 0: success; 1: internal error; 2: business processing error.",
+          "example": "0",
+          "member": "uint64",
+          "name": "TagCode",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Response of the Tag operation.",
+          "example": "ok",
+          "member": "string",
+          "name": "TagMsg",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
         {
           "document": "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.",
           "member": "string",
@@ -3616,6 +3684,15 @@
           "name": "DataKeyLen",
           "required": false,
           "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "Tag filtering conditions.",
+          "example": "无",
+          "member": "TagFilter",
+          "name": "TagFilters",
+          "required": false,
+          "type": "list"
         }
       ],
       "type": "object"

tccli/services/kms/v20190118/examples.json

@@ -114,10 +114,10 @@
     ],
     "DescribeKey": [
       {
-        "document": "This example shows you how to obtain the attribute details of a designated CMK.",
+        "document": "This example shows you how to obtain the detailed information of attributes for the designated CMK.",
         "input": "POST / HTTP/1.1\nHost: kms.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeKey\n<Common request parameters>\n\n{\n    \"KeyId\": \"93866e69-9755-11ef-8e65-52540089bc41\"\n}",
-        "output": "{\n    \"Response\": {\n        \"KeyMetadata\": {\n            \"Alias\": \"test11-lzc\",\n            \"CreateTime\": 1730357927,\n            \"CreatorUin\": 700001224419,\n            \"DeletionDate\": 0,\n\"Description\": \"Import an external key\"\n            \"HsmClusterId\": \"cls-hsm-3dflmo9g\",\n            \"KeyId\": \"93866e69-9755-11ef-8e65-52540089bc41\",\n            \"KeyRotationEnabled\": false,\n            \"KeyState\": \"Enabled\",\n            \"KeyUsage\": \"ENCRYPT_DECRYPT\",\n            \"NextRotateTime\": 1761893927,\n            \"Origin\": \"EXTERNAL\",\n            \"Owner\": \"user\",\n            \"ResourceId\": \"creatorUin/700001224419/93866e69-9755-11ef-8e65-52540089bc41\",\n            \"Type\": 4,\n            \"ValidTo\": 0\n        },\n        \"RequestId\": \"5575a949-8eda-497f-bee3-9d8a07763747\"\n    }\n}",
-        "title": "Get CMK Attribute Example"
+        "output": "{\n    \"Response\": {\n        \"KeyMetadata\": {\n            \"Alias\": \"test11-lzc\",\n            \"CreateTime\": 1730357927,\n            \"CreatorUin\": 700001224419,\n            \"DeletionDate\": 0,\n\"Description\": \"Import external key\"\n            \"HsmClusterId\": \"cls-hsm-3dflmo9g\",\n            \"KeyId\": \"93866e69-9755-11ef-8e65-52540089bc41\",\n            \"KeyRotationEnabled\": false,\n            \"KeyState\": \"Enabled\",\n            \"KeyUsage\": \"ENCRYPT_DECRYPT\",\n            \"NextRotateTime\": 1761893927,\n            \"Origin\": \"EXTERNAL\",\n            \"Owner\": \"user\",\n            \"ResourceId\": \"creatorUin/700001224419/93866e69-9755-11ef-8e65-52540089bc41\",\n            \"Type\": 4,\n            \"ValidTo\": 0\n        },\n        \"RequestId\": \"5575a949-8eda-497f-bee3-9d8a07763747\"\n    }\n}",
+        "title": "Retrieving CMK Attributes Example"
       }
     ],
     "DescribeKeys": [

tccli/services/mdl/v20200326/api.json

@@ -1561,7 +1561,7 @@
         },
         {
           "disabled": false,
-          "document": "Subtitle template configuration, only AVTemplates are valid.",
+          "document": "Subtitle template configuration.",
           "example": "无",
           "member": "SubtitleConf",
           "name": "CaptionTemplates",
@@ -4692,7 +4692,7 @@
         },
         {
           "disabled": false,
-          "document": "Subtitle template configuration, only AVTemplates are valid.",
+          "document": "Subtitle template configuration.",
           "example": "无",
           "member": "SubtitleConf",
           "name": "CaptionTemplates",
@@ -6520,7 +6520,7 @@
         },
         {
           "disabled": false,
-          "document": "Optional values: 1 Source, 2 Source+Target, 3 Target (original language only, original language + translation language, translation language). Required when CaptionSource selects `ANALYSIS `.",
+          "document": "Optional values: 1 Source, 2 Source+Target, 3 Target (original language only, original language + translation language, translation language). Required when CaptionSource selects `ANALYSIS `. When outputting as WebVTT, a single template can only output one language.",
           "example": "2",
           "member": "uint64",
           "name": "ContentType",
@@ -6531,7 +6531,7 @@
         },
         {
           "disabled": false,
-          "document": "Output mode: 1 Burn in, 2 Embedded. Support `2` when CaptionSource selects `INPUT`. Support `1` when CaptionSource selects `ANALYSIS `.",
+          "document": "Output mode: 1 Burn in, 2 Embedded, 3 WebVTT. Support `2` when CaptionSource selects `INPUT`. Support `1` and `3` when CaptionSource selects `ANALYSIS `.",
           "example": "1",
           "member": "uint64",
           "name": "TargetType",
@@ -6575,7 +6575,7 @@
         },
         {
           "disabled": false,
-          "document": "There are two modes: STEADY and DYNAMIC, corresponding to steady state and unstable state respectively; the default is STEADY. Required when CaptionSource selects `ANALYSIS `.",
+          "document": "There are two modes: STEADY and DYNAMIC, corresponding to steady state and unstable state respectively; the default is STEADY. Required when CaptionSource selects `ANALYSIS `. When the output is WebVTT, only STEADY can be selected.",
           "example": "STEADY",
           "member": "string",
           "name": "StateEffectMode",
@@ -6594,6 +6594,50 @@
           "required": false,
           "type": "int",
           "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Audio selector name, required for generating WebVTT subtitles using speech recognition, can be empty.",
+          "example": "audio",
+          "member": "string",
+          "name": "AudioSelectorName",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Format configuration for speech recognition output on WebVTT.",
+          "example": "无",
+          "member": "WebVTTFontStyle",
+          "name": "WebVTTFontStyle",
+          "output_required": false,
+          "required": false,
+          "type": "object",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Language code, length 2-20. ISO 639-2 three-digit code is recommend.",
+          "example": "eng",
+          "member": "string",
+          "name": "LanguageCode",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Language description, less than 100 characters in length.",
+          "example": "English",
+          "member": "string",
+          "name": "LanguageDescription",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
         }
       ],
       "usage": "both"
@@ -7355,6 +7399,122 @@
         }
       ],
       "usage": "both"
+    },
+    "WebVTTFontStyle": {
+      "document": "WebVTT format configuration.",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Text color, RGB hexadecimal representation, 6 hexadecimal characters (no # needed).",
+          "example": "00FF00",
+          "member": "string",
+          "name": "TextColor",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Background color, RGB hexadecimal representation, 6 hexadecimal characters (no # needed).",
+          "example": "00FF00",
+          "member": "string",
+          "name": "BackgroundColor",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Background opacity parameter, a number from 0 to 100, with 0 being the default for full transparency.",
+          "example": "0",
+          "member": "int64",
+          "name": "BackgroundAlpha",
+          "output_required": false,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Font size, in units of vh (1% of height), default value 0 means automatic.",
+          "example": "0",
+          "member": "int64",
+          "name": "FontSize",
+          "output_required": false,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "The position of the text box, default value AUTO, can be empty; represents the percentage of video height, supports integers from 0 to 100.",
+          "example": "AUTO",
+          "member": "string",
+          "name": "Line",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "The alignment of the text box on the Line. Optional values: START, CENTER, END. Which can be empty.",
+          "example": "START",
+          "member": "string",
+          "name": "LineAlignment",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "The text box is positioned in another direction as a percentage of the video's width. It defaults to AUTO and can be empty.",
+          "example": "AUTO",
+          "member": "string",
+          "name": "Position",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "The alignment of the text box on the Position. Optional values are LINE_LEFT, LINE_RIGHT, CENTER, and AUTO. The default value is AUTO, and it can be empty.",
+          "example": "AUTO",
+          "member": "string",
+          "name": "PositionAlignment",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Text box size, a percentage of video width/height, with values (0, 100), default AUTO, can be empty.",
+          "example": "AUTO",
+          "member": "string",
+          "name": "CueSize",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Text alignment, with possible values  START, CENTER, END, LEFT, and RIGHT; the default value is CENTER, which can be empty.",
+          "example": "CENTER",
+          "member": "string",
+          "name": "TextAlignment",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
     }
   },
   "version": "1.0"