@alicloud/config20200907 2.3.0 → 3.0.0

package/dist/client.d.ts

@@ -1457,6 +1457,48 @@ export declare class DeleteRemediationsResponse extends $tea.Model {
         [key: string]: any;
     });
 }
+export declare class DescribeRemediationRequest extends $tea.Model {
+    configRuleId?: string;
+    remediationId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class DescribeRemediationResponseBody extends $tea.Model {
+    remediation?: DescribeRemediationResponseBodyRemediation;
+    requestId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class DescribeRemediationResponse extends $tea.Model {
+    headers: {
+        [key: string]: string;
+    };
+    statusCode: number;
+    body: DescribeRemediationResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class DetachAggregateConfigRuleToCompliancePackRequest extends $tea.Model {
     aggregatorId?: string;
     compliancePackId?: string;
@@ -6758,6 +6800,28 @@ export declare class DeleteRemediationsResponseBodyRemediationDeleteResults exte
         [key: string]: any;
     });
 }
+export declare class DescribeRemediationResponseBodyRemediation extends $tea.Model {
+    accountId?: number;
+    configRuleId?: string;
+    invokeType?: string;
+    lastSuccessfulInvocationId?: string;
+    lastSuccessfulInvocationTime?: number;
+    lastSuccessfulInvocationType?: string;
+    remediationId?: string;
+    remediationOriginParams?: string;
+    remediationSourceType?: string;
+    remediationTemplateId?: string;
+    remediationType?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class DetachAggregateConfigRuleToCompliancePackResponseBodyOperateRuleResultOperateRuleItemList extends $tea.Model {
     configRuleId?: string;
     errorCode?: string;
@@ -9807,9 +9871,10 @@ export default class Client extends OpenApi {
      */
     createConfigDeliveryChannel(request: CreateConfigDeliveryChannelRequest): Promise<CreateConfigDeliveryChannelResponse>;
     /**
+      * ### Limits
+      * You can use an ordinary account to create up to 200 rules.
+      * ### Usage notes
       * This topic provides an example on how to create a managed rule named required-tags. The returned result indicates that the rule is created and the ID of the rule is `cr-5772ba41209e007b****`.
-      * ## Limits
-      * You can use a common account to create up to 200 rules.
       *
       * @param tmpReq CreateConfigRuleRequest
       * @param runtime runtime options for this request RuntimeOptions
@@ -9817,9 +9882,10 @@ export default class Client extends OpenApi {
      */
     createConfigRuleWithOptions(tmpReq: CreateConfigRuleRequest, runtime: $Util.RuntimeOptions): Promise<CreateConfigRuleResponse>;
     /**
+      * ### Limits
+      * You can use an ordinary account to create up to 200 rules.
+      * ### Usage notes
       * This topic provides an example on how to create a managed rule named required-tags. The returned result indicates that the rule is created and the ID of the rule is `cr-5772ba41209e007b****`.
-      * ## Limits
-      * You can use a common account to create up to 200 rules.
       *
       * @param request CreateConfigRuleRequest
       * @return CreateConfigRuleResponse
@@ -10028,10 +10094,13 @@ export default class Client extends OpenApi {
       * @return DeleteRemediationsResponse
      */
     deleteRemediations(request: DeleteRemediationsRequest): Promise<DeleteRemediationsResponse>;
+    describeRemediationWithOptions(request: DescribeRemediationRequest, runtime: $Util.RuntimeOptions): Promise<DescribeRemediationResponse>;
+    describeRemediation(request: DescribeRemediationRequest): Promise<DescribeRemediationResponse>;
     /**
+      * ### Prerequisites
+      * One or more rules are added to a compliance package.
+      * ### Usage notes
       * The sample request in this topic shows you how to remove the `cr-6cc4626622af00e7****` rule in the `ca-75b4626622af00c3****` account group from the `cp-5bb1626622af00bd****` compliance package.
-      * ## Prerequisites
-      * One or more rules in an account group are added to a compliance package.
       *
       * @param request DetachAggregateConfigRuleToCompliancePackRequest
       * @param runtime runtime options for this request RuntimeOptions
@@ -10039,9 +10108,10 @@ export default class Client extends OpenApi {
      */
     detachAggregateConfigRuleToCompliancePackWithOptions(request: DetachAggregateConfigRuleToCompliancePackRequest, runtime: $Util.RuntimeOptions): Promise<DetachAggregateConfigRuleToCompliancePackResponse>;
     /**
+      * ### Prerequisites
+      * One or more rules are added to a compliance package.
+      * ### Usage notes
       * The sample request in this topic shows you how to remove the `cr-6cc4626622af00e7****` rule in the `ca-75b4626622af00c3****` account group from the `cp-5bb1626622af00bd****` compliance package.
-      * ## Prerequisites
-      * One or more rules in an account group are added to a compliance package.
       *
       * @param request DetachAggregateConfigRuleToCompliancePackRequest
       * @return DetachAggregateConfigRuleToCompliancePackResponse
@@ -10104,7 +10174,20 @@ export default class Client extends OpenApi {
       * @return GenerateAggregateConfigRulesReportResponse
      */
     generateAggregateConfigRulesReport(request: GenerateAggregateConfigRulesReportRequest): Promise<GenerateAggregateConfigRulesReportResponse>;
+    /**
+      * This topic provides an example to show how to generate a downloadable inventory for global resources in the account group ca-a91d626622af0035\\*\\*\\*\\*.
+      *
+      * @param request GenerateAggregateResourceInventoryRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return GenerateAggregateResourceInventoryResponse
+     */
     generateAggregateResourceInventoryWithOptions(request: GenerateAggregateResourceInventoryRequest, runtime: $Util.RuntimeOptions): Promise<GenerateAggregateResourceInventoryResponse>;
+    /**
+      * This topic provides an example to show how to generate a downloadable inventory for global resources in the account group ca-a91d626622af0035\\*\\*\\*\\*.
+      *
+      * @param request GenerateAggregateResourceInventoryRequest
+      * @return GenerateAggregateResourceInventoryResponse
+     */
     generateAggregateResourceInventory(request: GenerateAggregateResourceInventoryRequest): Promise<GenerateAggregateResourceInventoryResponse>;
     /**
       * > You can call this operation to generate the latest compliance evaluation report. To download the report, call the GetCompliancePackReport operation. For more information, see [GetCompliancePackReport](~~263347~~).
@@ -10140,7 +10223,20 @@ export default class Client extends OpenApi {
       * @return GenerateConfigRulesReportResponse
      */
     generateConfigRulesReport(request: GenerateConfigRulesReportRequest): Promise<GenerateConfigRulesReportResponse>;
+    /**
+      * This topic provides an example on how to generate a resource inventory for global resources of the current account.
+      *
+      * @param request GenerateResourceInventoryRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return GenerateResourceInventoryResponse
+     */
     generateResourceInventoryWithOptions(request: GenerateResourceInventoryRequest, runtime: $Util.RuntimeOptions): Promise<GenerateResourceInventoryResponse>;
+    /**
+      * This topic provides an example on how to generate a resource inventory for global resources of the current account.
+      *
+      * @param request GenerateResourceInventoryRequest
+      * @return GenerateResourceInventoryResponse
+     */
     generateResourceInventory(request: GenerateResourceInventoryRequest): Promise<GenerateResourceInventoryResponse>;
     getAdvancedSearchFileWithOptions(runtime: $Util.RuntimeOptions): Promise<GetAdvancedSearchFileResponse>;
     getAdvancedSearchFile(): Promise<GetAdvancedSearchFileResponse>;
@@ -10193,7 +10289,20 @@ export default class Client extends OpenApi {
       * @return GetAggregateCompliancePackReportResponse
      */
     getAggregateCompliancePackReport(request: GetAggregateCompliancePackReportRequest): Promise<GetAggregateCompliancePackReportResponse>;
+    /**
+      * This topic provides an example on how to query the compliance statistics of resources and rules in the account group ca-a91d626622af0035\\*\\*\\*\\*.
+      *
+      * @param request GetAggregateComplianceSummaryRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return GetAggregateComplianceSummaryResponse
+     */
     getAggregateComplianceSummaryWithOptions(request: GetAggregateComplianceSummaryRequest, runtime: $Util.RuntimeOptions): Promise<GetAggregateComplianceSummaryResponse>;
+    /**
+      * This topic provides an example on how to query the compliance statistics of resources and rules in the account group ca-a91d626622af0035\\*\\*\\*\\*.
+      *
+      * @param request GetAggregateComplianceSummaryRequest
+      * @return GetAggregateComplianceSummaryResponse
+     */
     getAggregateComplianceSummary(request: GetAggregateComplianceSummaryRequest): Promise<GetAggregateComplianceSummaryResponse>;
     getAggregateConfigDeliveryChannelWithOptions(request: GetAggregateConfigDeliveryChannelRequest, runtime: $Util.RuntimeOptions): Promise<GetAggregateConfigDeliveryChannelResponse>;
     getAggregateConfigDeliveryChannel(request: GetAggregateConfigDeliveryChannelRequest): Promise<GetAggregateConfigDeliveryChannelResponse>;
@@ -10275,7 +10384,7 @@ export default class Client extends OpenApi {
      */
     getAggregateDiscoveredResource(request: GetAggregateDiscoveredResourceRequest): Promise<GetAggregateDiscoveredResourceResponse>;
     /**
-      * The sample request in this topic shows you how to query the compliance evaluation results based on the `cr-d369626622af008e****` rule in the `ca-a4e5626622af0079****` account group. The return result shows that a total of 10 resources are evaluated by the rule and five of them are evaluated as compliant.
+      * This topic provides an example on how to query the compliance evaluation results based on the `cr-d369626622af008e****` rule in the `ca-a4e5626622af0079****` account group. The returned result shows that a total of 10 resources are evaluated by the rule and five of them are evaluated as compliant.
       *
       * @param request GetAggregateResourceComplianceByConfigRuleRequest
       * @param runtime runtime options for this request RuntimeOptions
@@ -10283,7 +10392,7 @@ export default class Client extends OpenApi {
      */
     getAggregateResourceComplianceByConfigRuleWithOptions(request: GetAggregateResourceComplianceByConfigRuleRequest, runtime: $Util.RuntimeOptions): Promise<GetAggregateResourceComplianceByConfigRuleResponse>;
     /**
-      * The sample request in this topic shows you how to query the compliance evaluation results based on the `cr-d369626622af008e****` rule in the `ca-a4e5626622af0079****` account group. The return result shows that a total of 10 resources are evaluated by the rule and five of them are evaluated as compliant.
+      * This topic provides an example on how to query the compliance evaluation results based on the `cr-d369626622af008e****` rule in the `ca-a4e5626622af0079****` account group. The returned result shows that a total of 10 resources are evaluated by the rule and five of them are evaluated as compliant.
       *
       * @param request GetAggregateResourceComplianceByConfigRuleRequest
       * @return GetAggregateResourceComplianceByConfigRuleResponse
@@ -10417,7 +10526,19 @@ export default class Client extends OpenApi {
       * @return GetCompliancePackReportResponse
      */
     getCompliancePackReport(request: GetCompliancePackReportRequest): Promise<GetCompliancePackReportResponse>;
+    /**
+      * This topic provides an example on how to query the compliance statistics of resources and rules in the current account group.
+      *
+      * @param request GetComplianceSummaryRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return GetComplianceSummaryResponse
+     */
     getComplianceSummaryWithOptions(runtime: $Util.RuntimeOptions): Promise<GetComplianceSummaryResponse>;
+    /**
+      * This topic provides an example on how to query the compliance statistics of resources and rules in the current account group.
+      *
+      * @return GetComplianceSummaryResponse
+     */
     getComplianceSummary(): Promise<GetComplianceSummaryResponse>;
     getConfigDeliveryChannelWithOptions(request: GetConfigDeliveryChannelRequest, runtime: $Util.RuntimeOptions): Promise<GetConfigDeliveryChannelResponse>;
     getConfigDeliveryChannel(request: GetConfigDeliveryChannelRequest): Promise<GetConfigDeliveryChannelResponse>;
@@ -10482,7 +10603,19 @@ export default class Client extends OpenApi {
       * @return GetConfigRulesReportResponse
      */
     getConfigRulesReport(request: GetConfigRulesReportRequest): Promise<GetConfigRulesReportResponse>;
+    /**
+      * This topic provides an example on how to query the activation status and resource monitoring scope of Cloud Config for the current account.
+      *
+      * @param request GetConfigurationRecorderRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return GetConfigurationRecorderResponse
+     */
     getConfigurationRecorderWithOptions(runtime: $Util.RuntimeOptions): Promise<GetConfigurationRecorderResponse>;
+    /**
+      * This topic provides an example on how to query the activation status and resource monitoring scope of Cloud Config for the current account.
+      *
+      * @return GetConfigurationRecorderResponse
+     */
     getConfigurationRecorder(): Promise<GetConfigurationRecorderResponse>;
     /**
       * The sample request in this topic shows you how to query the details of the `new-bucket` resource.
@@ -10546,7 +10679,20 @@ export default class Client extends OpenApi {
       * @return GetManagedRuleResponse
      */
     getManagedRule(request: GetManagedRuleRequest): Promise<GetManagedRuleResponse>;
+    /**
+      * This topic provides an example on how to query the details of the automatic remediation template ACS-ALB-BulkyEnableDeletionProtection.
+      *
+      * @param request GetRemediationTemplateRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return GetRemediationTemplateResponse
+     */
     getRemediationTemplateWithOptions(request: GetRemediationTemplateRequest, runtime: $Util.RuntimeOptions): Promise<GetRemediationTemplateResponse>;
+    /**
+      * This topic provides an example on how to query the details of the automatic remediation template ACS-ALB-BulkyEnableDeletionProtection.
+      *
+      * @param request GetRemediationTemplateRequest
+      * @return GetRemediationTemplateResponse
+     */
     getRemediationTemplate(request: GetRemediationTemplateRequest): Promise<GetRemediationTemplateResponse>;
     /**
       * In this topic, the `cr-d369626622af008e****` rule is used as an example. The return result shows that a total of 10 resources are evaluated by the rule and `five` of them are evaluated as compliant.
@@ -10889,7 +11035,20 @@ export default class Client extends OpenApi {
     listManagedRules(request: ListManagedRulesRequest): Promise<ListManagedRulesResponse>;
     listPreManagedRulesWithOptions(tmpReq: ListPreManagedRulesRequest, runtime: $Util.RuntimeOptions): Promise<ListPreManagedRulesResponse>;
     listPreManagedRules(request: ListPreManagedRulesRequest): Promise<ListPreManagedRulesResponse>;
+    /**
+      * This topic provides an example on how to query the remediation records of the rule cr-5392626622af0000\\*\\*\\*\\*.
+      *
+      * @param request ListRemediationExecutionsRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return ListRemediationExecutionsResponse
+     */
     listRemediationExecutionsWithOptions(request: ListRemediationExecutionsRequest, runtime: $Util.RuntimeOptions): Promise<ListRemediationExecutionsResponse>;
+    /**
+      * This topic provides an example on how to query the remediation records of the rule cr-5392626622af0000\\*\\*\\*\\*.
+      *
+      * @param request ListRemediationExecutionsRequest
+      * @return ListRemediationExecutionsResponse
+     */
     listRemediationExecutions(request: ListRemediationExecutionsRequest): Promise<ListRemediationExecutionsResponse>;
     /**
       * In this topic, the `oss-bucket-public-write-prohibited` managed rule is used as an example. The return result shows the details of the remediation template of the `OOS` type for the managed rule. OOS represents Operation Orchestration Service.
@@ -11033,9 +11192,34 @@ export default class Client extends OpenApi {
       * @return StartAggregateRemediationResponse
      */
     startAggregateRemediation(request: StartAggregateRemediationRequest): Promise<StartAggregateRemediationResponse>;
+    /**
+      * In this example, the cr-9920626622af0035\\*\\*\\*\\* rule is used to re-evaluate the compliance of resources.
+      *
+      * @param request StartConfigRuleEvaluationRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return StartConfigRuleEvaluationResponse
+     */
     startConfigRuleEvaluationWithOptions(request: StartConfigRuleEvaluationRequest, runtime: $Util.RuntimeOptions): Promise<StartConfigRuleEvaluationResponse>;
+    /**
+      * In this example, the cr-9920626622af0035\\*\\*\\*\\* rule is used to re-evaluate the compliance of resources.
+      *
+      * @param request StartConfigRuleEvaluationRequest
+      * @return StartConfigRuleEvaluationResponse
+     */
     startConfigRuleEvaluation(request: StartConfigRuleEvaluationRequest): Promise<StartConfigRuleEvaluationResponse>;
+    /**
+      * This topic provides an example on how to enable Cloud Config to monitor the resources of your Alibaba Cloud account.
+      *
+      * @param request StartConfigurationRecorderRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return StartConfigurationRecorderResponse
+     */
     startConfigurationRecorderWithOptions(runtime: $Util.RuntimeOptions): Promise<StartConfigurationRecorderResponse>;
+    /**
+      * This topic provides an example on how to enable Cloud Config to monitor the resources of your Alibaba Cloud account.
+      *
+      * @return StartConfigurationRecorderResponse
+     */
     startConfigurationRecorder(): Promise<StartConfigurationRecorderResponse>;
     /**
       * This topic provides an example on how to perform a remediation operation by using the rule whose ID is `cr-8a973ac2e2be00a2****`. The returned result shows that the manual execution is successful.
@@ -11178,7 +11362,20 @@ export default class Client extends OpenApi {
       * @return UpdateConfigRuleResponse
      */
     updateConfigRule(request: UpdateConfigRuleRequest): Promise<UpdateConfigRuleResponse>;
+    /**
+      * This topic provides an example on how to change the resource monitoring scope of the current account to ACS::ECS::Instance.
+      *
+      * @param request UpdateConfigurationRecorderRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return UpdateConfigurationRecorderResponse
+     */
     updateConfigurationRecorderWithOptions(request: UpdateConfigurationRecorderRequest, runtime: $Util.RuntimeOptions): Promise<UpdateConfigurationRecorderResponse>;
+    /**
+      * This topic provides an example on how to change the resource monitoring scope of the current account to ACS::ECS::Instance.
+      *
+      * @param request UpdateConfigurationRecorderRequest
+      * @return UpdateConfigurationRecorderResponse
+     */
     updateConfigurationRecorder(request: UpdateConfigurationRecorderRequest): Promise<UpdateConfigurationRecorderResponse>;
     /**
       * @deprecated : UpdateDeliveryChannel is deprecated, please use Config::2020-09-07::UpdateConfigDeliveryChannel,Config::2020-09-07::UpdateAggregateConfigDeliveryChannel instead.