Skip to content

List Profile Times

codeguruprofiler_list_profile_times R Documentation

Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range

Description

Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.

Usage

codeguruprofiler_list_profile_times(endTime, maxResults, nextToken,
  orderBy, period, profilingGroupName, startTime)

Arguments

endTime

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

maxResults

The maximum number of profile time results returned by list_profile_times in paginated output. When this parameter is used, list_profile_times 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 list_profile_times request with the returned nextToken value.

nextToken

The nextToken value returned from a previous paginated list_profile_times 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.

orderBy

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

period

[required] 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

profilingGroupName

[required] The name of the profiling group.

startTime

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

Value

A list with the following syntax: 

list(
  nextToken = "string",
  profileTimes = list(
    list(
      start = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

svc$list_profile_times(
  endTime = as.POSIXct(
    "2015-01-01"
  ),
  maxResults = 123,
  nextToken = "string",
  orderBy = "TimestampDescending"|"TimestampAscending",
  period = "PT5M"|"PT1H"|"P1D",
  profilingGroupName = "string",
  startTime = as.POSIXct(
    "2015-01-01"
  )
)