deregister_job_definition ¶

deregister_job_definition(
    *,
    config_overrides: Optional[BatchClientConfig] = None,
    job_definition: Optional[String] = None,
) -> DeregisterJobDefinitionResponse

Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.

Parameters:

job_definition (Optional[String], default: None ) –

The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition to deregister.

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.

Examples:

To deregister a job definition This example deregisters a job definition called sleep10.

>>> client.deregister_job_definition(job_definition='sleep10')

Source code in docs_src/capo_batch/_services/batch.py

def deregister_job_definition(
    self,
    *,
    config_overrides: Optional[BatchClientConfig] = None,
    job_definition: Optional["capo_batch.types.string.String"] = None,
) -> "capo_batch.types.deregister_job_definition_response.DeregisterJobDefinitionResponse":
    """<p>Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.</p>

    Args:
        job_definition: <p>The name and revision (<code>name:revision</code>) or full Amazon Resource Name (ARN) of the job definition to deregister.</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.

    Examples:
        To deregister a job definition
        This example deregisters a job definition called sleep10.

        >>> client.deregister_job_definition(job_definition='sleep10')
    """

    def _handler(
        req: "OperationRequest[capo_batch.types.deregister_job_definition_request.DeregisterJobDefinitionRequest]",
    ) -> OperationResponse[
        "capo_batch.types.deregister_job_definition_response.DeregisterJobDefinitionResponse"
    ]:
        import capo_batch._operations.aws_batch_v20160810.deregister_job_definition

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeregisterJobDefinition")
    )
    input_: capo_batch.types.deregister_job_definition_request.DeregisterJobDefinitionRequest = {}
    if job_definition is not None:
        input_["job_definition"] = job_definition

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