get_search_results `async` ¶

get_search_results(
    search_id: SearchId,
    workspace_name: WorkspaceName,
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    max_results: Optional[GetSearchResultsRequestMaxResultsInteger] = None,
    next_token: Optional[NextToken] = None,
) -> GetSearchResultsResponse

Retrieves the ranked results of a search, ordered by descending relevance score. Results are available only after the search has reached the SUCCEEDED status. Calling this on a search that exists but has not yet completed returns InvalidRequestException, while calling it on a search that does not exist returns ResourceNotFoundException. The response is paginated: when nextToken is present, pass it on a subsequent call to retrieve the next page.

Parameters:

search_id (SearchId) –

The identifier of the search whose results are retrieved.
workspace_name (WorkspaceName) –

The name of the workspace the search belongs to.
max_results (Optional[GetSearchResultsRequestMaxResultsInteger], default: None ) –

The maximum number of results to return in a single page. Valid range is 1 to 10,000; if omitted, a service-defined default is used.
next_token (Optional[NextToken], default: None ) –

The pagination token returned by a previous GetSearchResults call. Provide it to retrieve the next page of results; omit it to retrieve the first page.

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_search_results(
    self,
    search_id: "capo_iotsitewise.types.search_id.SearchId",
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    max_results: Optional[
        "capo_iotsitewise.types.get_search_results_request_max_results_integer.GetSearchResultsRequestMaxResultsInteger"
    ] = None,
    next_token: Optional["capo_iotsitewise.types.next_token.NextToken"] = None,
) -> "capo_iotsitewise.types.get_search_results_response.GetSearchResultsResponse":
    """<p>Retrieves the ranked results of a search, ordered by descending relevance score. Results are available only after the search has reached the <code>SUCCEEDED</code> status. Calling this on a search that exists but has not yet completed returns <code>InvalidRequestException</code>, while calling it on a search that does not exist returns <code>ResourceNotFoundException</code>. The response is paginated: when <code>nextToken</code> is present, pass it on a subsequent call to retrieve the next page.</p>

    Args:
        search_id: <p>The identifier of the search whose results are retrieved.</p>
        workspace_name: <p>The name of the workspace the search belongs to.</p>
        max_results: <p>The maximum number of results to return in a single page. Valid range is 1 to 10,000; if omitted, a service-defined default is used.</p>
        next_token: <p>The pagination token returned by a previous GetSearchResults call. Provide it to retrieve the next page of results; omit it to retrieve the first page.</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_search_results_request.GetSearchResultsRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotsitewise.types.get_search_results_response.GetSearchResultsResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.get_search_results

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetSearchResults")
    )
    input_: capo_iotsitewise.types.get_search_results_request.GetSearchResultsRequest = {
        "search_id": search_id,
        "workspace_name": workspace_name,
    }
    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_search_results async ¶

get_search_results `async` ¶