get_query_results `async` ¶

get_query_results(
    workspace_name: WorkspaceName,
    query_id: QueryId,
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    max_results: Optional[QueryMaxResults] = None,
    next_token: Optional[QueryNextToken] = None,
) -> GetQueryResultsResponse

Retrieves the paginated results of a query. Returns empty rows if the query is not yet complete.

Parameters:

workspace_name (WorkspaceName) –

The name of the workspace associated with the query.
query_id (QueryId) –

The unique identifier for the query execution.
max_results (Optional[QueryMaxResults], default: None ) –

The maximum number of results to return for each paginated request.
next_token (Optional[QueryNextToken], default: None ) –

The token to be used for the next set of paginated results.

Raises:

AccessDeniedException –

Access is denied.
InternalFailureException –

IoT SiteWise can't process your request right now. Try again later.
InvalidRequestException –

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
ResourceNotFoundException –

The requested resource can't be found.
ThrottlingException –

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.

For more information, see Quotas in the IoT SiteWise User Guide.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_iotsitewise/_services/async_io_t_site_wise.py

async def get_query_results(
    self,
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    query_id: "capo_iotsitewise.types.query_id.QueryId",
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    max_results: Optional[
        "capo_iotsitewise.types.query_max_results.QueryMaxResults"
    ] = None,
    next_token: Optional[
        "capo_iotsitewise.types.query_next_token.QueryNextToken"
    ] = None,
) -> "capo_iotsitewise.types.get_query_results_response.GetQueryResultsResponse":
    """<p>Retrieves the paginated results of a query. Returns empty rows if the query is not yet complete.</p>

    Args:
        workspace_name: <p>The name of the workspace associated with the query.</p>
        query_id: <p>The unique identifier for the query execution.</p>
        max_results: <p>The maximum number of results to return for each paginated request.</p>
        next_token: <p>The token to be used for the next set of paginated results.</p>

    Raises:
        capo_iotsitewise.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iotsitewise.types.get_query_results_request.GetQueryResultsRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotsitewise.types.get_query_results_response.GetQueryResultsResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.get_query_results

        (
            output,
            http_response,
        ) = await capo_iotsitewise._operations.aws_io_t_site_wise.get_query_results.async_get_query_results(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetQueryResults")
    )
    input_: capo_iotsitewise.types.get_query_results_request.GetQueryResultsRequest = {
        "workspace_name": workspace_name,
        "query_id": query_id,
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_query_results async ¶

get_query_results `async` ¶