startQueryPlanning method

Future<StartQueryPlanningResponse> startQueryPlanning({ required QueryPlanningContext queryPlanningContext, required String queryString, })

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.

May throw AccessDeniedException. May throw InternalServiceException. May throw InvalidInputException. May throw ThrottledException.

Parameter queryPlanningContext : A structure containing information about the query plan.

Parameter queryString : A PartiQL query statement used as an input to the planner service.

Implementation

Future<StartQueryPlanningResponse> startQueryPlanning({
  required QueryPlanningContext queryPlanningContext,
  required String queryString,
}) async {
  final $payload = <String, dynamic>{
    'QueryPlanningContext': queryPlanningContext,
    'QueryString': queryString,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/StartQueryPlanning',
    exceptionFnMap: _exceptionFns,
  );
  return StartQueryPlanningResponse.fromJson(response);
}