ConfigService / Paginator / ListResourceEvaluations

ListResourceEvaluations

class ConfigService.Paginator.ListResourceEvaluations

paginator = client.get_paginator('list_resource_evaluations')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters={
        'EvaluationMode': 'DETECTIVE'|'PROACTIVE',
        'TimeWindow': {
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
        'EvaluationContextIdentifier': 'string'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Filters (dict) –

  Returns a ResourceEvaluationFilters object.

  • EvaluationMode (string) –

    Filters all resource evaluations results based on an evaluation mode.

    Warning

    Currently, DECTECTIVE is not supported as a valid value. Ignore other documentation stating otherwise.

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

• 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

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

}

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.