You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CodeGuruProfiler::Types::ListFindingsReportsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CodeGuruProfiler::Types::ListFindingsReportsRequest
- Defined in:
- (unknown)
Overview
When passing ListFindingsReportsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
daily_reports_only: false,
end_time: Time.now, # required
max_results: 1,
next_token: "PaginationToken",
profiling_group_name: "ProfilingGroupName", # required
start_time: Time.now, # required
}
The structure representing the ListFindingsReportsRequest.
Instance Attribute Summary collapse
-
#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 paginatedListFindingsReportsRequest
request wheremaxResults
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).
#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.
#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.
#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.
#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. 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.