amazonka-config-2.0: Amazon Config SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Config.ListConformancePackComplianceScores

Description

Returns a list of conformance pack compliance scores. A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack. This metric provides you with a high-level view of the compliance state of your conformance packs. You can use it to identify, investigate, and understand the level of compliance in your conformance packs.

Conformance packs with no evaluation results will have a compliance score of INSUFFICIENT_DATA.

Synopsis

Creating a Request

data ListConformancePackComplianceScores Source #

Constructors

ListConformancePackComplianceScores' 

Fields

  • filters :: Maybe ConformancePackComplianceScoresFilters

    Filters the results based on the ConformancePackComplianceScoresFilters.

  • limit :: Maybe Natural

    The maximum number of conformance pack compliance scores returned on each page.

  • nextToken :: Maybe Text

    The nextToken string in a prior request that you can use to get the paginated response for next set of conformance pack compliance scores.

  • sortBy :: Maybe SortBy

    Sorts your conformance pack compliance scores in either ascending or descending order, depending on SortOrder.

    By default, conformance pack compliance scores are sorted in alphabetical order by name of the conformance pack. Enter SCORE, to sort conformance pack compliance scores by the numerical value of the compliance score.

  • sortOrder :: Maybe SortOrder

    Determines the order in which conformance pack compliance scores are sorted. Either in ascending or descending order.

    By default, conformance pack compliance scores are sorted in alphabetical order by name of the conformance pack. Conformance pack compliance scores are sorted in reverse alphabetical order if you enter DESCENDING.

    You can sort conformance pack compliance scores by the numerical value of the compliance score by entering SCORE in the SortBy action. When compliance scores are sorted by SCORE, conformance packs with a compliance score of INSUFFICIENT_DATA will be last when sorting by ascending order and first when sorting by descending order.

Instances

Instances details
ToJSON ListConformancePackComplianceScores Source # 
Instance details

Defined in Amazonka.Config.ListConformancePackComplianceScores

ToHeaders ListConformancePackComplianceScores Source # 
Instance details

Defined in Amazonka.Config.ListConformancePackComplianceScores

ToPath ListConformancePackComplianceScores Source # 
Instance details

Defined in Amazonka.Config.ListConformancePackComplianceScores

ToQuery ListConformancePackComplianceScores Source # 
Instance details

Defined in Amazonka.Config.ListConformancePackComplianceScores

AWSRequest ListConformancePackComplianceScores Source # 
Instance details

Defined in Amazonka.Config.ListConformancePackComplianceScores

Generic ListConformancePackComplianceScores Source # 
Instance details

Defined in Amazonka.Config.ListConformancePackComplianceScores

Read ListConformancePackComplianceScores Source # 
Instance details

Defined in Amazonka.Config.ListConformancePackComplianceScores

Show ListConformancePackComplianceScores Source # 
Instance details

Defined in Amazonka.Config.ListConformancePackComplianceScores

NFData ListConformancePackComplianceScores Source # 
Instance details

Defined in Amazonka.Config.ListConformancePackComplianceScores

Eq ListConformancePackComplianceScores Source # 
Instance details

Defined in Amazonka.Config.ListConformancePackComplianceScores

Hashable ListConformancePackComplianceScores Source # 
Instance details

Defined in Amazonka.Config.ListConformancePackComplianceScores

type AWSResponse ListConformancePackComplianceScores Source # 
Instance details

Defined in Amazonka.Config.ListConformancePackComplianceScores

type Rep ListConformancePackComplianceScores Source # 
Instance details

Defined in Amazonka.Config.ListConformancePackComplianceScores

type Rep ListConformancePackComplianceScores = D1 ('MetaData "ListConformancePackComplianceScores" "Amazonka.Config.ListConformancePackComplianceScores" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "ListConformancePackComplianceScores'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConformancePackComplianceScoresFilters)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortBy)) :*: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder))))))

newListConformancePackComplianceScores :: ListConformancePackComplianceScores Source #

Create a value of ListConformancePackComplianceScores 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:ListConformancePackComplianceScores', listConformancePackComplianceScores_filters - Filters the results based on the ConformancePackComplianceScoresFilters.

$sel:limit:ListConformancePackComplianceScores', listConformancePackComplianceScores_limit - The maximum number of conformance pack compliance scores returned on each page.

ListConformancePackComplianceScores, listConformancePackComplianceScores_nextToken - The nextToken string in a prior request that you can use to get the paginated response for next set of conformance pack compliance scores.

$sel:sortBy:ListConformancePackComplianceScores', listConformancePackComplianceScores_sortBy - Sorts your conformance pack compliance scores in either ascending or descending order, depending on SortOrder.

By default, conformance pack compliance scores are sorted in alphabetical order by name of the conformance pack. Enter SCORE, to sort conformance pack compliance scores by the numerical value of the compliance score.

$sel:sortOrder:ListConformancePackComplianceScores', listConformancePackComplianceScores_sortOrder - Determines the order in which conformance pack compliance scores are sorted. Either in ascending or descending order.

By default, conformance pack compliance scores are sorted in alphabetical order by name of the conformance pack. Conformance pack compliance scores are sorted in reverse alphabetical order if you enter DESCENDING.

You can sort conformance pack compliance scores by the numerical value of the compliance score by entering SCORE in the SortBy action. When compliance scores are sorted by SCORE, conformance packs with a compliance score of INSUFFICIENT_DATA will be last when sorting by ascending order and first when sorting by descending order.

Request Lenses

listConformancePackComplianceScores_limit :: Lens' ListConformancePackComplianceScores (Maybe Natural) Source #

The maximum number of conformance pack compliance scores returned on each page.

listConformancePackComplianceScores_nextToken :: Lens' ListConformancePackComplianceScores (Maybe Text) Source #

The nextToken string in a prior request that you can use to get the paginated response for next set of conformance pack compliance scores.

listConformancePackComplianceScores_sortBy :: Lens' ListConformancePackComplianceScores (Maybe SortBy) Source #

Sorts your conformance pack compliance scores in either ascending or descending order, depending on SortOrder.

By default, conformance pack compliance scores are sorted in alphabetical order by name of the conformance pack. Enter SCORE, to sort conformance pack compliance scores by the numerical value of the compliance score.

listConformancePackComplianceScores_sortOrder :: Lens' ListConformancePackComplianceScores (Maybe SortOrder) Source #

Determines the order in which conformance pack compliance scores are sorted. Either in ascending or descending order.

By default, conformance pack compliance scores are sorted in alphabetical order by name of the conformance pack. Conformance pack compliance scores are sorted in reverse alphabetical order if you enter DESCENDING.

You can sort conformance pack compliance scores by the numerical value of the compliance score by entering SCORE in the SortBy action. When compliance scores are sorted by SCORE, conformance packs with a compliance score of INSUFFICIENT_DATA will be last when sorting by ascending order and first when sorting by descending order.

Destructuring the Response

data ListConformancePackComplianceScoresResponse Source #

Constructors

ListConformancePackComplianceScoresResponse' 

Fields

Instances

Instances details
Generic ListConformancePackComplianceScoresResponse Source # 
Instance details

Defined in Amazonka.Config.ListConformancePackComplianceScores

Read ListConformancePackComplianceScoresResponse Source # 
Instance details

Defined in Amazonka.Config.ListConformancePackComplianceScores

Show ListConformancePackComplianceScoresResponse Source # 
Instance details

Defined in Amazonka.Config.ListConformancePackComplianceScores

NFData ListConformancePackComplianceScoresResponse Source # 
Instance details

Defined in Amazonka.Config.ListConformancePackComplianceScores

Eq ListConformancePackComplianceScoresResponse Source # 
Instance details

Defined in Amazonka.Config.ListConformancePackComplianceScores

type Rep ListConformancePackComplianceScoresResponse Source # 
Instance details

Defined in Amazonka.Config.ListConformancePackComplianceScores

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

newListConformancePackComplianceScoresResponse Source #

Create a value of ListConformancePackComplianceScoresResponse 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:

ListConformancePackComplianceScores, listConformancePackComplianceScoresResponse_nextToken - The nextToken string that you can use to get the next page of results in a paginated response.

$sel:httpStatus:ListConformancePackComplianceScoresResponse', listConformancePackComplianceScoresResponse_httpStatus - The response's http status code.

$sel:conformancePackComplianceScores:ListConformancePackComplianceScoresResponse', listConformancePackComplianceScoresResponse_conformancePackComplianceScores - A list of ConformancePackComplianceScore objects.

Response Lenses

listConformancePackComplianceScoresResponse_nextToken :: Lens' ListConformancePackComplianceScoresResponse (Maybe Text) Source #

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