Class: Aws::SecurityHub::Types::ExportSummary

Inherits:

Struct

• Object
• Struct
• Aws::SecurityHub::Types::ExportSummary

Defined in:

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

Overview

A summary of an export job, as returned by ListExportJobsV2.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #data_type ⇒ String

  The category of data that the export job produces.

• #destination ⇒ Types::ExportDestination

  The destination that the export job writes to.

• #ended_at ⇒ Time

  The time when the export job reached a terminal state.

• #export_job_id ⇒ String

  The unique identifier of the export job.

• #failure_code ⇒ String

  A code that classifies why the export job failed.

• #failure_message ⇒ String

  A human-readable message about why the export job failed.

• #name ⇒ String

  The user-provided name of the export job, if one was specified.

• #output_configuration ⇒ Types::ExportOutputSummary

  The output configuration of the export job.

• #scopes ⇒ Types::ExportScopes

  The organization scopes that the export job was started with, echoed verbatim.

• #started_at ⇒ Time

  The time when the export job was created.

• #status ⇒ String

  The current state of the export job.

Instance Attribute Details

#data_type ⇒ String

The category of data that the export job produces.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 25498

class ExportSummary < Struct.new(
  :export_job_id,
  :name,
  :status,
  :data_type,
  :output_configuration,
  :scopes,
  :destination,
  :failure_code,
  :failure_message,
  :started_at,
  :ended_at)
  SENSITIVE = []
  include Aws::Structure
end

#destination ⇒ Types::ExportDestination

The destination that the export job writes to.

Returns:

• (Types::ExportDestination)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 25498

class ExportSummary < Struct.new(
  :export_job_id,
  :name,
  :status,
  :data_type,
  :output_configuration,
  :scopes,
  :destination,
  :failure_code,
  :failure_message,
  :started_at,
  :ended_at)
  SENSITIVE = []
  include Aws::Structure
end

#ended_at ⇒ Time

The time when the export job reached a terminal state. Absent while the job is RUNNING.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Returns:

• (Time)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 25498

class ExportSummary < Struct.new(
  :export_job_id,
  :name,
  :status,
  :data_type,
  :output_configuration,
  :scopes,
  :destination,
  :failure_code,
  :failure_message,
  :started_at,
  :ended_at)
  SENSITIVE = []
  include Aws::Structure
end

#export_job_id ⇒ String

The unique identifier of the export job.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 25498

class ExportSummary < Struct.new(
  :export_job_id,
  :name,
  :status,
  :data_type,
  :output_configuration,
  :scopes,
  :destination,
  :failure_code,
  :failure_message,
  :started_at,
  :ended_at)
  SENSITIVE = []
  include Aws::Structure
end

#failure_code ⇒ String

A code that classifies why the export job failed. Present only when Status is FAILED.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 25498

class ExportSummary < Struct.new(
  :export_job_id,
  :name,
  :status,
  :data_type,
  :output_configuration,
  :scopes,
  :destination,
  :failure_code,
  :failure_message,
  :started_at,
  :ended_at)
  SENSITIVE = []
  include Aws::Structure
end

#failure_message ⇒ String

A human-readable message about why the export job failed. Present only when Status is FAILED.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 25498

class ExportSummary < Struct.new(
  :export_job_id,
  :name,
  :status,
  :data_type,
  :output_configuration,
  :scopes,
  :destination,
  :failure_code,
  :failure_message,
  :started_at,
  :ended_at)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The user-provided name of the export job, if one was specified.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 25498

class ExportSummary < Struct.new(
  :export_job_id,
  :name,
  :status,
  :data_type,
  :output_configuration,
  :scopes,
  :destination,
  :failure_code,
  :failure_message,
  :started_at,
  :ended_at)
  SENSITIVE = []
  include Aws::Structure
end

#output_configuration ⇒ Types::ExportOutputSummary

The output configuration of the export job. For findings exports, this reports the output format. Present only for findings exports; absent for other data types.

Returns:

• (Types::ExportOutputSummary)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 25498

class ExportSummary < Struct.new(
  :export_job_id,
  :name,
  :status,
  :data_type,
  :output_configuration,
  :scopes,
  :destination,
  :failure_code,
  :failure_message,
  :started_at,
  :ended_at)
  SENSITIVE = []
  include Aws::Structure
end

#scopes ⇒ Types::ExportScopes

The organization scopes that the export job was started with, echoed verbatim. Absent if the caller didn't supply Scopes.

Returns:

• (Types::ExportScopes)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 25498

class ExportSummary < Struct.new(
  :export_job_id,
  :name,
  :status,
  :data_type,
  :output_configuration,
  :scopes,
  :destination,
  :failure_code,
  :failure_message,
  :started_at,
  :ended_at)
  SENSITIVE = []
  include Aws::Structure
end

#started_at ⇒ Time

The time when the export job was created.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Returns:

• (Time)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 25498

class ExportSummary < Struct.new(
  :export_job_id,
  :name,
  :status,
  :data_type,
  :output_configuration,
  :scopes,
  :destination,
  :failure_code,
  :failure_message,
  :started_at,
  :ended_at)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current state of the export job.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 25498

class ExportSummary < Struct.new(
  :export_job_id,
  :name,
  :status,
  :data_type,
  :output_configuration,
  :scopes,
  :destination,
  :failure_code,
  :failure_message,
  :started_at,
  :ended_at)
  SENSITIVE = []
  include Aws::Structure
end