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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

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

Synopsis

Creating a Request

data GetAggregateConfigRuleComplianceSummary Source #

See: newGetAggregateConfigRuleComplianceSummary smart constructor.

Constructors

GetAggregateConfigRuleComplianceSummary'

Fields

filters :: Maybe ConfigRuleComplianceSummaryFilters
Filters the results based on the ConfigRuleComplianceSummaryFilters 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.
limit :: Maybe Natural
The maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default.
groupByKey :: Maybe ConfigRuleComplianceSummaryGroupKey
Groups the result based on ACCOUNT_ID or AWS_REGION.
configurationAggregatorName :: Text
The name of the configuration aggregator.

Instances

Instances details

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

newGetAggregateConfigRuleComplianceSummary Source #

Arguments

:: Text	`$sel:configurationAggregatorName:GetAggregateConfigRuleComplianceSummary'`
-> GetAggregateConfigRuleComplianceSummary

Create a value of GetAggregateConfigRuleComplianceSummary 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:GetAggregateConfigRuleComplianceSummary', getAggregateConfigRuleComplianceSummary_filters - Filters the results based on the ConfigRuleComplianceSummaryFilters object.

$sel:nextToken:GetAggregateConfigRuleComplianceSummary', getAggregateConfigRuleComplianceSummary_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:GetAggregateConfigRuleComplianceSummary', getAggregateConfigRuleComplianceSummary_limit - The maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default.

$sel:groupByKey:GetAggregateConfigRuleComplianceSummary', getAggregateConfigRuleComplianceSummary_groupByKey - Groups the result based on ACCOUNT_ID or AWS_REGION.

$sel:configurationAggregatorName:GetAggregateConfigRuleComplianceSummary', getAggregateConfigRuleComplianceSummary_configurationAggregatorName - The name of the configuration aggregator.

Request Lenses

getAggregateConfigRuleComplianceSummary_filters :: Lens' GetAggregateConfigRuleComplianceSummary (Maybe ConfigRuleComplianceSummaryFilters) Source #

Filters the results based on the ConfigRuleComplianceSummaryFilters object.

getAggregateConfigRuleComplianceSummary_nextToken :: Lens' GetAggregateConfigRuleComplianceSummary (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.

getAggregateConfigRuleComplianceSummary_limit :: Lens' GetAggregateConfigRuleComplianceSummary (Maybe Natural) Source #

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

getAggregateConfigRuleComplianceSummary_groupByKey :: Lens' GetAggregateConfigRuleComplianceSummary (Maybe ConfigRuleComplianceSummaryGroupKey) Source #

Groups the result based on ACCOUNT_ID or AWS_REGION.

getAggregateConfigRuleComplianceSummary_configurationAggregatorName :: Lens' GetAggregateConfigRuleComplianceSummary Text Source #

The name of the configuration aggregator.

Destructuring the Response

data GetAggregateConfigRuleComplianceSummaryResponse Source #

See: newGetAggregateConfigRuleComplianceSummaryResponse smart constructor.

Constructors

GetAggregateConfigRuleComplianceSummaryResponse'
Fields aggregateComplianceCounts :: Maybe [AggregateComplianceCount] Returns a list of AggregateComplianceCounts 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. groupByKey :: Maybe Text Groups the result based on ACCOUNT_ID or AWS_REGION. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetAggregateConfigRuleComplianceSummaryResponse Source #

Arguments

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

Create a value of GetAggregateConfigRuleComplianceSummaryResponse 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:aggregateComplianceCounts:GetAggregateConfigRuleComplianceSummaryResponse', getAggregateConfigRuleComplianceSummaryResponse_aggregateComplianceCounts - Returns a list of AggregateComplianceCounts object.

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

$sel:groupByKey:GetAggregateConfigRuleComplianceSummary', getAggregateConfigRuleComplianceSummaryResponse_groupByKey - Groups the result based on ACCOUNT_ID or AWS_REGION.

$sel:httpStatus:GetAggregateConfigRuleComplianceSummaryResponse', getAggregateConfigRuleComplianceSummaryResponse_httpStatus - The response's http status code.

Response Lenses

getAggregateConfigRuleComplianceSummaryResponse_aggregateComplianceCounts :: Lens' GetAggregateConfigRuleComplianceSummaryResponse (Maybe [AggregateComplianceCount]) Source #

Returns a list of AggregateComplianceCounts object.

getAggregateConfigRuleComplianceSummaryResponse_nextToken :: Lens' GetAggregateConfigRuleComplianceSummaryResponse (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.

getAggregateConfigRuleComplianceSummaryResponse_groupByKey :: Lens' GetAggregateConfigRuleComplianceSummaryResponse (Maybe Text) Source #

Groups the result based on ACCOUNT_ID or AWS_REGION.

getAggregateConfigRuleComplianceSummaryResponse_httpStatus :: Lens' GetAggregateConfigRuleComplianceSummaryResponse Int Source #

The response's http status code.