Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Config.GetComplianceDetailsByConfigRule

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the evaluation results for the specified Config rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.

This operation returns paginated results.

Synopsis

Creating a Request

data GetComplianceDetailsByConfigRule Source #

See: newGetComplianceDetailsByConfigRule smart constructor.

Constructors

GetComplianceDetailsByConfigRule'

Fields

complianceTypes :: Maybe [ComplianceType]
Filters the results by compliance.
The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.
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.
limit :: Maybe Natural
The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
configRuleName :: Text
The name of the Config rule for which you want compliance information.

Instances

Instances details

Eq GetComplianceDetailsByConfigRule Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByConfigRule Methods (==) :: GetComplianceDetailsByConfigRule -> GetComplianceDetailsByConfigRule -> Bool # (/=) :: GetComplianceDetailsByConfigRule -> GetComplianceDetailsByConfigRule -> Bool #
Read GetComplianceDetailsByConfigRule Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByConfigRule Methods readsPrec :: Int -> ReadS GetComplianceDetailsByConfigRule # readList :: ReadS [GetComplianceDetailsByConfigRule] # readPrec :: ReadPrec GetComplianceDetailsByConfigRule # readListPrec :: ReadPrec [GetComplianceDetailsByConfigRule] #
Show GetComplianceDetailsByConfigRule Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByConfigRule Methods showsPrec :: Int -> GetComplianceDetailsByConfigRule -> ShowS # show :: GetComplianceDetailsByConfigRule -> String # showList :: [GetComplianceDetailsByConfigRule] -> ShowS #
Generic GetComplianceDetailsByConfigRule Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByConfigRule Associated Types type Rep GetComplianceDetailsByConfigRule :: Type -> Type # Methods from :: GetComplianceDetailsByConfigRule -> Rep GetComplianceDetailsByConfigRule x # to :: Rep GetComplianceDetailsByConfigRule x -> GetComplianceDetailsByConfigRule #
NFData GetComplianceDetailsByConfigRule Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByConfigRule Methods rnf :: GetComplianceDetailsByConfigRule -> () #
Hashable GetComplianceDetailsByConfigRule Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByConfigRule Methods hashWithSalt :: Int -> GetComplianceDetailsByConfigRule -> Int # hash :: GetComplianceDetailsByConfigRule -> Int #
ToJSON GetComplianceDetailsByConfigRule Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByConfigRule Methods toJSON :: GetComplianceDetailsByConfigRule -> Value # toEncoding :: GetComplianceDetailsByConfigRule -> Encoding # toJSONList :: [GetComplianceDetailsByConfigRule] -> Value # toEncodingList :: [GetComplianceDetailsByConfigRule] -> Encoding #
AWSPager GetComplianceDetailsByConfigRule Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByConfigRule Methods page :: GetComplianceDetailsByConfigRule -> AWSResponse GetComplianceDetailsByConfigRule -> Maybe GetComplianceDetailsByConfigRule #
AWSRequest GetComplianceDetailsByConfigRule Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByConfigRule Associated Types type AWSResponse GetComplianceDetailsByConfigRule # Methods request :: GetComplianceDetailsByConfigRule -> Request GetComplianceDetailsByConfigRule # response :: MonadResource m => Logger -> Service -> Proxy GetComplianceDetailsByConfigRule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetComplianceDetailsByConfigRule))) #
ToHeaders GetComplianceDetailsByConfigRule Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByConfigRule Methods toHeaders :: GetComplianceDetailsByConfigRule -> [Header] #
ToPath GetComplianceDetailsByConfigRule Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByConfigRule Methods toPath :: GetComplianceDetailsByConfigRule -> ByteString #
ToQuery GetComplianceDetailsByConfigRule Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByConfigRule Methods toQuery :: GetComplianceDetailsByConfigRule -> QueryString #
type Rep GetComplianceDetailsByConfigRule Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByConfigRule type Rep GetComplianceDetailsByConfigRule = D1 ('MetaData "GetComplianceDetailsByConfigRule" "Amazonka.Config.GetComplianceDetailsByConfigRule" "libZSservicesZSamazonka-configZSamazonka-config" 'False) (C1 ('MetaCons "GetComplianceDetailsByConfigRule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "complianceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ComplianceType])) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "configRuleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetComplianceDetailsByConfigRule Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByConfigRule type AWSResponse GetComplianceDetailsByConfigRule = GetComplianceDetailsByConfigRuleResponse

newGetComplianceDetailsByConfigRule Source #

Arguments

:: Text	`$sel:configRuleName:GetComplianceDetailsByConfigRule'`
-> GetComplianceDetailsByConfigRule

Create a value of GetComplianceDetailsByConfigRule 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:GetComplianceDetailsByConfigRule', getComplianceDetailsByConfigRule_complianceTypes - Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

$sel:nextToken:GetComplianceDetailsByConfigRule', getComplianceDetailsByConfigRule_nextToken - The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

$sel:limit:GetComplianceDetailsByConfigRule', getComplianceDetailsByConfigRule_limit - The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

$sel:configRuleName:GetComplianceDetailsByConfigRule', getComplianceDetailsByConfigRule_configRuleName - The name of the Config rule for which you want compliance information.

Request Lenses

getComplianceDetailsByConfigRule_complianceTypes :: Lens' GetComplianceDetailsByConfigRule (Maybe [ComplianceType]) Source #

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

getComplianceDetailsByConfigRule_nextToken :: Lens' GetComplianceDetailsByConfigRule (Maybe Text) Source #

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

getComplianceDetailsByConfigRule_limit :: Lens' GetComplianceDetailsByConfigRule (Maybe Natural) Source #

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

getComplianceDetailsByConfigRule_configRuleName :: Lens' GetComplianceDetailsByConfigRule Text Source #

The name of the Config rule for which you want compliance information.

Destructuring the Response

data GetComplianceDetailsByConfigRuleResponse Source #

See: newGetComplianceDetailsByConfigRuleResponse smart constructor.

Constructors

GetComplianceDetailsByConfigRuleResponse'
Fields evaluationResults :: Maybe [EvaluationResult] Indicates whether the Amazon Web Services resource complies with the specified Config rule. 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

Instances details

Eq GetComplianceDetailsByConfigRuleResponse Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByConfigRule Methods (==) :: GetComplianceDetailsByConfigRuleResponse -> GetComplianceDetailsByConfigRuleResponse -> Bool # (/=) :: GetComplianceDetailsByConfigRuleResponse -> GetComplianceDetailsByConfigRuleResponse -> Bool #
Read GetComplianceDetailsByConfigRuleResponse Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByConfigRule Methods readsPrec :: Int -> ReadS GetComplianceDetailsByConfigRuleResponse # readList :: ReadS [GetComplianceDetailsByConfigRuleResponse] # readPrec :: ReadPrec GetComplianceDetailsByConfigRuleResponse # readListPrec :: ReadPrec [GetComplianceDetailsByConfigRuleResponse] #
Show GetComplianceDetailsByConfigRuleResponse Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByConfigRule Methods showsPrec :: Int -> GetComplianceDetailsByConfigRuleResponse -> ShowS # show :: GetComplianceDetailsByConfigRuleResponse -> String # showList :: [GetComplianceDetailsByConfigRuleResponse] -> ShowS #
Generic GetComplianceDetailsByConfigRuleResponse Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByConfigRule Associated Types type Rep GetComplianceDetailsByConfigRuleResponse :: Type -> Type # Methods from :: GetComplianceDetailsByConfigRuleResponse -> Rep GetComplianceDetailsByConfigRuleResponse x # to :: Rep GetComplianceDetailsByConfigRuleResponse x -> GetComplianceDetailsByConfigRuleResponse #
NFData GetComplianceDetailsByConfigRuleResponse Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByConfigRule Methods rnf :: GetComplianceDetailsByConfigRuleResponse -> () #
type Rep GetComplianceDetailsByConfigRuleResponse Source #
Instance details Defined in Amazonka.Config.GetComplianceDetailsByConfigRule type Rep GetComplianceDetailsByConfigRuleResponse = D1 ('MetaData "GetComplianceDetailsByConfigRuleResponse" "Amazonka.Config.GetComplianceDetailsByConfigRule" "libZSservicesZSamazonka-configZSamazonka-config" 'False) (C1 ('MetaCons "GetComplianceDetailsByConfigRuleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "evaluationResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EvaluationResult])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetComplianceDetailsByConfigRuleResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetComplianceDetailsByConfigRuleResponse'`
-> GetComplianceDetailsByConfigRuleResponse

Create a value of GetComplianceDetailsByConfigRuleResponse 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:evaluationResults:GetComplianceDetailsByConfigRuleResponse', getComplianceDetailsByConfigRuleResponse_evaluationResults - Indicates whether the Amazon Web Services resource complies with the specified Config rule.

$sel:nextToken:GetComplianceDetailsByConfigRule', getComplianceDetailsByConfigRuleResponse_nextToken - The string that you use in a subsequent request to get the next page of results in a paginated response.

$sel:httpStatus:GetComplianceDetailsByConfigRuleResponse', getComplianceDetailsByConfigRuleResponse_httpStatus - The response's http status code.

Response Lenses

getComplianceDetailsByConfigRuleResponse_evaluationResults :: Lens' GetComplianceDetailsByConfigRuleResponse (Maybe [EvaluationResult]) Source #

Indicates whether the Amazon Web Services resource complies with the specified Config rule.

getComplianceDetailsByConfigRuleResponse_nextToken :: Lens' GetComplianceDetailsByConfigRuleResponse (Maybe Text) Source #

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

getComplianceDetailsByConfigRuleResponse_httpStatus :: Lens' GetComplianceDetailsByConfigRuleResponse Int Source #

The response's http status code.