ConfigService / Paginator / GetAggregateComplianceDetailsByConfigRule

GetAggregateComplianceDetailsByConfigRule

class ConfigService.Paginator.GetAggregateComplianceDetailsByConfigRule

paginator = client.get_paginator('get_aggregate_compliance_details_by_config_rule')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ConfigService.Client.get_aggregate_compliance_details_by_config_rule().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ConfigurationAggregatorName='string',
    ConfigRuleName='string',
    AccountId='string',
    AwsRegion='string',
    ComplianceType='COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ConfigurationAggregatorName (string) –

  [REQUIRED]

  The name of the configuration aggregator.

• ConfigRuleName (string) –

  [REQUIRED]

  The name of the Config rule for which you want compliance information.

• AccountId (string) –

  [REQUIRED]

  The 12-digit account ID of the source account.

• AwsRegion (string) –

  [REQUIRED]

  The source region from where the data is aggregated.

• ComplianceType (string) –

  The resource compliance status.

  Note

  For the GetAggregateComplianceDetailsByConfigRuleRequest data type, Config supports only the COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA values.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'AggregateEvaluationResults': [
        {
            'EvaluationResultIdentifier': {
                'EvaluationResultQualifier': {
                    'ConfigRuleName': 'string',
                    'ResourceType': 'string',
                    'ResourceId': 'string',
                    'EvaluationMode': 'DETECTIVE'|'PROACTIVE'
                },
                'OrderingTimestamp': datetime(2015, 1, 1),
                'ResourceEvaluationId': 'string'
            },
            'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
            'ResultRecordedTime': datetime(2015, 1, 1),
            'ConfigRuleInvokedTime': datetime(2015, 1, 1),
            'Annotation': 'string',
            'AccountId': 'string',
            'AwsRegion': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • AggregateEvaluationResults (list) –

    Returns an AggregateEvaluationResults object.

    • (dict) –

      The details of an Config evaluation for an account ID and region in an aggregator. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.

      • EvaluationResultIdentifier (dict) –

        Uniquely identifies the evaluation result.

        • EvaluationResultQualifier (dict) –

          Identifies an Config rule used to evaluate an Amazon Web Services resource, and provides the type and ID of the evaluated resource.

          • ConfigRuleName (string) –

            The name of the Config rule that was used in the evaluation.

          • ResourceType (string) –

            The type of Amazon Web Services resource that was evaluated.

          • ResourceId (string) –

            The ID of the evaluated Amazon Web Services resource.

          • EvaluationMode (string) –

            The mode of an evaluation. The valid values are Detective or Proactive.

        • OrderingTimestamp (datetime) –

          The time of the event that triggered the evaluation of your Amazon Web Services resources. The time can indicate when Config delivered a configuration item change notification, or it can indicate when Config delivered the configuration snapshot, depending on which event triggered the evaluation.

        • ResourceEvaluationId (string) –

          A Unique ID for an evaluation result.

      • ComplianceType (string) –

        The resource compliance status.

        For the AggregationEvaluationResult data type, Config supports only the COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA value.

      • ResultRecordedTime (datetime) –

        The time when Config recorded the aggregate evaluation result.

      • ConfigRuleInvokedTime (datetime) –

        The time when the Config rule evaluated the Amazon Web Services resource.

      • Annotation (string) –

        Supplementary information about how the agrregate evaluation determined the compliance.

      • AccountId (string) –

        The 12-digit account ID of the source account.

      • AwsRegion (string) –

        The source region from where the data is aggregated.