Skip to content

describe_compilation_job async

describe_compilation_job(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    compilation_job_name: Optional[EntityName] = None,
) -> DescribeCompilationJobResponse

Returns information about a model compilation job.

To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

Parameters:

  • compilation_job_name (Optional[EntityName], default: None ) –

    The name of the model compilation job that you want information about.

Raises:

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py
async def describe_compilation_job(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    compilation_job_name: Optional[
        "capo_sagemaker.types.entity_name.EntityName"
    ] = None,
) -> "capo_sagemaker.types.describe_compilation_job_response.DescribeCompilationJobResponse":
    """<p>Returns information about a model compilation job.</p> <p>To create a model compilation job, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateCompilationJob.html">CreateCompilationJob</a>. To get information about multiple model compilation jobs, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListCompilationJobs.html">ListCompilationJobs</a>.</p>

    Args:
        compilation_job_name: <p>The name of the model compilation job that you want information about.</p>

    Raises:
        capo_sagemaker.errors.resource_not_found.ResourceNotFound: <p>Resource being access is not found.</p>
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sagemaker.types.describe_compilation_job_request.DescribeCompilationJobRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.describe_compilation_job_response.DescribeCompilationJobResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_compilation_job

        (
            output,
            http_response,
        ) = await capo_sagemaker._operations.sage_maker.describe_compilation_job.async_describe_compilation_job(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCompilationJob")
    )
    input_: capo_sagemaker.types.describe_compilation_job_request.DescribeCompilationJobRequest = {}
    if compilation_job_name is not None:
        input_["compilation_job_name"] = compilation_job_name

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