deregister_task_definition ¶

def deregister_task_definition(
    self,
    task_definition: "capo_ecs.types.string.String",
    *,
    config_overrides: Optional[ECSClientConfig] = None,
) -> "capo_ecs.types.deregister_task_definition_response.DeregisterTaskDefinitionResponse":
    """<p>Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as <code>INACTIVE</code>. Existing tasks and services that reference an <code>INACTIVE</code> task definition continue to run without disruption. Existing services that reference an <code>INACTIVE</code> task definition can still scale up or down by modifying the service's desired count. If you want to delete a task definition revision, you must first deregister the task definition revision.</p> <p>You can't use an <code>INACTIVE</code> task definition to run new tasks or create new services, and you can't update an existing service to reference an <code>INACTIVE</code> task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.</p> <note> <p>At this time, <code>INACTIVE</code> task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future. We don't recommend that you rely on <code>INACTIVE</code> task definitions persisting beyond the lifecycle of any associated tasks and services.</p> </note> <p>You must deregister a task definition revision before you delete it. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteTaskDefinitions.html">DeleteTaskDefinitions</a>.</p>

    Args:
        task_definition: <p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a <code>revision</code>.</p>

    Raises:
        capo_ecs.errors.access_denied_exception.AccessDeniedException: <p>You don't have authorization to perform the requested action.</p>
        capo_ecs.errors.client_exception.ClientException: <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
        capo_ecs.errors.invalid_parameter_exception.InvalidParameterException: <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
        capo_ecs.errors.server_exception.ServerException: <p>These errors are usually caused by a server issue.</p>
        capo_ecs.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To deregister a revision of a task definition
        This example deregisters the first revision of the fargate-task task definition

        >>> client.deregister_task_definition(task_definition='fargate-task:1')
    """

    def _handler(
        req: "OperationRequest[capo_ecs.types.deregister_task_definition_request.DeregisterTaskDefinitionRequest]",
    ) -> OperationResponse[
        "capo_ecs.types.deregister_task_definition_response.DeregisterTaskDefinitionResponse"
    ]:
        import capo_ecs._operations.amazon_ec2_container_service_v20141113.deregister_task_definition

        output, http_response = (
            capo_ecs._operations.amazon_ec2_container_service_v20141113.deregister_task_definition.deregister_task_definition(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_ecs.types.deregister_task_definition_response.DeregisterTaskDefinitionResponse",
    ) -> dict[str, Any]:
        import capo_ecs.types.deregister_task_definition_response

        return capo_ecs.types.deregister_task_definition_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DeregisterTaskDefinition", redact_output=_redact_output),
    )
    input_: capo_ecs.types.deregister_task_definition_request.DeregisterTaskDefinitionRequest = {
        "task_definition": task_definition
    }

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