Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Config.DescribeAggregateComplianceByConfigRules

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results.

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 DescribeAggregateComplianceByConfigRules Source #

See: newDescribeAggregateComplianceByConfigRules smart constructor.

Constructors

DescribeAggregateComplianceByConfigRules'

Fields

filters :: Maybe ConfigRuleComplianceFilters
Filters the results by ConfigRuleComplianceFilters object.
limit :: Maybe Natural
The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.
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.
configurationAggregatorName :: Text
The name of the configuration aggregator.

Instances

Instances details

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

newDescribeAggregateComplianceByConfigRules Source #

Arguments

:: Text	`DescribeAggregateComplianceByConfigRules`
-> DescribeAggregateComplianceByConfigRules

Create a value of DescribeAggregateComplianceByConfigRules 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:filters:DescribeAggregateComplianceByConfigRules', describeAggregateComplianceByConfigRules_filters - Filters the results by ConfigRuleComplianceFilters object.

$sel:limit:DescribeAggregateComplianceByConfigRules', describeAggregateComplianceByConfigRules_limit - The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.

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

DescribeAggregateComplianceByConfigRules, describeAggregateComplianceByConfigRules_configurationAggregatorName - The name of the configuration aggregator.

Request Lenses

describeAggregateComplianceByConfigRules_filters :: Lens' DescribeAggregateComplianceByConfigRules (Maybe ConfigRuleComplianceFilters) Source #

Filters the results by ConfigRuleComplianceFilters object.

describeAggregateComplianceByConfigRules_limit :: Lens' DescribeAggregateComplianceByConfigRules (Maybe Natural) Source #

The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.

describeAggregateComplianceByConfigRules_nextToken :: Lens' DescribeAggregateComplianceByConfigRules (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.

describeAggregateComplianceByConfigRules_configurationAggregatorName :: Lens' DescribeAggregateComplianceByConfigRules Text Source #

The name of the configuration aggregator.

Destructuring the Response

data DescribeAggregateComplianceByConfigRulesResponse Source #

See: newDescribeAggregateComplianceByConfigRulesResponse smart constructor.

Constructors

DescribeAggregateComplianceByConfigRulesResponse'
Fields aggregateComplianceByConfigRules :: Maybe [AggregateComplianceByConfigRule] Returns a list of AggregateComplianceByConfigRule object. 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. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeAggregateComplianceByConfigRulesResponse Source #

Arguments

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

Create a value of DescribeAggregateComplianceByConfigRulesResponse 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:aggregateComplianceByConfigRules:DescribeAggregateComplianceByConfigRulesResponse', describeAggregateComplianceByConfigRulesResponse_aggregateComplianceByConfigRules - Returns a list of AggregateComplianceByConfigRule object.

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

$sel:httpStatus:DescribeAggregateComplianceByConfigRulesResponse', describeAggregateComplianceByConfigRulesResponse_httpStatus - The response's http status code.

Response Lenses

describeAggregateComplianceByConfigRulesResponse_aggregateComplianceByConfigRules :: Lens' DescribeAggregateComplianceByConfigRulesResponse (Maybe [AggregateComplianceByConfigRule]) Source #

Returns a list of AggregateComplianceByConfigRule object.

describeAggregateComplianceByConfigRulesResponse_nextToken :: Lens' DescribeAggregateComplianceByConfigRulesResponse (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.

describeAggregateComplianceByConfigRulesResponse_httpStatus :: Lens' DescribeAggregateComplianceByConfigRulesResponse Int Source #

The response's http status code.