[ aws . configservice ]

list-conformance-pack-compliance-scores

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, and can be used to identify, investigate, and understand the level of compliance in your conformance packs.

Note

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-conformance-pack-compliance-scores
[--filters <value>]
[--sort-order <value>]
[--sort-by <value>]
[--limit <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--filters (structure)

Filters the results based on the ConformancePackComplianceScoresFilters .

ConformancePackNames -> (list)

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.

(string)

Shorthand Syntax:

ConformancePackNames=string,string

JSON Syntax:

{
  "ConformancePackNames": ["string", ...]
}

--sort-order (string)

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

Conformance packs with a compliance score of INSUFFICIENT_DATA will be first when sorting by ascending order and last when sorting by descending order.

Possible values:

• ASCENDING

• DESCENDING

--sort-by (string)

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

By default, conformance pack compliance scores are sorted in ascending order by compliance score and alphabetically by name of the conformance pack if there is more than one conformance pack with the same compliance score.

Possible values:

• SCORE

--limit (integer)

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

--next-token (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

NextToken -> (string)

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

ConformancePackComplianceScores -> (list)

A list of ConformancePackComplianceScore objects.

(structure)

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, and can be used to identify, investigate, and understand the level of compliance in your conformance packs.

Score -> (string)

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

ConformancePackName -> (string)

The name of the conformance pack.

LastUpdatedTime -> (timestamp)

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