search_jobs ¶

search_jobs(
    filters: SearchJobsFilterList,
    *,
    config_overrides: Optional[BraketClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> SearchJobsResponse

Searches for Amazon Braket hybrid jobs that match the specified filter values.

Parameters:

next_token (Optional[str], default: None ) –

A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.
max_results (Optional[int], default: None ) –

The maximum number of results to return in the response.
filters (SearchJobsFilterList) –

Array of SearchJobsFilter objects to use when searching for hybrid jobs.

Raises:

AccessDeniedException –

You do not have sufficient permissions to perform this action.
InternalServiceException –

The request failed because of an unknown error.
ThrottlingException –

The API throttling rate limit is exceeded.
ValidationException –

The input request failed to satisfy constraints expected by Amazon Braket.
UnknownServiceError –

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

Source code in docs_src/capo_braket/_services/braket.py

def search_jobs(
    self,
    filters: "capo_braket.types.search_jobs_filter_list.SearchJobsFilterList",
    *,
    config_overrides: Optional[BraketClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> "capo_braket.types.search_jobs_response.SearchJobsResponse":
    """<p>Searches for Amazon Braket hybrid jobs that match the specified filter values.</p>

    Args:
        next_token: <p>A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.</p>
        max_results: <p>The maximum number of results to return in the response.</p>
        filters: <p>Array of SearchJobsFilter objects to use when searching for hybrid jobs.</p>

    Raises:
        capo_braket.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
        capo_braket.errors.internal_service_exception.InternalServiceException: <p>The request failed because of an unknown error.</p>
        capo_braket.errors.throttling_exception.ThrottlingException: <p>The API throttling rate limit is exceeded.</p>
        capo_braket.errors.validation_exception.ValidationException: <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
        capo_braket.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_braket.types.search_jobs_request.SearchJobsRequest]",
    ) -> OperationResponse[
        "capo_braket.types.search_jobs_response.SearchJobsResponse"
    ]:
        import capo_braket._operations.braket.search_jobs

        output, http_response = (
            capo_braket._operations.braket.search_jobs.search_jobs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SearchJobs")
    )
    input_: capo_braket.types.search_jobs_request.SearchJobsRequest = {
        "filters": filters
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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