/

POST

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Filters": {
        "ConformancePackNames": []
    },
    "SortOrder": "ASCENDING",
    "SortBy": "SCORE",
    "Limit": 0,
    "NextToken": "string"
}'

Response Example

200 - Example 1

{
    "NextToken": "string",
    "ConformancePackComplianceScores": []
}

Request

Query Params

Limit

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

Filters

object

optional

Filters the results based on the ConformancePackComplianceScoresFilters.

ConformancePackNames

array[string]

required

The names of the conformance packs whose compliance scores you want to include in the conformance pack compliance score result set. You can include up to 25 conformance packs in the ConformancePackNames array of strings, each with a character limit of 256 characters for the conformance pack name.

>= 1 items<= 25 items

SortOrder

enum<string>

optional

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.

Allowed values:

ASCENDINGDESCENDING

SortBy

enum<string>

optional

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.

Allowed value:

SCORE

Limit

integer

optional

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

>= 0<= 20

NextToken

string

optional

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

Examples

Responses

🟢200Success

application/json

Body

NextToken

string

optional

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

ConformancePackComplianceScores

array[object (ConformancePackComplianceScore) {3}]

required

A list of ConformancePackComplianceScore objects.

Score

string

optional

Compliance score for the conformance pack. Conformance packs with no evaluation results will have a compliance score of INSUFFICIENT_DATA.

ConformancePackName

string

optional

The name of the conformance pack.

>= 1 characters<= 256 characters

Match pattern:

[a-zA-Z][-a-zA-Z0-9]*

LastUpdatedTime

string <date-time>

optional

The time that the conformance pack compliance score was last updated.

🟠480InvalidParameterValueException

🟠481InvalidLimitException

🟠482InvalidNextTokenException

Modified at 2023-08-15 05:59:06