Skip to content

search_quantum_tasks 

search_quantum_tasks(
    filters: SearchQuantumTasksFilterList,
    *,
    config_overrides: Optional[BraketClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> SearchQuantumTasksResponse

Searches for tasks 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 ) –

    Maximum number of results to return in the response.

  • filters (SearchQuantumTasksFilterList) –

    Array of SearchQuantumTasksFilter objects to use when searching for quantum tasks.

Raises:

Source code in docs_src/capo_braket/_services/braket.py 
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
def search_quantum_tasks(
    self,
    filters: "capo_braket.types.search_quantum_tasks_filter_list.SearchQuantumTasksFilterList",
    *,
    config_overrides: Optional[BraketClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
) -> "capo_braket.types.search_quantum_tasks_response.SearchQuantumTasksResponse":
    """<p>Searches for tasks 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>Maximum number of results to return in the response.</p>
        filters: <p>Array of <code>SearchQuantumTasksFilter</code> objects to use when searching for quantum tasks.</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_quantum_tasks_request.SearchQuantumTasksRequest]",
    ) -> OperationResponse[
        "capo_braket.types.search_quantum_tasks_response.SearchQuantumTasksResponse"
    ]:
        import capo_braket._operations.braket.search_quantum_tasks

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SearchQuantumTasks")
    )
    input_: capo_braket.types.search_quantum_tasks_request.SearchQuantumTasksRequest = {
        "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