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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the evaluation results for the specified Config rule for a specific resource in a 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.

The results can return an empty result page. But if you have a nextToken, the results are displayed on the next page.

This operation returns paginated results.

Synopsis

Creating a Request

data GetAggregateComplianceDetailsByConfigRule Source #

See: newGetAggregateComplianceDetailsByConfigRule smart constructor.

Constructors

GetAggregateComplianceDetailsByConfigRule'

Fields

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 50. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
complianceType :: Maybe ComplianceType
The resource compliance status.
For the GetAggregateComplianceDetailsByConfigRuleRequest data type, Config supports only the COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA values.
configurationAggregatorName :: Text
The name of the configuration aggregator.
configRuleName :: Text
The name of the Config rule for which you want compliance information.
accountId :: Text
The 12-digit account ID of the source account.
awsRegion :: Text
The source region from where the data is aggregated.

Instances

Instances details

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

newGetAggregateComplianceDetailsByConfigRule Source #

Arguments

:: Text	`$sel:configurationAggregatorName:GetAggregateComplianceDetailsByConfigRule'`
-> Text	`$sel:configRuleName:GetAggregateComplianceDetailsByConfigRule'`
-> Text	`$sel:accountId:GetAggregateComplianceDetailsByConfigRule'`
-> Text	`$sel:awsRegion:GetAggregateComplianceDetailsByConfigRule'`
-> GetAggregateComplianceDetailsByConfigRule

Create a value of GetAggregateComplianceDetailsByConfigRule 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:nextToken:GetAggregateComplianceDetailsByConfigRule', getAggregateComplianceDetailsByConfigRule_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:GetAggregateComplianceDetailsByConfigRule', getAggregateComplianceDetailsByConfigRule_limit - The maximum number of evaluation results returned on each page. The default is 50. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

$sel:complianceType:GetAggregateComplianceDetailsByConfigRule', getAggregateComplianceDetailsByConfigRule_complianceType - The resource compliance status.

For the GetAggregateComplianceDetailsByConfigRuleRequest data type, Config supports only the COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA values.

$sel:configurationAggregatorName:GetAggregateComplianceDetailsByConfigRule', getAggregateComplianceDetailsByConfigRule_configurationAggregatorName - The name of the configuration aggregator.

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

$sel:accountId:GetAggregateComplianceDetailsByConfigRule', getAggregateComplianceDetailsByConfigRule_accountId - The 12-digit account ID of the source account.

$sel:awsRegion:GetAggregateComplianceDetailsByConfigRule', getAggregateComplianceDetailsByConfigRule_awsRegion - The source region from where the data is aggregated.

Request Lenses

getAggregateComplianceDetailsByConfigRule_nextToken :: Lens' GetAggregateComplianceDetailsByConfigRule (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.

getAggregateComplianceDetailsByConfigRule_limit :: Lens' GetAggregateComplianceDetailsByConfigRule (Maybe Natural) Source #

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

getAggregateComplianceDetailsByConfigRule_complianceType :: Lens' GetAggregateComplianceDetailsByConfigRule (Maybe ComplianceType) Source #

The resource compliance status.

For the GetAggregateComplianceDetailsByConfigRuleRequest data type, Config supports only the COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA values.

getAggregateComplianceDetailsByConfigRule_configurationAggregatorName :: Lens' GetAggregateComplianceDetailsByConfigRule Text Source #

The name of the configuration aggregator.

getAggregateComplianceDetailsByConfigRule_configRuleName :: Lens' GetAggregateComplianceDetailsByConfigRule Text Source #

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

getAggregateComplianceDetailsByConfigRule_accountId :: Lens' GetAggregateComplianceDetailsByConfigRule Text Source #

The 12-digit account ID of the source account.

getAggregateComplianceDetailsByConfigRule_awsRegion :: Lens' GetAggregateComplianceDetailsByConfigRule Text Source #

The source region from where the data is aggregated.

Destructuring the Response

data GetAggregateComplianceDetailsByConfigRuleResponse Source #

See: newGetAggregateComplianceDetailsByConfigRuleResponse smart constructor.

Constructors

GetAggregateComplianceDetailsByConfigRuleResponse'
Fields 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. aggregateEvaluationResults :: Maybe [AggregateEvaluationResult] Returns an AggregateEvaluationResults object. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetAggregateComplianceDetailsByConfigRuleResponse Source #

Arguments

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

Create a value of GetAggregateComplianceDetailsByConfigRuleResponse 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:nextToken:GetAggregateComplianceDetailsByConfigRule', getAggregateComplianceDetailsByConfigRuleResponse_nextToken - The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

$sel:aggregateEvaluationResults:GetAggregateComplianceDetailsByConfigRuleResponse', getAggregateComplianceDetailsByConfigRuleResponse_aggregateEvaluationResults - Returns an AggregateEvaluationResults object.

$sel:httpStatus:GetAggregateComplianceDetailsByConfigRuleResponse', getAggregateComplianceDetailsByConfigRuleResponse_httpStatus - The response's http status code.

Response Lenses

getAggregateComplianceDetailsByConfigRuleResponse_nextToken :: Lens' GetAggregateComplianceDetailsByConfigRuleResponse (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.

getAggregateComplianceDetailsByConfigRuleResponse_aggregateEvaluationResults :: Lens' GetAggregateComplianceDetailsByConfigRuleResponse (Maybe [AggregateEvaluationResult]) Source #

Returns an AggregateEvaluationResults object.

getAggregateComplianceDetailsByConfigRuleResponse_httpStatus :: Lens' GetAggregateComplianceDetailsByConfigRuleResponse Int Source #

The response's http status code.