start_query ¶

def start_query(
    self,
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    query_statement: "capo_iotsitewise.types.query_string.QueryString",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    client_token: Optional[
        "capo_iotsitewise.types.client_token.ClientToken"
    ] = None,
) -> "capo_iotsitewise.types.start_query_response.StartQueryResponse":
    """<p>Starts an asynchronous SQL query against workspace telemetry, annotations, data segment, and dataset data.</p>

    Args:
        client_token: <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
        workspace_name: <p>The name of the workspace to query.</p>
        query_statement: <p>The SQL query to execute against the workspace telemetry, annotations, data segment, and dataset data.</p>

    Raises:
        capo_iotsitewise.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_iotsitewise.errors.conflicting_operation_exception.ConflictingOperationException: <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</p>
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iotsitewise.types.start_query_request.StartQueryRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.start_query_response.StartQueryResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.start_query

        output, http_response = (
            capo_iotsitewise._operations.aws_io_t_site_wise.start_query.start_query(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_iotsitewise.types.start_query_request.StartQueryRequest",
    ) -> dict[str, Any]:
        import capo_iotsitewise.types.start_query_request

        return capo_iotsitewise.types.start_query_request.redact_sensitive(input_)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartQuery", redact_input=_redact_input)
    )
    input_: capo_iotsitewise.types.start_query_request.StartQueryRequest = {
        "workspace_name": workspace_name,
        "query_statement": query_statement,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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