Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Returns a list of queries and query statuses for the past seven days.
You must specify an ARN value for EventDataStore
. Optionally, to
shorten the list of results, you can specify a time range, formatted as
timestamps, by adding StartTime
and EndTime
parameters, and a
QueryStatus
value. Valid values for QueryStatus
include QUEUED
,
RUNNING
, FINISHED
, FAILED
, TIMED_OUT
, or CANCELLED
.
Synopsis
- data ListQueries = ListQueries' {}
- newListQueries :: Text -> ListQueries
- listQueries_endTime :: Lens' ListQueries (Maybe UTCTime)
- listQueries_maxResults :: Lens' ListQueries (Maybe Natural)
- listQueries_nextToken :: Lens' ListQueries (Maybe Text)
- listQueries_queryStatus :: Lens' ListQueries (Maybe QueryStatus)
- listQueries_startTime :: Lens' ListQueries (Maybe UTCTime)
- listQueries_eventDataStore :: Lens' ListQueries Text
- data ListQueriesResponse = ListQueriesResponse' {}
- newListQueriesResponse :: Int -> ListQueriesResponse
- listQueriesResponse_nextToken :: Lens' ListQueriesResponse (Maybe Text)
- listQueriesResponse_queries :: Lens' ListQueriesResponse (Maybe [Query])
- listQueriesResponse_httpStatus :: Lens' ListQueriesResponse Int
Creating a Request
data ListQueries Source #
See: newListQueries
smart constructor.
ListQueries' | |
|
Instances
Create a value of ListQueries
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:endTime:ListQueries'
, listQueries_endTime
- Use with StartTime
to bound a ListQueries
request, and limit its
results to only those queries run within a specified time period.
$sel:maxResults:ListQueries'
, listQueries_maxResults
- The maximum number of queries to show on a page.
ListQueries
, listQueries_nextToken
- A token you can use to get the next page of results.
ListQueries
, listQueries_queryStatus
- The status of queries that you want to return in results. Valid values
for QueryStatus
include QUEUED
, RUNNING
, FINISHED
, FAILED
,
TIMED_OUT
, or CANCELLED
.
$sel:startTime:ListQueries'
, listQueries_startTime
- Use with EndTime
to bound a ListQueries
request, and limit its
results to only those queries run within a specified time period.
$sel:eventDataStore:ListQueries'
, listQueries_eventDataStore
- The ARN (or the ID suffix of the ARN) of an event data store on which
queries were run.
Request Lenses
listQueries_endTime :: Lens' ListQueries (Maybe UTCTime) Source #
Use with StartTime
to bound a ListQueries
request, and limit its
results to only those queries run within a specified time period.
listQueries_maxResults :: Lens' ListQueries (Maybe Natural) Source #
The maximum number of queries to show on a page.
listQueries_nextToken :: Lens' ListQueries (Maybe Text) Source #
A token you can use to get the next page of results.
listQueries_queryStatus :: Lens' ListQueries (Maybe QueryStatus) Source #
The status of queries that you want to return in results. Valid values
for QueryStatus
include QUEUED
, RUNNING
, FINISHED
, FAILED
,
TIMED_OUT
, or CANCELLED
.
listQueries_startTime :: Lens' ListQueries (Maybe UTCTime) Source #
Use with EndTime
to bound a ListQueries
request, and limit its
results to only those queries run within a specified time period.
listQueries_eventDataStore :: Lens' ListQueries Text Source #
The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.
Destructuring the Response
data ListQueriesResponse Source #
See: newListQueriesResponse
smart constructor.
Instances
newListQueriesResponse Source #
Create a value of ListQueriesResponse
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:
ListQueries
, listQueriesResponse_nextToken
- A token you can use to get the next page of results.
$sel:queries:ListQueriesResponse'
, listQueriesResponse_queries
- Lists matching query results, and shows query ID, status, and creation
time of each query.
$sel:httpStatus:ListQueriesResponse'
, listQueriesResponse_httpStatus
- The response's http status code.
Response Lenses
listQueriesResponse_nextToken :: Lens' ListQueriesResponse (Maybe Text) Source #
A token you can use to get the next page of results.
listQueriesResponse_queries :: Lens' ListQueriesResponse (Maybe [Query]) Source #
Lists matching query results, and shows query ID, status, and creation time of each query.
listQueriesResponse_httpStatus :: Lens' ListQueriesResponse Int Source #
The response's http status code.