Skip to content

describe_batch_inference_job async

describe_batch_inference_job(
    batch_inference_job_arn: Arn,
    *,
    config_overrides: Optional[AsyncPersonalizeClientConfig] = None,
) -> DescribeBatchInferenceJobResponse

Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.

Parameters:

  • batch_inference_job_arn (Arn) –

    The ARN of the batch inference job to describe.

Raises:

Source code in docs_src/capo_personalize/_services/async_personalize.py
async def describe_batch_inference_job(
    self,
    batch_inference_job_arn: "capo_personalize.types.arn.Arn",
    *,
    config_overrides: Optional[AsyncPersonalizeClientConfig] = None,
) -> "capo_personalize.types.describe_batch_inference_job_response.DescribeBatchInferenceJobResponse":
    """<p>Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.</p>

    Args:
        batch_inference_job_arn: <p>The ARN of the batch inference job to describe.</p>

    Raises:
        capo_personalize.errors.invalid_input_exception.InvalidInputException: <p>Provide a valid value for the field or parameter.</p>
        capo_personalize.errors.resource_not_found_exception.ResourceNotFoundException: <p>Could not find the specified resource.</p>
        capo_personalize.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_personalize.types.describe_batch_inference_job_request.DescribeBatchInferenceJobRequest]",
    ) -> AsyncOperationResponse[
        "capo_personalize.types.describe_batch_inference_job_response.DescribeBatchInferenceJobResponse"
    ]:
        import capo_personalize._operations.amazon_personalize.describe_batch_inference_job

        (
            output,
            http_response,
        ) = await capo_personalize._operations.amazon_personalize.describe_batch_inference_job.async_describe_batch_inference_job(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeBatchInferenceJob")
    )
    input_: capo_personalize.types.describe_batch_inference_job_request.DescribeBatchInferenceJobRequest = {
        "batch_inference_job_arn": batch_inference_job_arn
    }

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