Amazonka.Config.DescribeComplianceByConfigRule

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 operation returns paginated results.

Creating a Request

data DescribeComplianceByConfigRule

See: newDescribeComplianceByConfigRule smart constructor.

Constructors

DescribeComplianceByConfigRule'

Fields

• complianceTypes :: Maybe [ComplianceType]

  Filters the results by compliance.

  The allowed values are COMPLIANT and NON_COMPLIANT.

• configRuleNames :: Maybe [Text]

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

• nextToken :: Maybe Text

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

Instances

ToJSON DescribeComplianceByConfigRule

Defined in Amazonka.Config.DescribeComplianceByConfigRule

Methods

toJSON :: DescribeComplianceByConfigRule -> Value

toEncoding :: DescribeComplianceByConfigRule -> Encoding

toJSONList :: [DescribeComplianceByConfigRule] -> Value

toEncodingList :: [DescribeComplianceByConfigRule] -> Encoding

ToHeaders DescribeComplianceByConfigRule

Defined in Amazonka.Config.DescribeComplianceByConfigRule

Methods

toHeaders :: DescribeComplianceByConfigRule -> [Header]

ToPath DescribeComplianceByConfigRule

Defined in Amazonka.Config.DescribeComplianceByConfigRule

Methods

toPath :: DescribeComplianceByConfigRule -> ByteString

ToQuery DescribeComplianceByConfigRule

Defined in Amazonka.Config.DescribeComplianceByConfigRule

Methods

toQuery :: DescribeComplianceByConfigRule -> QueryString

AWSPager DescribeComplianceByConfigRule

Defined in Amazonka.Config.DescribeComplianceByConfigRule

Methods

page :: DescribeComplianceByConfigRule -> AWSResponse DescribeComplianceByConfigRule -> Maybe DescribeComplianceByConfigRule

AWSRequest DescribeComplianceByConfigRule

Defined in Amazonka.Config.DescribeComplianceByConfigRule

Associated Types

type AWSResponse DescribeComplianceByConfigRule

Methods

request :: (Service -> Service) -> DescribeComplianceByConfigRule -> Request DescribeComplianceByConfigRule

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeComplianceByConfigRule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeComplianceByConfigRule)))

Generic DescribeComplianceByConfigRule

Defined in Amazonka.Config.DescribeComplianceByConfigRule

Associated Types

type Rep DescribeComplianceByConfigRule :: Type -> Type

Methods

from :: DescribeComplianceByConfigRule -> Rep DescribeComplianceByConfigRule x

to :: Rep DescribeComplianceByConfigRule x -> DescribeComplianceByConfigRule

Read DescribeComplianceByConfigRule

Defined in Amazonka.Config.DescribeComplianceByConfigRule

Methods

readsPrec :: Int -> ReadS DescribeComplianceByConfigRule

readList :: ReadS [DescribeComplianceByConfigRule]

readPrec :: ReadPrec DescribeComplianceByConfigRule

readListPrec :: ReadPrec [DescribeComplianceByConfigRule]

Show DescribeComplianceByConfigRule

Defined in Amazonka.Config.DescribeComplianceByConfigRule

Methods

showsPrec :: Int -> DescribeComplianceByConfigRule -> ShowS

show :: DescribeComplianceByConfigRule -> String

showList :: [DescribeComplianceByConfigRule] -> ShowS

NFData DescribeComplianceByConfigRule

Defined in Amazonka.Config.DescribeComplianceByConfigRule

Methods

rnf :: DescribeComplianceByConfigRule -> ()

Eq DescribeComplianceByConfigRule

Defined in Amazonka.Config.DescribeComplianceByConfigRule

Methods

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

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

Hashable DescribeComplianceByConfigRule

Defined in Amazonka.Config.DescribeComplianceByConfigRule

Methods

hashWithSalt :: Int -> DescribeComplianceByConfigRule -> Int

hash :: DescribeComplianceByConfigRule -> Int

type AWSResponse DescribeComplianceByConfigRule

Defined in Amazonka.Config.DescribeComplianceByConfigRule

type AWSResponse DescribeComplianceByConfigRule = DescribeComplianceByConfigRuleResponse

type Rep DescribeComplianceByConfigRule

Defined in Amazonka.Config.DescribeComplianceByConfigRule

type Rep DescribeComplianceByConfigRule = D1 ('MetaData "DescribeComplianceByConfigRule" "Amazonka.Config.DescribeComplianceByConfigRule" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "DescribeComplianceByConfigRule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "complianceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ComplianceType])) :*: (S1 ('MetaSel ('Just "configRuleNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeComplianceByConfigRule :: DescribeComplianceByConfigRule

Create a value of DescribeComplianceByConfigRule with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:complianceTypes:DescribeComplianceByConfigRule', describeComplianceByConfigRule_complianceTypes - Filters the results by compliance.

The allowed values are COMPLIANT and NON_COMPLIANT.

DescribeComplianceByConfigRule, describeComplianceByConfigRule_configRuleNames - Specify one or more Config rule names to filter the results by rule.

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

Request Lenses

describeComplianceByConfigRule_complianceTypes :: Lens' DescribeComplianceByConfigRule (Maybe [ComplianceType])

Filters the results by compliance.

The allowed values are COMPLIANT and NON_COMPLIANT.

describeComplianceByConfigRule_configRuleNames :: Lens' DescribeComplianceByConfigRule (Maybe [Text])

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

describeComplianceByConfigRule_nextToken :: 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

data DescribeComplianceByConfigRuleResponse

See: newDescribeComplianceByConfigRuleResponse smart constructor.

Constructors

DescribeComplianceByConfigRuleResponse'

Fields

• complianceByConfigRules :: Maybe [ComplianceByConfigRule]

  Indicates whether each of the specified Config rules is compliant.

• nextToken :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeComplianceByConfigRuleResponse

Defined in Amazonka.Config.DescribeComplianceByConfigRule

Associated Types

type Rep DescribeComplianceByConfigRuleResponse :: Type -> Type

Methods

from :: DescribeComplianceByConfigRuleResponse -> Rep DescribeComplianceByConfigRuleResponse x

to :: Rep DescribeComplianceByConfigRuleResponse x -> DescribeComplianceByConfigRuleResponse

Read DescribeComplianceByConfigRuleResponse

Defined in Amazonka.Config.DescribeComplianceByConfigRule

Methods

readsPrec :: Int -> ReadS DescribeComplianceByConfigRuleResponse

readList :: ReadS [DescribeComplianceByConfigRuleResponse]

readPrec :: ReadPrec DescribeComplianceByConfigRuleResponse

readListPrec :: ReadPrec [DescribeComplianceByConfigRuleResponse]

Show DescribeComplianceByConfigRuleResponse

Defined in Amazonka.Config.DescribeComplianceByConfigRule

Methods

showsPrec :: Int -> DescribeComplianceByConfigRuleResponse -> ShowS

show :: DescribeComplianceByConfigRuleResponse -> String

showList :: [DescribeComplianceByConfigRuleResponse] -> ShowS

NFData DescribeComplianceByConfigRuleResponse

Defined in Amazonka.Config.DescribeComplianceByConfigRule

Methods

rnf :: DescribeComplianceByConfigRuleResponse -> ()

Eq DescribeComplianceByConfigRuleResponse

Defined in Amazonka.Config.DescribeComplianceByConfigRule

Methods

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

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

type Rep DescribeComplianceByConfigRuleResponse

Defined in Amazonka.Config.DescribeComplianceByConfigRule

type Rep DescribeComplianceByConfigRuleResponse = D1 ('MetaData "DescribeComplianceByConfigRuleResponse" "Amazonka.Config.DescribeComplianceByConfigRule" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "DescribeComplianceByConfigRuleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "complianceByConfigRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ComplianceByConfigRule])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeComplianceByConfigRuleResponse

Arguments

:: Int

$sel:httpStatus:DescribeComplianceByConfigRuleResponse'

-> DescribeComplianceByConfigRuleResponse

Create a value of DescribeComplianceByConfigRuleResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:complianceByConfigRules:DescribeComplianceByConfigRuleResponse', describeComplianceByConfigRuleResponse_complianceByConfigRules - Indicates whether each of the specified Config rules is compliant.

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

$sel:httpStatus:DescribeComplianceByConfigRuleResponse', describeComplianceByConfigRuleResponse_httpStatus - The response's http status code.

Response Lenses

describeComplianceByConfigRuleResponse_complianceByConfigRules :: Lens' DescribeComplianceByConfigRuleResponse (Maybe [ComplianceByConfigRule])

Indicates whether each of the specified Config rules is compliant.

describeComplianceByConfigRuleResponse_nextToken :: Lens' DescribeComplianceByConfigRuleResponse (Maybe Text)

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

describeComplianceByConfigRuleResponse_httpStatus :: Lens' DescribeComplianceByConfigRuleResponse Int

The response's http status code.