Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ListProfileTimesRequest

The structure representing the listProfileTimesRequest.

Hierarchy

Index

Properties

endTime

endTime: Date | undefined

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

Optional maxResults

maxResults: undefined | number

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.

Optional nextToken

nextToken: undefined | 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.

Optional orderBy

orderBy: OrderBy | string

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

period

period: AggregationPeriod | string | undefined

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

profilingGroupName: string | undefined

The name of the profiling group.

startTime

startTime: Date | undefined

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