| 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.StartQueryPlanning
Description
Submits a request to process a query statement.
This operation generates work units that can be retrieved with the
GetWorkUnits operation as soon as the query state is
WORKUNITS_AVAILABLE or FINISHED.
Synopsis
- data StartQueryPlanning = StartQueryPlanning' {}
- newStartQueryPlanning :: QueryPlanningContext -> Text -> StartQueryPlanning
- startQueryPlanning_queryPlanningContext :: Lens' StartQueryPlanning QueryPlanningContext
- startQueryPlanning_queryString :: Lens' StartQueryPlanning Text
- data StartQueryPlanningResponse = StartQueryPlanningResponse' {
- httpStatus :: Int
- queryId :: Text
- newStartQueryPlanningResponse :: Int -> Text -> StartQueryPlanningResponse
- startQueryPlanningResponse_httpStatus :: Lens' StartQueryPlanningResponse Int
- startQueryPlanningResponse_queryId :: Lens' StartQueryPlanningResponse Text
Creating a Request
data StartQueryPlanning Source #
See: newStartQueryPlanning smart constructor.
Constructors
| StartQueryPlanning' | |
Fields
| |
Instances
newStartQueryPlanning Source #
Arguments
| :: QueryPlanningContext | |
| -> Text | |
| -> StartQueryPlanning |
Create a value of StartQueryPlanning 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:queryPlanningContext:StartQueryPlanning', startQueryPlanning_queryPlanningContext - A structure containing information about the query plan.
$sel:queryString:StartQueryPlanning', startQueryPlanning_queryString - A PartiQL query statement used as an input to the planner service.
Request Lenses
startQueryPlanning_queryPlanningContext :: Lens' StartQueryPlanning QueryPlanningContext Source #
A structure containing information about the query plan.
startQueryPlanning_queryString :: Lens' StartQueryPlanning Text Source #
A PartiQL query statement used as an input to the planner service.
Destructuring the Response
data StartQueryPlanningResponse Source #
A structure for the output.
See: newStartQueryPlanningResponse smart constructor.
Constructors
| StartQueryPlanningResponse' | |
Fields
| |
Instances
newStartQueryPlanningResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> StartQueryPlanningResponse |
Create a value of StartQueryPlanningResponse 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:StartQueryPlanningResponse', startQueryPlanningResponse_httpStatus - The response's http status code.
$sel:queryId:StartQueryPlanningResponse', startQueryPlanningResponse_queryId - The ID of the plan query operation can be used to fetch the actual work
unit descriptors that are produced as the result of the operation. The
ID is also used to get the query state and as an input to the Execute
operation.
Response Lenses
startQueryPlanningResponse_httpStatus :: Lens' StartQueryPlanningResponse Int Source #
The response's http status code.
startQueryPlanningResponse_queryId :: Lens' StartQueryPlanningResponse Text Source #
The ID of the plan query operation can be used to fetch the actual work
unit descriptors that are produced as the result of the operation. The
ID is also used to get the query state and as an input to the Execute
operation.