| 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 |
Amazonka.LakeFormation.GetQueryState
Description
Returns the state of a query previously submitted. Clients are expected
to poll GetQueryState to monitor the current state of the planning
before retrieving the work units. A query state is only visible to the
principal that made the initial call to StartQueryPlanning.
Synopsis
- data GetQueryState = GetQueryState' {}
- newGetQueryState :: Text -> GetQueryState
- getQueryState_queryId :: Lens' GetQueryState Text
- data GetQueryStateResponse = GetQueryStateResponse' {
- error :: Maybe Text
- httpStatus :: Int
- state :: QueryStateString
- newGetQueryStateResponse :: Int -> QueryStateString -> GetQueryStateResponse
- getQueryStateResponse_error :: Lens' GetQueryStateResponse (Maybe Text)
- getQueryStateResponse_httpStatus :: Lens' GetQueryStateResponse Int
- getQueryStateResponse_state :: Lens' GetQueryStateResponse QueryStateString
Creating a Request
data GetQueryState Source #
See: newGetQueryState smart constructor.
Constructors
| GetQueryState' | |
Instances
Arguments
| :: Text | |
| -> GetQueryState |
Create a value of GetQueryState 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:GetQueryState', getQueryState_queryId - The ID of the plan query operation.
Request Lenses
getQueryState_queryId :: Lens' GetQueryState Text Source #
The ID of the plan query operation.
Destructuring the Response
data GetQueryStateResponse Source #
A structure for the output.
See: newGetQueryStateResponse smart constructor.
Constructors
| GetQueryStateResponse' | |
Fields
| |
Instances
newGetQueryStateResponse Source #
Arguments
| :: Int | |
| -> QueryStateString | |
| -> GetQueryStateResponse |
Create a value of GetQueryStateResponse 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:
GetQueryStateResponse, getQueryStateResponse_error - An error message when the operation fails.
$sel:httpStatus:GetQueryStateResponse', getQueryStateResponse_httpStatus - The response's http status code.
$sel:state:GetQueryStateResponse', getQueryStateResponse_state - The state of a query previously submitted. The possible states are:
- PENDING: the query is pending.
- WORKUNITS_AVAILABLE: some work units are ready for retrieval and execution.
- FINISHED: the query planning finished successfully, and all work units are ready for retrieval and execution.
- ERROR: an error occurred with the query, such as an invalid query ID or a backend error.
Response Lenses
getQueryStateResponse_error :: Lens' GetQueryStateResponse (Maybe Text) Source #
An error message when the operation fails.
getQueryStateResponse_httpStatus :: Lens' GetQueryStateResponse Int Source #
The response's http status code.
getQueryStateResponse_state :: Lens' GetQueryStateResponse QueryStateString Source #
The state of a query previously submitted. The possible states are:
- PENDING: the query is pending.
- WORKUNITS_AVAILABLE: some work units are ready for retrieval and execution.
- FINISHED: the query planning finished successfully, and all work units are ready for retrieval and execution.
- ERROR: an error occurred with the query, such as an invalid query ID or a backend error.