list-scan-job-summaries¶

Description¶

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

Synopsis¶

  list-scan-job-summaries
[--account-id <value>]
[--resource-type <value>]
[--malware-scanner <value>]
[--scan-result-status <value>]
[--state <value>]
[--aggregation-period <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--account-id (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.

Constraints:

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

--resource-type (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.

Constraints:

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

--malware-scanner (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 .

Possible values:

GUARDDUTY

--scan-result-status (string)

Returns only the scan jobs for the specified scan results.

Possible values:

NO_THREATS_FOUND

THREATS_FOUND

--state (string)

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

Possible values:

CREATED

COMPLETED

COMPLETED_WITH_ISSUES

RUNNING

FAILED

CANCELED

AGGREGATE_ALL

ANY

--aggregation-period (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.

Possible values:

ONE_DAY

SEVEN_DAYS

FOURTEEN_DAYS

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

ScanJobSummaries -> (list)

The summary information.

(structure)

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.

Constraints:

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

State -> (string)

The state of the scan jobs included in this summary.

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

Possible values:

CREATED

COMPLETED

COMPLETED_WITH_ISSUES

RUNNING

FAILED

CANCELED

AGGREGATE_ALL

ANY

ResourceType -> (string)

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

Constraints:

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

Count -> (integer)

The number of scan jobs that match the specified criteria.

StartTime -> (timestamp)

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 -> (timestamp)

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 .

Possible values:

GUARDDUTY

ScanResultStatus -> (string)

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

Valid values: THREATS_FOUND | NO_THREATS_FOUND .

Possible values:

NO_THREATS_FOUND

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.

Table of Contents

Feedback

User Guide