Skip to content

get_quantum_task

get_quantum_task(
    quantum_task_arn: QuantumTaskArn,
    *,
    config_overrides: Optional[BraketClientConfig] = None,
    additional_attribute_names: Optional[
        QuantumTaskAdditionalAttributeNamesList
    ] = None,
) -> GetQuantumTaskResponse

Retrieves the specified quantum task.

Parameters:

  • quantum_task_arn (QuantumTaskArn) –

    The ARN of the quantum task to retrieve.

  • additional_attribute_names (Optional[QuantumTaskAdditionalAttributeNamesList], default: None ) –

    A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported.

Raises:

Source code in docs_src/capo_braket/_services/braket.py
def get_quantum_task(
    self,
    quantum_task_arn: "capo_braket.types.quantum_task_arn.QuantumTaskArn",
    *,
    config_overrides: Optional[BraketClientConfig] = None,
    additional_attribute_names: Optional[
        "capo_braket.types.quantum_task_additional_attribute_names_list.QuantumTaskAdditionalAttributeNamesList"
    ] = None,
) -> "capo_braket.types.get_quantum_task_response.GetQuantumTaskResponse":
    """<p>Retrieves the specified quantum task.</p>

    Args:
        quantum_task_arn: <p>The ARN of the quantum task to retrieve.</p>
        additional_attribute_names: <p>A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported.</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.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</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.get_quantum_task_request.GetQuantumTaskRequest]",
    ) -> OperationResponse[
        "capo_braket.types.get_quantum_task_response.GetQuantumTaskResponse"
    ]:
        import capo_braket._operations.braket.get_quantum_task

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetQuantumTask")
    )
    input_: capo_braket.types.get_quantum_task_request.GetQuantumTaskRequest = {
        "quantum_task_arn": quantum_task_arn
    }
    if additional_attribute_names is not None:
        input_["additional_attribute_names"] = additional_attribute_names

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