@alicloud/config20200907 4.2.1 → 4.2.3

package/src/models/ListRemediationTemplatesResponseBody.ts

@@ -3,10 +3,74 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListRemediationTemplatesResponseBodyRemediationTemplates extends $dara.Model {
+  /**
+   * @remarks
+   * The type of the remediation template. Valid value: OOS, which indicates Operation Orchestration Service.
+   * 
+   * @example
+   * OOS
+   */
   remediationType?: string;
+  /**
+   * @remarks
+   * The definition of the remediation template.
+   * 
+   * @example
+   * {
+   *     "Parameters": {
+   *         "bucketName": {
+   *             "Default": "{resourceId}",
+   *             "Description": {
+   *                 "zh-cn": "[Required]OSS Bucket Name.",
+   *                 "en": "[Required]OSS Bucket Name."
+   *             },
+   *             "Type": "String"
+   *         },
+   *         "regionId": {
+   *             "AssociationProperty": "RegionId",
+   *             "Default": "{regionId}",
+   *             "Description": {
+   *                 "zh-cn": "[Required]The id of target region.",
+   *                 "en": "[Required]The id of target region."
+   *             },
+   *             "Type": "String"
+   *         },
+   *         "permissionName": {
+   *             "AllowValues": "[\\"public-read-write\\",\\"public-read\\",\\"private\\"]",
+   *             "Default": "private",
+   *             "Description": {
+   *                 "zh-cn": "[Required]ACL Permission Name.",
+   *                 "en": "[Required]ACL Permission Name."
+   *             },
+   *             "Type": "String"
+   *         }
+   *     }
+   * }
+   */
   templateDefinition?: string;
+  /**
+   * @remarks
+   * The description of the remediation template.
+   * 
+   * @example
+   * Configure encryption rules for OSSBucket through the PutBucketEncryption interface. Be aware of the risks and exercise caution.
+   */
   templateDescription?: string;
+  /**
+   * @remarks
+   * The ID of the remediation template.
+   * 
+   * @example
+   * ACS-OSS-PutBucketAcl
+   */
   templateIdentifier?: string;
+  /**
+   * @remarks
+   * The name of the remediation template.
+   * 
+   * @example
+   * Set the ACL of an OSS bucket to private
+   */
   templateName?: string;
   static names(): { [key: string]: string } {
     return {
@@ -38,10 +102,42 @@ export class ListRemediationTemplatesResponseBodyRemediationTemplates extends $d
 }
 
 export class ListRemediationTemplatesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The page number. Pages start from page 1.
+   * 
+   * @example
+   * 1
+   */
   pageNumber?: number;
+  /**
+   * @remarks
+   * The number of entries per page. Valid values: 1 to 100.
+   * 
+   * @example
+   * 10
+   */
   pageSize?: number;
+  /**
+   * @remarks
+   * The queried remediation templates.
+   */
   remediationTemplates?: ListRemediationTemplatesResponseBodyRemediationTemplates[];
+  /**
+   * @remarks
+   * The ID of the request.
+   * 
+   * @example
+   * FC2C4750-7024-499C-A69F-763543D1CBE3
+   */
   requestId?: string;
+  /**
+   * @remarks
+   * The total number of remediation templates.
+   * 
+   * @example
+   * 1
+   */
   totalCount?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListRemediationsRequest.ts

@@ -3,8 +3,31 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListRemediationsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The rule IDs. Separate multiple rule IDs with commas (,).
+   * 
+   * For more information about how to obtain the ID of a rule, see [ListConfigRules](https://help.aliyun.com/document_detail/169607.html).
+   * 
+   * @example
+   * cr-6b7c626622af00b4****
+   */
   configRuleIds?: string;
+  /**
+   * @remarks
+   * The page number. Pages start from page 1.
+   * 
+   * @example
+   * 1
+   */
   pageNumber?: number;
+  /**
+   * @remarks
+   * The number of entries per page. Valid values: 1 to 50.
+   * 
+   * @example
+   * 10
+   */
   pageSize?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListRemediationsResponseBody.ts

@@ -3,16 +3,110 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListRemediationsResponseBodyRemediations extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the Alibaba Cloud account to which the resource belongs.
+   * 
+   * @example
+   * 100931896542****
+   */
   accountId?: number;
+  /**
+   * @remarks
+   * The rule ID.
+   * 
+   * @example
+   * cr-6b7c626622af00b4****
+   */
   configRuleId?: string;
+  /**
+   * @remarks
+   * The execution mode of the remediation template. Valid values:
+   * 
+   * *   NON_EXECUTION: The remediation template was not executed.
+   * *   AUTO_EXECUTION: The remediation template was automatically executed.
+   * *   MANUAL_EXECUTION: The remediation template was manually executed.
+   * *   NOT_CONFIG: The execution mode was not specified.
+   * 
+   * @example
+   * AUTO_EXECUTION
+   */
   invokeType?: string;
+  /**
+   * @remarks
+   * The ID of the last successful execution of the remediation template.
+   * 
+   * @example
+   * bd7629fb-cac8-42fe-bcb1-e362c5a6****
+   */
   lastSuccessfulInvocationId?: string;
+  /**
+   * @remarks
+   * The timestamp of the last successful execution of the remediation template Unit: milliseconds.
+   * 
+   * @example
+   * 1625451393589
+   */
   lastSuccessfulInvocationTime?: number;
+  /**
+   * @remarks
+   * The mode of the last successful execution of the remediation template. Valid values:
+   * 
+   * *   NON_EXECUTION: The remediation template was not executed.
+   * *   AUTO_EXECUTION: The remediation template was automatically executed.
+   * *   MANUAL_EXECUTION: The remediation template was manually executed.
+   * *   NOT_CONFIG: The execution mode was not specified.
+   * 
+   * @example
+   * AUTO_EXECUTION
+   */
   lastSuccessfulInvocationType?: string;
+  /**
+   * @remarks
+   * The ID of the remediation template.
+   * 
+   * @example
+   * crr-6b7c626622af0026****
+   */
   remediationId?: string;
+  /**
+   * @remarks
+   * The converted configuration of the remediation template. This parameter is available only for an OOS remediation template.
+   * 
+   * @example
+   * {"bucketName": "{resourceId}", "regionId": "{regionId}", "permissionName": "private"}
+   */
   remediationOriginParams?: string;
+  /**
+   * @remarks
+   * The source of remediation. Valid values:
+   * 
+   * *   ALIYUN: official template.
+   * *   CUSTOM: custom template.
+   * *   NONE: none.
+   * 
+   * @example
+   * ALIYUN
+   */
   remediationSourceType?: string;
+  /**
+   * @remarks
+   * The ID of the remediation template.
+   * 
+   * @example
+   * ACS-OSS-PutBucketAcl
+   */
   remediationTemplateId?: string;
+  /**
+   * @remarks
+   * The type of the remediation template. Valid values:
+   * 
+   * *   OOS: Operation Orchestration Service (official remediation)
+   * *   FC: Function Compute (custom remediation)
+   * 
+   * @example
+   * OOS
+   */
   remediationType?: string;
   static names(): { [key: string]: string } {
     return {
@@ -58,19 +152,45 @@ export class ListRemediationsResponseBodyRemediations extends $dara.Model {
 export class ListRemediationsResponseBody extends $dara.Model {
   /**
    * @remarks
+   * The page number. Pages start from page 1.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * 1
    */
   pageNumber?: number;
   /**
    * @remarks
+   * The number of entries per page. Valid values: 1 to 50.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * 10
    */
   pageSize?: number;
+  /**
+   * @remarks
+   * The converted configuration of the remediation template. This parameter is returned only for an OOS remediation template.
+   */
   remediations?: ListRemediationsResponseBodyRemediations[];
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 0146963A-20C0-4E75-B93A-7D622B5FD7C8
+   */
   requestId?: string;
   /**
    * @remarks
+   * The total number of remediation settings.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * 1
    */
   totalCount?: string;
   static names(): { [key: string]: string } {

package/src/models/ListReportTemplatesRequest.ts

@@ -4,27 +4,16 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListReportTemplatesRequest extends $dara.Model {
   /**
-   * @remarks
-   * The keyword for your search.
-   * 
-   * You can perform a fuzzy query on template ID, template name, or template description.
-   * 
    * @example
    * test-description
    */
   keyword?: string;
   /**
-   * @remarks
-   * The number of entries to return per page. Default value: 20.
-   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
-   * @remarks
-   * If the response is truncated, use NextToken to send another request and get results after the truncation point.
-   * 
    * @example
    * IWBjqMYSy0is7zSMGu16****
    */

package/src/models/ListReportTemplatesResponseBody.ts

@@ -4,31 +4,16 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListReportTemplatesResponseBodyReportTemplateListReportScope extends $dara.Model {
   /**
-   * @remarks
-   * The key for the report scope. Supported values:
-   * 
-   * - AggregatorId
-   * 
-   * - CompliancePackId
-   * 
-   * - RuleId
-   * 
    * @example
    * RuleId
    */
   key?: string;
   /**
-   * @remarks
-   * The matching logic. Only In is supported.
-   * 
    * @example
    * In
    */
   matchType?: string;
   /**
-   * @remarks
-   * The value for the report scope. For multiple values of the same type — such as multiple rule IDs — separate them with commas (,).
-   * 
    * @example
    * cr-1,cr-2
    */
@@ -60,96 +45,33 @@ export class ListReportTemplatesResponseBodyReportTemplateListReportScope extend
 
 export class ListReportTemplatesResponseBodyReportTemplateList extends $dara.Model {
   /**
-   * @remarks
-   * The format of the report. Only Excel is supported.
-   * 
    * @example
    * excel
    */
   reportFileFormats?: string;
   /**
-   * @remarks
-   * The aggregation granularity of the report.
-   * 
-   * From the management account perspective, the following options are supported:
-   * 
-   * - AllInOne: Aggregate all accounts in the template scope into one report.
-   * 
-   * - GroupByAggregator: Generate reports by aggregator group. Output as one compressed file.
-   * 
-   * - GroupByAccount: Generate separate reports for each account (default). Output as one compressed file.
-   * 
-   * Member accounts support only GroupByAccount.
-   * 
    * @example
    * AllInOne
    */
   reportGranularity?: string;
-  /**
-   * @remarks
-   * The language of the report. Valid values: zh-CN and en-US. Default value: en-US.
-   * 
-   * @example
-   * en-US
-   */
   reportLanguage?: string;
-  /**
-   * @remarks
-   * An array that defines which rules appear in the audit report. Each ReportScope object uses OR logic (additive logic).
-   * 
-   * > For example, if the array has two items — the first specifies RuleId cr-1 and the second specifies RuleId cr-2 — then the report covers both cr-1 and cr-2.
-   */
   reportScope?: ListReportTemplatesResponseBodyReportTemplateListReportScope[];
   /**
-   * @remarks
-   * The description of the report template.
-   * 
    * @example
    * test-description
    */
   reportTemplateDescription?: string;
   /**
-   * @remarks
-   * The ID of the report template.
-   * 
    * @example
    * crt-xxx
    */
   reportTemplateId?: string;
   /**
-   * @remarks
-   * The name of the report template.
-   * 
    * @example
    * test-name
    */
   reportTemplateName?: string;
   /**
-   * @remarks
-   * The subscription frequency of the report. If this parameter is specified, it must be a Quartz-formatted cron expression.
-   * 
-   * The format is: second minute hour day month weekday. Common examples:
-   * 
-   * - Run daily at 00:00: 0 0 0 \\* \\* ?
-   * 
-   * - Run every Monday at 15:30: 0 30 15 ? \\* MON
-   * 
-   * - Run on the first day of each month at 02:00: 0 0 2 1 \\* ?
-   * 
-   * Where:
-   * 
-   * - "\\*" means any value.
-   * 
-   * - "?" means no specific value for day or weekday.
-   * 
-   * - "MON" means Monday.
-   * 
-   * > Times are in UTC+8. Adjust your cron expression based on your local time zone.
-   * 
-   * > The system tries to run reports at the scheduled time, but delays may occur due to report generation. Each template can trigger at most one notification per day.
-   * 
-   * > In Quartz, weekdays are numbered starting from Sunday: 1 = Sunday, 2 = Monday, 3 = Tuesday, 4 = Wednesday, 5 = Thursday, 6 = Friday, 7 = Saturday.
-   * 
    * @example
    * 0 0 13 * * ?
    */
@@ -194,38 +116,22 @@ export class ListReportTemplatesResponseBodyReportTemplateList extends $dara.Mod
 
 export class ListReportTemplatesResponseBody extends $dara.Model {
   /**
-   * @remarks
-   * The maximum number of entries to return per page. Valid values: 1 to 50. Default value: 20.
-   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
-   * @remarks
-   * If the response is truncated, use NextToken to send another request and get results after the truncation point.
-   * 
    * @example
    * aVCjqNaSy0Ps7zSMGu25****
    */
   nextToken?: string;
-  /**
-   * @remarks
-   * The list of report templates.
-   */
   reportTemplateList?: ListReportTemplatesResponseBodyReportTemplateList[];
   /**
-   * @remarks
-   * The ID of the request.
-   * 
    * @example
    * 8195B664-9565-4685-89AC-8B5F04B44B92
    */
   requestId?: string;
   /**
-   * @remarks
-   * The total number of templates.
-   * 
    * @example
    * 7
    */

package/src/models/ListResourceEvaluationResultsRequest.ts

@@ -5,17 +5,13 @@ import * as $dara from '@darabonba/typescript';
 export class ListResourceEvaluationResultsRequest extends $dara.Model {
   /**
    * @remarks
-   * The compliance evaluation result. Valid values:
+   * The compliance evaluation result of the resource. 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 for the resource.
-   * 
-   * - IGNORED: The evaluation result is ignored.
+   * *   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 resources.
+   * *   INSUFFICIENT_DATA: No data is available.
+   * *   IGNORED: The resource is ignored during compliance evaluation.
    * 
    * @example
    * NON_COMPLIANT
@@ -23,7 +19,7 @@ export class ListResourceEvaluationResultsRequest extends $dara.Model {
   complianceType?: string;
   /**
    * @remarks
-   * The maximum number of entries to return for a single request. Valid values: 1 to 100.
+   * The maximum number of entries to return in a request. Valid values: 1 to 100.
    * 
    * @example
    * 10
@@ -31,7 +27,7 @@ export class ListResourceEvaluationResultsRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * If the response is truncated, pass the `NextToken` value in a subsequent request to retrieve the remaining results.
+   * The token that you want to use to initiate the current request. If the response of the previous request is truncated, you can use this token to initiate another request and obtain the remaining entries.``
    * 
    * @example
    * IWBjqMYSy0is7zSMGu16****
@@ -39,9 +35,9 @@ export class ListResourceEvaluationResultsRequest extends $dara.Model {
   nextToken?: string;
   /**
    * @remarks
-   * The ID of the region where the resource resides. For example, `global` indicates Global, and `cn-hangzhou` indicates China (Hangzhou).
+   * The ID of the region where one or more resources you want to query reside. For example, the value `global` indicates global regions and the value `cn-hangzhou` indicates the China (Hangzhou) region.
    * 
-   * For more information, see [ListDiscoveredResources](https://help.aliyun.com/document_detail/169620.html).
+   * For more information about how to obtain the ID of the region where a resource resides, see [ListDiscoveredResources](https://help.aliyun.com/document_detail/169620.html).
    * 
    * @example
    * global
@@ -49,9 +45,9 @@ export class ListResourceEvaluationResultsRequest extends $dara.Model {
   region?: string;
   /**
    * @remarks
-   * The resource ID.
+   * The ID of the resource.
    * 
-   * For more information, see [ListDiscoveredResources](https://help.aliyun.com/document_detail/169620.html).
+   * For more information about how to obtain the ID of a resource, see [ListDiscoveredResources](https://help.aliyun.com/document_detail/169620.html).
    * 
    * @example
    * 23642660635396****
@@ -59,35 +55,15 @@ export class ListResourceEvaluationResultsRequest extends $dara.Model {
   resourceId?: string;
   /**
    * @remarks
-   * The resource type.
+   * The type of the resource.
    * 
-   * For more information, see [ListDiscoveredResources](https://help.aliyun.com/document_detail/169620.html).
+   * For more information about how to query the type of a resource, see [ListDiscoveredResources](https://help.aliyun.com/document_detail/169620.html).
    * 
    * @example
    * ACS::RAM::User
    */
   resourceType?: string;
-  /**
-   * @remarks
-   * The risk level of the rule. Valid values:
-   * 
-   * - 1: High risk.
-   * 
-   * - 2: Medium risk.
-   * 
-   * - 3: Low risk.
-   * 
-   * @example
-   * 1
-   */
   riskLevel?: number;
-  /**
-   * @remarks
-   * This parameter is optional. The only supported value is `LastNonCompliantRecordTimestamp-Asc`. This value sorts resources based on when they first became non-compliant, with the earliest appearing first. Use this parameter only when you set the `ComplianceType` parameter to `NON_COMPLIANT`.
-   * 
-   * @example
-   * LastNonCompliantRecordTimestamp-Asc
-   */
   sortBy?: string;
   static names(): { [key: string]: string } {
     return {