Inspector / Paginator / ListAssessmentRuns

ListAssessmentRuns

class Inspector.Paginator.ListAssessmentRuns

paginator = client.get_paginator('list_assessment_runs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Inspector.Client.list_assessment_runs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    assessmentTemplateArns=[
        'string',
    ],
    filter={
        'namePattern': 'string',
        'states': [
            'CREATED'|'START_DATA_COLLECTION_PENDING'|'START_DATA_COLLECTION_IN_PROGRESS'|'COLLECTING_DATA'|'STOP_DATA_COLLECTION_PENDING'|'DATA_COLLECTED'|'START_EVALUATING_RULES_PENDING'|'EVALUATING_RULES'|'FAILED'|'ERROR'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'CANCELED',
        ],
        'durationRange': {
            'minSeconds': 123,
            'maxSeconds': 123
        },
        'rulesPackageArns': [
            'string',
        ],
        'startTimeRange': {
            'beginDate': datetime(2015, 1, 1),
            'endDate': datetime(2015, 1, 1)
        },
        'completionTimeRange': {
            'beginDate': datetime(2015, 1, 1),
            'endDate': datetime(2015, 1, 1)
        },
        'stateChangeTimeRange': {
            'beginDate': datetime(2015, 1, 1),
            'endDate': datetime(2015, 1, 1)
        }
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• assessmentTemplateArns (list) –

  The ARNs that specify the assessment templates whose assessment runs you want to list.

  • (string) –

• filter (dict) –

  You can use this parameter to specify a subset of data to be included in the action’s response.

  For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

  • namePattern (string) –

    For a record to match a filter, an explicit value or a string containing a wildcard that is specified for this data type property must match the value of the assessmentRunName property of the AssessmentRun data type.

  • states (list) –

    For a record to match a filter, one of the values specified for this data type property must be the exact match of the value of the assessmentRunState property of the AssessmentRun data type.

    • (string) –

  • durationRange (dict) –

    For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the durationInSeconds property of the AssessmentRun data type.

    • minSeconds (integer) –

      The minimum value of the duration range. Must be greater than zero.

    • maxSeconds (integer) –

      The maximum value of the duration range. Must be less than or equal to 604800 seconds (1 week).

  • rulesPackageArns (list) –

    For a record to match a filter, the value that is specified for this data type property must be contained in the list of values of the rulesPackages property of the AssessmentRun data type.

    • (string) –

  • startTimeRange (dict) –

    For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the startTime property of the AssessmentRun data type.

    • beginDate (datetime) –

      The minimum value of the timestamp range.

    • endDate (datetime) –

      The maximum value of the timestamp range.

  • completionTimeRange (dict) –

    For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the completedAt property of the AssessmentRun data type.

    • beginDate (datetime) –

      The minimum value of the timestamp range.

    • endDate (datetime) –

      The maximum value of the timestamp range.

  • stateChangeTimeRange (dict) –

    For a record to match a filter, the value that is specified for this data type property must match the stateChangedAt property of the AssessmentRun data type.

    • beginDate (datetime) –

      The minimum value of the timestamp range.

    • endDate (datetime) –

      The maximum value of the timestamp range.

• 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

{
    'assessmentRunArns': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • assessmentRunArns (list) –

    A list of ARNs that specifies the assessment runs that are returned by the action.

    • (string) –

  • NextToken (string) –

    A token to resume pagination.