Scan - Amazon GuardDuty

Scan

Contains information about a malware scan.

Contents

accountId

The ID for the account that belongs to the scan.

Type: String

Length Constraints: Fixed length of 12.

Required: No

adminDetectorId

The unique detector ID of the administrator account that the request is associated with. If the account is an administrator, the AdminDetectorId will be the same as the one used for DetectorId.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 300.

Required: No

attachedVolumes

List of volumes that were attached to the original instance to be scanned.

Type: Array of VolumeDetail objects

Required: No

detectorId

The unique ID of the detector that the request is associated with.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 300.

Required: No

failureReason

Represents the reason for FAILED scan status.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: No

fileCount

Represents the number of files that were scanned.

Type: Long

Valid Range: Minimum value of 0.

Required: No

resourceDetails

Represents the resources that were scanned in the scan entry.

Type: ResourceDetails object

Required: No

scanEndTime

The timestamp of when the scan was finished.

Type: Timestamp

Required: No

scanId

The unique scan ID associated with a scan entry.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: No

scanResultDetails

Represents the result of the scan.

Type: ScanResultDetails object

Required: No

scanStartTime

The timestamp of when the scan was triggered.

Type: Timestamp

Required: No

scanStatus

An enum value representing possible scan statuses.

Type: String

Valid Values: RUNNING | COMPLETED | FAILED | SKIPPED

Required: No

scanType

Specifies the scan type that invoked the malware scan.

Type: String

Valid Values: GUARDDUTY_INITIATED | ON_DEMAND

Required: No

totalBytes

Represents total bytes that were scanned.

Type: Long

Valid Range: Minimum value of 0.

Required: No

triggerDetails

Specifies the reason why the scan was initiated.

Type: TriggerDetails object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: