Class: Aws::NetworkFirewall::Types::GetAnalysisReportResultsResponse

Inherits:

Struct

• Object
• Struct
• Aws::NetworkFirewall::Types::GetAnalysisReportResultsResponse

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #analysis_report_results ⇒ Array<Types::AnalysisTypeReportResult>

  Retrieves the results of a traffic analysis report.

• #analysis_type ⇒ String

  The type of traffic that will be used to generate a report.

• #end_time ⇒ Time

  The date and time, up to the current date, from which to stop retrieving analysis data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

• #next_token ⇒ String

  When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response.

• #report_time ⇒ Time

  The date and time the analysis report was ran.

• #start_time ⇒ Time

  The date and time within the last 30 days from which to start retrieving analysis data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ..

• #status ⇒ String

  The status of the analysis report you specify.

Instance Attribute Details

#analysis_report_results ⇒ Array<Types::AnalysisTypeReportResult>

Retrieves the results of a traffic analysis report.

Returns:

• (Array<Types::AnalysisTypeReportResult>)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3446

class GetAnalysisReportResultsResponse < Struct.new(
  :status,
  :start_time,
  :end_time,
  :report_time,
  :analysis_type,
  :next_token,
  :analysis_report_results)
  SENSITIVE = []
  include Aws::Structure
end

#analysis_type ⇒ String

The type of traffic that will be used to generate a report.

Returns:

• (String)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3446

class GetAnalysisReportResultsResponse < Struct.new(
  :status,
  :start_time,
  :end_time,
  :report_time,
  :analysis_type,
  :next_token,
  :analysis_report_results)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The date and time, up to the current date, from which to stop retrieving analysis data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Returns:

• (Time)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3446

class GetAnalysisReportResultsResponse < Struct.new(
  :status,
  :start_time,
  :end_time,
  :report_time,
  :analysis_type,
  :next_token,
  :analysis_report_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

Returns:

• (String)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3446

class GetAnalysisReportResultsResponse < Struct.new(
  :status,
  :start_time,
  :end_time,
  :report_time,
  :analysis_type,
  :next_token,
  :analysis_report_results)
  SENSITIVE = []
  include Aws::Structure
end

#report_time ⇒ Time

The date and time the analysis report was ran.

Returns:

• (Time)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3446

class GetAnalysisReportResultsResponse < Struct.new(
  :status,
  :start_time,
  :end_time,
  :report_time,
  :analysis_type,
  :next_token,
  :analysis_report_results)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The date and time within the last 30 days from which to start retrieving analysis data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ.

Returns:

• (Time)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3446

class GetAnalysisReportResultsResponse < Struct.new(
  :status,
  :start_time,
  :end_time,
  :report_time,
  :analysis_type,
  :next_token,
  :analysis_report_results)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the analysis report you specify. Statuses include RUNNING, COMPLETED, or FAILED.

Returns:

• (String)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 3446

class GetAnalysisReportResultsResponse < Struct.new(
  :status,
  :start_time,
  :end_time,
  :report_time,
  :analysis_type,
  :next_token,
  :analysis_report_results)
  SENSITIVE = []
  include Aws::Structure
end