Skip to content

describe_service_job

describe_service_job(
    *,
    config_overrides: Optional[BatchClientConfig] = None,
    job_id: Optional[String] = None,
) -> DescribeServiceJobResponse

The details of a service job.

Parameters:

  • job_id (Optional[String], default: None ) –

    The job ID for the service job to describe.

Raises:

  • ClientException –

    These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

  • ServerException –

    These errors are usually caused by a server issue.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_batch/_services/batch.py
def describe_service_job(
    self,
    *,
    config_overrides: Optional[BatchClientConfig] = None,
    job_id: Optional["capo_batch.types.string.String"] = None,
) -> "capo_batch.types.describe_service_job_response.DescribeServiceJobResponse":
    """<p>The details of a service job.</p>

    Args:
        job_id: <p>The job ID for the service job to describe.</p>

    Raises:
        capo_batch.errors.client_exception.ClientException: <p>These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.</p>
        capo_batch.errors.server_exception.ServerException: <p>These errors are usually caused by a server issue.</p>
        capo_batch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_batch.types.describe_service_job_request.DescribeServiceJobRequest]",
    ) -> OperationResponse[
        "capo_batch.types.describe_service_job_response.DescribeServiceJobResponse"
    ]:
        import capo_batch._operations.aws_batch_v20160810.describe_service_job

        output, http_response = (
            capo_batch._operations.aws_batch_v20160810.describe_service_job.describe_service_job(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeServiceJob")
    )
    input_: capo_batch.types.describe_service_job_request.DescribeServiceJobRequest = {}
    if job_id is not None:
        input_["job_id"] = job_id

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