@alicloud/config20200907 4.2.1 → 4.2.3

package/src/models/CreateAggregateConfigRuleRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAggregateConfigRuleRequestExcludeTagsScope extends $dara.Model {
   /**
    * @remarks
-   * The tag key of the resource to be excluded.
+   * The tag key of the resource that you want to exclude.
    * 
    * @example
    * key-2
@@ -13,7 +13,7 @@ export class CreateAggregateConfigRuleRequestExcludeTagsScope extends $dara.Mode
   tagKey?: string;
   /**
    * @remarks
-   * The tag value of the resource to be excluded.
+   * The tag value of the resource that you want to exclude.
    * 
    * @example
    * value-2
@@ -45,9 +45,11 @@ export class CreateAggregateConfigRuleRequestExcludeTagsScope extends $dara.Mode
 export class CreateAggregateConfigRuleRequestTag extends $dara.Model {
   /**
    * @remarks
-   * The key of the tag.
+   * The tag key.
    * 
-   * You can add up to 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
@@ -55,9 +57,11 @@ export class CreateAggregateConfigRuleRequestTag extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * The value of the tag.
+   * The tag values.
+   * 
+   * The tag values can be an empty string or up to 128 characters in length. The tag values cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.
    * 
-   * You can add up to 20 tag values.
+   * Each key-value must be unique. You can specify at most 20 tag values in each call.
    * 
    * @example
    * value-1
@@ -89,7 +93,7 @@ export class CreateAggregateConfigRuleRequestTag extends $dara.Model {
 export class CreateAggregateConfigRuleRequestTagsScope extends $dara.Model {
   /**
    * @remarks
-   * The tag key of the resource.
+   * The tag key.
    * 
    * @example
    * key-1
@@ -97,7 +101,7 @@ export class CreateAggregateConfigRuleRequestTagsScope extends $dara.Model {
   tagKey?: string;
   /**
    * @remarks
-   * The tag value of the resource.
+   * The tag value.
    * 
    * @example
    * value-1
@@ -129,9 +133,7 @@ export class CreateAggregateConfigRuleRequestTagsScope extends $dara.Model {
 export class CreateAggregateConfigRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The rule is effective only for resources of the specified member accounts. Separate multiple member account IDs with commas (,).
-   * 
-   * > This parameter applies only to rule templates.
+   * The IDs of the member accounts to which the rule applies, which means that the resources within the member accounts are evaluated based on the rule. Separate multiple member account IDs with commas (,).
    * 
    * @example
    * 115748125982****
@@ -141,7 +143,7 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
    * @remarks
    * The ID of the account group.
    * 
-   * For more information about how to obtain the ID of an account group, 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.
    * 
@@ -151,7 +153,7 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
   aggregatorId?: string;
   /**
    * @remarks
-   * A client token to ensure that the request is idempotent. Generate a unique value from your client for each request. The `ClientToken` parameter must contain only ASCII characters and be no more than 64 characters long.
+   * 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****
@@ -159,26 +161,25 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @example
-   * {"ComplianceConditions":"{\"operator\":\"and\",\"children\":[{\"operator\":\"StringEquals\",\"featurePath\":\"$.Status\",\"desired\":\"1\",\"featureSource\":\"CONFIGURATION\"}]}"}
+   * {"ComplianceConditions":"{\\"operator\\":\\"and\\",\\"children\\":[{\\"operator\\":\\"StringEquals\\",\\"featurePath\\":\\"$.Status\\",\\"desired\\":\\"1\\",\\"featureSource\\":\\"CONFIGURATION\\"}]}"}
    */
   conditions?: string;
   /**
    * @remarks
-   * The name of the rule.
+   * The rule name.
    * 
    * This parameter is required.
    * 
    * @example
-   * 存在所有指定标签
+   * oss-default-encryption-kms
    */
   configRuleName?: string;
   /**
    * @remarks
    * The trigger type of the rule. Valid values:
    * 
-   * - ConfigurationItemChangeNotification: The rule is triggered by configuration changes.
-   * 
-   * - ScheduledNotification: The rule is triggered on a regular basis.
+   * *   ConfigurationItemChangeNotification: The rule is triggered by configuration changes.
+   * *   ScheduledNotification: The rule is periodically triggered.
    * 
    * This parameter is required.
    * 
@@ -191,14 +192,14 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
    * The description of the rule.
    * 
    * @example
-   * 最多可以定义6组标签。如果资源同时具有指定的所有标签，则视为“合规”。
+   * description of rule
    */
   description?: string;
   /**
    * @remarks
-   * The rule is not effective for resources of the specified member accounts. The resources of the specified member accounts are not evaluated. Separate multiple member account IDs with commas (,).
+   * The ID of the member account to which the rule does not apply, which means that the resources within the member account are not evaluated based on the rule. Separate multiple member account IDs with commas (,).
    * 
-   * > This parameter applies only to rule templates.
+   * > This parameter applies only to a managed rule.
    * 
    * @example
    * 120886317861****
@@ -206,11 +207,13 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
   excludeAccountIdsScope?: string;
   /**
    * @remarks
-   * The rule is not effective for resources of the member accounts in the specified folders. The resources of the member accounts in the specified folders are not evaluated. Separate multiple folder IDs with commas (,).
+   * The ID of the resource directory to which the rule does not apply, which means that the resources within member accounts in the resource directory are not evaluated based on the rule. Separate multiple resource directory IDs with commas (,).
+   * 
+   * > 
+   * 
+   * *   This parameter applies only to a rule of a global account group.
    * 
-   * > - This parameter applies only to rules of a global account group.
-   * >
-   * > - This parameter applies only to rule templates.
+   * *   This parameter applies only to a managed rule.
    * 
    * @example
    * fd-pWmkqZ****
@@ -218,7 +221,7 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
   excludeFolderIdsScope?: string;
   /**
    * @remarks
-   * The rule is not effective for resources in the specified regions. The resources in the specified regions are not evaluated. Separate multiple region IDs with commas (,).
+   * The IDs of the regions to which the rule not applies. Separate multiple region IDs with commas (,).
    * 
    * @example
    * cn-shanghai
@@ -226,7 +229,7 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
   excludeRegionIdsScope?: string;
   /**
    * @remarks
-   * The rule is not effective for resources in the specified resource groups. The resources in the specified resource groups are not evaluated. Separate multiple resource group IDs with commas (,).
+   * ExcludeResourceGroupIdsScope. Separate multiple resource group IDs with commas (,).
    * 
    * @example
    * rg-bnczc6r7rml****
@@ -234,7 +237,9 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
   excludeResourceGroupIdsScope?: string;
   /**
    * @remarks
-   * The rule is not effective for the specified resources. The specified resources are not evaluated. Separate multiple resource IDs with commas (,).
+   * The ID of the resource to be excluded from the compliance evaluations performed by the rule. Separate multiple resource IDs with commas (,).
+   * 
+   * > This parameter applies only to a managed rule.
    * 
    * @example
    * lb-t4nbowvtbkss7t326****
@@ -242,12 +247,12 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
   excludeResourceIdsScope?: string;
   /**
    * @remarks
-   * The scope of the tags to be excluded.
+   * The scope of the tag that is excluded.
    */
   excludeTagsScope?: CreateAggregateConfigRuleRequestExcludeTagsScope[];
   /**
    * @remarks
-   * The extended content. This parameter specifies the trigger time for a rule that runs on a 24-hour cycle.
+   * The extended content, which is temporarily only used to configure the trigger time with a 24-hour cycle trigger.
    * 
    * @example
    * {"fixedHour":"12"}
@@ -255,11 +260,13 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
   extendContent?: string;
   /**
    * @remarks
-   * The rule is effective only for resources of the member accounts in the specified folders. Separate multiple folder IDs with commas (,).
+   * The ID of the resource directory to which the rule applies, which means that the resources within member accounts in the resource directory are evaluated based on the rule.
+   * 
+   * > 
+   * 
+   * *   This parameter applies only to a rule of a global account group.
    * 
-   * > - This parameter applies only to rules of a global account group.
-   * >
-   * > - This parameter applies only to rule templates.
+   * *   This parameter applies only to a managed rule.
    * 
    * @example
    * fd-ZtHsRH****
@@ -267,7 +274,7 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
   folderIdsScope?: string;
   /**
    * @remarks
-   * The input parameters of the rule.
+   * The input parameter of the rule.
    * 
    * @example
    * {"tag1Key":"ECS","tag1Value":"test"}
@@ -275,19 +282,15 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
   inputParameters?: { [key: string]: any };
   /**
    * @remarks
-   * The frequency at which the rule is run. Valid values:
-   * 
-   * - One_Hour: 1 hour.
-   * 
-   * - Three_Hours: 3 hours.
+   * The interval at which the rule is triggered. Valid values:
    * 
-   * - Six_Hours: 6 hours.
+   * *   One_Hour
+   * *   Three_Hours
+   * *   Six_Hours
+   * *   Twelve_Hours
+   * *   TwentyFour_Hours (default)
    * 
-   * - Twelve_Hours: 12 hours.
-   * 
-   * - TwentyFour_Hours (default): 24 hours.
-   * 
-   * > This parameter is required if you set `ConfigRuleTriggerTypes` to `ScheduledNotification`.
+   * >  This parameter is required if the `ConfigRuleTriggerTypes` parameter is set to `ScheduledNotification`.
    * 
    * @example
    * One_Hour
@@ -295,7 +298,9 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
   maximumExecutionFrequency?: string;
   /**
    * @remarks
-   * The rule is effective only for resources in the specified regions. Separate multiple region IDs with commas (,).
+   * The ID of the region to which the rule applies. Separate multiple region IDs with commas (,).
+   * 
+   * > This parameter applies only to a managed rule.
    * 
    * @example
    * cn-hangzhou
@@ -303,7 +308,9 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
   regionIdsScope?: string;
   /**
    * @remarks
-   * The rule is effective only for resources in the specified resource groups. Separate multiple resource group IDs with commas (,).
+   * The ID of the resource group to which the rule applies. Separate multiple resource group IDs with commas (,).
+   * 
+   * > This parameter applies only to a managed rule.
    * 
    * @example
    * rg-aekzc7r7rhx****
@@ -311,7 +318,7 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
   resourceGroupIdsScope?: string;
   /**
    * @remarks
-   * The rule is effective only for the specified resources. Separate multiple resource IDs with commas (,).
+   * The IDs of the resources included from the compliance evaluations performed by the rule. Separate multiple resource IDs with commas (,).
    * 
    * @example
    * lb-5cmbowstbkss9ta03****
@@ -319,7 +326,7 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
   resourceIdsScope?: string;
   /**
    * @remarks
-   * The rule is effective only for resources that have the specified names.
+   * The names of the resource to which the rule applies.
    * 
    * @example
    * i-xxx
@@ -330,7 +337,7 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
   resourceNameScope?: string;
   /**
    * @remarks
-   * The resource types to be evaluated by the rule. Separate multiple resource types with commas (,).
+   * The type of the resource evaluated by the rule. Separate multiple resource types with commas (,).
    * 
    * This parameter is required.
    * 
@@ -340,13 +347,11 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
   resourceTypesScope?: string[];
   /**
    * @remarks
-   * The risk level of the rule. Valid values:
-   * 
-   * - 1: high
+   * The risk level of the resources that do not comply with the rule. Valid values:
    * 
-   * - 2: medium
-   * 
-   * - 3: low
+   * *   1: high
+   * *   2: medium
+   * *   3: low
    * 
    * This parameter is required.
    * 
@@ -358,15 +363,10 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
    * @remarks
    * The identifier of the rule.
    * 
-   * - If you set `SourceOwner` to `ALIYUN`, enter the identifier of the rule template, such as `required-tags`.
-   * 
-   *   > For more information about how to query the identifier of a rule template, see [List of rule templates](https://help.aliyun.com/document_detail/127404.html).
-   * 
-   * - If you set `SourceOwner` to `CUSTOM_FC`, enter the Alibaba Cloud Resource Name (ARN) of the function in Function Compute.
+   * *   If you set the SourceOwner parameter to ALIYUN, set this parameter to the name of the managed rule.
+   * *   If you set the SourceOwner parameter to CUSTOM_FC, set this parameter to the Alibaba Cloud Resource Name (ARN) of the relevant function in Function Compute.
    * 
-   *   The ARN is in the format of `acs:fc:{region}:{accountId}:services/{serviceName}.LATEST/functions/{functionName}`. For example, `acs:fc:cn-hangzhou:120886317861****:services/service-test.LATEST/functions/config-test`.
-   * 
-   *   > For more information about how to obtain the ARN of a function, see [ListFunctions](https://help.aliyun.com/document_detail/415752.html).
+   * For more information about how to query the name of a managed rule, see [Managed rules](https://help.aliyun.com/document_detail/127404.html).
    * 
    * This parameter is required.
    * 
@@ -378,9 +378,8 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
    * @remarks
    * The type of the rule. Valid values:
    * 
-   * - ALIYUN: rule template
-   * 
-   * - CUSTOM_FC: custom rule
+   * *   ALIYUN: a managed rule.
+   * *   CUSTOM_FC: a custom rule.
    * 
    * This parameter is required.
    * 
@@ -390,20 +389,20 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
   sourceOwner?: string;
   /**
    * @remarks
-   * The tags to add to the rule. You can add up to 20 tags.
+   * The tags.
    */
   tag?: CreateAggregateConfigRuleRequestTag[];
   /**
    * @remarks
-   * The logical relationship for multiple tags in the `TagsScope` parameter. For example, if you set the `TagsScope` parameter to `"TagsScope.1.TagKey":"a","TagsScope.1.TagValue":"a","TagsScope.2.TagKey":"b","TagsScope.2.TagValue":"b"` and set this parameter to `AND`, the rule applies only to resources that have both the `a:a` and `b:b` tags. The default value is `OR`.
+   * The logical relationship when parameter `TagsScope` takes multiple values, for example: When the parameter `TagsScope` is `"TagsScope.1.TagKey":"a", "TagsScope.1.TagValue":"a", "TagsScope.2.TagKey":"b", "TagsScope.2.TagValue":"b"`, if this parameter is set to` AND`, it means that the rule only applies to resources bound with both tags `a:a` and `b:b`. If not specified, the default logic is `OR`.
    * 
-   * This parameter can also be used for the deprecated `TagKeyScope` parameter, but this is not recommended. For example, if you set `TagKeyScope` to `ECS,OSS` and set this parameter to `AND`, the rule applies only to resources that have both the `ECS` and `OSS` tags.
+   * It can also be used for the deprecated field `TagKeyScope` (not recommended), for example: When the parameter `TagKeyScope` has a value of `ECS`,`OSS`, if this parameter is set to `AND`, it means that the rule only applies to resources bound with both labels `ECS` and `OSS`.
    * 
-   * Valid values:
+   * Values:
    * 
-   * - AND
+   *  - AND: And.
    * 
-   * - OR
+   *  - OR: Or.
    * 
    * @example
    * AND
@@ -411,11 +410,11 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
   tagKeyLogicScope?: string;
   /**
    * @remarks
-   * This parameter is deprecated. Use the `TagsScope` parameter.
+   * This parameter is deprecated. We recommend that you use the `TagsScope` parameter.
    * 
-   * The rule is effective only for resources that have the specified tag keys. Separate multiple tag keys with commas (,).
+   * The tag key used to filter resources. The rule applies only to the resources with the specified tag key. Separate multiple parameter values with commas (,).
    * 
-   * > This parameter applies only to rule templates. The `TagKeyScope` and `TagValueScope` parameters must be used together.
+   * >  This parameter applies only to a managed rule. You must configure the `TagKeyScope` and `TagValueScope` parameters at the same time.
    * 
    * @example
    * ECS
@@ -425,11 +424,11 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
   tagKeyScope?: string;
   /**
    * @remarks
-   * This parameter is deprecated. Use the `TagsScope` parameter.
+   * This parameter is deprecated. We recommend that you use the `TagsScope` parameter.
    * 
-   * The rule is effective only for resources that have the specified tag values.
+   * The tag value used to filter resources. The rule applies only to the resources that use the specified tag value.
    * 
-   * > This parameter applies only to rule templates. The `TagKeyScope` and `TagValueScope` parameters must be used together.
+   * >  This parameter applies only to a managed rule. You must configure the `TagKeyScope` and `TagValueScope` parameters at the same time.
    * 
    * @example
    * test
@@ -439,7 +438,7 @@ export class CreateAggregateConfigRuleRequest extends $dara.Model {
   tagValueScope?: string;
   /**
    * @remarks
-   * The scope of the tags.
+   * The tag scope.
    */
   tagsScope?: CreateAggregateConfigRuleRequestTagsScope[];
   static names(): { [key: string]: string } {

package/src/models/CreateAggregateConfigRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAggregateConfigRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the rule.
+   * The rule ID.
    * 
    * @example
    * cr-4e3d626622af0080****
@@ -13,7 +13,7 @@ export class CreateAggregateConfigRuleResponseBody extends $dara.Model {
   configRuleId?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 5895065A-196C-4254-8AD8-14EFC31EEF50