ConfigService / Client / describe_config_rule_evaluation_status

describe_config_rule_evaluation_status#

ConfigService.Client.describe_config_rule_evaluation_status(**kwargs)#

Returns status information for each of your Config managed rules. The status includes information such as the last time Config invoked the rule, the last time Config failed to invoke the rule, and the related error for the last failure.

See also: AWS API Documentation

Request Syntax

response = client.describe_config_rule_evaluation_status(
    ConfigRuleNames=[
        'string',
    ],
    NextToken='string',
    Limit=123
)
Parameters:

  • ConfigRuleNames (list) –

    The name of the Config managed rules for which you want status information. If you do not specify any names, Config returns status information for all Config managed rules that you use.

    • (string) –

  • NextToken (string) – The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

  • Limit (integer) –

    The number of rule evaluation results that you want returned.

    This parameter is required if the rule limit for your account is more than the default of 1000 rules.

    For information about requesting a rule limit increase, see Config Limits in the Amazon Web Services General Reference Guide.

Return type:

dict

Returns:

Response Syntax

{
    'ConfigRulesEvaluationStatus': [
        {
            'ConfigRuleName': 'string',
            'ConfigRuleArn': 'string',
            'ConfigRuleId': 'string',
            'LastSuccessfulInvocationTime': datetime(2015, 1, 1),
            'LastFailedInvocationTime': datetime(2015, 1, 1),
            'LastSuccessfulEvaluationTime': datetime(2015, 1, 1),
            'LastFailedEvaluationTime': datetime(2015, 1, 1),
            'FirstActivatedTime': datetime(2015, 1, 1),
            'LastDeactivatedTime': datetime(2015, 1, 1),
            'LastErrorCode': 'string',
            'LastErrorMessage': 'string',
            'FirstEvaluationStarted': True|False,
            'LastDebugLogDeliveryStatus': 'string',
            'LastDebugLogDeliveryStatusReason': 'string',
            'LastDebugLogDeliveryTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ConfigRulesEvaluationStatus (list) –

      Status information about your Config managed rules.

      • (dict) –

        Status information for your Config Managed rules and Config Custom Policy rules. The status includes information such as the last time the rule ran, the last time it failed, and the related error for the last failure.

        This action does not return status information about Config Custom Lambda rules.

        • ConfigRuleName (string) –

          The name of the Config rule.

        • ConfigRuleArn (string) –

          The Amazon Resource Name (ARN) of the Config rule.

        • ConfigRuleId (string) –

          The ID of the Config rule.

        • LastSuccessfulInvocationTime (datetime) –

          The time that Config last successfully invoked the Config rule to evaluate your Amazon Web Services resources.

        • LastFailedInvocationTime (datetime) –

          The time that Config last failed to invoke the Config rule to evaluate your Amazon Web Services resources.

        • LastSuccessfulEvaluationTime (datetime) –

          The time that Config last successfully evaluated your Amazon Web Services resources against the rule.

        • LastFailedEvaluationTime (datetime) –

          The time that Config last failed to evaluate your Amazon Web Services resources against the rule.

        • FirstActivatedTime (datetime) –

          The time that you first activated the Config rule.

        • LastDeactivatedTime (datetime) –

          The time that you last turned off the Config rule.

        • LastErrorCode (string) –

          The error code that Config returned when the rule last failed.

        • LastErrorMessage (string) –

          The error message that Config returned when the rule last failed.

        • FirstEvaluationStarted (boolean) –

          Indicates whether Config has evaluated your resources against the rule at least once.

          • true - Config has evaluated your Amazon Web Services resources against the rule at least once.

          • false - Config has not finished evaluating your Amazon Web Services resources against the rule at least once.

        • LastDebugLogDeliveryStatus (string) –

          The status of the last attempted delivery of a debug log for your Config Custom Policy rules. Either Successful or Failed.

        • LastDebugLogDeliveryStatusReason (string) –

          The reason Config was not able to deliver a debug log. This is for the last failed attempt to retrieve a debug log for your Config Custom Policy rules.

        • LastDebugLogDeliveryTime (datetime) –

          The time Config last attempted to deliver a debug log for your Config Custom Policy rules.

    • NextToken (string) –

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

Exceptions