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 that has been issued. Cancellation is provided only if
the query has not completed running before the cancellation request was
issued. Because cancellation is an idempotent operation, subsequent
cancellation requests will return a CancellationMessage
, indicating
that the query has already been canceled. See
code sample
for details.
Synopsis
- data CancelQuery = CancelQuery' {}
- newCancelQuery :: Text -> CancelQuery
- cancelQuery_queryId :: Lens' CancelQuery Text
- data CancelQueryResponse = CancelQueryResponse' {}
- newCancelQueryResponse :: Int -> CancelQueryResponse
- cancelQueryResponse_cancellationMessage :: Lens' CancelQueryResponse (Maybe Text)
- cancelQueryResponse_httpStatus :: Lens' CancelQueryResponse Int
Creating a Request
data CancelQuery Source #
See: newCancelQuery
smart constructor.
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:queryId:CancelQuery'
, cancelQuery_queryId
- The ID of the query that needs to be cancelled. QueryID
is returned as
part of the query result.
Request Lenses
cancelQuery_queryId :: Lens' CancelQuery Text Source #
The ID of the query that needs to be cancelled. QueryID
is returned as
part of the query result.
Destructuring the Response
data CancelQueryResponse Source #
See: newCancelQueryResponse
smart constructor.
CancelQueryResponse' | |
|
Instances
newCancelQueryResponse Source #
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:cancellationMessage:CancelQueryResponse'
, cancelQueryResponse_cancellationMessage
- A CancellationMessage
is returned when a CancelQuery
request for the
query specified by QueryId
has already been issued.
$sel:httpStatus:CancelQueryResponse'
, cancelQueryResponse_httpStatus
- The response's http status code.
Response Lenses
cancelQueryResponse_cancellationMessage :: Lens' CancelQueryResponse (Maybe Text) Source #
A CancellationMessage
is returned when a CancelQuery
request for the
query specified by QueryId
has already been issued.
cancelQueryResponse_httpStatus :: Lens' CancelQueryResponse Int Source #
The response's http status code.