Skip to content

get_job async

get_job(
    job_arn: JobArn,
    *,
    config_overrides: Optional[AsyncBraketClientConfig] = None,
    additional_attribute_names: Optional[HybridJobAdditionalAttributeNamesList] = None,
) -> GetJobResponse

Retrieves the specified Amazon Braket hybrid job.

Parameters:

  • job_arn (JobArn) –

    The ARN of the hybrid job to retrieve.

  • additional_attribute_names (Optional[HybridJobAdditionalAttributeNamesList], 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/async_braket.py
async def get_job(
    self,
    job_arn: "capo_braket.types.job_arn.JobArn",
    *,
    config_overrides: Optional[AsyncBraketClientConfig] = None,
    additional_attribute_names: Optional[
        "capo_braket.types.hybrid_job_additional_attribute_names_list.HybridJobAdditionalAttributeNamesList"
    ] = None,
) -> "capo_braket.types.get_job_response.GetJobResponse":
    """<p>Retrieves the specified Amazon Braket hybrid job.</p>

    Args:
        job_arn: <p>The ARN of the hybrid job 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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_braket.types.get_job_request.GetJobRequest]",
    ) -> AsyncOperationResponse[
        "capo_braket.types.get_job_response.GetJobResponse"
    ]:
        import capo_braket._operations.braket.get_job

        (
            output,
            http_response,
        ) = await capo_braket._operations.braket.get_job.async_get_job(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetJob")
    )
    input_: capo_braket.types.get_job_request.GetJobRequest = {"job_arn": job_arn}
    if additional_attribute_names is not None:
        input_["additional_attribute_names"] = additional_attribute_names

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