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.
Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this action returns the number of Amazon Web Services resources that do not comply with the rule.
A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply.
If Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA.
This result might indicate one of the following conditions:
Config has never invoked an evaluation for the rule. To check whether it has, use
the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime
and LastFailedInvocationTime.
The rule's Lambda function is failing to send evaluation results to Config. Verify
that the role you assigned to your configuration recorder includes the config:PutEvaluations
permission. If the rule is a custom rule, verify that the Lambda execution role includes
the config:PutEvaluations permission.
The rule's Lambda function has returned NOT_APPLICABLE for all evaluation results.
This can occur if the resources were deleted or removed from the rule's scope.
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 BeginDescribeComplianceByConfigRule and EndDescribeComplianceByConfigRule.
Namespace: Amazon.ConfigService
Assembly: AWSSDK.ConfigService.dll
Version: 3.x.y.z
public abstract Task<DescribeComplianceByConfigRuleResponse> DescribeComplianceByConfigRuleAsync( DescribeComplianceByConfigRuleRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the DescribeComplianceByConfigRule service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| InvalidNextTokenException | The specified next token is not valid. Specify the nextToken string that was returned in the previous response to get the next page of results. |
| InvalidParameterValueException | One or more of the specified parameters are not valid. Verify that your parameters are valid and try again. |
| 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. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer