GuardDuty / Paginator / ListMalwareScans

ListMalwareScans

class GuardDuty.Paginator.ListMalwareScans

paginator = client.get_paginator('list_malware_scans')

paginate(**kwargs)

Creates an iterator that will paginate through responses from GuardDuty.Client.list_malware_scans().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    FilterCriteria={
        'ListMalwareScansFilterCriterion': [
            {
                'ListMalwareScansCriterionKey': 'RESOURCE_ARN'|'SCAN_ID'|'ACCOUNT_ID'|'GUARDDUTY_FINDING_ID'|'RESOURCE_TYPE'|'SCAN_START_TIME'|'SCAN_STATUS'|'SCAN_TYPE',
                'FilterCondition': {
                    'EqualsValue': 'string',
                    'GreaterThan': 123,
                    'LessThan': 123
                }
            },
        ]
    },
    SortCriteria={
        'AttributeName': 'string',
        'OrderBy': 'ASC'|'DESC'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• FilterCriteria (dict) –

  Represents the criteria used to filter the malware scan entries.

  • ListMalwareScansFilterCriterion (list) –

    Represents a condition that when matched will be added to the response of the operation.

    • (dict) –

      Represents a condition that when matched will be added to the response of the operation. Irrespective of using any filter criteria, an administrator account can view the scan entries for all of its member accounts. However, each member account can view the scan entries only for their own account.

      • ListMalwareScansCriterionKey (string) –

        An enum value representing possible scan properties to match with given scan entries.

      • FilterCondition (dict) –

        Contains information about the condition.

        • EqualsValue (string) –

          Represents an equal condition to be applied to a single field when querying for scan entries.

        • GreaterThan (integer) –

          Represents a greater than condition to be applied to a single field when querying for scan entries.

        • LessThan (integer) –

          Represents a less than condition to be applied to a single field when querying for scan entries.

• SortCriteria (dict) –

  Represents the criteria used for sorting malware scan entries.

  • AttributeName (string) –

    Represents the finding attribute, such as accountId, that sorts the findings.

  • OrderBy (string) –

    The order by which the sorted findings are to be displayed.

• 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

{
    'Scans': [
        {
            'ResourceArn': 'string',
            'ResourceType': 'EBS_RECOVERY_POINT'|'EBS_SNAPSHOT'|'EBS_VOLUME'|'EC2_AMI'|'EC2_INSTANCE'|'EC2_RECOVERY_POINT'|'S3_RECOVERY_POINT'|'S3_BUCKET',
            'ScanId': 'string',
            'ScanStatus': 'RUNNING'|'COMPLETED'|'COMPLETED_WITH_ISSUES'|'FAILED'|'SKIPPED',
            'ScanResultStatus': 'NO_THREATS_FOUND'|'THREATS_FOUND',
            'ScanType': 'BACKUP_INITIATED'|'ON_DEMAND'|'GUARDDUTY_INITIATED',
            'ScanStartedAt': datetime(2015, 1, 1),
            'ScanCompletedAt': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • Scans (list) –

    The list of malware scans associated with the provided input parameters.

    • (dict) –

      Contains information about a particular malware scan.

      • ResourceArn (string) –

        Amazon Resource Name (ARN) of the resource for the given malware scan.

      • ResourceType (string) –

        The type of resource that was scanned for malware.

      • ScanId (string) –

        A unique identifier that gets generated when you invoke the API without any error. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.

      • ScanStatus (string) –

        An enum value representing the current status of the malware scan.

      • ScanResultStatus (string) –

        An enum value representing the result of the malware scan.

      • ScanType (string) –

        An enum value representing the type of scan that was initiated.

      • ScanStartedAt (datetime) –

        The timestamp representing when the malware scan was started.

      • ScanCompletedAt (datetime) –

        The timestamp representing when the malware scan was completed.