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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.

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

See: newDescribeAggregateComplianceByConformancePacks smart constructor.

Constructors

DescribeAggregateComplianceByConformancePacks'

Fields

filters :: Maybe AggregateConformancePackComplianceFilters
Filters the result by AggregateConformancePackComplianceFilters 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 conformance packs compliance details returned on each page. The default is maximum. If you specify 0, Config uses the default.
configurationAggregatorName :: Text
The name of the configuration aggregator.

Instances

Instances details

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

newDescribeAggregateComplianceByConformancePacks Source #

Arguments

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

Create a value of DescribeAggregateComplianceByConformancePacks 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:DescribeAggregateComplianceByConformancePacks', describeAggregateComplianceByConformancePacks_filters - Filters the result by AggregateConformancePackComplianceFilters object.

$sel:nextToken:DescribeAggregateComplianceByConformancePacks', describeAggregateComplianceByConformancePacks_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:DescribeAggregateComplianceByConformancePacks', describeAggregateComplianceByConformancePacks_limit - The maximum number of conformance packs compliance details returned on each page. The default is maximum. If you specify 0, Config uses the default.

$sel:configurationAggregatorName:DescribeAggregateComplianceByConformancePacks', describeAggregateComplianceByConformancePacks_configurationAggregatorName - The name of the configuration aggregator.

Request Lenses

describeAggregateComplianceByConformancePacks_filters :: Lens' DescribeAggregateComplianceByConformancePacks (Maybe AggregateConformancePackComplianceFilters) Source #

Filters the result by AggregateConformancePackComplianceFilters object.

describeAggregateComplianceByConformancePacks_nextToken :: Lens' DescribeAggregateComplianceByConformancePacks (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.

describeAggregateComplianceByConformancePacks_limit :: Lens' DescribeAggregateComplianceByConformancePacks (Maybe Natural) Source #

The maximum number of conformance packs compliance details returned on each page. The default is maximum. If you specify 0, Config uses the default.

describeAggregateComplianceByConformancePacks_configurationAggregatorName :: Lens' DescribeAggregateComplianceByConformancePacks Text Source #

The name of the configuration aggregator.

Destructuring the Response

data DescribeAggregateComplianceByConformancePacksResponse Source #

See: newDescribeAggregateComplianceByConformancePacksResponse smart constructor.

Constructors

DescribeAggregateComplianceByConformancePacksResponse'
Fields aggregateComplianceByConformancePacks :: Maybe [AggregateComplianceByConformancePack] Returns the `AggregateComplianceByConformancePack` 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

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

newDescribeAggregateComplianceByConformancePacksResponse Source #

Arguments

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

Create a value of DescribeAggregateComplianceByConformancePacksResponse 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:aggregateComplianceByConformancePacks:DescribeAggregateComplianceByConformancePacksResponse', describeAggregateComplianceByConformancePacksResponse_aggregateComplianceByConformancePacks - Returns the AggregateComplianceByConformancePack object.

$sel:nextToken:DescribeAggregateComplianceByConformancePacks', describeAggregateComplianceByConformancePacksResponse_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:DescribeAggregateComplianceByConformancePacksResponse', describeAggregateComplianceByConformancePacksResponse_httpStatus - The response's http status code.

Response Lenses

describeAggregateComplianceByConformancePacksResponse_aggregateComplianceByConformancePacks :: Lens' DescribeAggregateComplianceByConformancePacksResponse (Maybe [AggregateComplianceByConformancePack]) Source #

Returns the AggregateComplianceByConformancePack object.

describeAggregateComplianceByConformancePacksResponse_nextToken :: Lens' DescribeAggregateComplianceByConformancePacksResponse (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.

describeAggregateComplianceByConformancePacksResponse_httpStatus :: Lens' DescribeAggregateComplianceByConformancePacksResponse Int Source #

The response's http status code.