@alicloud/config20200907 4.2.1 → 4.2.3

package/src/models/ListAggregateConfigRuleEvaluationStatisticsResponseBody.ts

@@ -3,11 +3,53 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListAggregateConfigRuleEvaluationStatisticsResponseBodyEvaluationResults extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the account group.
+   * 
+   * @example
+   * ca-edd3626622af00b3****
+   */
   aggregatorId?: string;
+  /**
+   * @remarks
+   * The number of resources that are evaluated as non-compliant.
+   * 
+   * @example
+   * 25
+   */
   nonCompliantResourceCnt?: number;
+  /**
+   * @remarks
+   * The number of rules based on which resources are evaluated as non-compliant.
+   * 
+   * @example
+   * 3
+   */
   nonCompliantRuleCnt?: number;
+  /**
+   * @remarks
+   * The date on which the statistics are obtained.
+   * 
+   * @example
+   * 2023-06-27
+   */
   statisticDate?: string;
+  /**
+   * @remarks
+   * The total number of resources.
+   * 
+   * @example
+   * 153
+   */
   totalResourceCnt?: number;
+  /**
+   * @remarks
+   * The total number of rules.
+   * 
+   * @example
+   * 10
+   */
   totalRuleCnt?: number;
   static names(): { [key: string]: string } {
     return {
@@ -41,7 +83,18 @@ export class ListAggregateConfigRuleEvaluationStatisticsResponseBodyEvaluationRe
 }
 
 export class ListAggregateConfigRuleEvaluationStatisticsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The statistics of compliance evaluation results.
+   */
   evaluationResults?: ListAggregateConfigRuleEvaluationStatisticsResponseBodyEvaluationResults[];
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 9EFA436B-FC6F-513B-9DB8-C96E6CEBE5E0
+   */
   requestId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListAggregateConfigRulesRequest.ts

@@ -5,9 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class ListAggregateConfigRulesRequestTag extends $dara.Model {
   /**
    * @remarks
-   * The key of a resource tag.
+   * The tag key.
    * 
-   * You can add a maximum of 20 tag keys.
+   * The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with `acs:` or `aliyun`. It cannot contain `http://` or `https://`.
+   * 
+   * You can specify at most 20 tag keys.
    * 
    * @example
    * key-1
@@ -15,9 +17,9 @@ export class ListAggregateConfigRulesRequestTag extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * The value of a resource tag.
+   * The value of the tag. You can specify up to 20 tag values. The tag value can be an empty string.
    * 
-   * You can add a maximum of 20 tag values.
+   * The tag value can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag value cannot contain `http://` or `https://`.
    * 
    * @example
    * value-1
@@ -61,7 +63,7 @@ export class ListAggregateConfigRulesRequest extends $dara.Model {
   aggregatorId?: string;
   /**
    * @remarks
-   * The ID of the compliance package.
+   * The compliance package ID.
    * 
    * @example
    * cp-fe416457e0d90022****
@@ -71,13 +73,10 @@ export class ListAggregateConfigRulesRequest extends $dara.Model {
    * @remarks
    * The compliance evaluation result. Valid values:
    * 
-   * - COMPLIANT: The resource is compliant.
-   * 
-   * - NON_COMPLIANT: The resource is non-compliant.
-   * 
-   * - NOT_APPLICABLE: The rule does not apply to the resource.
-   * 
-   * - INSUFFICIENT_DATA: No data is available.
+   * *   COMPLIANT: The resources are evaluated as compliant.
+   * *   NON_COMPLIANT: The resources are evaluated as non-compliant.
+   * *   NOT_APPLICABLE: The rule does not apply to the resources.
+   * *   INSUFFICIENT_DATA: No data is available.
    * 
    * @example
    * COMPLIANT
@@ -88,20 +87,17 @@ export class ListAggregateConfigRulesRequest extends $dara.Model {
    * The name of the rule.
    * 
    * @example
-   * The name of the rule.
+   * test-rule-name
    */
   configRuleName?: string;
   /**
    * @remarks
-   * The state of the rule. Valid values:
-   * 
-   * - ACTIVE: The rule is enabled.
-   * 
-   * - DELETING: The rule is being deleted.
-   * 
-   * - EVALUATING: The rule is being evaluated.
+   * The status of the rule. Valid values:
    * 
-   * - INACTIVE: The rule is disabled.
+   * *   ACTIVE: The rule is being used to monitor resource configurations.
+   * *   DELETING: The rule is being deleted.
+   * *   EVALUATING: The rule is triggered and is being used to monitor resource configurations.
+   * *   INACTIVE: The rule is disabled.
    * 
    * @example
    * ACTIVE
@@ -109,9 +105,9 @@ export class ListAggregateConfigRulesRequest extends $dara.Model {
   configRuleState?: string;
   /**
    * @remarks
-   * The keyword for a fuzzy query.
+   * The keyword that is used for queries.
    * 
-   * The keyword can be a rule ID, rule name, rule description, or rule template identifier.
+   * You can perform a fuzzy search by rule ID, rule name, rule description, or managed rule ID.
    * 
    * @example
    * ecs
@@ -121,7 +117,7 @@ export class ListAggregateConfigRulesRequest extends $dara.Model {
    * @remarks
    * The page number.
    * 
-   * Pages start from page 1. Default value: 1.
+   * Pages start from page 1. Default value: 1
    * 
    * @example
    * 1
@@ -129,9 +125,9 @@ export class ListAggregateConfigRulesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page.
+   * The number of entries per page.
    * 
-   * Valid values: 1 to 100. Default value: 10.
+   * Valid values: 1 to 100. Minimum value: 1. Default value: 10
    * 
    * @example
    * 10
@@ -139,7 +135,7 @@ export class ListAggregateConfigRulesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The resource type to be evaluated by the rule.
+   * Resource type for the rule to evaluate.
    * 
    * @example
    * ACS::ECS::Instance
@@ -147,31 +143,22 @@ export class ListAggregateConfigRulesRequest extends $dara.Model {
   resourceTypes?: string;
   /**
    * @remarks
-   * The risk level of the rule. Valid values:
+   * The risk level of the resources that do not comply with the rule. Valid values:
    * 
-   * - 1: high
-   * 
-   * - 2: medium
-   * 
-   * - 3: low
+   * *   1: high
+   * *   2: medium
+   * *   3: low
    * 
    * @example
    * 1
    */
   riskLevel?: number;
-  /**
-   * @remarks
-   * The method that is used to sort the rules. By default, this parameter is not specified. Set the value to `CreateDate-Desc` to sort the rules in descending order of their creation time.
-   * 
-   * @example
-   * CreateDate-Desc
-   */
   sortBy?: string;
   /**
    * @remarks
    * The tags of the resource.
    * 
-   * You can add a maximum of 20 tags.
+   * You can add up to 20 tags to a resource.
    */
   tag?: ListAggregateConfigRulesRequestTag[];
   static names(): { [key: string]: string } {

package/src/models/ListAggregateConfigRulesResponseBody.ts

@@ -5,15 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleListCompliance extends $dara.Model {
   /**
    * @remarks
-   * The summary of the compliance evaluation result. Valid values:
+   * The compliance evaluation result. Valid values:
    * 
-   * - COMPLIANT: The resource is compliant.
-   * 
-   * - NON_COMPLIANT: The resource is non-compliant.
-   * 
-   * - NOT_APPLICABLE: The rule does not apply to the resource.
-   * 
-   * - INSUFFICIENT_DATA: No data is available.
+   * *   COMPLIANT: The resources are evaluated as compliant.
+   * *   NON_COMPLIANT: The resources are evaluated as non-compliant.
+   * *   NOT_APPLICABLE: The rule does not apply to the resources.
+   * *   INSUFFICIENT_DATA: No data is available.
    * 
    * @example
    * COMPLIANT
@@ -21,7 +18,7 @@ export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleListCompli
   complianceType?: string;
   /**
    * @remarks
-   * The number of resources that are evaluated based on the summary of the compliance evaluation.
+   * The number of evaluation resources that correspond to the summary result of the rule compliance evaluation.
    * 
    * @example
    * 2
@@ -53,7 +50,7 @@ export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleListCompli
 export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleListCreateBy extends $dara.Model {
   /**
    * @remarks
-   * The ID of the account group.
+   * The account group ID.
    * 
    * @example
    * ca-f632626622af0079****
@@ -69,7 +66,7 @@ export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleListCreate
   aggregatorName?: string;
   /**
    * @remarks
-   * The ID of the compliance package.
+   * The compliance package ID.
    * 
    * @example
    * cp-fdc8626622af00f9****
@@ -80,7 +77,7 @@ export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleListCreate
    * The name of the compliance package.
    * 
    * @example
-   * The name of the compliance package.
+   * test-pack-name
    */
   compliancePackName?: string;
   /**
@@ -93,7 +90,7 @@ export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleListCreate
   creatorId?: string;
   /**
    * @remarks
-   * The name of the management account that created the rule.
+   * The name of the management account that create the rule.
    * 
    * @example
    * Alice
@@ -101,7 +98,7 @@ export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleListCreate
   creatorName?: string;
   /**
    * @remarks
-   * The type of the creator. The value is fixed to AGGREGATOR.
+   * The type of the creator of the rule. The value is fixed to AGGREGATOR, which indicates an account group.
    * 
    * @example
    * AGGREGATOR
@@ -143,7 +140,7 @@ export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleListCreate
 export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleListTags extends $dara.Model {
   /**
    * @remarks
-   * The key of the tag.
+   * The tag key of the rule.
    * 
    * @example
    * env
@@ -151,7 +148,7 @@ export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleListTags e
   key?: string;
   /**
    * @remarks
-   * The value of the tag.
+   * The tag value of the rule.
    * 
    * @example
    * prod
@@ -183,7 +180,7 @@ export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleListTags e
 export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleList extends $dara.Model {
   /**
    * @remarks
-   * The ID of the management account to which the rule belongs.
+   * The ID of the management account to which the rules belong.
    * 
    * @example
    * 100931896542****
@@ -191,7 +188,7 @@ export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleList exten
   accountId?: number;
   /**
    * @remarks
-   * The remediation type. The value is fixed to OOS, which indicates Operation Orchestration Service.
+   * The type of the remediation template. Only OOS is returned, which indicates CloudOps Orchestration Service.
    * 
    * @example
    * OOS
@@ -212,7 +209,7 @@ export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleList exten
   configRuleArn?: string;
   /**
    * @remarks
-   * The ID of the rule.
+   * The rule ID.
    * 
    * @example
    * cr-fdc8626622af00f9****
@@ -223,20 +220,17 @@ export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleList exten
    * The name of the rule.
    * 
    * @example
-   * The name of the rule.
+   * test-rule-name
    */
   configRuleName?: string;
   /**
    * @remarks
-   * The state of the rule. Valid values:
+   * The status of the rule. Valid values:
    * 
-   * - ACTIVE: The rule is enabled.
-   * 
-   * - DELETING: The rule is being deleted.
-   * 
-   * - EVALUATING: The rule is being evaluated.
-   * 
-   * - INACTIVE: The rule is disabled.
+   * *   ACTIVE: The rule is being used to monitor resource configurations.
+   * *   DELETING: The rule is being deleted.
+   * *   EVALUATING: The rule is triggered and is being used to monitor resource configurations.
+   * *   INACTIVE: The rule is disabled.
    * 
    * @example
    * ACTIVE
@@ -244,28 +238,21 @@ export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleList exten
   configRuleState?: string;
   /**
    * @remarks
-   * The information about the creator of the rule.
+   * The information about the creation of the rule.
    */
   createBy?: ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleListCreateBy;
-  /**
-   * @remarks
-   * The time when the rule was created. The time is displayed in UTC+8.
-   * 
-   * @example
-   * 2025-09-19T15:51:00
-   */
   createDate?: string;
   /**
    * @remarks
    * The description of the rule.
    * 
    * @example
-   * The description of the rule.
+   * The description of the test rule.
    */
   description?: string;
   /**
    * @remarks
-   * The types of the resources that are evaluated by the rule. Multiple resource types are separated by commas (,).
+   * The types of resources evaluated by the rule. Multiple resource types are separated with commas (,).
    * 
    * @example
    * ACS::EIP::EipAddress
@@ -273,13 +260,11 @@ export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleList exten
   resourceTypesScope?: string;
   /**
    * @remarks
-   * The risk level of the rule. Valid values:
+   * The risk level of the resources that do not comply with the rule. Valid values:
    * 
-   * - 1: high
-   * 
-   * - 2: medium
-   * 
-   * - 3: low
+   * *   1: high
+   * *   2: medium
+   * *   3: low
    * 
    * @example
    * 1
@@ -289,9 +274,8 @@ export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleList exten
    * @remarks
    * The identifier of the rule.
    * 
-   * - If the rule is a managed rule, the value of this parameter is the identifier of the rule template.
-   * 
-   * - If the rule is a custom rule, the value of this parameter is the ARN of the function.
+   * *   If the rule is a managed rule, the value of this parameter is the name of the managed rule.
+   * *   If the rule is a custom rule, the value of this parameter is the Alibaba Cloud Resource Name (ARN) of a function.
    * 
    * @example
    * eip-bandwidth-limit
@@ -299,11 +283,10 @@ export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleList exten
   sourceIdentifier?: string;
   /**
    * @remarks
-   * The owner of the rule. Valid values:
-   * 
-   * - CUSTOM_FC: a custom rule.
+   * The type of the rule. Valid values:
    * 
-   * - ALIYUN: a managed rule.
+   * *   CUSTOM_FC: a custom rule.
+   * *   ALIYUN: a managed rule.
    * 
    * @example
    * ALIYUN
@@ -375,12 +358,12 @@ export class ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleList exten
 export class ListAggregateConfigRulesResponseBodyConfigRules extends $dara.Model {
   /**
    * @remarks
-   * The details of the rules.
+   * The details of the rule.
    */
   configRuleList?: ListAggregateConfigRulesResponseBodyConfigRulesConfigRuleList[];
   /**
    * @remarks
-   * The page number.
+   * The number of the page returned.
    * 
    * @example
    * 1
@@ -388,7 +371,7 @@ export class ListAggregateConfigRulesResponseBodyConfigRules extends $dara.Model
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries returned on each page.
+   * The number of entries returned per page.
    * 
    * @example
    * 10
@@ -435,12 +418,12 @@ export class ListAggregateConfigRulesResponseBodyConfigRules extends $dara.Model
 export class ListAggregateConfigRulesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The rules.
+   * The queried rules.
    */
   configRules?: ListAggregateConfigRulesResponseBodyConfigRules;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 22EF8287-2C9A-4F1F-80A6-CEFA7612689D

package/src/models/ListAggregateConfigRulesShrinkRequest.ts

@@ -17,7 +17,7 @@ export class ListAggregateConfigRulesShrinkRequest extends $dara.Model {
   aggregatorId?: string;
   /**
    * @remarks
-   * The ID of the compliance package.
+   * The compliance package ID.
    * 
    * @example
    * cp-fe416457e0d90022****
@@ -27,13 +27,10 @@ export class ListAggregateConfigRulesShrinkRequest extends $dara.Model {
    * @remarks
    * The compliance evaluation result. Valid values:
    * 
-   * - COMPLIANT: The resource is compliant.
-   * 
-   * - NON_COMPLIANT: The resource is non-compliant.
-   * 
-   * - NOT_APPLICABLE: The rule does not apply to the resource.
-   * 
-   * - INSUFFICIENT_DATA: No data is available.
+   * *   COMPLIANT: The resources are evaluated as compliant.
+   * *   NON_COMPLIANT: The resources are evaluated as non-compliant.
+   * *   NOT_APPLICABLE: The rule does not apply to the resources.
+   * *   INSUFFICIENT_DATA: No data is available.
    * 
    * @example
    * COMPLIANT
@@ -44,20 +41,17 @@ export class ListAggregateConfigRulesShrinkRequest extends $dara.Model {
    * The name of the rule.
    * 
    * @example
-   * The name of the rule.
+   * test-rule-name
    */
   configRuleName?: string;
   /**
    * @remarks
-   * The state of the rule. Valid values:
-   * 
-   * - ACTIVE: The rule is enabled.
-   * 
-   * - DELETING: The rule is being deleted.
-   * 
-   * - EVALUATING: The rule is being evaluated.
+   * The status of the rule. Valid values:
    * 
-   * - INACTIVE: The rule is disabled.
+   * *   ACTIVE: The rule is being used to monitor resource configurations.
+   * *   DELETING: The rule is being deleted.
+   * *   EVALUATING: The rule is triggered and is being used to monitor resource configurations.
+   * *   INACTIVE: The rule is disabled.
    * 
    * @example
    * ACTIVE
@@ -65,9 +59,9 @@ export class ListAggregateConfigRulesShrinkRequest extends $dara.Model {
   configRuleState?: string;
   /**
    * @remarks
-   * The keyword for a fuzzy query.
+   * The keyword that is used for queries.
    * 
-   * The keyword can be a rule ID, rule name, rule description, or rule template identifier.
+   * You can perform a fuzzy search by rule ID, rule name, rule description, or managed rule ID.
    * 
    * @example
    * ecs
@@ -77,7 +71,7 @@ export class ListAggregateConfigRulesShrinkRequest extends $dara.Model {
    * @remarks
    * The page number.
    * 
-   * Pages start from page 1. Default value: 1.
+   * Pages start from page 1. Default value: 1
    * 
    * @example
    * 1
@@ -85,9 +79,9 @@ export class ListAggregateConfigRulesShrinkRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page.
+   * The number of entries per page.
    * 
-   * Valid values: 1 to 100. Default value: 10.
+   * Valid values: 1 to 100. Minimum value: 1. Default value: 10
    * 
    * @example
    * 10
@@ -95,7 +89,7 @@ export class ListAggregateConfigRulesShrinkRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The resource type to be evaluated by the rule.
+   * Resource type for the rule to evaluate.
    * 
    * @example
    * ACS::ECS::Instance
@@ -103,31 +97,22 @@ export class ListAggregateConfigRulesShrinkRequest extends $dara.Model {
   resourceTypes?: string;
   /**
    * @remarks
-   * The risk level of the rule. Valid values:
+   * The risk level of the resources that do not comply with the rule. Valid values:
    * 
-   * - 1: high
-   * 
-   * - 2: medium
-   * 
-   * - 3: low
+   * *   1: high
+   * *   2: medium
+   * *   3: low
    * 
    * @example
    * 1
    */
   riskLevel?: number;
-  /**
-   * @remarks
-   * The method that is used to sort the rules. By default, this parameter is not specified. Set the value to `CreateDate-Desc` to sort the rules in descending order of their creation time.
-   * 
-   * @example
-   * CreateDate-Desc
-   */
   sortBy?: string;
   /**
    * @remarks
    * The tags of the resource.
    * 
-   * You can add a maximum of 20 tags.
+   * You can add up to 20 tags to a resource.
    */
   tagShrink?: string;
   static names(): { [key: string]: string } {