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 INSUFFICIENT_DATA. 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.

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

Methods

(==) :: DescribeComplianceByConfigRule -> DescribeComplianceByConfigRule -> Bool

(/=) :: DescribeComplianceByConfigRule -> DescribeComplianceByConfigRule -> Bool

Data DescribeComplianceByConfigRule

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeComplianceByConfigRule -> c DescribeComplianceByConfigRule

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeComplianceByConfigRule

toConstr :: DescribeComplianceByConfigRule -> Constr

dataTypeOf :: DescribeComplianceByConfigRule -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeComplianceByConfigRule)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeComplianceByConfigRule)

gmapT :: (forall b. Data b => b -> b) -> DescribeComplianceByConfigRule -> DescribeComplianceByConfigRule

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeComplianceByConfigRule -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeComplianceByConfigRule -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeComplianceByConfigRule -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeComplianceByConfigRule -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeComplianceByConfigRule -> m DescribeComplianceByConfigRule

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeComplianceByConfigRule -> m DescribeComplianceByConfigRule

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeComplianceByConfigRule -> m DescribeComplianceByConfigRule

Read DescribeComplianceByConfigRule

Methods

readsPrec :: Int -> ReadS DescribeComplianceByConfigRule

readList :: ReadS [DescribeComplianceByConfigRule]

readPrec :: ReadPrec DescribeComplianceByConfigRule

readListPrec :: ReadPrec [DescribeComplianceByConfigRule]

Show DescribeComplianceByConfigRule

Methods

showsPrec :: Int -> DescribeComplianceByConfigRule -> ShowS

show :: DescribeComplianceByConfigRule -> String

showList :: [DescribeComplianceByConfigRule] -> ShowS

Generic DescribeComplianceByConfigRule

Associated Types

type Rep DescribeComplianceByConfigRule :: * -> *

Methods

from :: DescribeComplianceByConfigRule -> Rep DescribeComplianceByConfigRule x

to :: Rep DescribeComplianceByConfigRule x -> DescribeComplianceByConfigRule

ToJSON DescribeComplianceByConfigRule

Methods

toJSON :: DescribeComplianceByConfigRule -> Value

toEncoding :: DescribeComplianceByConfigRule -> Encoding

Hashable DescribeComplianceByConfigRule

Methods

hashWithSalt :: Int -> DescribeComplianceByConfigRule -> Int

hash :: DescribeComplianceByConfigRule -> Int

NFData DescribeComplianceByConfigRule

Methods

rnf :: DescribeComplianceByConfigRule -> ()

AWSRequest DescribeComplianceByConfigRule

Associated Types

type Rs DescribeComplianceByConfigRule :: *

Methods

request :: DescribeComplianceByConfigRule -> Request DescribeComplianceByConfigRule

response :: MonadResource m => Logger -> Service -> Proxy * DescribeComplianceByConfigRule -> ClientResponse -> m (Response DescribeComplianceByConfigRule)

ToPath DescribeComplianceByConfigRule

Methods

toPath :: DescribeComplianceByConfigRule -> ByteString

ToHeaders DescribeComplianceByConfigRule

Methods

toHeaders :: DescribeComplianceByConfigRule -> [Header]

ToQuery DescribeComplianceByConfigRule

Methods

toQuery :: DescribeComplianceByConfigRule -> QueryString

type Rep DescribeComplianceByConfigRule

type Rep DescribeComplianceByConfigRule = D1 (MetaData "DescribeComplianceByConfigRule" "Network.AWS.Config.DescribeComplianceByConfigRule" "amazonka-config-1.4.3-6dEKTXSzLg81CPzXP0Z06u" False) (C1 (MetaCons "DescribeComplianceByConfigRule'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dcbcrConfigRuleNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_dcbcrComplianceTypes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ComplianceType]))) (S1 (MetaSel (Just Symbol "_dcbcrNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Rs 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 allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.

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

Methods

(==) :: DescribeComplianceByConfigRuleResponse -> DescribeComplianceByConfigRuleResponse -> Bool

(/=) :: DescribeComplianceByConfigRuleResponse -> DescribeComplianceByConfigRuleResponse -> Bool

Data DescribeComplianceByConfigRuleResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeComplianceByConfigRuleResponse -> c DescribeComplianceByConfigRuleResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeComplianceByConfigRuleResponse

toConstr :: DescribeComplianceByConfigRuleResponse -> Constr

dataTypeOf :: DescribeComplianceByConfigRuleResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeComplianceByConfigRuleResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeComplianceByConfigRuleResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeComplianceByConfigRuleResponse -> DescribeComplianceByConfigRuleResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeComplianceByConfigRuleResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeComplianceByConfigRuleResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeComplianceByConfigRuleResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeComplianceByConfigRuleResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeComplianceByConfigRuleResponse -> m DescribeComplianceByConfigRuleResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeComplianceByConfigRuleResponse -> m DescribeComplianceByConfigRuleResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeComplianceByConfigRuleResponse -> m DescribeComplianceByConfigRuleResponse

Read DescribeComplianceByConfigRuleResponse

Methods

readsPrec :: Int -> ReadS DescribeComplianceByConfigRuleResponse

readList :: ReadS [DescribeComplianceByConfigRuleResponse]

readPrec :: ReadPrec DescribeComplianceByConfigRuleResponse

readListPrec :: ReadPrec [DescribeComplianceByConfigRuleResponse]

Show DescribeComplianceByConfigRuleResponse

Methods

showsPrec :: Int -> DescribeComplianceByConfigRuleResponse -> ShowS

show :: DescribeComplianceByConfigRuleResponse -> String

showList :: [DescribeComplianceByConfigRuleResponse] -> ShowS

Generic DescribeComplianceByConfigRuleResponse

Associated Types

type Rep DescribeComplianceByConfigRuleResponse :: * -> *

Methods

from :: DescribeComplianceByConfigRuleResponse -> Rep DescribeComplianceByConfigRuleResponse x

to :: Rep DescribeComplianceByConfigRuleResponse x -> DescribeComplianceByConfigRuleResponse

NFData DescribeComplianceByConfigRuleResponse

Methods

rnf :: DescribeComplianceByConfigRuleResponse -> ()

type Rep DescribeComplianceByConfigRuleResponse

type Rep DescribeComplianceByConfigRuleResponse = D1 (MetaData "DescribeComplianceByConfigRuleResponse" "Network.AWS.Config.DescribeComplianceByConfigRule" "amazonka-config-1.4.3-6dEKTXSzLg81CPzXP0Z06u" False) (C1 (MetaCons "DescribeComplianceByConfigRuleResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dcbcrrsComplianceByConfigRules") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ComplianceByConfigRule]))) ((:*:) (S1 (MetaSel (Just Symbol "_dcbcrrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dcbcrrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

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.