start_query_execution ¶

def start_query_execution(
    self,
    query_string: "capo_athena.types.query_string.QueryString",
    *,
    config_overrides: Optional[AthenaClientConfig] = None,
    client_request_token: Optional[
        "capo_athena.types.idempotency_token.IdempotencyToken"
    ] = None,
    query_execution_context: Optional[
        "capo_athena.types.query_execution_context.QueryExecutionContext"
    ] = None,
    result_configuration: Optional[
        "capo_athena.types.result_configuration.ResultConfiguration"
    ] = None,
    work_group: Optional["capo_athena.types.work_group_name.WorkGroupName"] = None,
    execution_parameters: Optional[
        "capo_athena.types.execution_parameters.ExecutionParameters"
    ] = None,
    result_reuse_configuration: Optional[
        "capo_athena.types.result_reuse_configuration.ResultReuseConfiguration"
    ] = None,
    engine_configuration: Optional[
        "capo_athena.types.engine_configuration.EngineConfiguration"
    ] = None,
) -> "capo_athena.types.start_query_execution_output.StartQueryExecutionOutput":
    """<p>Runs the SQL query statements contained in the <code>Query</code>. Requires you to have access to the workgroup in which the query ran. Running queries against an external catalog requires <a>GetDataCatalog</a> permission to the catalog. For code samples using the Amazon Web Services SDK for Java, see <a href="http://docs.aws.amazon.com/athena/latest/ug/code-samples.html">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>

    Args:
        query_string: <p>The SQL query statements to be executed.</p>
        client_request_token: <p>A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another <code>StartQueryExecution</code> request is received, the same response is returned and another query is not created. An error is returned if a parameter, such as <code>QueryString</code>, has changed. A call to <code>StartQueryExecution</code> that uses a previous client request token returns the same <code>QueryExecutionId</code> even if the requester doesn't have permission on the tables specified in <code>QueryString</code>.</p> <important> <p>This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.</p> </important>
        query_execution_context: <p>The database within which the query executes.</p>
        result_configuration: <p>Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>
        work_group: <p>The name of the workgroup in which the query is being started.</p>
        execution_parameters: <p>A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.</p>
        result_reuse_configuration: <p>Specifies the query result reuse behavior for the query.</p>
        engine_configuration: <p>The engine configuration for the workgroup, which includes the minimum/maximum number of Data Processing Units (DPU) that queries should use when running in provisioned capacity. If not specified, Athena uses default values (Default value for min is 4 and for max is Minimum of 124 and allocated DPUs).</p> <p>To specify minimum and maximum DPU values for Capacity Reservations queries, the workgroup containing <code>EngineConfiguration</code> should have the following values: The name of the <code>Classifications</code> should be <code>athena-query-engine-properties</code>, with the only allowed properties as <code>max-dpu-count</code> and <code>min-dpu-count</code>.</p>

    Raises:
        capo_athena.errors.internal_server_exception.InternalServerException: <p>Indicates a platform issue, which may be due to a transient condition or outage.</p>
        capo_athena.errors.invalid_request_exception.InvalidRequestException: <p>Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.</p>
        capo_athena.errors.too_many_requests_exception.TooManyRequestsException: <p>Indicates that the request was throttled.</p>
        capo_athena.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_athena.types.start_query_execution_input.StartQueryExecutionInput]",
    ) -> OperationResponse[
        "capo_athena.types.start_query_execution_output.StartQueryExecutionOutput"
    ]:
        import capo_athena._operations.amazon_athena.start_query_execution

        output, http_response = (
            capo_athena._operations.amazon_athena.start_query_execution.start_query_execution(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartQueryExecution")
    )
    input_: capo_athena.types.start_query_execution_input.StartQueryExecutionInput = {
        "query_string": query_string
    }
    if client_request_token is None:
        client_request_token = str(uuid.uuid4())
    input_["client_request_token"] = client_request_token
    if query_execution_context is not None:
        input_["query_execution_context"] = query_execution_context
    if result_configuration is not None:
        input_["result_configuration"] = result_configuration
    if work_group is not None:
        input_["work_group"] = work_group
    if execution_parameters is not None:
        input_["execution_parameters"] = execution_parameters
    if result_reuse_configuration is not None:
        input_["result_reuse_configuration"] = result_reuse_configuration
    if engine_configuration is not None:
        input_["engine_configuration"] = engine_configuration

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output