Backup / Client / list_scan_job_summaries

list_scan_job_summaries

Backup.Client.list_scan_job_summaries(**kwargs)

This is a request for a summary of scan jobs created or running within the most recent 30 days.

See also: AWS API Documentation

Request Syntax

response = client.list_scan_job_summaries(
    AccountId='string',
    ResourceType='string',
    MalwareScanner='GUARDDUTY',
    ScanResultStatus='NO_THREATS_FOUND'|'THREATS_FOUND',
    State='CREATED'|'COMPLETED'|'COMPLETED_WITH_ISSUES'|'RUNNING'|'FAILED'|'CANCELED'|'AGGREGATE_ALL'|'ANY',
    AggregationPeriod='ONE_DAY'|'SEVEN_DAYS'|'FOURTEEN_DAYS',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • AccountId (string) –

    Returns the job count for the specified account.

    If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor’s account will be returned.

    Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

    AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

  • ResourceType (string) –

    Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

    The the value ANY returns count of all resource types.

    AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

  • MalwareScanner (string) – Returns only the scan jobs for the specified malware scanner. Currently the only MalwareScanner is GUARDDUTY. But the field also supports ANY, and AGGREGATE_ALL.

  • ScanResultStatus (string) – Returns only the scan jobs for the specified scan results.

  • State (string) – Returns only the scan jobs for the specified scanning job state.

  • AggregationPeriod (string) –

    The period for the returned results.

    • ``ONE_DAY``The daily job count for the prior 1 day.

    • ``SEVEN_DAYS``The daily job count for the prior 7 days.

    • ``FOURTEEN_DAYS``The daily job count for the prior 14 days.

  • MaxResults (integer) –

    The maximum number of items to be returned.

    The value is an integer. Range of accepted values is from 1 to 500.

  • NextToken (string) – The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Return type:

dict

Returns:

Response Syntax

{
    'ScanJobSummaries': [
        {
            'Region': 'string',
            'AccountId': 'string',
            'State': 'CREATED'|'COMPLETED'|'COMPLETED_WITH_ISSUES'|'RUNNING'|'FAILED'|'CANCELED'|'AGGREGATE_ALL'|'ANY',
            'ResourceType': 'string',
            'Count': 123,
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'MalwareScanner': 'GUARDDUTY',
            'ScanResultStatus': 'NO_THREATS_FOUND'|'THREATS_FOUND'
        },
    ],
    'AggregationPeriod': 'string',
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ScanJobSummaries (list) –

      The summary information.

      • (dict) –

        Contains summary information about scan jobs, including counts and metadata for a specific time period and criteria.

        • Region (string) –

          The Amazon Web Services Region where the scan jobs were executed.

        • AccountId (string) –

          The account ID that owns the scan jobs included in this summary.

        • State (string) –

          The state of the scan jobs included in this summary.

          Valid values: CREATED | RUNNING | COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED.

        • ResourceType (string) –

          The type of Amazon Web Services resource for the scan jobs included in this summary.

        • Count (integer) –

          The number of scan jobs that match the specified criteria.

        • StartTime (datetime) –

          The value of time in number format of a job start time.

          This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • EndTime (datetime) –

          The value of time in number format of a job end time.

          This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • MalwareScanner (string) –

          Specifies the malware scanner used during the scan job. Currently only supports GUARDDUTY.

        • ScanResultStatus (string) –

          The scan result status for the scan jobs included in this summary.

          Valid values: THREATS_FOUND | NO_THREATS_FOUND.

    • AggregationPeriod (string) –

      The period for the returned results.

      • ``ONE_DAY``The daily job count for the prior 1 day.

      • ``SEVEN_DAYS``The daily job count for the prior 7 days.

      • ``FOURTEEN_DAYS``The daily job count for the prior 14 days.

      Valid Values: 'ONE_DAY' | 'SEVEN_DAYS' | 'FOURTEEN_DAYS'

    • NextToken (string) –

      The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Exceptions