ConfigService / Client / list_conformance_pack_compliance_scores

list_conformance_pack_compliance_scores#

ConfigService.Client.list_conformance_pack_compliance_scores(**kwargs)#

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.

Note

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

See also: AWS API Documentation

Request Syntax

response = client.list_conformance_pack_compliance_scores(
    Filters={
        'ConformancePackNames': [
            'string',
        ]
    },
    SortOrder='ASCENDING'|'DESCENDING',
    SortBy='SCORE',
    Limit=123,
    NextToken='string'
)
Parameters:

  • Filters (dict) –

    Filters the results based on the ConformancePackComplianceScoresFilters.

    • ConformancePackNames (list) – [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.

      • (string) –

  • SortOrder (string) –

    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.

  • SortBy (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 alphabetical order by name of the conformance pack. Enter SCORE, to sort conformance pack compliance scores by the numerical value of the compliance score.

  • Limit (integer) – The maximum number of conformance pack compliance scores returned on each page.

  • NextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'ConformancePackComplianceScores': [
        {
            'Score': 'string',
            'ConformancePackName': 'string',
            'LastUpdatedTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

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

      • (dict) –

        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.

        • 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 (datetime) –

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

Exceptions