scan_job_summaries

Creates, updates, deletes, gets or lists a scan_job_summaries resource.

Overview

Name	scan_job_summaries
Type	Resource
Id	aws.backup.scan_job_summaries

Fields

The following fields are returned by SELECT queries:

list_scan_job_summaries

Name	Datatype	Description
account_id	string	The account ID that owns the scan jobs included in this summary. (pattern: <code>^[0-9]{12}$</code>)
count	integer	The number of scan jobs that match the specified criteria.
end_time	string (date-time)	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.
malware_scanner	string	Specifies the malware scanner used during the scan job. Currently only supports GUARDDUTY. (GUARDDUTY)
region	string	The Amazon Web Services Region where the scan jobs were executed.
resource_type	string	The type of Amazon Web Services resource for the scan jobs included in this summary. (pattern: <code>^[a-zA-Z0-9-_.]{1,50}$</code>)
scan_result_status	string	The scan result status for the scan jobs included in this summary. Valid values: THREATS_FOUND | NO_THREATS_FOUND. (NO_THREATS_FOUND, THREATS_FOUND, UNKNOWN)
start_time	string (date-time)	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.
state	string	The state of the scan jobs included in this summary. Valid values: CREATED | RUNNING | COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED. (CREATED, COMPLETED, COMPLETED_WITH_ISSUES, RUNNING, FAILED, CANCELED, AGGREGATE_ALL, ANY)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_scan_job_summaries	select	region	AccountId, ResourceType, MalwareScanner, ScanResultStatus, State, AggregationPeriod, MaxResults, NextToken	This is a request for a summary of scan jobs created or running within the most recent 30 days.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
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.
AggregationPeriod	string	The period for the returned results. ONE_DAYThe daily job count for the prior 1 day. SEVEN_DAYSThe daily job count for the prior 7 days. FOURTEEN_DAYSThe daily job count for the prior 14 days.
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.
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.
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.
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.

SELECT examples

list_scan_job_summaries

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

SELECT
account_id,
count,
end_time,
malware_scanner,
region,
resource_type,
scan_result_status,
start_time,
state
FROM aws.backup.scan_job_summaries
WHERE region = '{{ region }}' -- required
AND AccountId = '{{ AccountId }}'
AND ResourceType = '{{ ResourceType }}'
AND MalwareScanner = '{{ MalwareScanner }}'
AND ScanResultStatus = '{{ ScanResultStatus }}'
AND State = '{{ State }}'
AND AggregationPeriod = '{{ AggregationPeriod }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;