You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CodeGuruProfiler::Types::ListProfileTimesRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListProfileTimesRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  end_time: Time.now, # required
  max_results: 1,
  next_token: "PaginationToken",
  order_by: "TimestampAscending", # accepts TimestampAscending, TimestampDescending
  period: "P1D", # required, accepts P1D, PT1H, PT5M
  profiling_group_name: "ProfilingGroupName", # required
  start_time: Time.now, # required
}

The structure representing the listProfileTimesRequest.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#end_time ⇒ Time

The end time of the time range from which to list the profiles.

Returns:

  • (Time) —

    The end time of the time range from which to list the profiles.

#max_results ⇒ Integer

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

Returns:

  • (Integer) —

    The maximum number of profile time results returned by ListProfileTimes in paginated output.

#next_token ⇒ String

The nextToken value returned from a previous paginated ListProfileTimes 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) —

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

#order_by ⇒ String

The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to TIMESTAMP_DESCENDING.

Possible values:

  • TimestampAscending
  • TimestampDescending

Returns:

  • (String) —

    The order (ascending or descending by start time of the profile) to use when listing profiles.

#period ⇒ String

The aggregation period. This specifies the period during which an aggregation profile collects posted agent profiles for a profiling group. There are 3 valid values.

  • P1D — 1 day

  • PT1H — 1 hour

  • PT5M — 5 minutes

    Possible values:

    • P1D
    • PT1H
    • PT5M

Returns:

  • (String) —

    The aggregation period.

#profiling_group_name ⇒ String

The name of the profiling group.

Returns:

  • (String) —

    The name of the profiling group.

#start_time ⇒ Time

The start time of the time range from which to list the profiles.

Returns:

  • (Time) —

    The start time of the time range from which to list the profiles.