| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.CodeGuruProfiler.ListProfileTimes
Description
Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.
This operation returns paginated results.
Synopsis
- data ListProfileTimes = ListProfileTimes' {}
- newListProfileTimes :: UTCTime -> AggregationPeriod -> Text -> UTCTime -> ListProfileTimes
- listProfileTimes_orderBy :: Lens' ListProfileTimes (Maybe OrderBy)
- listProfileTimes_nextToken :: Lens' ListProfileTimes (Maybe Text)
- listProfileTimes_maxResults :: Lens' ListProfileTimes (Maybe Natural)
- listProfileTimes_endTime :: Lens' ListProfileTimes UTCTime
- listProfileTimes_period :: Lens' ListProfileTimes AggregationPeriod
- listProfileTimes_profilingGroupName :: Lens' ListProfileTimes Text
- listProfileTimes_startTime :: Lens' ListProfileTimes UTCTime
- data ListProfileTimesResponse = ListProfileTimesResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- profileTimes :: [ProfileTime]
- newListProfileTimesResponse :: Int -> ListProfileTimesResponse
- listProfileTimesResponse_nextToken :: Lens' ListProfileTimesResponse (Maybe Text)
- listProfileTimesResponse_httpStatus :: Lens' ListProfileTimesResponse Int
- listProfileTimesResponse_profileTimes :: Lens' ListProfileTimesResponse [ProfileTime]
Creating a Request
data ListProfileTimes Source #
The structure representing the listProfileTimesRequest.
See: newListProfileTimes smart constructor.
Constructors
| ListProfileTimes' | |
Fields
| |
Instances
Arguments
| :: UTCTime | |
| -> AggregationPeriod | |
| -> Text | |
| -> UTCTime | |
| -> ListProfileTimes |
Create a value of ListProfileTimes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:orderBy:ListProfileTimes', listProfileTimes_orderBy - The order (ascending or descending by start time of the profile) to use
when listing profiles. Defaults to TIMESTAMP_DESCENDING.
$sel:nextToken:ListProfileTimes', listProfileTimes_nextToken - 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.
$sel:maxResults:ListProfileTimes', listProfileTimes_maxResults - 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.
$sel:endTime:ListProfileTimes', listProfileTimes_endTime - The end time of the time range from which to list the profiles.
$sel:period:ListProfileTimes', listProfileTimes_period - 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 dayPT1H— 1 hourPT5M— 5 minutes
$sel:profilingGroupName:ListProfileTimes', listProfileTimes_profilingGroupName - The name of the profiling group.
$sel:startTime:ListProfileTimes', listProfileTimes_startTime - The start time of the time range from which to list the profiles.
Request Lenses
listProfileTimes_orderBy :: Lens' ListProfileTimes (Maybe OrderBy) Source #
The order (ascending or descending by start time of the profile) to use
when listing profiles. Defaults to TIMESTAMP_DESCENDING.
listProfileTimes_nextToken :: Lens' ListProfileTimes (Maybe Text) Source #
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.
listProfileTimes_maxResults :: Lens' ListProfileTimes (Maybe Natural) Source #
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.
listProfileTimes_endTime :: Lens' ListProfileTimes UTCTime Source #
The end time of the time range from which to list the profiles.
listProfileTimes_period :: Lens' ListProfileTimes AggregationPeriod Source #
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 dayPT1H— 1 hourPT5M— 5 minutes
listProfileTimes_profilingGroupName :: Lens' ListProfileTimes Text Source #
The name of the profiling group.
listProfileTimes_startTime :: Lens' ListProfileTimes UTCTime Source #
The start time of the time range from which to list the profiles.
Destructuring the Response
data ListProfileTimesResponse Source #
The structure representing the listProfileTimesResponse.
See: newListProfileTimesResponse smart constructor.
Constructors
| ListProfileTimesResponse' | |
Fields
| |
Instances
newListProfileTimesResponse Source #
Create a value of ListProfileTimesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListProfileTimes', listProfileTimesResponse_nextToken - The nextToken value to include in a future ListProfileTimes request.
When the results of a ListProfileTimes request exceed maxResults,
this value can be used to retrieve the next page of results. This value
is null when there are no more results to return.
$sel:httpStatus:ListProfileTimesResponse', listProfileTimesResponse_httpStatus - The response's http status code.
$sel:profileTimes:ListProfileTimesResponse', listProfileTimesResponse_profileTimes - The list of start times of the available profiles for the aggregation
period in the specified time range.
Response Lenses
listProfileTimesResponse_nextToken :: Lens' ListProfileTimesResponse (Maybe Text) Source #
The nextToken value to include in a future ListProfileTimes request.
When the results of a ListProfileTimes request exceed maxResults,
this value can be used to retrieve the next page of results. This value
is null when there are no more results to return.
listProfileTimesResponse_httpStatus :: Lens' ListProfileTimesResponse Int Source #
The response's http status code.
listProfileTimesResponse_profileTimes :: Lens' ListProfileTimesResponse [ProfileTime] Source #
The list of start times of the available profiles for the aggregation period in the specified time range.