list-scan-jobs¶

Description¶

Returns a list of existing scan jobs for an authenticated account for the last 30 days.

Synopsis¶

  list-scan-jobs
[--by-account-id <value>]
[--by-backup-vault-name <value>]
[--by-complete-after <value>]
[--by-complete-before <value>]
[--by-malware-scanner <value>]
[--by-recovery-point-arn <value>]
[--by-resource-arn <value>]
[--by-resource-type <value>]
[--by-scan-result-status <value>]
[--by-state <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¶

--by-account-id (string)

The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.

If used from an Amazon Web Services Organizations management account, passing * returns all jobs across the organization.

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

--by-backup-vault-name (string)

Returns only scan jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

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

--by-complete-after (timestamp)

Returns only scan jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

--by-complete-before (timestamp)

Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

--by-malware-scanner (string)

Returns only the scan jobs for the specified malware scanner. Currently only supports GUARDDUTY .

Possible values:

GUARDDUTY

--by-recovery-point-arn (string)

Returns only the scan jobs that are ran against the specified recovery point.

--by-resource-arn (string)

Returns only scan jobs that match the specified resource Amazon Resource Name (ARN).

--by-resource-type (string)

Returns restore testing selections by the specified restore testing plan name.

EBS for Amazon Elastic Block Store

EC2 for Amazon Elastic Compute Cloud

S3 for Amazon Simple Storage Service (Amazon S3)

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

Possible values:

EBS

EC2

S3

--by-scan-result-status (string)

Returns only the scan jobs for the specified scan results:

THREATS_FOUND

NO_THREATS_FOUND

Possible values:

NO_THREATS_FOUND

THREATS_FOUND

--by-state (string)

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

Possible values:

CANCELED

COMPLETED

COMPLETED_WITH_ISSUES

CREATED

FAILED

RUNNING

--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¶

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.

ScanJobs -> (list)

An array of structures containing metadata about your scan jobs returned in JSON format.

(structure)

Contains metadata about a scan job, including information about the scanning process, results, and associated resources.

AccountId -> (string) [required]

The account ID that owns the scan job.

BackupVaultArn -> (string) [required]

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault .

BackupVaultName -> (string) [required]

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

CompletionDate -> (timestamp)

The date and time that a scan job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

CreatedBy -> (structure) [required]

Contains identifying information about the creation of a scan job.

BackupPlanArn -> (string) [required]

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50 .

BackupPlanId -> (string) [required]

The ID of the backup plan.

BackupPlanVersion -> (string) [required]

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

BackupRuleId -> (string) [required]

Uniquely identifies the backup rule that initiated the scan job.

CreationDate -> (timestamp) [required]

The date and time that a scan job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

IamRoleArn -> (string) [required]

Specifies the IAM role ARN used to create the scan job; for example, arn:aws:iam::123456789012:role/S3Access .

MalwareScanner -> (string) [required]

The scanning engine used for the scan job. Currently only GUARDDUTY is supported.

Possible values:

GUARDDUTY

RecoveryPointArn -> (string) [required]

An ARN that uniquely identifies the recovery point being scanned; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .

ResourceArn -> (string) [required]

An ARN that uniquely identifies the source resource of the recovery point being scanned.

ResourceName -> (string) [required]

The non-unique name of the resource that belongs to the specified backup.

ResourceType -> (string) [required]

The type of Amazon Web Services resource being scanned; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

Possible values:

EBS

EC2

S3

ScanBaseRecoveryPointArn -> (string)

An ARN that uniquely identifies the base recovery point for scanning. This field is populated when an incremental scan job has taken place.

ScanId -> (string)

The scan ID generated by the malware scanner for the corresponding scan job.

ScanJobId -> (string) [required]

The unique identifier that identifies the scan job request to Backup.

ScanMode -> (string) [required]

Specifies the scan type use for the scan job.

Includes:

FULL_SCAN will scan the entire data lineage within the backup.

INCREMENTAL_SCAN will scan the data difference between the target recovery point and base recovery point ARN.

Possible values:

FULL_SCAN

INCREMENTAL_SCAN

ScanResult -> (structure)

Contains the scan results information, including the status of threats found during scanning.

ScanResultStatus -> (string) [required]

The status of the scan results.

Valid values: THREATS_FOUND | NO_THREATS_FOUND .

Possible values:

NO_THREATS_FOUND

THREATS_FOUND

ScannerRoleArn -> (string) [required]

Specifies the scanner IAM role ARN used for the scan job.

State -> (string)

The current state of the scan job.

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

Possible values:

CANCELED

COMPLETED

COMPLETED_WITH_ISSUES

CREATED

FAILED

RUNNING

StatusMessage -> (string)

A detailed message explaining the status of the scan job.

Table of Contents

Feedback

User Guide