Skip to content

describe_job async

describe_job(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    job_name: Optional[JobName] = None,
    job_category: Optional[JobCategory] = None,
) -> DescribeJobResponse

Returns detailed information about a job, including its current status, secondary status, configuration, and timestamps. Use SecondaryStatus for granular progress tracking and SecondaryStatusTransitions to see the full history of status changes with timestamps.

The following operations are related to DescribeJob:

  • CreateJob

  • ListJobs

  • StopJob

  • DeleteJob

Parameters:

Raises:

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py
async def describe_job(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    job_name: Optional["capo_sagemaker.types.job_name.JobName"] = None,
    job_category: Optional["capo_sagemaker.types.job_category.JobCategory"] = None,
) -> "capo_sagemaker.types.describe_job_response.DescribeJobResponse":
    """<p>Returns detailed information about a job, including its current status, secondary status, configuration, and timestamps. Use <code>SecondaryStatus</code> for granular progress tracking and <code>SecondaryStatusTransitions</code> to see the full history of status changes with timestamps.</p> <p>The following operations are related to <code>DescribeJob</code>:</p> <ul> <li> <p> <code>CreateJob</code> </p> </li> <li> <p> <code>ListJobs</code> </p> </li> <li> <p> <code>StopJob</code> </p> </li> <li> <p> <code>DeleteJob</code> </p> </li> </ul>

    Args:
        job_name: <p>The name of the job to describe.</p>
        job_category: <p>The category of the job.</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_job_request.DescribeJobRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.describe_job_response.DescribeJobResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_job

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeJob")
    )
    input_: capo_sagemaker.types.describe_job_request.DescribeJobRequest = {}
    if job_name is not None:
        input_["job_name"] = job_name
    if job_category is not None:
        input_["job_category"] = job_category

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