Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

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.

Creating a Request

data GetAggregateComplianceDetailsByConfigRule

See: newGetAggregateComplianceDetailsByConfigRule smart constructor.

Constructors

GetAggregateComplianceDetailsByConfigRule'

Fields

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

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

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

• 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

ToJSON GetAggregateComplianceDetailsByConfigRule

Defined in Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

Methods

toJSON :: GetAggregateComplianceDetailsByConfigRule -> Value

toEncoding :: GetAggregateComplianceDetailsByConfigRule -> Encoding

toJSONList :: [GetAggregateComplianceDetailsByConfigRule] -> Value

toEncodingList :: [GetAggregateComplianceDetailsByConfigRule] -> Encoding

ToHeaders GetAggregateComplianceDetailsByConfigRule

Defined in Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

Methods

toHeaders :: GetAggregateComplianceDetailsByConfigRule -> [Header]

ToPath GetAggregateComplianceDetailsByConfigRule

Defined in Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

Methods

toPath :: GetAggregateComplianceDetailsByConfigRule -> ByteString

ToQuery GetAggregateComplianceDetailsByConfigRule

Defined in Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

Methods

toQuery :: GetAggregateComplianceDetailsByConfigRule -> QueryString

AWSPager GetAggregateComplianceDetailsByConfigRule

Defined in Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

Methods

page :: GetAggregateComplianceDetailsByConfigRule -> AWSResponse GetAggregateComplianceDetailsByConfigRule -> Maybe GetAggregateComplianceDetailsByConfigRule

AWSRequest GetAggregateComplianceDetailsByConfigRule

Defined in Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

Associated Types

type AWSResponse GetAggregateComplianceDetailsByConfigRule

Methods

request :: (Service -> Service) -> GetAggregateComplianceDetailsByConfigRule -> Request GetAggregateComplianceDetailsByConfigRule

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetAggregateComplianceDetailsByConfigRule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetAggregateComplianceDetailsByConfigRule)))

Generic GetAggregateComplianceDetailsByConfigRule

Defined in Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

Associated Types

type Rep GetAggregateComplianceDetailsByConfigRule :: Type -> Type

Methods

from :: GetAggregateComplianceDetailsByConfigRule -> Rep GetAggregateComplianceDetailsByConfigRule x

to :: Rep GetAggregateComplianceDetailsByConfigRule x -> GetAggregateComplianceDetailsByConfigRule

Read GetAggregateComplianceDetailsByConfigRule

Defined in Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

Methods

readsPrec :: Int -> ReadS GetAggregateComplianceDetailsByConfigRule

readList :: ReadS [GetAggregateComplianceDetailsByConfigRule]

readPrec :: ReadPrec GetAggregateComplianceDetailsByConfigRule

readListPrec :: ReadPrec [GetAggregateComplianceDetailsByConfigRule]

Show GetAggregateComplianceDetailsByConfigRule

Defined in Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

Methods

showsPrec :: Int -> GetAggregateComplianceDetailsByConfigRule -> ShowS

show :: GetAggregateComplianceDetailsByConfigRule -> String

showList :: [GetAggregateComplianceDetailsByConfigRule] -> ShowS

NFData GetAggregateComplianceDetailsByConfigRule

Defined in Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

Methods

rnf :: GetAggregateComplianceDetailsByConfigRule -> ()

Eq GetAggregateComplianceDetailsByConfigRule

Defined in Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

Methods

(==) :: GetAggregateComplianceDetailsByConfigRule -> GetAggregateComplianceDetailsByConfigRule -> Bool

(/=) :: GetAggregateComplianceDetailsByConfigRule -> GetAggregateComplianceDetailsByConfigRule -> Bool

Hashable GetAggregateComplianceDetailsByConfigRule

Defined in Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

Methods

hashWithSalt :: Int -> GetAggregateComplianceDetailsByConfigRule -> Int

hash :: GetAggregateComplianceDetailsByConfigRule -> Int

type AWSResponse GetAggregateComplianceDetailsByConfigRule

Defined in Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

type AWSResponse GetAggregateComplianceDetailsByConfigRule = GetAggregateComplianceDetailsByConfigRuleResponse

type Rep GetAggregateComplianceDetailsByConfigRule

Defined in Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

type Rep GetAggregateComplianceDetailsByConfigRule = D1 ('MetaData "GetAggregateComplianceDetailsByConfigRule" "Amazonka.Config.GetAggregateComplianceDetailsByConfigRule" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "GetAggregateComplianceDetailsByConfigRule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "complianceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComplianceType)) :*: (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) :*: 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)))))

newGetAggregateComplianceDetailsByConfigRule

Arguments

:: Text

GetAggregateComplianceDetailsByConfigRule

-> Text

GetAggregateComplianceDetailsByConfigRule

-> Text

GetAggregateComplianceDetailsByConfigRule

-> Text

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:

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

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.

GetAggregateComplianceDetailsByConfigRule, getAggregateComplianceDetailsByConfigRule_configurationAggregatorName - The name of the configuration aggregator.

GetAggregateComplianceDetailsByConfigRule, getAggregateComplianceDetailsByConfigRule_configRuleName - The name of the Config rule for which you want compliance information.

GetAggregateComplianceDetailsByConfigRule, getAggregateComplianceDetailsByConfigRule_accountId - The 12-digit account ID of the source account.

GetAggregateComplianceDetailsByConfigRule, getAggregateComplianceDetailsByConfigRule_awsRegion - The source region from where the data is aggregated.

Request Lenses

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

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

getAggregateComplianceDetailsByConfigRule_nextToken :: Lens' GetAggregateComplianceDetailsByConfigRule (Maybe Text)

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

getAggregateComplianceDetailsByConfigRule_configurationAggregatorName :: Lens' GetAggregateComplianceDetailsByConfigRule Text

The name of the configuration aggregator.

getAggregateComplianceDetailsByConfigRule_configRuleName :: Lens' GetAggregateComplianceDetailsByConfigRule Text

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

getAggregateComplianceDetailsByConfigRule_accountId :: Lens' GetAggregateComplianceDetailsByConfigRule Text

The 12-digit account ID of the source account.

getAggregateComplianceDetailsByConfigRule_awsRegion :: Lens' GetAggregateComplianceDetailsByConfigRule Text

The source region from where the data is aggregated.

Destructuring the Response

data GetAggregateComplianceDetailsByConfigRuleResponse

See: newGetAggregateComplianceDetailsByConfigRuleResponse smart constructor.

Constructors

GetAggregateComplianceDetailsByConfigRuleResponse'

Fields

• aggregateEvaluationResults :: Maybe [AggregateEvaluationResult]

  Returns an AggregateEvaluationResults 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

Generic GetAggregateComplianceDetailsByConfigRuleResponse

Defined in Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

Associated Types

type Rep GetAggregateComplianceDetailsByConfigRuleResponse :: Type -> Type

Methods

from :: GetAggregateComplianceDetailsByConfigRuleResponse -> Rep GetAggregateComplianceDetailsByConfigRuleResponse x

to :: Rep GetAggregateComplianceDetailsByConfigRuleResponse x -> GetAggregateComplianceDetailsByConfigRuleResponse

Read GetAggregateComplianceDetailsByConfigRuleResponse

Defined in Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

Methods

readsPrec :: Int -> ReadS GetAggregateComplianceDetailsByConfigRuleResponse

readList :: ReadS [GetAggregateComplianceDetailsByConfigRuleResponse]

readPrec :: ReadPrec GetAggregateComplianceDetailsByConfigRuleResponse

readListPrec :: ReadPrec [GetAggregateComplianceDetailsByConfigRuleResponse]

Show GetAggregateComplianceDetailsByConfigRuleResponse

Defined in Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

Methods

showsPrec :: Int -> GetAggregateComplianceDetailsByConfigRuleResponse -> ShowS

show :: GetAggregateComplianceDetailsByConfigRuleResponse -> String

showList :: [GetAggregateComplianceDetailsByConfigRuleResponse] -> ShowS

NFData GetAggregateComplianceDetailsByConfigRuleResponse

Defined in Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

Methods

rnf :: GetAggregateComplianceDetailsByConfigRuleResponse -> ()

Eq GetAggregateComplianceDetailsByConfigRuleResponse

Defined in Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

Methods

(==) :: GetAggregateComplianceDetailsByConfigRuleResponse -> GetAggregateComplianceDetailsByConfigRuleResponse -> Bool

(/=) :: GetAggregateComplianceDetailsByConfigRuleResponse -> GetAggregateComplianceDetailsByConfigRuleResponse -> Bool

type Rep GetAggregateComplianceDetailsByConfigRuleResponse

Defined in Amazonka.Config.GetAggregateComplianceDetailsByConfigRule

type Rep GetAggregateComplianceDetailsByConfigRuleResponse = D1 ('MetaData "GetAggregateComplianceDetailsByConfigRuleResponse" "Amazonka.Config.GetAggregateComplianceDetailsByConfigRule" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "GetAggregateComplianceDetailsByConfigRuleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "aggregateEvaluationResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AggregateEvaluationResult])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetAggregateComplianceDetailsByConfigRuleResponse

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:aggregateEvaluationResults:GetAggregateComplianceDetailsByConfigRuleResponse', getAggregateComplianceDetailsByConfigRuleResponse_aggregateEvaluationResults - Returns an AggregateEvaluationResults object.

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:httpStatus:GetAggregateComplianceDetailsByConfigRuleResponse', getAggregateComplianceDetailsByConfigRuleResponse_httpStatus - The response's http status code.

Response Lenses

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

Returns an AggregateEvaluationResults object.

getAggregateComplianceDetailsByConfigRuleResponse_nextToken :: Lens' GetAggregateComplianceDetailsByConfigRuleResponse (Maybe Text)

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

getAggregateComplianceDetailsByConfigRuleResponse_httpStatus :: Lens' GetAggregateComplianceDetailsByConfigRuleResponse Int

The response's http status code.