Network.AWS.Config.DescribeComplianceByConfigRule

Indicates whether the specified AWS Config rules are compliant. If a rule is noncompliant, this action returns the number of AWS resources that do not comply with the rule.

A rule is compliant if all of the evaluated resources comply with it, and it is noncompliant if any of these resources do not comply.

If AWS Config has no current evaluation results for the rule, it returns InsufficientData. This result might indicate one of the following conditions:

• AWS 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 AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the 'config:PutEvaluations' permission. If the rule is a customer managed rule, verify that the AWS Lambda execution role includes the 'config:PutEvaluations' permission.
• The rule's AWS 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.

See: AWS API Reference for DescribeComplianceByConfigRule.

Creating a Request

describeComplianceByConfigRule :: DescribeComplianceByConfigRule

Creates a value of DescribeComplianceByConfigRule with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcbcrConfigRuleNames
• dcbcrComplianceTypes
• dcbcrNextToken

data DescribeComplianceByConfigRule

See: describeComplianceByConfigRule smart constructor.

Instances

Eq DescribeComplianceByConfigRule

Data DescribeComplianceByConfigRule

Read DescribeComplianceByConfigRule

Show DescribeComplianceByConfigRule

Generic DescribeComplianceByConfigRule

ToJSON DescribeComplianceByConfigRule

AWSRequest DescribeComplianceByConfigRule

ToPath DescribeComplianceByConfigRule

ToHeaders DescribeComplianceByConfigRule

ToQuery DescribeComplianceByConfigRule

type Rep DescribeComplianceByConfigRule

type Rs DescribeComplianceByConfigRule = DescribeComplianceByConfigRuleResponse

Request Lenses

dcbcrConfigRuleNames :: Lens' DescribeComplianceByConfigRule [Text]

Specify one or more AWS Config rule names to filter the results by rule.

dcbcrComplianceTypes :: Lens' DescribeComplianceByConfigRule [ComplianceType]

Filters the results by compliance. The valid values are Compliant and NonCompliant.

dcbcrNextToken :: Lens' DescribeComplianceByConfigRule (Maybe Text)

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Destructuring the Response

describeComplianceByConfigRuleResponse

Arguments

:: Int

dcbcrrsResponseStatus

-> DescribeComplianceByConfigRuleResponse

Creates a value of DescribeComplianceByConfigRuleResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcbcrrsComplianceByConfigRules
• dcbcrrsNextToken
• dcbcrrsResponseStatus

data DescribeComplianceByConfigRuleResponse

See: describeComplianceByConfigRuleResponse smart constructor.

Instances

Eq DescribeComplianceByConfigRuleResponse

Data DescribeComplianceByConfigRuleResponse

Read DescribeComplianceByConfigRuleResponse

Show DescribeComplianceByConfigRuleResponse

Generic DescribeComplianceByConfigRuleResponse

type Rep DescribeComplianceByConfigRuleResponse

Response Lenses

dcbcrrsComplianceByConfigRules :: Lens' DescribeComplianceByConfigRuleResponse [ComplianceByConfigRule]

Indicates whether each of the specified AWS Config rules is compliant.

dcbcrrsNextToken :: Lens' DescribeComplianceByConfigRuleResponse (Maybe Text)

The string that you use in a subsequent request to get the next page of results in a paginated response.

dcbcrrsResponseStatus :: Lens' DescribeComplianceByConfigRuleResponse Int

The response status code.