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 |
Cancels a query if the query is not in a terminated state, such as
CANCELLED
, FAILED
, TIMED_OUT
, or FINISHED
. You must specify an
ARN value for EventDataStore
. The ID of the query that you want to
cancel is also required. When you run CancelQuery
, the query status
might show as CANCELLED
even if the operation is not yet finished.
Synopsis
- data CancelQuery = CancelQuery' {
- eventDataStore :: Maybe Text
- queryId :: Text
- newCancelQuery :: Text -> CancelQuery
- cancelQuery_eventDataStore :: Lens' CancelQuery (Maybe Text)
- cancelQuery_queryId :: Lens' CancelQuery Text
- data CancelQueryResponse = CancelQueryResponse' {
- httpStatus :: Int
- queryId :: Text
- queryStatus :: QueryStatus
- newCancelQueryResponse :: Int -> Text -> QueryStatus -> CancelQueryResponse
- cancelQueryResponse_httpStatus :: Lens' CancelQueryResponse Int
- cancelQueryResponse_queryId :: Lens' CancelQueryResponse Text
- cancelQueryResponse_queryStatus :: Lens' CancelQueryResponse QueryStatus
Creating a Request
data CancelQuery Source #
See: newCancelQuery
smart constructor.
CancelQuery' | |
|
Instances
Create a value of CancelQuery
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:eventDataStore:CancelQuery'
, cancelQuery_eventDataStore
- The ARN (or the ID suffix of the ARN) of an event data store on which
the specified query is running.
CancelQuery
, cancelQuery_queryId
- The ID of the query that you want to cancel. The QueryId
comes from
the response of a StartQuery
operation.
Request Lenses
cancelQuery_eventDataStore :: Lens' CancelQuery (Maybe Text) Source #
The ARN (or the ID suffix of the ARN) of an event data store on which the specified query is running.
cancelQuery_queryId :: Lens' CancelQuery Text Source #
The ID of the query that you want to cancel. The QueryId
comes from
the response of a StartQuery
operation.
Destructuring the Response
data CancelQueryResponse Source #
See: newCancelQueryResponse
smart constructor.
CancelQueryResponse' | |
|
Instances
newCancelQueryResponse Source #
:: Int | |
-> Text | |
-> QueryStatus | |
-> CancelQueryResponse |
Create a value of CancelQueryResponse
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:httpStatus:CancelQueryResponse'
, cancelQueryResponse_httpStatus
- The response's http status code.
CancelQuery
, cancelQueryResponse_queryId
- The ID of the canceled query.
CancelQueryResponse
, cancelQueryResponse_queryStatus
- Shows the status of a query after a CancelQuery
request. Typically,
the values shown are either RUNNING
or CANCELLED
.
Response Lenses
cancelQueryResponse_httpStatus :: Lens' CancelQueryResponse Int Source #
The response's http status code.
cancelQueryResponse_queryId :: Lens' CancelQueryResponse Text Source #
The ID of the canceled query.
cancelQueryResponse_queryStatus :: Lens' CancelQueryResponse QueryStatus Source #
Shows the status of a query after a CancelQuery
request. Typically,
the values shown are either RUNNING
or CANCELLED
.