Class: Aws::CodeGuruProfiler::Types::ListFindingsReportsRequest

Inherits:

Struct

• Object
• Struct
• Aws::CodeGuruProfiler::Types::ListFindingsReportsRequest

Defined in:

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

Overview

The structure representing the ListFindingsReportsRequest.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #daily_reports_only ⇒ Boolean

  A Boolean value indicating whether to only return reports from daily profiles.

• #end_time ⇒ Time

  The end time of the profile to get analysis data about.

• #max_results ⇒ Integer

  The maximum number of report results returned by ListFindingsReports in paginated output.

• #next_token ⇒ String

  The nextToken value returned from a previous paginated ListFindingsReportsRequest request where maxResults was used and the results exceeded the value of that parameter.

• #profiling_group_name ⇒ String

  The name of the profiling group from which to search for analysis data.

• #start_time ⇒ Time

  The start time of the profile to get analysis data about.

Instance Attribute Details

#daily_reports_only ⇒ Boolean

A Boolean value indicating whether to only return reports from daily profiles. If set to True, only analysis data from daily profiles is returned. If set to False, analysis data is returned from smaller time windows (for example, one hour).

Returns:

• (Boolean)

# File 'gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler/types.rb', line 1067

class ListFindingsReportsRequest < Struct.new(
  :daily_reports_only,
  :end_time,
  :max_results,
  :next_token,
  :profiling_group_name,
  :start_time)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The end time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

Returns:

• (Time)

# File 'gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler/types.rb', line 1067

class ListFindingsReportsRequest < Struct.new(
  :daily_reports_only,
  :end_time,
  :max_results,
  :next_token,
  :profiling_group_name,
  :start_time)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of report results returned by ListFindingsReports in paginated output. When this parameter is used, ListFindingsReports only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFindingsReports request with the returned nextToken value.

Returns:

• (Integer)

# File 'gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler/types.rb', line 1067

class ListFindingsReportsRequest < Struct.new(
  :daily_reports_only,
  :end_time,
  :max_results,
  :next_token,
  :profiling_group_name,
  :start_time)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The nextToken value returned from a previous paginated ListFindingsReportsRequest request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Returns:

• (String)

# File 'gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler/types.rb', line 1067

class ListFindingsReportsRequest < Struct.new(
  :daily_reports_only,
  :end_time,
  :max_results,
  :next_token,
  :profiling_group_name,
  :start_time)
  SENSITIVE = []
  include Aws::Structure
end

#profiling_group_name ⇒ String

The name of the profiling group from which to search for analysis data.

Returns:

• (String)

# File 'gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler/types.rb', line 1067

class ListFindingsReportsRequest < Struct.new(
  :daily_reports_only,
  :end_time,
  :max_results,
  :next_token,
  :profiling_group_name,
  :start_time)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The start time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

Returns:

• (Time)

# File 'gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler/types.rb', line 1067

class ListFindingsReportsRequest < Struct.new(
  :daily_reports_only,
  :end_time,
  :max_results,
  :next_token,
  :profiling_group_name,
  :start_time)
  SENSITIVE = []
  include Aws::Structure
end