Skip to content

deregister_target_from_maintenance_window

deregister_target_from_maintenance_window(
    window_id: MaintenanceWindowId,
    window_target_id: MaintenanceWindowTargetId,
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    safe: Optional[Boolean] = None,
) -> DeregisterTargetFromMaintenanceWindowResult

Removes a target from a maintenance window.

Parameters:

  • window_id (MaintenanceWindowId) –

    The ID of the maintenance window the target should be removed from.

  • window_target_id (MaintenanceWindowTargetId) –

    The ID of the target definition to remove.

  • safe (Optional[Boolean], default: None ) –

    The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and doesn't deregister the target from the maintenance window.

Raises:

  • DoesNotExistException –

    Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

    For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

  • InternalServerError –

    An error occurred on the server side.

  • TargetInUseException –

    You specified the Safe option for the DeregisterTargetFromMaintenanceWindow operation, but the target is still referenced in a task.

  • UnknownServiceError –

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

Source code in docs_src/capo_ssm/_services/ssm.py
def deregister_target_from_maintenance_window(
    self,
    window_id: "capo_ssm.types.maintenance_window_id.MaintenanceWindowId",
    window_target_id: "capo_ssm.types.maintenance_window_target_id.MaintenanceWindowTargetId",
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    safe: Optional["capo_ssm.types.boolean.Boolean"] = None,
) -> "capo_ssm.types.deregister_target_from_maintenance_window_result.DeregisterTargetFromMaintenanceWindowResult":
    """<p>Removes a target from a maintenance window.</p>

    Args:
        window_id: <p>The ID of the maintenance window the target should be removed from.</p>
        window_target_id: <p>The ID of the target definition to remove.</p>
        safe: <p>The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and doesn't deregister the target from the maintenance window.</p>

    Raises:
        capo_ssm.errors.does_not_exist_exception.DoesNotExistException: <p>Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.</p> <p>For information about resource quotas in Amazon Web Services Systems Manager, see <a href="https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm">Systems Manager service quotas</a> in the <i>Amazon Web Services General Reference</i>.</p>
        capo_ssm.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_ssm.errors.target_in_use_exception.TargetInUseException: <p>You specified the <code>Safe</code> option for the DeregisterTargetFromMaintenanceWindow operation, but the target is still referenced in a task.</p>
        capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm.types.deregister_target_from_maintenance_window_request.DeregisterTargetFromMaintenanceWindowRequest]",
    ) -> OperationResponse[
        "capo_ssm.types.deregister_target_from_maintenance_window_result.DeregisterTargetFromMaintenanceWindowResult"
    ]:
        import capo_ssm._operations.amazon_ssm.deregister_target_from_maintenance_window

        output, http_response = (
            capo_ssm._operations.amazon_ssm.deregister_target_from_maintenance_window.deregister_target_from_maintenance_window(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeregisterTargetFromMaintenanceWindow")
    )
    input_: capo_ssm.types.deregister_target_from_maintenance_window_request.DeregisterTargetFromMaintenanceWindowRequest = {
        "window_id": window_id,
        "window_target_id": window_target_id,
    }
    if safe is not None:
        input_["safe"] = safe

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