AWS Config

2022/07/27 - AWS Config - 1 new api methods

Changes  This release adds ListConformancePackComplianceScores API to support the new compliance score feature, which provides a 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.

ListConformancePackComplianceScores (new) Link ΒΆ

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 compliance deviations in your conformance packs.

See also: AWS API Documentation

Request Syntax

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

dict

param Filters:

Filters the results based on the ConformancePackComplianceScoresFilters.

  • ConformancePackNames (list) -- [REQUIRED]

    The name of a conformance pack whose score should be included in the compliance score result.

    • (string) --

type SortOrder:

string

param SortOrder:

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

type SortBy:

string

param SortBy:

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

type Limit:

integer

param Limit:

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

type NextToken:

string

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

rtype:

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

        • Score (string) --

          Compliance score for the conformance pack.

        • ConformancePackName (string) --

          The name of the conformance pack.

        • LastUpdatedTime (datetime) --

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