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 |
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
- data ListConformancePackComplianceScores = ListConformancePackComplianceScores' {}
- newListConformancePackComplianceScores :: ListConformancePackComplianceScores
- listConformancePackComplianceScores_filters :: Lens' ListConformancePackComplianceScores (Maybe ConformancePackComplianceScoresFilters)
- listConformancePackComplianceScores_limit :: Lens' ListConformancePackComplianceScores (Maybe Natural)
- listConformancePackComplianceScores_nextToken :: Lens' ListConformancePackComplianceScores (Maybe Text)
- listConformancePackComplianceScores_sortBy :: Lens' ListConformancePackComplianceScores (Maybe SortBy)
- listConformancePackComplianceScores_sortOrder :: Lens' ListConformancePackComplianceScores (Maybe SortOrder)
- data ListConformancePackComplianceScoresResponse = ListConformancePackComplianceScoresResponse' {}
- newListConformancePackComplianceScoresResponse :: Int -> ListConformancePackComplianceScoresResponse
- listConformancePackComplianceScoresResponse_nextToken :: Lens' ListConformancePackComplianceScoresResponse (Maybe Text)
- listConformancePackComplianceScoresResponse_httpStatus :: Lens' ListConformancePackComplianceScoresResponse Int
- listConformancePackComplianceScoresResponse_conformancePackComplianceScores :: Lens' ListConformancePackComplianceScoresResponse [ConformancePackComplianceScore]
Creating a Request
data ListConformancePackComplianceScores Source #
See: newListConformancePackComplianceScores
smart constructor.
ListConformancePackComplianceScores' | |
|
Instances
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_filters :: Lens' ListConformancePackComplianceScores (Maybe ConformancePackComplianceScoresFilters) Source #
Filters the results based on the
ConformancePackComplianceScoresFilters
.
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 #
See: newListConformancePackComplianceScoresResponse
smart constructor.
ListConformancePackComplianceScoresResponse' | |
|
Instances
newListConformancePackComplianceScoresResponse Source #
:: Int |
|
-> ListConformancePackComplianceScoresResponse |
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.
listConformancePackComplianceScoresResponse_httpStatus :: Lens' ListConformancePackComplianceScoresResponse Int Source #
The response's http status code.
listConformancePackComplianceScoresResponse_conformancePackComplianceScores :: Lens' ListConformancePackComplianceScoresResponse [ConformancePackComplianceScore] Source #
A list of ConformancePackComplianceScore
objects.