Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListScanJobSummaries

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

Request Syntax


GET /audit/scan-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MalwareScanner=MalwareScanner&MaxResults=MaxResults&NextToken=NextToken&ResourceType=ResourceType&ScanResultStatus=ScanResultStatus&State=State HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AccountId

Returns the job count for the specified account.

If the request is sent from a member account or an account not part of AWS 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.

Pattern: ^[0-9]{12}$

AggregationPeriod

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.

Valid Values: ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS

MalwareScanner

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.

Valid Values: GUARDDUTY

MaxResults

The maximum number of items to be returned.

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

Valid Range: Minimum value of 1. Maximum value of 1000.

NextToken

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

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.

Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

ScanResultStatus

Returns only the scan jobs for the specified scan results.

Valid Values: NO_THREATS_FOUND | THREATS_FOUND

State

Returns only the scan jobs for the specified scanning job state.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AggregationPeriod": "string",
   "NextToken": "string",
   "ScanJobSummaries": [ 
      { 
         "AccountId": "string",
         "Count": number,
         "EndTime": number,
         "MalwareScanner": "string",
         "Region": "string",
         "ResourceType": "string",
         "ScanResultStatus": "string",
         "StartTime": number,
         "State": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AggregationPeriod

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.

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

Type: String

NextToken

Type: String

ScanJobSummaries

The summary information.

Type: Array of ScanJobSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterValueException

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

Context
Type

HTTP Status Code: 400

ServiceUnavailableException

The request failed due to a temporary failure of the server.

Context
Type

HTTP Status Code: 500