@alicloud/config20200907 4.2.2 → 4.2.3

package/src/models/ListConfigRuleEvaluationResultsResponseBody.ts

@@ -13,7 +13,7 @@ export class ListConfigRuleEvaluationResultsResponseBodyEvaluationResultsEvaluat
   compliancePackId?: string;
   /**
    * @remarks
-   * The Alibaba Cloud Resource Name (ARN) of the rule.
+   * The ARN of the rule.
    * 
    * @example
    * acs:config::120886317861****:rule/cr-cac56457e0d900d3****
@@ -32,14 +32,14 @@ export class ListConfigRuleEvaluationResultsResponseBodyEvaluationResultsEvaluat
    * The rule name.
    * 
    * @example
-   * ECS实例CPU核数满足最低要求
+   * test-rule-name
    */
   configRuleName?: string;
   /**
    * @remarks
-   * The date when the ignored evaluation result is automatically resumed.
+   * The date on which the system automatically re-evaluates the ignored incompliant resources.
    * 
-   * > If this parameter is empty, the result is not automatically resumed. You must manually resume it.
+   * >  If the value of this parameter is left empty, the system does not automatically re-evaluate the ignored incompliant resources. You must manually re-evaluate the ignored incompliant resources.
    * 
    * @example
    * 2022-06-01
@@ -47,7 +47,7 @@ export class ListConfigRuleEvaluationResultsResponseBodyEvaluationResultsEvaluat
   ignoreDate?: string;
   /**
    * @remarks
-   * The ID of the region to which the resource belongs.
+   * The ID of the region in which your resources reside.
    * 
    * @example
    * cn-hangzhou
@@ -55,13 +55,8 @@ export class ListConfigRuleEvaluationResultsResponseBodyEvaluationResultsEvaluat
   regionId?: string;
   /**
    * @remarks
-   * The ID of the resource group to which the resource belongs.
-   * 
    * This parameter is required.
    * 
-   * @example
-   * rg-aek3tprgnnc****
-   * 
    * **if can be null:**
    * true
    */
@@ -92,7 +87,7 @@ export class ListConfigRuleEvaluationResultsResponseBodyEvaluationResultsEvaluat
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The resource type.
+   * The type of the resource that is monitored by Cloud Config.
    * 
    * @example
    * ACS::ECS::Instance
@@ -142,12 +137,12 @@ export class ListConfigRuleEvaluationResultsResponseBodyEvaluationResultsEvaluat
 export class ListConfigRuleEvaluationResultsResponseBodyEvaluationResultsEvaluationResultListEvaluationResultIdentifier extends $dara.Model {
   /**
    * @remarks
-   * The resource information in the rule evaluation result.
+   * The information about the evaluated resource in the compliance evaluation result.
    */
   evaluationResultQualifier?: ListConfigRuleEvaluationResultsResponseBodyEvaluationResultsEvaluationResultListEvaluationResultIdentifierEvaluationResultQualifier;
   /**
    * @remarks
-   * The UNIX timestamp displayed on the timeline. Unit: milliseconds.
+   * The timestamp when the compliance evaluation was performed. Unit: milliseconds.
    * 
    * @example
    * 1622802307081
@@ -182,17 +177,13 @@ export class ListConfigRuleEvaluationResultsResponseBodyEvaluationResultsEvaluat
 export class ListConfigRuleEvaluationResultsResponseBodyEvaluationResultsEvaluationResultList extends $dara.Model {
   /**
    * @remarks
-   * The supplementary information about the non-compliant resource. This may include the following information:
-   * 
-   * - `configuration`: The current configuration of the resource, which is the non-compliant configuration.
-   * 
-   * - `desiredValue`: The expected configuration of the resource, which is the compliant configuration.
-   * 
-   * - `operator`: The comparison operator used to compare the current configuration with the expected configuration.
+   * The annotation to the resource that is evaluated as non-compliant. The following section describe the parameters that can be returned:
    * 
-   * - `property`: The JSON path of the current configuration in the resource property struct.
-   * 
-   * - `reason`: The reason why the resource is non-compliant.
+   * *   `configuration`: the current resource configuration that is evaluated as non-compliant.
+   * *   `desiredValue`: the expected resource configuration that is evaluated as compliant.
+   * *   `operator`: the operator that compares the current configuration with the expected configuration of the resource.
+   * *   `property`: the JSON path of the current configuration in the resource property struct.
+   * *   `reason`: the reason why the resource is evaluated as non-compliant.
    * 
    * @example
    * {\\"configuration\\":\\"\\",\\"desiredValue\\":\\"\\",\\"operator\\":\\"IsNotStringEmpty\\",\\"property\\":\\"$.KeyPairName\\",\\"reason\\":\\"No property contains.\\"}
@@ -200,17 +191,13 @@ export class ListConfigRuleEvaluationResultsResponseBodyEvaluationResultsEvaluat
   annotation?: string;
   /**
    * @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.
+   * The compliance evaluation result of the resource. Valid values:
    * 
-   * - IGNORED: The evaluation result is ignored.
+   * *   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.
+   * *   IGNORED: The resource is ignored during compliance evaluation.
    * 
    * @example
    * NON_COMPLIANT
@@ -218,62 +205,50 @@ export class ListConfigRuleEvaluationResultsResponseBodyEvaluationResultsEvaluat
   complianceType?: string;
   /**
    * @remarks
-   * The UNIX timestamp when the rule was triggered for evaluation. Unit: milliseconds.
+   * The timestamp when the rule was triggered for the compliance evaluation. Unit: milliseconds.
    * 
    * @example
    * 1622802307081
    */
   configRuleInvokedTimestamp?: number;
   /**
-   * @remarks
-   * The unique ID of the evaluation result.
-   * 
    * @example
    * 00000089-4e0d-58b5-a96a-8e54112110f3
    */
   evaluationId?: string;
   /**
    * @remarks
-   * The identifier of the rule evaluation result.
+   * The identifying information about the compliance evaluation result.
    */
   evaluationResultIdentifier?: ListConfigRuleEvaluationResultsResponseBodyEvaluationResultsEvaluationResultListEvaluationResultIdentifier;
   /**
    * @remarks
    * The trigger type of the rule. Valid values:
    * 
-   * - ConfigurationItemChangeNotification: The rule is triggered by a configuration change.
-   * 
-   * - ScheduledNotification: The rule is triggered periodically.
-   * 
-   * - Manual: The rule is triggered manually.
+   * *   ConfigurationItemChangeNotification: The rule is triggered by configuration changes.
+   * *   ScheduledNotification: The rule is periodically triggered.
+   * *   Manual: The rule is manually triggered.
    * 
    * @example
    * ConfigurationItemChangeNotification
    */
   invokingEventMessageType?: string;
   /**
-   * @remarks
-   * The time when the resource was last remediated to a compliant state. This value is not recorded when a new resource or rule is evaluated as compliant for the first time.
-   * 
    * @example
-   * 1768788515723
+   * 1768788515725
    */
   lastCompliantFixedTimestamp?: number;
   /**
-   * @remarks
-   * The start time of the last non-compliance.
-   * 
    * @example
    * 1744696665000
    */
   lastNonCompliantRecordTimestamp?: number;
   /**
    * @remarks
-   * Indicates whether the remediation setting is enabled. Valid values:
-   * 
-   * - true: The remediation setting is enabled.
+   * Indicates whether the remediation template is enabled. Valid values:
    * 
-   * - false: The remediation setting is disabled.
+   * *   true: The remediation template is enabled.
+   * *   false: The remediation template is disabled.
    * 
    * @example
    * false
@@ -281,7 +256,7 @@ export class ListConfigRuleEvaluationResultsResponseBodyEvaluationResultsEvaluat
   remediationEnabled?: boolean;
   /**
    * @remarks
-   * The UNIX timestamp when the resource evaluation result was generated. Unit: milliseconds.
+   * The timestamp when the compliance evaluation result was recorded. Unit: milliseconds.
    * 
    * @example
    * 1622802307150
@@ -289,13 +264,11 @@ export class ListConfigRuleEvaluationResultsResponseBodyEvaluationResultsEvaluat
   resultRecordedTimestamp?: number;
   /**
    * @remarks
-   * The risk level of the rule. Valid values:
-   * 
-   * - 1: high
-   * 
-   * - 2: medium
+   * The risk level of the resources that do not comply with the rule. Valid values:
    * 
-   * - 3: low
+   * *   1: high
+   * *   2: medium
+   * *   3: low
    * 
    * @example
    * 1
@@ -348,7 +321,7 @@ export class ListConfigRuleEvaluationResultsResponseBodyEvaluationResultsEvaluat
 export class ListConfigRuleEvaluationResultsResponseBodyEvaluationResults extends $dara.Model {
   /**
    * @remarks
-   * The list of rule evaluation results.
+   * The details of the compliance evaluation result.
    */
   evaluationResultList?: ListConfigRuleEvaluationResultsResponseBodyEvaluationResultsEvaluationResultList[];
   /**
@@ -361,7 +334,7 @@ export class ListConfigRuleEvaluationResultsResponseBodyEvaluationResults extend
   maxResults?: number;
   /**
    * @remarks
-   * The token used to retrieve the next page of results.
+   * A pagination token. It can be used in the next request to retrieve a new page of results.
    * 
    * @example
    * IWBjqMYSy0is7zSMGu16****
@@ -398,7 +371,7 @@ export class ListConfigRuleEvaluationResultsResponseBodyEvaluationResults extend
 export class ListConfigRuleEvaluationResultsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The rule evaluation results.
+   * The compliance evaluation results returned.
    */
   evaluationResults?: ListConfigRuleEvaluationResultsResponseBodyEvaluationResults;
   /**

package/src/models/ListConfigRuleEvaluationStatisticsResponseBody.ts

@@ -3,10 +3,45 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListConfigRuleEvaluationStatisticsResponseBodyEvaluationResults extends $dara.Model {
+  /**
+   * @remarks
+   * The number of resources that are evaluated as non-compliant.
+   * 
+   * @example
+   * 30
+   */
   nonCompliantResourceCnt?: number;
+  /**
+   * @remarks
+   * The number of rules based on which resources are evaluated as non-compliant.
+   * 
+   * @example
+   * 5
+   */
   nonCompliantRuleCnt?: number;
+  /**
+   * @remarks
+   * The date on which the statistics are obtained.
+   * 
+   * @example
+   * 2023-06-27
+   */
   statisticDate?: string;
+  /**
+   * @remarks
+   * The total number of resources.
+   * 
+   * @example
+   * 91
+   */
   totalResourceCnt?: number;
+  /**
+   * @remarks
+   * The total number of rules.
+   * 
+   * @example
+   * 13
+   */
   totalRuleCnt?: number;
   static names(): { [key: string]: string } {
     return {
@@ -38,7 +73,18 @@ export class ListConfigRuleEvaluationStatisticsResponseBodyEvaluationResults ext
 }
 
 export class ListConfigRuleEvaluationStatisticsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The statistics of compliance evaluation results.
+   */
   evaluationResults?: ListConfigRuleEvaluationStatisticsResponseBodyEvaluationResults[];
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 4FF2B787-347E-5299-A196-2C0448DEA341
+   */
   requestId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListConfigRuleOperatorsResponseBody.ts

@@ -4,87 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListConfigRuleOperatorsResponseBodyOperators extends $dara.Model {
   /**
-   * @remarks
-   * The data type that the operator applies to.
-   * 
    * @example
    * String
    */
   dataType?: string;
-  /**
-   * @remarks
-   * The description of the operator, which can be used to explain why a resource is non-compliant.
-   * 
-   * @example
-   * The current value must equal the target value (case insensitive)
-   */
   description?: string;
   /**
-   * @remarks
-   * The name of the operator.
-   * 
    * @example
    * StringEquals
    */
   name?: string;
   /**
-   * @remarks
-   * The operator for the rule\\"s input parameter. The available operators vary based on the data type retrieved using SelectPath.
-   * 
-   * - If the data type is String, valid values are:
-   * 
-   *   - StringEquals: equals.
-   * 
-   *   - NotStringEquals: does not equal.
-   * 
-   *   - StringIn: is in.
-   * 
-   *   - NotStringIn: is not in.
-   * 
-   *   - StringContains: contains.
-   * 
-   *   - NotStringContains: does not contain.
-   * 
-   * - If the data type is Number, valid values are:
-   * 
-   *   - Equals: equals.
-   * 
-   *   - NotEquals: does not equal.
-   * 
-   *   - Less: is less than.
-   * 
-   *   - LessOrEquals: is less than or equal to.
-   * 
-   *   - Greater: is greater than.
-   * 
-   *   - GreaterOrEquals: is greater than or equal to.
-   * 
-   * - If the data type is a Base64-encoded string, valid values are:
-   * 
-   *   - Base64Contains: contains.
-   * 
-   *   - NotBase64Contains: does not contain.
-   * 
-   *   - Base64ContainsAll: contains all.
-   * 
-   *   - Base64ExcludeAll: excludes all.
-   * 
-   * - If the data type is Array, valid values are:
-   * 
-   *   - Contains: contains.
-   * 
-   *   - NotContains: does not contain.
-   * 
-   *   - In: is in.
-   * 
-   *   - NotIn: is not in.
-   * 
-   *   - ContainsAll: contains all.
-   * 
-   *   - ExcludeAll: excludes all.
-   * 
-   *   - IsEmpty: is empty.
-   * 
    * @example
    * StringEquals
    */
@@ -117,17 +47,13 @@ export class ListConfigRuleOperatorsResponseBodyOperators extends $dara.Model {
 }
 
 export class ListConfigRuleOperatorsResponseBody extends $dara.Model {
-  /**
-   * @remarks
-   * A list of operators.
-   */
   operators?: ListConfigRuleOperatorsResponseBodyOperators[];
   /**
    * @remarks
-   * The ID of the request.
+   * Id of the request
    * 
    * @example
-   * A68DD98C-DE65-46AC-B2D2-04A4A9AB****
+   * A68DD98C-DE65-46AC-B2D2-04A4A9AB5B99
    */
   requestId?: string;
   static names(): { [key: string]: string } {

package/src/models/ListConfigRulesRequest.ts

@@ -7,13 +7,19 @@ export class ListConfigRulesRequestTag extends $dara.Model {
    * @remarks
    * The tag key.
    * 
+   * 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
    */
   key?: string;
   /**
    * @remarks
-   * The tag value.
+   * The value of tag N to add to the resource. You can specify up to 20 tag values. The tag value can be an empty string.
+   * 
+   * The tag value can be up to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The tag value must start with a letter but cannot start with `aliyun` or `acs:`. The tag value cannot contain `http://` or `https://`.
    * 
    * @example
    * value-1
@@ -45,7 +51,11 @@ export class ListConfigRulesRequestTag extends $dara.Model {
 export class ListConfigRulesRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the compliance package.
+   * The compliance package ID.
+   * 
+   * For more information about how to obtain the ID of a compliance package, see [ListCompliancePacks](https://help.aliyun.com/document_detail/606968.html).
+   * 
+   * >  You must configure either the `CompliancePackId` or `ConfigRuleId` parameter.
    * 
    * @example
    * cp-fe416457e0d90022****
@@ -55,13 +65,10 @@ export class ListConfigRulesRequest extends $dara.Model {
    * @remarks
    * The compliance evaluation result of the rule. Valid values:
    * 
-   * - COMPLIANT: Compliant.
-   * 
-   * - NON_COMPLIANT: Non-compliant.
-   * 
-   * - NOT_APPLICABLE: Not applicable.
-   * 
-   * - INSUFFICIENT_DATA: Insufficient data.
+   * *   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 resource data is available.
    * 
    * @example
    * COMPLIANT
@@ -72,20 +79,17 @@ export class ListConfigRulesRequest 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.
+   * The status of the rule. Valid values:
    * 
-   * - DELETING: The rule is being deleted.
-   * 
-   * - EVALUATING: The rule is being evaluated.
-   * 
-   * - INACTIVE: The rule is disabled.
+   * *   ACTIVE: The rule is enabled.
+   * *   DELETING: The rule is being deleted.
+   * *   EVALUATING: The rule is being used to evaluate resource configurations.
+   * *   INACTIVE: The rule is disabled.
    * 
    * @example
    * ACTIVE
@@ -93,9 +97,9 @@ export class ListConfigRulesRequest extends $dara.Model {
   configRuleState?: string;
   /**
    * @remarks
-   * The keyword for the fuzzy query.
+   * The query keyword.
    * 
-   * Supports fuzzy queries by 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
@@ -105,7 +109,7 @@ export class ListConfigRulesRequest extends $dara.Model {
    * @remarks
    * The page number.
    * 
-   * The default value is 1.
+   * Page numbers start from 1. Default value: 1.
    * 
    * @example
    * 1
@@ -113,9 +117,9 @@ export class ListConfigRulesRequest 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. A minimum of 1 entry can be returned per page. Default value: 10.
    * 
    * @example
    * 10
@@ -123,7 +127,7 @@ export class ListConfigRulesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The type of resource evaluated by the rule.
+   * The type of the resources to be evaluated based on the rule.
    * 
    * @example
    * ACS::ECS::Instance
@@ -131,31 +135,22 @@ export class ListConfigRulesRequest extends $dara.Model {
   resourceTypes?: string;
   /**
    * @remarks
-   * The risk level of the rule. Valid values:
-   * 
-   * - 1: High risk.
+   * The risk level of the resources that are not compliant with the rule. Valid values:
    * 
-   * - 2: Medium risk.
-   * 
-   * - 3: Low risk.
+   * *   1: high
+   * *   2: medium
+   * *   3: low
    * 
    * @example
    * 1
    */
   riskLevel?: number;
-  /**
-   * @remarks
-   * The sorting method. This parameter is not required. Set the value to `CreateDate-Desc` to sort the rules by creation time in descending order.
-   * 
-   * @example
-   * CreateDate-Desc
-   */
   sortBy?: string;
   /**
    * @remarks
    * The tags of the resource.
    * 
-   * A maximum of 20 tags can be attached.
+   * You can add up to 20 tags to a resource.
    */
   tag?: ListConfigRulesRequestTag[];
   static names(): { [key: string]: string } {