AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Deletes the specified Config rule and all of its evaluation results.

Config sets the state of a rule to DELETING until the deletion is complete. You cannot update a rule while it is in this state. If you make a PutConfigRule or DeleteConfigRule request for the rule, you will receive a ResourceInUseException.

You can check the state of a rule by using the DescribeConfigRules request.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDeleteConfigRule and EndDeleteConfigRule.

Namespace: Amazon.ConfigService
Assembly: AWSSDK.ConfigService.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<DeleteConfigRuleResponse> DeleteConfigRuleAsync(
         DeleteConfigRuleRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.ConfigService.Model.DeleteConfigRuleRequest

Container for the necessary parameters to execute the DeleteConfigRule service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DeleteConfigRule service method, as returned by ConfigService.

Exceptions

ExceptionCondition
NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
ResourceInUseException You see this exception in the following cases: For DeleteConfigRule, Config is deleting this rule. Try your request again later. For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later. For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later. For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later. For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later. For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later. For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also