@alicloud/config20200907 4.2.2 → 4.2.3

package/src/models/DetachConfigRuleToCompliancePackResponseBody.ts

@@ -13,20 +13,10 @@ export class DetachConfigRuleToCompliancePackResponseBodyOperateRuleResultOperat
   configRuleId?: string;
   /**
    * @remarks
-   * The error code.
+   * The error code returned.
    * 
-   * - This parameter is empty if the operation is successful.
-   * 
-   * <props="china">
-   * 
-   * - An error code is returned if the operation fails. For more information about error codes, see the [Error Center](https://error-center.aliyun.com/status/product/Config).
-   * 
-   * 
-   * 
-   * 
-   * <props="intl">
-   * 
-   * - An error code is returned if the operation fails. For more information about error codes, see the [Error Center](https://error-center.alibabacloud.com/status/product/Config).
+   * *   This parameter is empty if the rule is removed from the compliance package.
+   * *   An error code is returned if the rule fails to be removed from the compliance package. For more information about error codes, see [Error codes](https://error-center.alibabacloud.com/status/product/Config).
    * 
    * @example
    * ConfigRuleNotExists
@@ -34,11 +24,10 @@ export class DetachConfigRuleToCompliancePackResponseBodyOperateRuleResultOperat
   errorCode?: string;
   /**
    * @remarks
-   * Indicates whether the operation was successful. Valid values:
-   * 
-   * - true: The operation was successful.
+   * Indicates whether the request was successful. Valid values:
    * 
-   * - false: The operation failed.
+   * *   true: The request was successful.
+   * *   false: The request failed.
    * 
    * @example
    * true
@@ -72,7 +61,7 @@ export class DetachConfigRuleToCompliancePackResponseBodyOperateRuleResultOperat
 export class DetachConfigRuleToCompliancePackResponseBodyOperateRuleResult extends $dara.Model {
   /**
    * @remarks
-   * A list of the results of the operation to detach rules.
+   * The result of the operation to remove the rule.
    */
   operateRuleItemList?: DetachConfigRuleToCompliancePackResponseBodyOperateRuleResultOperateRuleItemList[];
   static names(): { [key: string]: string } {
@@ -102,12 +91,12 @@ export class DetachConfigRuleToCompliancePackResponseBodyOperateRuleResult exten
 export class DetachConfigRuleToCompliancePackResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The results of the operation to detach rules.
+   * The results of the operations to remove one or more rules.
    */
   operateRuleResult?: DetachConfigRuleToCompliancePackResponseBodyOperateRuleResult;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 1AC7AED1-172F-42AE-9C12-295BC2ADB12A

package/src/models/DryRunConfigRuleRequest.ts

@@ -3,52 +3,8 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DryRunConfigRuleRequest extends $dara.Model {
-  /**
-   * @remarks
-   * The complete configuration information of the resource.
-   * 
-   * @example
-   * {
-   *   "ResourceCreationTime": 1741241360000,
-   *   "AccountId": 123,
-   *   "Configuration": {
-   *     "ResourceGroupId": "",
-   *     "Memory": 1024,
-   *     "InstanceChargeType": "PrePaid",
-   *     "Cpu": 1,
-   *     "OSName": "Alibaba Cloud Linux  3.2104 LTS 64 bit",
-   *     "InstanceNetworkType": "vpc",
-   *     "InnerIpAddress": {
-   *       "IpAddress": []
-   *     },
-   *     "ExpiredTime": "2026-05-06T16:00Z",
-   *     "ImageId": "aliyun_3_x64_20G_alibase_20250117.vhd",
-   *     "EipAddress": {
-   *       "AllocationId": "",
-   *       "IpAddress": "",
-   *       "InternetChargeType": ""
-   *     },
-   *     "ImageOptions": {},
-   *     "Status": "Running",
-   *     "AdditionalInfo": {},
-   *     "HibernationOptions": {
-   *       "Configured": false
-   *     }
-   *   },
-   *   "ResourceId": "i-bp1d8kd8ztaynb4c****",
-   *   "ResourceName": "****",
-   *   "ResourceStatus": "Running",
-   *   "Region": "cn-hangzhou",
-   *   "AvailabilityZone": "cn-hangzhou-h",
-   *   "ResourceType": "ACS::ECS::Instance",
-   *   "ResourceDeleted": 1
-   * }
-   */
   configurationItem?: string;
   /**
-   * @remarks
-   * The resource type that is evaluated by the rule.
-   * 
    * @example
    * ACS::ECS::Instance
    */

package/src/models/DryRunConfigRuleResponseBody.ts

@@ -4,49 +4,36 @@ import * as $dara from '@darabonba/typescript';
 
 export class DryRunConfigRuleResponseBody extends $dara.Model {
   /**
-   * @remarks
-   * The compliance type of the rule. Valid values:
-   * 
-   * - COMPLIANT: Compliant.
-   * 
-   * - NON_COMPLIANT: Non-compliant.
-   * 
-   * - NOT_APPLICABLE: Not applicable.
-   * 
-   * - INSUFFICIENT_DATA: Insufficient data.
-   * 
    * @example
    * COMPLIANT
    */
   complianceType?: string;
   /**
    * @remarks
-   * The request ID.
+   * Id of the request
    * 
    * @example
-   * C32EEAD7-BF64-5927-977A-AFF9342B****
+   * C32EEAD7-BF64-5927-977A-AFF9342B7275
    */
   requestId?: string;
   /**
-   * @remarks
-   * The context of the rule conditions.
-   * 
    * @example
    * {
-   *   "result":"NON_COMPLIANT",
-   *   "children":[
-   *     {
-   *       "featureValue":"1",
-   *       "featureSource":"CONFIGURATION",
-   *       "result":"NON_COMPLIANT",
-   *       "desired":"4",
-   *       "children":[],
-   *       "operator":"StringEquals",
-   *       "featurePath":"$.Cpu"
-   *     }
-   *   ],
-   *   "operator":"and"
-   * }
+   * 			"result":"NON_COMPLIANT",
+   * 			"children":[
+   * 				{
+   * 					"featureValue":"1",
+   * 					"featureSource":"CONFIGURATION",
+   * 					"result":"NON_COMPLIANT",
+   * 					"desired":"4",
+   * 					"children":[],
+   * 					"operator":"StringEquals",
+   * 					"featurePath":"$.Cpu"
+   * 				}
+   * 			],
+   * 			"operator":"and"
+   * 		}
+   * 	}
    */
   ruleConditionContext?: string;
   static names(): { [key: string]: string } {

package/src/models/EvaluatePreConfigRulesRequest.ts

@@ -5,11 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class EvaluatePreConfigRulesRequestResourceEvaluateItemsRules extends $dara.Model {
   /**
    * @remarks
-   * The identifier of the rule.
+   * The identifier of the evaluation rule.
    * 
-   * For information about how to obtain the identifier of a rule, see [ListPreManagedRules](https://help.aliyun.com/document_detail/467810.html).
-   * 
-   * > The `ResourceType`, `Identifier`, and `ResourceProperties` parameters must be specified at the same time.
+   * For more information about how to obtain the identifier of an evaluation rule, see [ListManagedRules](https://help.aliyun.com/document_detail/467810.html).
    * 
    * @example
    * ecs-instance-deletion-protection-enabled
@@ -17,7 +15,7 @@ export class EvaluatePreConfigRulesRequestResourceEvaluateItemsRules extends $da
   identifier?: string;
   /**
    * @remarks
-   * The input parameters of the rule.
+   * The input parameters of the evaluation rule.
    * 
    * @example
    * {}
@@ -51,37 +49,34 @@ export class EvaluatePreConfigRulesRequestResourceEvaluateItems extends $dara.Mo
    * @remarks
    * The logical ID of the resource.
    * 
-   * > If this parameter is empty, it is generated based on the Base64 value of `ResourceProperties`.
-   * 
    * @example
    * ResourceLogicId-test
    */
   resourceLogicalId?: string;
   /**
    * @remarks
-   * The resource configuration items (properties of the resource to be created), such as the specifications, region, name, status, and port or network interface switch status of the resource.
-   * 
-   * > The `ResourceType`, `Identifier`, and `ResourceProperties` parameters must be specified at the same time.
+   * The properties of the resource.
    * 
    * @example
-   * {"ResourceGroupId":"","Memory":8192,"InstanceChargeType":"PostPaid","Cpu":2}
+   * {
+   *     "ImageId": "ubuntu_18_04_64_20G_alibase_20190624.vhd",
+   *     "SecurityGroupId": "sg-bp15ed6xe1yxeycg****",
+   *     "HostName": "LocalHostName",
+   *     "RegionId": "cn-hangzhou"
+   * }
    */
   resourceProperties?: string;
   /**
    * @remarks
    * The type of the resource.
    * 
-   * For information about how to obtain the identifier of an evaluation rule, see [ListPreManagedRules](https://help.aliyun.com/document_detail/467810.html).
-   * 
-   * > The `ResourceType`, `Identifier`, and `ResourceProperties` parameters must be specified at the same time.
-   * 
    * @example
    * ACS::ECS::Instance
    */
   resourceType?: string;
   /**
    * @remarks
-   * An array that contains the evaluation rules.
+   * The evaluation rules.
    */
   rules?: EvaluatePreConfigRulesRequestResourceEvaluateItemsRules[];
   static names(): { [key: string]: string } {
@@ -117,11 +112,12 @@ export class EvaluatePreConfigRulesRequestResourceEvaluateItems extends $dara.Mo
 export class EvaluatePreConfigRulesRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to enable rule templates. Valid values:
+   * Specifies whether to enable the managed rule. Valid values:
    * 
-   * - true: enables rule templates.
+   * *   true: enables the managed rule.
+   * *   false: does not enable the managed rule. This is the default value.
    * 
-   * - false (default): does not enable rule templates.
+   * >  After you create an evaluation rule, a managed rule that has the same settings as the evaluation rule is created. After you create a resource, the managed rule can be used to continuously check the compliance of the resource.
    * 
    * @example
    * false
@@ -129,14 +125,14 @@ export class EvaluatePreConfigRulesRequest extends $dara.Model {
   enableManagedRules?: boolean;
   /**
    * @remarks
-   * An array that contains the resources that you want to evaluate.
+   * The resources that you want to evaluate.
    * 
    * This parameter is required.
    */
   resourceEvaluateItems?: EvaluatePreConfigRulesRequestResourceEvaluateItems[];
   /**
    * @remarks
-   * The query start token
+   * 下一个查询开始Token
    * 
    * @example
    * ros

package/src/models/EvaluatePreConfigRulesResponseBody.ts

@@ -15,11 +15,9 @@ export class EvaluatePreConfigRulesResponseBodyResourceEvaluationsRules extends
    * @remarks
    * The compliance type of the resource that was evaluated by using the evaluation rule. Valid values:
    * 
-   * - COMPLIANT: The resource is evaluated as compliant.
-   * 
-   * - NON_COMPLIANT: The resource is evaluated as non-compliant.
-   * 
-   * - NOT_APPLICABLE: The rule does not apply to the resource.
+   * *   COMPLIANT: The resource was evaluated as compliant.
+   * *   NON_COMPLIANT: The resource was evaluated as incompliant.
+   * *   NOT_APPLICABLE: The evaluation rule does not apply to the resource.
    * 
    * @example
    * NON_COMPLIANT
@@ -27,7 +25,7 @@ export class EvaluatePreConfigRulesResponseBodyResourceEvaluationsRules extends
   complianceType?: string;
   /**
    * @remarks
-   * The URL of the topic that describes how the managed rule remediates the non-compliant configurations.
+   * The URL of the topic that describes how the managed rule remediates the incompliant configurations.
    * 
    * @example
    * https://example.aliyundoc.com
@@ -35,7 +33,7 @@ export class EvaluatePreConfigRulesResponseBodyResourceEvaluationsRules extends
   helpUrl?: string;
   /**
    * @remarks
-   * The identifier of the rule.
+   * The identifier of the evaluation rule.
    * 
    * @example
    * ecs-instance-deletion-protection-enabled
@@ -73,7 +71,7 @@ export class EvaluatePreConfigRulesResponseBodyResourceEvaluations extends $dara
    * @remarks
    * The logical ID of the resource.
    * 
-   * > If the request parameter is empty, it is automatically generated based on the Base64 value of `ResourceProperties`.
+   * >  If the ResourceLogicalId request parameter is left empty, the value of the ResourceLogicalId response parameter is generated based on the value of the `ResourceProperties` parameter.
    * 
    * @example
    * ResourceLogicId-test
@@ -131,7 +129,7 @@ export class EvaluatePreConfigRulesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The array that contains the compliance evaluation results.
+   * The details of the compliance evaluation result.
    */
   resourceEvaluations?: EvaluatePreConfigRulesResponseBodyResourceEvaluations[];
   static names(): { [key: string]: string } {

package/src/models/EvaluatePreConfigRulesShrinkRequest.ts

@@ -5,11 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class EvaluatePreConfigRulesShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to enable rule templates. Valid values:
+   * Specifies whether to enable the managed rule. Valid values:
    * 
-   * - true: enables rule templates.
+   * *   true: enables the managed rule.
+   * *   false: does not enable the managed rule. This is the default value.
    * 
-   * - false (default): does not enable rule templates.
+   * >  After you create an evaluation rule, a managed rule that has the same settings as the evaluation rule is created. After you create a resource, the managed rule can be used to continuously check the compliance of the resource.
    * 
    * @example
    * false
@@ -17,14 +18,14 @@ export class EvaluatePreConfigRulesShrinkRequest extends $dara.Model {
   enableManagedRules?: boolean;
   /**
    * @remarks
-   * An array that contains the resources that you want to evaluate.
+   * The resources that you want to evaluate.
    * 
    * This parameter is required.
    */
   resourceEvaluateItemsShrink?: string;
   /**
    * @remarks
-   * The query start token
+   * 下一个查询开始Token
    * 
    * @example
    * ros

package/src/models/GenerateAggregateCompliancePackReportRequest.ts

@@ -7,7 +7,7 @@ export class GenerateAggregateCompliancePackReportRequest extends $dara.Model {
    * @remarks
    * The ID of the account group.
    * 
-   * For information about how to obtain the account group ID, see [ListAggregators](https://help.aliyun.com/document_detail/255797.html).
+   * For more information about how to obtain the ID of the account group, see [ListAggregators](https://help.aliyun.com/document_detail/255797.html).
    * 
    * This parameter is required.
    * 
@@ -17,7 +17,7 @@ export class GenerateAggregateCompliancePackReportRequest extends $dara.Model {
   aggregatorId?: string;
   /**
    * @remarks
-   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The `ClientToken` can contain only ASCII characters and cannot exceed 64 characters in length.
+   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The `token` can contain only ASCII characters and cannot exceed 64 characters in length.
    * 
    * @example
    * 1594295238-f9361358-5843-4294-8d30-b5183fac****
@@ -27,7 +27,7 @@ export class GenerateAggregateCompliancePackReportRequest extends $dara.Model {
    * @remarks
    * The ID of the compliance package.
    * 
-   * For information about how to obtain the compliance package ID, see [ListAggregateCompliancePacks](https://help.aliyun.com/document_detail/262059.html).
+   * For more information about how to obtain the ID of a compliance package, see [ListAggregateCompliancePacks](https://help.aliyun.com/document_detail/262059.html).
    * 
    * This parameter is required.
    * 
@@ -35,17 +35,6 @@ export class GenerateAggregateCompliancePackReportRequest extends $dara.Model {
    * cp-fdc8626622af00f9****
    */
   compliancePackId?: string;
-  /**
-   * @remarks
-   * Specifies whether to generate multiple files based on resource ownership user IDs. Valid values:
-   * 
-   * - true: generates multiple files (default)
-   * 
-   * - false: generates a single file
-   * 
-   * @example
-   * true
-   */
   multiFiles?: boolean;
   static names(): { [key: string]: string } {
     return {

package/src/models/GenerateAggregateCompliancePackReportResponseBody.ts

@@ -13,7 +13,7 @@ export class GenerateAggregateCompliancePackReportResponseBody extends $dara.Mod
   compliancePackId?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 6EC7AED1-172F-42AE-9C12-295BC2ADB751

package/src/models/GenerateAggregateConfigRulesReportRequest.ts

@@ -5,10 +5,33 @@ import * as $dara from '@darabonba/typescript';
 export class GenerateAggregateConfigRulesReportRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the account group.
+   * 
+   * For more information about how to obtain the ID of the account group, see [ListAggregators](https://help.aliyun.com/document_detail/255797.html).
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * ca-f632626622af0079****
    */
   aggregatorId?: string;
+  /**
+   * @remarks
+   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The `token` can contain only ASCII characters and cannot exceed 64 characters in length.
+   * 
+   * @example
+   * 1594295238-f9361358-5843-4294-8d30-b5183fac****
+   */
   clientToken?: string;
+  /**
+   * @remarks
+   * The rule ID. Separate multiple rule IDs with commas (,).
+   * 
+   * For more information about how to obtain the ID of a rule, see [ListAggregateConfigRules](https://help.aliyun.com/document_detail/264148.html).
+   * 
+   * @example
+   * cr-25d86457e0d900b5****
+   */
   configRuleIds?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/GenerateAggregateConfigRulesReportResponseBody.ts

@@ -3,8 +3,29 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GenerateAggregateConfigRulesReportResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the account group.
+   * 
+   * @example
+   * ca-f632626622af0079****
+   */
   aggregatorId?: string;
+  /**
+   * @remarks
+   * The ID of the compliance evaluation report.
+   * 
+   * @example
+   * crp-88176457e0d900c9****
+   */
   reportId?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 6EC7AED1-172F-42AE-9C12-295BC2ADB751
+   */
   requestId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/GenerateAggregateResourceInventoryRequest.ts

@@ -3,14 +3,50 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GenerateAggregateResourceInventoryRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The IDs of member accounts in the account group. Separate multiple member account IDs with commas (,).
+   * 
+   * @example
+   * 126672004088****
+   */
   accountIds?: string;
   /**
    * @remarks
+   * The ID of the account group.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * ca-a91d626622af0035****
    */
   aggregatorId?: string;
+  /**
+   * @remarks
+   * The IDs of the regions to which the resources belong. Separate multiple region IDs with commas (,).
+   * 
+   * @example
+   * cn-shanghai
+   */
   regions?: string;
+  /**
+   * @remarks
+   * Indicates whether the resource is deleted. Valid values:
+   * 
+   * *   1 (default): The resource is retained.
+   * *   0: The resource is deleted.
+   * 
+   * @example
+   * 1
+   */
   resourceDeleted?: number;
+  /**
+   * @remarks
+   * The resource types. Separate multiple resource types with commas (,).
+   * 
+   * @example
+   * ACS::ECS::Instance
+   */
   resourceTypes?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/GenerateAggregateResourceInventoryResponseBody.ts

@@ -3,6 +3,13 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GenerateAggregateResourceInventoryResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 5111CBA6-6485-57EB-BCDD-85D8BB31E7A7
+   */
   requestId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/GenerateCompliancePackReportRequest.ts

@@ -3,10 +3,24 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GenerateCompliancePackReportRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The `token` can contain only ASCII characters and cannot exceed 64 characters in length.
+   * 
+   * @example
+   * AAAAAdDWBF2****
+   */
   clientToken?: string;
   /**
    * @remarks
+   * The ID of the compliance package.
+   * 
+   * For more information about how to obtain the ID of a compliance package, see [ListCompliancePacks](https://help.aliyun.com/document_detail/263332.html).
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * cp-a8a8626622af0082****
    */
   compliancePackId?: string;
   static names(): { [key: string]: string } {

package/src/models/GenerateCompliancePackReportResponseBody.ts

@@ -3,7 +3,21 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GenerateCompliancePackReportResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the compliance package.
+   * 
+   * @example
+   * cp-a8a8626622af0082****
+   */
   compliancePackId?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 6EC7AED1-172F-42AE-9C12-295BC2ADB751
+   */
   requestId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/GenerateConfigRulesReportRequest.ts

@@ -3,7 +3,23 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GenerateConfigRulesReportRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
+   * 
+   * @example
+   * AAAAAdDWBF2****
+   */
   clientToken?: string;
+  /**
+   * @remarks
+   * The ID of the rule. Separate multiple rule IDs with commas (,).
+   * 
+   * For more information about how to query the ID of a rule, see [ListConfigRules](https://help.aliyun.com/document_detail/169607.html).
+   * 
+   * @example
+   * cr-25d86457e0d900b5****
+   */
   configRuleIds?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/GenerateConfigRulesReportResponseBody.ts

@@ -3,7 +3,21 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GenerateConfigRulesReportResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the compliance evaluation report.
+   * 
+   * @example
+   * crp-88176457e0d900c9****
+   */
   reportId?: string;
+  /**
+   * @remarks
+   * The ID of the request.
+   * 
+   * @example
+   * 6EC7AED1-172F-42AE-9C12-295BC2ADB751
+   */
   requestId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/GenerateReportFromTemplateRequest.ts

@@ -5,8 +5,6 @@ import * as $dara from '@darabonba/typescript';
 export class GenerateReportFromTemplateRequest extends $dara.Model {
   /**
    * @remarks
-   * Report template ID.
-   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GenerateReportFromTemplateResponseBody.ts

@@ -4,9 +4,6 @@ import * as $dara from '@darabonba/typescript';
 
 export class GenerateReportFromTemplateResponseBody extends $dara.Model {
   /**
-   * @remarks
-   * Request ID.
-   * 
    * @example
    * 6CE4ABA1-9A57-41A9-8EA9-E8B17D4671CD
    */