ConfigService / Client / list_resource_evaluations

list_resource_evaluations#

ConfigService.Client.list_resource_evaluations(**kwargs)#

Returns a list of proactive resource evaluations.

See also: AWS API Documentation

Request Syntax

response = client.list_resource_evaluations(
    Filters={
        'EvaluationMode': 'DETECTIVE'|'PROACTIVE',
        'TimeWindow': {
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
        'EvaluationContextIdentifier': 'string'
    },
    Limit=123,
    NextToken='string'
)
Parameters:

  • Filters (dict) –

    Returns a ResourceEvaluationFilters object.

    • EvaluationMode (string) –

      Filters all resource evaluations results based on an evaluation mode. the valid value for this API is Proactive.

    • TimeWindow (dict) –

      Returns a TimeWindow object.

      • StartTime (datetime) –

        The start time of an execution.

      • EndTime (datetime) –

        The end time of an execution. The end time must be after the start date.

    • EvaluationContextIdentifier (string) –

      Filters evaluations for a given infrastructure deployment. For example: CFN Stack.

  • Limit (integer) – The maximum number of evaluations returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

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

Return type:

dict

Returns:

Response Syntax

{
    'ResourceEvaluations': [
        {
            'ResourceEvaluationId': 'string',
            'EvaluationMode': 'DETECTIVE'|'PROACTIVE',
            'EvaluationStartTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ResourceEvaluations (list) –

      Returns a ResourceEvaluations object.

      • (dict) –

        Returns details of a resource evaluation.

        • ResourceEvaluationId (string) –

          The ResourceEvaluationId of a evaluation.

        • EvaluationMode (string) –

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

        • EvaluationStartTimestamp (datetime) –

          The starting time of an execution.

    • NextToken (string) –

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

Exceptions

  • ConfigService.Client.exceptions.InvalidNextTokenException

  • ConfigService.Client.exceptions.InvalidParameterValueException

  • ConfigService.Client.exceptions.InvalidTimeRangeException