Class: Aws::Backup::Types::DescribeScanJobOutput

Inherits:

Struct

• Object
• Struct
• Aws::Backup::Types::DescribeScanJobOutput

Includes:

Structure

Defined in:

lib/aws-sdk-backup/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_id ⇒ String

  Returns the account ID that owns the scan job.

• #backup_vault_arn ⇒ String

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

• #backup_vault_name ⇒ String

  The name of a logical container where backups are stored.

• #completion_date ⇒ Time

  The date and time that a backup index finished creation, in Unix format and Coordinated Universal Time (UTC).

• #created_by ⇒ Types::ScanJobCreator

  Contains identifying information about the creation of a scan job, including the backup plan and rule that initiated the scan.

• #creation_date ⇒ Time

  The date and time that a backup index finished creation, in Unix format and Coordinated Universal Time (UTC).

• #iam_role_arn ⇒ String

  An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, ‘arn:aws:iam::123456789012:role/S3Access`.

• #malware_scanner ⇒ String

  The scanning engine used for the corresponding scan job.

• #recovery_point_arn ⇒ String

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

• #resource_arn ⇒ String

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

• #resource_name ⇒ String

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

• #resource_type ⇒ String

  The type of Amazon Web Services Resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume.

• #scan_base_recovery_point_arn ⇒ String

  An ARN that uniquely identifies the base recovery point for scanning.

• #scan_id ⇒ String

  The scan ID generated by Amazon GuardDuty for the corresponding Scan Job ID request from Backup.

• #scan_job_id ⇒ String

  The scan job ID that uniquely identified the request to Backup.

• #scan_mode ⇒ String

  Specifies the scan type used for the scan job.

• #scan_result ⇒ Types::ScanResultInfo

  Contains the ‘ScanResultsStatus` for the scanning job and returns `THREATS_FOUND` or `NO_THREATS_FOUND` for completed jobs.

• #scanner_role_arn ⇒ String

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

• #state ⇒ String

  The current state of a scan job.

• #status_message ⇒ String

  A detailed message explaining the status of the job to back up a resource.

Instance Attribute Details

#account_id ⇒ String

Returns the account ID that owns the scan job.

Pattern: ‘^[0-9]12$`

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 4215

class DescribeScanJobOutput < Struct.new(
  :account_id,
  :backup_vault_arn,
  :backup_vault_name,
  :completion_date,
  :created_by,
  :creation_date,
  :iam_role_arn,
  :malware_scanner,
  :recovery_point_arn,
  :resource_arn,
  :resource_name,
  :resource_type,
  :scan_base_recovery_point_arn,
  :scan_id,
  :scan_job_id,
  :scan_mode,
  :scan_result,
  :scanner_role_arn,
  :state,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#backup_vault_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 4215

class DescribeScanJobOutput < Struct.new(
  :account_id,
  :backup_vault_arn,
  :backup_vault_name,
  :completion_date,
  :created_by,
  :creation_date,
  :iam_role_arn,
  :malware_scanner,
  :recovery_point_arn,
  :resource_arn,
  :resource_name,
  :resource_type,
  :scan_base_recovery_point_arn,
  :scan_id,
  :scan_job_id,
  :scan_mode,
  :scan_result,
  :scanner_role_arn,
  :state,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#backup_vault_name ⇒ String

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.

Pattern: ‘^[a-zA-Z0-9-_.]2,50$`

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 4215

class DescribeScanJobOutput < Struct.new(
  :account_id,
  :backup_vault_arn,
  :backup_vault_name,
  :completion_date,
  :created_by,
  :creation_date,
  :iam_role_arn,
  :malware_scanner,
  :recovery_point_arn,
  :resource_arn,
  :resource_name,
  :resource_type,
  :scan_base_recovery_point_arn,
  :scan_id,
  :scan_job_id,
  :scan_mode,
  :scan_result,
  :scanner_role_arn,
  :state,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#completion_date ⇒ Time

The date and time that a backup index finished creation, 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.

Returns:

• (Time)

# File 'lib/aws-sdk-backup/types.rb', line 4215

class DescribeScanJobOutput < Struct.new(
  :account_id,
  :backup_vault_arn,
  :backup_vault_name,
  :completion_date,
  :created_by,
  :creation_date,
  :iam_role_arn,
  :malware_scanner,
  :recovery_point_arn,
  :resource_arn,
  :resource_name,
  :resource_type,
  :scan_base_recovery_point_arn,
  :scan_id,
  :scan_job_id,
  :scan_mode,
  :scan_result,
  :scanner_role_arn,
  :state,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#created_by ⇒ Types::ScanJobCreator

Contains identifying information about the creation of a scan job, including the backup plan and rule that initiated the scan.

Returns:

• (Types::ScanJobCreator)

# File 'lib/aws-sdk-backup/types.rb', line 4215

class DescribeScanJobOutput < Struct.new(
  :account_id,
  :backup_vault_arn,
  :backup_vault_name,
  :completion_date,
  :created_by,
  :creation_date,
  :iam_role_arn,
  :malware_scanner,
  :recovery_point_arn,
  :resource_arn,
  :resource_name,
  :resource_type,
  :scan_base_recovery_point_arn,
  :scan_id,
  :scan_job_id,
  :scan_mode,
  :scan_result,
  :scanner_role_arn,
  :state,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ Time

The date and time that a backup index finished creation, 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.

Returns:

• (Time)

# File 'lib/aws-sdk-backup/types.rb', line 4215

class DescribeScanJobOutput < Struct.new(
  :account_id,
  :backup_vault_arn,
  :backup_vault_name,
  :completion_date,
  :created_by,
  :creation_date,
  :iam_role_arn,
  :malware_scanner,
  :recovery_point_arn,
  :resource_arn,
  :resource_name,
  :resource_type,
  :scan_base_recovery_point_arn,
  :scan_id,
  :scan_job_id,
  :scan_mode,
  :scan_result,
  :scanner_role_arn,
  :state,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#iam_role_arn ⇒ String

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, ‘arn:aws:iam::123456789012:role/S3Access`.

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 4215

class DescribeScanJobOutput < Struct.new(
  :account_id,
  :backup_vault_arn,
  :backup_vault_name,
  :completion_date,
  :created_by,
  :creation_date,
  :iam_role_arn,
  :malware_scanner,
  :recovery_point_arn,
  :resource_arn,
  :resource_name,
  :resource_type,
  :scan_base_recovery_point_arn,
  :scan_id,
  :scan_job_id,
  :scan_mode,
  :scan_result,
  :scanner_role_arn,
  :state,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#malware_scanner ⇒ String

The scanning engine used for the corresponding scan job. Currently only ‘GUARDUTY` is supported.

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 4215

class DescribeScanJobOutput < Struct.new(
  :account_id,
  :backup_vault_arn,
  :backup_vault_name,
  :completion_date,
  :created_by,
  :creation_date,
  :iam_role_arn,
  :malware_scanner,
  :recovery_point_arn,
  :resource_arn,
  :resource_name,
  :resource_type,
  :scan_base_recovery_point_arn,
  :scan_id,
  :scan_job_id,
  :scan_mode,
  :scan_result,
  :scanner_role_arn,
  :state,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#recovery_point_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 4215

class DescribeScanJobOutput < Struct.new(
  :account_id,
  :backup_vault_arn,
  :backup_vault_name,
  :completion_date,
  :created_by,
  :creation_date,
  :iam_role_arn,
  :malware_scanner,
  :recovery_point_arn,
  :resource_arn,
  :resource_name,
  :resource_type,
  :scan_base_recovery_point_arn,
  :scan_id,
  :scan_job_id,
  :scan_mode,
  :scan_result,
  :scanner_role_arn,
  :state,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 4215

class DescribeScanJobOutput < Struct.new(
  :account_id,
  :backup_vault_arn,
  :backup_vault_name,
  :completion_date,
  :created_by,
  :creation_date,
  :iam_role_arn,
  :malware_scanner,
  :recovery_point_arn,
  :resource_arn,
  :resource_name,
  :resource_type,
  :scan_base_recovery_point_arn,
  :scan_id,
  :scan_job_id,
  :scan_mode,
  :scan_result,
  :scanner_role_arn,
  :state,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#resource_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 4215

class DescribeScanJobOutput < Struct.new(
  :account_id,
  :backup_vault_arn,
  :backup_vault_name,
  :completion_date,
  :created_by,
  :creation_date,
  :iam_role_arn,
  :malware_scanner,
  :recovery_point_arn,
  :resource_arn,
  :resource_name,
  :resource_type,
  :scan_base_recovery_point_arn,
  :scan_id,
  :scan_job_id,
  :scan_mode,
  :scan_result,
  :scanner_role_arn,
  :state,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

The type of Amazon Web Services Resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume.

Pattern: ‘^[a-zA-Z0-9-_.]1,50$`

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 4215

class DescribeScanJobOutput < Struct.new(
  :account_id,
  :backup_vault_arn,
  :backup_vault_name,
  :completion_date,
  :created_by,
  :creation_date,
  :iam_role_arn,
  :malware_scanner,
  :recovery_point_arn,
  :resource_arn,
  :resource_name,
  :resource_type,
  :scan_base_recovery_point_arn,
  :scan_id,
  :scan_job_id,
  :scan_mode,
  :scan_result,
  :scanner_role_arn,
  :state,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#scan_base_recovery_point_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 4215

class DescribeScanJobOutput < Struct.new(
  :account_id,
  :backup_vault_arn,
  :backup_vault_name,
  :completion_date,
  :created_by,
  :creation_date,
  :iam_role_arn,
  :malware_scanner,
  :recovery_point_arn,
  :resource_arn,
  :resource_name,
  :resource_type,
  :scan_base_recovery_point_arn,
  :scan_id,
  :scan_job_id,
  :scan_mode,
  :scan_result,
  :scanner_role_arn,
  :state,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#scan_id ⇒ String

The scan ID generated by Amazon GuardDuty for the corresponding Scan Job ID request from Backup.

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 4215

class DescribeScanJobOutput < Struct.new(
  :account_id,
  :backup_vault_arn,
  :backup_vault_name,
  :completion_date,
  :created_by,
  :creation_date,
  :iam_role_arn,
  :malware_scanner,
  :recovery_point_arn,
  :resource_arn,
  :resource_name,
  :resource_type,
  :scan_base_recovery_point_arn,
  :scan_id,
  :scan_job_id,
  :scan_mode,
  :scan_result,
  :scanner_role_arn,
  :state,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#scan_job_id ⇒ String

The scan job ID that uniquely identified the request to Backup.

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 4215

class DescribeScanJobOutput < Struct.new(
  :account_id,
  :backup_vault_arn,
  :backup_vault_name,
  :completion_date,
  :created_by,
  :creation_date,
  :iam_role_arn,
  :malware_scanner,
  :recovery_point_arn,
  :resource_arn,
  :resource_name,
  :resource_type,
  :scan_base_recovery_point_arn,
  :scan_id,
  :scan_job_id,
  :scan_mode,
  :scan_result,
  :scanner_role_arn,
  :state,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#scan_mode ⇒ String

Specifies the scan type used for the scan job.

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 4215

class DescribeScanJobOutput < Struct.new(
  :account_id,
  :backup_vault_arn,
  :backup_vault_name,
  :completion_date,
  :created_by,
  :creation_date,
  :iam_role_arn,
  :malware_scanner,
  :recovery_point_arn,
  :resource_arn,
  :resource_name,
  :resource_type,
  :scan_base_recovery_point_arn,
  :scan_id,
  :scan_job_id,
  :scan_mode,
  :scan_result,
  :scanner_role_arn,
  :state,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#scan_result ⇒ Types::ScanResultInfo

Contains the ‘ScanResultsStatus` for the scanning job and returns `THREATS_FOUND` or `NO_THREATS_FOUND` for completed jobs.

Returns:

• (Types::ScanResultInfo)

# File 'lib/aws-sdk-backup/types.rb', line 4215

class DescribeScanJobOutput < Struct.new(
  :account_id,
  :backup_vault_arn,
  :backup_vault_name,
  :completion_date,
  :created_by,
  :creation_date,
  :iam_role_arn,
  :malware_scanner,
  :recovery_point_arn,
  :resource_arn,
  :resource_name,
  :resource_type,
  :scan_base_recovery_point_arn,
  :scan_id,
  :scan_job_id,
  :scan_mode,
  :scan_result,
  :scanner_role_arn,
  :state,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#scanner_role_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 4215

class DescribeScanJobOutput < Struct.new(
  :account_id,
  :backup_vault_arn,
  :backup_vault_name,
  :completion_date,
  :created_by,
  :creation_date,
  :iam_role_arn,
  :malware_scanner,
  :recovery_point_arn,
  :resource_arn,
  :resource_name,
  :resource_type,
  :scan_base_recovery_point_arn,
  :scan_id,
  :scan_job_id,
  :scan_mode,
  :scan_result,
  :scanner_role_arn,
  :state,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The current state of a scan job.

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 4215

class DescribeScanJobOutput < Struct.new(
  :account_id,
  :backup_vault_arn,
  :backup_vault_name,
  :completion_date,
  :created_by,
  :creation_date,
  :iam_role_arn,
  :malware_scanner,
  :recovery_point_arn,
  :resource_arn,
  :resource_name,
  :resource_type,
  :scan_base_recovery_point_arn,
  :scan_id,
  :scan_job_id,
  :scan_mode,
  :scan_result,
  :scanner_role_arn,
  :state,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

A detailed message explaining the status of the job to back up a resource.

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 4215

class DescribeScanJobOutput < Struct.new(
  :account_id,
  :backup_vault_arn,
  :backup_vault_name,
  :completion_date,
  :created_by,
  :creation_date,
  :iam_role_arn,
  :malware_scanner,
  :recovery_point_arn,
  :resource_arn,
  :resource_name,
  :resource_type,
  :scan_base_recovery_point_arn,
  :scan_id,
  :scan_job_id,
  :scan_mode,
  :scan_result,
  :scanner_role_arn,
  :state,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end