@alicloud/config20200907 4.2.1 → 4.2.3

package/src/models/ListTagResourcesShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListTagResourcesShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The token to retrieve the next page of results.
+   * The pagination token that is used in the next request to retrieve a new page of results.
    * 
    * @example
    * MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJ****
@@ -13,7 +13,7 @@ export class ListTagResourcesShrinkRequest extends $dara.Model {
   nextToken?: string;
   /**
    * @remarks
-   * The ID of the region to which the tags belong.
+   * The region ID of the tag.
    * 
    * This parameter is required.
    * 
@@ -25,34 +25,30 @@ export class ListTagResourcesShrinkRequest extends $dara.Model {
    * @remarks
    * The resource ID.
    * 
-   * You can query tags for a maximum of 50 resources.
+   * You can add tags to up to 50 resources.
    */
   resourceId?: string[];
   /**
    * @remarks
-   * The resource type in CloudConfig. Valid values:
+   * The resource type. Valid values:
    * 
-   * - `ACS::Config::Rule`: a rule for a single account.
-   * 
-   * - `ACS::Config::AggregateConfigRule`: a rule for multiple accounts.
-   * 
-   * - `ACS::Config::Aggregator`: an account group.
-   * 
-   * - `ACS::Config::CompliancePack`: a compliance package for a single account.
-   * 
-   * - `ACS::Config::AggregateCompliancePack`: a compliance package for multiple accounts.
+   * *   `ACS::Config::Rule`
+   * *   `ACS::Config::AggregateConfigRule`
+   * *   `ACS::Config::Aggregator`
+   * *   `ACS::Config::CompliancePack`
+   * *   `ACS::Config::AggregateCompliancePack`
    * 
    * This parameter is required.
    * 
    * @example
-   * ACS::Config::Rule
+   * ACS::Config:rule
    */
   resourceType?: string;
   /**
    * @remarks
    * The tags of the resource.
    * 
-   * You can filter resources by a maximum of 20 tags.
+   * You can add up to 20 tags to a resource.
    */
   tagShrink?: string;
   static names(): { [key: string]: string } {

package/src/models/PutEvaluationsRequest.ts

@@ -3,11 +3,35 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class PutEvaluationsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to enable the delete mode. Valid values:
+   * 
+   * *   true: enables the delete mode
+   * *   false (default): disables the delete mode
+   * 
+   * > This parameter is valid only when you manually trigger or periodically trigger custom rules to evaluate resources. If you enable the delete mode, the evaluation results that are not updated during the current evaluation are automatically deleted.
+   * 
+   * @example
+   * false
+   */
   deleteMode?: boolean;
+  /**
+   * @remarks
+   * The evaluation results.
+   * 
+   * @example
+   * [{"accountId":120886317861****,"annotation":"The flow log is not enabled.","complianceResourceId":"flowlog-o6wdfo1yvgo4i8****","complianceResourceType":"ACS::CEN::Flowlog","complianceRegionId":"cn-shanghai","complianceType":"NON_COMPLIANT","orderingTimestamp":1588907220408}]
+   */
   evaluations?: string;
   /**
    * @remarks
+   * The callback token. When Cloud Config triggers a custom rule to evaluate resources, the token information is sent to Function Compute as an input parameter. The token must be specified when you submit the evaluation results.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * =lAUbfkWp7GL9AFoQEIStinqBMc4FC8sHvip/1F1npkWUDNS2GEm6xwL6Zl/fSr0bbkWY+aiCLjTJxnp4H/yp/8p/Q8VCAtqG5uhRii4sfnYRnTPnE****
    */
   resultToken?: string;
   static names(): { [key: string]: string } {

package/src/models/PutEvaluationsResponseBody.ts

@@ -3,7 +3,24 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class PutEvaluationsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * EDB324E2-A202-5FE4-A9BC-31E2C34F78A4
+   */
   requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the evaluation results of the custom rule are submitted. Valid values:
+   * 
+   * *   true: The evaluation results are submitted.
+   * *   false: The evaluation results fail to be submitted.
+   * 
+   * @example
+   * true
+   */
   result?: boolean;
   static names(): { [key: string]: string } {
     return {

package/src/models/ResourceDirectoryFolderNode.ts

@@ -3,11 +3,31 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ResourceDirectoryFolderNode extends $dara.Model {
+  /**
+   * @example
+   * 171322098523****
+   */
   accountId?: string;
   children?: ResourceDirectoryFolderNode[];
+  /**
+   * @example
+   * Alice
+   */
   displayName?: string;
+  /**
+   * @example
+   * fd-JeZYYJ****
+   */
   folderId?: string;
+  /**
+   * @example
+   * ECS
+   */
   folderName?: string;
+  /**
+   * @example
+   * fd-JeZYYJ****
+   */
   parentFolderId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/RevertAggregateEvaluationResultsRequest.ts

@@ -5,22 +5,50 @@ import * as $dara from '@darabonba/typescript';
 export class RevertAggregateEvaluationResultsRequestResources extends $dara.Model {
   /**
    * @remarks
+   * The ID of the region in which your resources reside.
+   * 
+   * For more information about how to obtain the ID of the region in which your resources reside, see [ListAggregateDiscoveredResources](https://help.aliyun.com/document_detail/265983.html).
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
    */
   region?: string;
   /**
    * @remarks
+   * The ID of the Alibaba Cloud account to which the resource belongs.
+   * 
+   * >  You must specify the ID of the current management account or a member in the account group of the management account.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * 120886317861****
    */
   resourceAccountId?: number;
   /**
    * @remarks
+   * The resource ID.
+   * 
+   * For more information about how to obtain the ID of a resource, see [ListAggregateDiscoveredResources](https://help.aliyun.com/document_detail/265983.html).
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * lb-hp3a3b4ztyfm2plgm****
    */
   resourceId?: string;
   /**
    * @remarks
+   * The type of the resource.
+   * 
+   * For more information about how to obtain the type of a resource, see [ListAggregateDiscoveredResources](https://help.aliyun.com/document_detail/265983.html).
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * ACS::SLB::LoadBalancer
    */
   resourceType?: string;
   static names(): { [key: string]: string } {
@@ -53,16 +81,30 @@ export class RevertAggregateEvaluationResultsRequestResources extends $dara.Mode
 export class RevertAggregateEvaluationResultsRequest 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).
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * ca-5b6c626622af008f****
    */
   aggregatorId?: string;
   /**
    * @remarks
+   * The ID of the rule in the account group.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * cr-7e72626622af0051****
    */
   configRuleId?: string;
   /**
    * @remarks
+   * The resources that you want to re-evaluate.
+   * 
    * This parameter is required.
    */
   resources?: RevertAggregateEvaluationResultsRequestResources[];

package/src/models/RevertAggregateEvaluationResultsResponseBody.ts

@@ -3,6 +3,13 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class RevertAggregateEvaluationResultsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * BB11CBF2-0B0B-59F2-9E84-07B38267AD12
+   */
   requestId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/RevertAggregateEvaluationResultsShrinkRequest.ts

@@ -5,16 +5,30 @@ import * as $dara from '@darabonba/typescript';
 export class RevertAggregateEvaluationResultsShrinkRequest 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).
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * ca-5b6c626622af008f****
    */
   aggregatorId?: string;
   /**
    * @remarks
+   * The ID of the rule in the account group.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * cr-7e72626622af0051****
    */
   configRuleId?: string;
   /**
    * @remarks
+   * The resources that you want to re-evaluate.
+   * 
    * This parameter is required.
    */
   resourcesShrink?: string;

package/src/models/RevertEvaluationResultsRequest.ts

@@ -5,22 +5,48 @@ import * as $dara from '@darabonba/typescript';
 export class RevertEvaluationResultsRequestResources extends $dara.Model {
   /**
    * @remarks
+   * The ID of the region in which the resource resides.
+   * 
+   * For more information about how to obtain the ID of the region in which a resource resides, see [ListDiscoveredResources](https://help.aliyun.com/document_detail/169620.html).
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
    */
   region?: string;
   /**
    * @remarks
+   * The ID of the Alibaba Cloud account to which the resource belongs.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * 100931896542****
    */
   resourceAccountId?: number;
   /**
    * @remarks
+   * The resource ID.
+   * 
+   * For more information about how to obtain the ID of a resource, see [ListDiscoveredResources](https://help.aliyun.com/document_detail/169620.html).
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * lb-hp3a3b4ztyfm2plgm****
    */
   resourceId?: string;
   /**
    * @remarks
+   * The resource type.
+   * 
+   * For more information about how to query the type of a resource, see [ListDiscoveredResources](https://help.aliyun.com/document_detail/169620.html).
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * ACS::SLB::LoadBalancer
    */
   resourceType?: string;
   static names(): { [key: string]: string } {
@@ -53,11 +79,20 @@ export class RevertEvaluationResultsRequestResources extends $dara.Model {
 export class RevertEvaluationResultsRequest extends $dara.Model {
   /**
    * @remarks
+   * The rule ID.
+   * 
+   * For more information about how to obtain the ID of a rule, see [ListConfigRules](https://help.aliyun.com/document_detail/169607.html).
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * cr-7e72626622af0051****
    */
   configRuleId?: string;
   /**
    * @remarks
+   * The resources that are to be re-evaluated.
+   * 
    * This parameter is required.
    */
   resources?: RevertEvaluationResultsRequestResources[];

package/src/models/RevertEvaluationResultsResponseBody.ts

@@ -3,6 +3,13 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class RevertEvaluationResultsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 01ACCBF2-0B0B-59F2-9E84-07B38267BCA1
+   */
   requestId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/RevertEvaluationResultsShrinkRequest.ts

@@ -5,11 +5,20 @@ import * as $dara from '@darabonba/typescript';
 export class RevertEvaluationResultsShrinkRequest extends $dara.Model {
   /**
    * @remarks
+   * The rule ID.
+   * 
+   * For more information about how to obtain the ID of a rule, see [ListConfigRules](https://help.aliyun.com/document_detail/169607.html).
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * cr-7e72626622af0051****
    */
   configRuleId?: string;
   /**
    * @remarks
+   * The resources that are to be re-evaluated.
+   * 
    * This parameter is required.
    */
   resourcesShrink?: string;

package/src/models/StartAggregateConfigRuleEvaluationRequest.ts

@@ -5,11 +5,50 @@ import * as $dara from '@darabonba/typescript';
 export class StartAggregateConfigRuleEvaluationRequest 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).
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * ca-3a58626622af0005****
    */
   aggregatorId?: string;
+  /**
+   * @remarks
+   * The ID of the compliance package.
+   * 
+   * For more information about how to obtain the ID of a compliance package, see [ListAggregateCompliancePacks](https://help.aliyun.com/document_detail/262059.html).
+   * 
+   * > You must configure either the `CompliancePackId` or `ConfigRuleId` parameter.
+   * 
+   * @example
+   * cp-ac16626622af0053****
+   */
   compliancePackId?: string;
+  /**
+   * @remarks
+   * The rule ID.
+   * 
+   * For more information about how to query the ID of a rule, see [ListAggregateConfigRules](https://help.aliyun.com/document_detail/264148.html).
+   * 
+   * >  You must configure either the `CompliancePackId` or `ConfigRuleId` parameter.
+   * 
+   * @example
+   * cr-c169626622af009f****
+   */
   configRuleId?: string;
+  /**
+   * @remarks
+   * Specifies whether to re-evaluate the ignored non-compliant resource. Valid values:
+   * 
+   * *   true: re-evaluates the ignored non-compliant resource based on the rule.
+   * *   false (default): does not re-evaluate the ignored non-compliant resource based on the rule.
+   * 
+   * @example
+   * false
+   */
   revertEvaluation?: boolean;
   static names(): { [key: string]: string } {
     return {

package/src/models/StartAggregateConfigRuleEvaluationResponseBody.ts

@@ -3,7 +3,24 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class StartAggregateConfigRuleEvaluationResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * ABC0FFF8-0B44-40C6-8BBF-3A185EFDD212
+   */
   requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the involved resources were evaluated. Valid values:
+   * 
+   * *   true: The involved resources were evaluated.
+   * *   false: The involved resources were not evaluated
+   * 
+   * @example
+   * true
+   */
   result?: boolean;
   static names(): { [key: string]: string } {
     return {

package/src/models/StartAggregateRemediationRequest.ts

@@ -5,20 +5,61 @@ import * as $dara from '@darabonba/typescript';
 export class StartAggregateRemediationRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the account group.
+   * 
+   * For information about how to obtain the ID of an account group, see [ListAggregators](https://help.aliyun.com/document_detail/255797.html).
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * ca-6b4a626622af0012****
    */
   aggregatorId?: string;
   /**
    * @remarks
+   * The rule ID.
+   * 
+   * For more information about how to obtain the ID of a rule, see [ListAggregateConfigRules](https://help.aliyun.com/document_detail/264148.html).
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * cr-6b7c626622af00b4****
    */
   configRuleId?: string;
+  /**
+   * @remarks
+   * The ID of the Alibaba Cloud account to which the resources to be remediated belong. If this parameter is left empty, non-compliant resources of all accounts in the account group are remediated.
+   * 
+   * > You must specify the ID of the current management account or a member account in the account group of the management account.
+   * 
+   * @example
+   * 100271897542****
+   */
   resourceAccountId?: number;
+  /**
+   * @example
+   * vpc-xxx
+   */
+  resourceId?: string;
+  /**
+   * @example
+   * cn-hangzhou
+   */
+  resourceRegionId?: string;
+  /**
+   * @example
+   * ACS::VPC::VPC
+   */
+  resourceType?: string;
   static names(): { [key: string]: string } {
     return {
       aggregatorId: 'AggregatorId',
       configRuleId: 'ConfigRuleId',
       resourceAccountId: 'ResourceAccountId',
+      resourceId: 'ResourceId',
+      resourceRegionId: 'ResourceRegionId',
+      resourceType: 'ResourceType',
     };
   }
 
@@ -27,6 +68,9 @@ export class StartAggregateRemediationRequest extends $dara.Model {
       aggregatorId: 'string',
       configRuleId: 'string',
       resourceAccountId: 'number',
+      resourceId: 'string',
+      resourceRegionId: 'string',
+      resourceType: 'string',
     };
   }
 

package/src/models/StartAggregateRemediationResponseBody.ts

@@ -3,7 +3,24 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class StartAggregateRemediationResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * *   true
+   * *   false
+   * 
+   * @example
+   * true
+   */
   data?: boolean;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * C7817373-78CB-4F9A-8AFA-E7A88E9D64A2
+   */
   requestId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/StartConfigRuleEvaluationByResourceRequest.ts

@@ -5,10 +5,6 @@ import * as $dara from '@darabonba/typescript';
 export class StartConfigRuleEvaluationByResourceRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the resource.
-   * 
-   * For more information about how to obtain the resource ID, see [ListDiscoveredResources](https://help.aliyun.com/document_detail/169620.html).
-   * 
    * This parameter is required.
    * 
    * @example

package/src/models/StartConfigRuleEvaluationByResourceResponseBody.ts

@@ -4,19 +4,11 @@ import * as $dara from '@darabonba/typescript';
 
 export class StartConfigRuleEvaluationByResourceResponseBody extends $dara.Model {
   /**
-   * @remarks
-   * The ID of the rule.
-   * 
-   * For more information about how to obtain the rule ID, see [ListConfigRules](https://help.aliyun.com/document_detail/169607.html).
-   * 
    * @example
    * cr-2da35180a8d1008e****
    */
   configRuleId?: string;
   /**
-   * @remarks
-   * The ID of the request.
-   * 
    * @example
    * A7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7
    */

package/src/models/StartConfigRuleEvaluationRequest.ts

@@ -5,11 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class StartConfigRuleEvaluationRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the compliance package.
+   * The compliance package ID.
    * 
-   * For more information, see [ListCompliancePacks](https://help.aliyun.com/document_detail/606968.html).
+   * For more information about how to obtain the ID of a compliance package, see [ListCompliancePacks](https://help.aliyun.com/document_detail/606968.html).
    * 
-   * > Specify either `CompliancePackId` or `ConfigRuleId`.
+   * >  You must configure either the `CompliancePackId` or `ConfigRuleId` parameter.
    * 
    * @example
    * cp-ac16626622af0053****
@@ -17,11 +17,11 @@ export class StartConfigRuleEvaluationRequest extends $dara.Model {
   compliancePackId?: string;
   /**
    * @remarks
-   * The ID of the rule.
+   * The rule ID.
    * 
-   * For more information, see [ListConfigRules](https://help.aliyun.com/document_detail/609222.html).
+   * You can call the [ListConfigRules](https://help.aliyun.com/document_detail/609222.html) operation to obtain the rule ID.
    * 
-   * > Specify either `CompliancePackId` or `ConfigRuleId`.
+   * >  You must configure either the `CompliancePackId` or `ConfigRuleId` parameter.
    * 
    * @example
    * cr-9920626622af0035****
@@ -29,11 +29,10 @@ export class StartConfigRuleEvaluationRequest extends $dara.Model {
   configRuleId?: string;
   /**
    * @remarks
-   * Specifies whether to restore evaluation results that were ignored. Valid values:
+   * Specifies whether to re-evaluate the ignored non-compliant resource. Valid values:
    * 
-   * - true: Restores ignored evaluation results.
-   * 
-   * - false (default): Does not restore ignored evaluation results.
+   * *   true: re-evaluates the ignored non-compliant resource based on the rule.
+   * *   false (default): does not re-evaluate the ignored non-compliant resource based on the rule.
    * 
    * @example
    * false

package/src/models/StartConfigRuleEvaluationResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class StartConfigRuleEvaluationResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * D31EEAD7-BF1E-5927-977A-AFF9342A7273
@@ -13,11 +13,10 @@ export class StartConfigRuleEvaluationResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The result of the request. Valid values:
+   * Indicates whether the operation is successful. Valid values:
    * 
-   * - true: The request is successful.
-   * 
-   * - false: The request failed.
+   * *   true
+   * *   false
    * 
    * @example
    * true