Class: Aws::GuardDuty::Types::Scan

Inherits:

Struct

• Object
• Struct
• Aws::GuardDuty::Types::Scan

Defined in:

gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb

Overview

Contains information about a malware scan.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_id ⇒ String

  The ID for the account that belongs to the scan.

• #admin_detector_id ⇒ String

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

• #attached_volumes ⇒ Array<Types::VolumeDetail>

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

• #detector_id ⇒ String

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

• #failure_reason ⇒ String

  Represents the reason for FAILED scan status.

• #file_count ⇒ Integer

  Represents the number of files that were scanned.

• #resource_details ⇒ Types::ResourceDetails

  Represents the resources that were scanned in the scan entry.

• #scan_end_time ⇒ Time

  The timestamp of when the scan was finished.

• #scan_id ⇒ String

  The unique scan ID associated with a scan entry.

• #scan_result_details ⇒ Types::ScanResultDetails

  Represents the result of the scan.

• #scan_start_time ⇒ Time

  The timestamp of when the scan was triggered.

• #scan_status ⇒ String

  An enum value representing possible scan statuses.

• #total_bytes ⇒ Integer

  Represents total bytes that were scanned.

• #trigger_details ⇒ Types::TriggerDetails

  Specifies the reason why the scan was initiated.

Instance Attribute Details

#account_id ⇒ String

The ID for the account that belongs to the scan.

Returns:

• (String)

# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 5172

class Scan < Struct.new(
  :detector_id,
  :admin_detector_id,
  :scan_id,
  :scan_status,
  :failure_reason,
  :scan_start_time,
  :scan_end_time,
  :trigger_details,
  :resource_details,
  :scan_result_details,
  :account_id,
  :total_bytes,
  :file_count,
  :attached_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#admin_detector_id ⇒ String

The unique detector ID of the administrator account that the request is associated with. Note that this value will be the same as the one used for DetectorId if the account is an administrator.

Returns:

• (String)

# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 5172

class Scan < Struct.new(
  :detector_id,
  :admin_detector_id,
  :scan_id,
  :scan_status,
  :failure_reason,
  :scan_start_time,
  :scan_end_time,
  :trigger_details,
  :resource_details,
  :scan_result_details,
  :account_id,
  :total_bytes,
  :file_count,
  :attached_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#attached_volumes ⇒ Array<Types::VolumeDetail>

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

Returns:

• (Array<Types::VolumeDetail>)

# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 5172

class Scan < Struct.new(
  :detector_id,
  :admin_detector_id,
  :scan_id,
  :scan_status,
  :failure_reason,
  :scan_start_time,
  :scan_end_time,
  :trigger_details,
  :resource_details,
  :scan_result_details,
  :account_id,
  :total_bytes,
  :file_count,
  :attached_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#detector_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 5172

class Scan < Struct.new(
  :detector_id,
  :admin_detector_id,
  :scan_id,
  :scan_status,
  :failure_reason,
  :scan_start_time,
  :scan_end_time,
  :trigger_details,
  :resource_details,
  :scan_result_details,
  :account_id,
  :total_bytes,
  :file_count,
  :attached_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

Represents the reason for FAILED scan status.

Returns:

• (String)

# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 5172

class Scan < Struct.new(
  :detector_id,
  :admin_detector_id,
  :scan_id,
  :scan_status,
  :failure_reason,
  :scan_start_time,
  :scan_end_time,
  :trigger_details,
  :resource_details,
  :scan_result_details,
  :account_id,
  :total_bytes,
  :file_count,
  :attached_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#file_count ⇒ Integer

Represents the number of files that were scanned.

Returns:

• (Integer)

# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 5172

class Scan < Struct.new(
  :detector_id,
  :admin_detector_id,
  :scan_id,
  :scan_status,
  :failure_reason,
  :scan_start_time,
  :scan_end_time,
  :trigger_details,
  :resource_details,
  :scan_result_details,
  :account_id,
  :total_bytes,
  :file_count,
  :attached_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#resource_details ⇒ Types::ResourceDetails

Represents the resources that were scanned in the scan entry.

Returns:

• (Types::ResourceDetails)

# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 5172

class Scan < Struct.new(
  :detector_id,
  :admin_detector_id,
  :scan_id,
  :scan_status,
  :failure_reason,
  :scan_start_time,
  :scan_end_time,
  :trigger_details,
  :resource_details,
  :scan_result_details,
  :account_id,
  :total_bytes,
  :file_count,
  :attached_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#scan_end_time ⇒ Time

The timestamp of when the scan was finished.

Returns:

• (Time)

# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 5172

class Scan < Struct.new(
  :detector_id,
  :admin_detector_id,
  :scan_id,
  :scan_status,
  :failure_reason,
  :scan_start_time,
  :scan_end_time,
  :trigger_details,
  :resource_details,
  :scan_result_details,
  :account_id,
  :total_bytes,
  :file_count,
  :attached_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#scan_id ⇒ String

The unique scan ID associated with a scan entry.

Returns:

• (String)

# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 5172

class Scan < Struct.new(
  :detector_id,
  :admin_detector_id,
  :scan_id,
  :scan_status,
  :failure_reason,
  :scan_start_time,
  :scan_end_time,
  :trigger_details,
  :resource_details,
  :scan_result_details,
  :account_id,
  :total_bytes,
  :file_count,
  :attached_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#scan_result_details ⇒ Types::ScanResultDetails

Represents the result of the scan.

Returns:

• (Types::ScanResultDetails)

# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 5172

class Scan < Struct.new(
  :detector_id,
  :admin_detector_id,
  :scan_id,
  :scan_status,
  :failure_reason,
  :scan_start_time,
  :scan_end_time,
  :trigger_details,
  :resource_details,
  :scan_result_details,
  :account_id,
  :total_bytes,
  :file_count,
  :attached_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#scan_start_time ⇒ Time

The timestamp of when the scan was triggered.

Returns:

• (Time)

# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 5172

class Scan < Struct.new(
  :detector_id,
  :admin_detector_id,
  :scan_id,
  :scan_status,
  :failure_reason,
  :scan_start_time,
  :scan_end_time,
  :trigger_details,
  :resource_details,
  :scan_result_details,
  :account_id,
  :total_bytes,
  :file_count,
  :attached_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#scan_status ⇒ String

An enum value representing possible scan statuses.

Returns:

• (String)

# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 5172

class Scan < Struct.new(
  :detector_id,
  :admin_detector_id,
  :scan_id,
  :scan_status,
  :failure_reason,
  :scan_start_time,
  :scan_end_time,
  :trigger_details,
  :resource_details,
  :scan_result_details,
  :account_id,
  :total_bytes,
  :file_count,
  :attached_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#total_bytes ⇒ Integer

Represents total bytes that were scanned.

Returns:

• (Integer)

# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 5172

class Scan < Struct.new(
  :detector_id,
  :admin_detector_id,
  :scan_id,
  :scan_status,
  :failure_reason,
  :scan_start_time,
  :scan_end_time,
  :trigger_details,
  :resource_details,
  :scan_result_details,
  :account_id,
  :total_bytes,
  :file_count,
  :attached_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#trigger_details ⇒ Types::TriggerDetails

Specifies the reason why the scan was initiated.

Returns:

• (Types::TriggerDetails)

# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 5172

class Scan < Struct.new(
  :detector_id,
  :admin_detector_id,
  :scan_id,
  :scan_status,
  :failure_reason,
  :scan_start_time,
  :scan_end_time,
  :trigger_details,
  :resource_details,
  :scan_result_details,
  :account_id,
  :total_bytes,
  :file_count,
  :attached_volumes)
  SENSITIVE = []
  include Aws::Structure
end