{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.IoT.DeleteJob -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Deletes a job and its related job executions. -- -- Deleting a job may take time, depending on the number of job executions -- created for the job and various other factors. While the job is being -- deleted, the status of the job will be shown as -- \"DELETION_IN_PROGRESS\". Attempting to delete or cancel a job whose -- status is already \"DELETION_IN_PROGRESS\" will result in an error. -- -- Only 10 jobs may have status \"DELETION_IN_PROGRESS\" at the same time, -- or a LimitExceededException will occur. -- -- Requires permission to access the -- -- action. module Amazonka.IoT.DeleteJob ( -- * Creating a Request DeleteJob (..), newDeleteJob, -- * Request Lenses deleteJob_force, deleteJob_namespaceId, deleteJob_jobId, -- * Destructuring the Response DeleteJobResponse (..), newDeleteJobResponse, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import Amazonka.IoT.Types import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newDeleteJob' smart constructor. data DeleteJob = DeleteJob' { -- | (Optional) When true, you can delete a job which is \"IN_PROGRESS\". -- Otherwise, you can only delete a job which is in a terminal state -- (\"COMPLETED\" or \"CANCELED\") or an exception will occur. The default -- is false. -- -- Deleting a job which is \"IN_PROGRESS\", will cause a device which is -- executing the job to be unable to access job information or update the -- job execution status. Use caution and ensure that each device executing -- a job which is deleted is able to recover to a valid state. force :: Prelude.Maybe Prelude.Bool, -- | The namespace used to indicate that a job is a customer-managed job. -- -- When you specify a value for this parameter, Amazon Web Services IoT -- Core sends jobs notifications to MQTT topics that contain the value in -- the following format. -- -- @$aws\/things\/@/@THING_NAME@/@\/jobs\/@/@JOB_ID@/@\/notify-namespace-@/@NAMESPACE_ID@/@\/@ -- -- The @namespaceId@ feature is in public preview. namespaceId :: Prelude.Maybe Prelude.Text, -- | The ID of the job to be deleted. -- -- After a job deletion is completed, you may reuse this jobId when you -- create a new job. However, this is not recommended, and you must ensure -- that your devices are not using the jobId to refer to the deleted job. jobId :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DeleteJob' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'force', 'deleteJob_force' - (Optional) When true, you can delete a job which is \"IN_PROGRESS\". -- Otherwise, you can only delete a job which is in a terminal state -- (\"COMPLETED\" or \"CANCELED\") or an exception will occur. The default -- is false. -- -- Deleting a job which is \"IN_PROGRESS\", will cause a device which is -- executing the job to be unable to access job information or update the -- job execution status. Use caution and ensure that each device executing -- a job which is deleted is able to recover to a valid state. -- -- 'namespaceId', 'deleteJob_namespaceId' - The namespace used to indicate that a job is a customer-managed job. -- -- When you specify a value for this parameter, Amazon Web Services IoT -- Core sends jobs notifications to MQTT topics that contain the value in -- the following format. -- -- @$aws\/things\/@/@THING_NAME@/@\/jobs\/@/@JOB_ID@/@\/notify-namespace-@/@NAMESPACE_ID@/@\/@ -- -- The @namespaceId@ feature is in public preview. -- -- 'jobId', 'deleteJob_jobId' - The ID of the job to be deleted. -- -- After a job deletion is completed, you may reuse this jobId when you -- create a new job. However, this is not recommended, and you must ensure -- that your devices are not using the jobId to refer to the deleted job. newDeleteJob :: -- | 'jobId' Prelude.Text -> DeleteJob newDeleteJob pJobId_ = DeleteJob' { force = Prelude.Nothing, namespaceId = Prelude.Nothing, jobId = pJobId_ } -- | (Optional) When true, you can delete a job which is \"IN_PROGRESS\". -- Otherwise, you can only delete a job which is in a terminal state -- (\"COMPLETED\" or \"CANCELED\") or an exception will occur. The default -- is false. -- -- Deleting a job which is \"IN_PROGRESS\", will cause a device which is -- executing the job to be unable to access job information or update the -- job execution status. Use caution and ensure that each device executing -- a job which is deleted is able to recover to a valid state. deleteJob_force :: Lens.Lens' DeleteJob (Prelude.Maybe Prelude.Bool) deleteJob_force = Lens.lens (\DeleteJob' {force} -> force) (\s@DeleteJob' {} a -> s {force = a} :: DeleteJob) -- | The namespace used to indicate that a job is a customer-managed job. -- -- When you specify a value for this parameter, Amazon Web Services IoT -- Core sends jobs notifications to MQTT topics that contain the value in -- the following format. -- -- @$aws\/things\/@/@THING_NAME@/@\/jobs\/@/@JOB_ID@/@\/notify-namespace-@/@NAMESPACE_ID@/@\/@ -- -- The @namespaceId@ feature is in public preview. deleteJob_namespaceId :: Lens.Lens' DeleteJob (Prelude.Maybe Prelude.Text) deleteJob_namespaceId = Lens.lens (\DeleteJob' {namespaceId} -> namespaceId) (\s@DeleteJob' {} a -> s {namespaceId = a} :: DeleteJob) -- | The ID of the job to be deleted. -- -- After a job deletion is completed, you may reuse this jobId when you -- create a new job. However, this is not recommended, and you must ensure -- that your devices are not using the jobId to refer to the deleted job. deleteJob_jobId :: Lens.Lens' DeleteJob Prelude.Text deleteJob_jobId = Lens.lens (\DeleteJob' {jobId} -> jobId) (\s@DeleteJob' {} a -> s {jobId = a} :: DeleteJob) instance Core.AWSRequest DeleteJob where type AWSResponse DeleteJob = DeleteJobResponse request overrides = Request.delete (overrides defaultService) response = Response.receiveNull DeleteJobResponse' instance Prelude.Hashable DeleteJob where hashWithSalt _salt DeleteJob' {..} = _salt `Prelude.hashWithSalt` force `Prelude.hashWithSalt` namespaceId `Prelude.hashWithSalt` jobId instance Prelude.NFData DeleteJob where rnf DeleteJob' {..} = Prelude.rnf force `Prelude.seq` Prelude.rnf namespaceId `Prelude.seq` Prelude.rnf jobId instance Data.ToHeaders DeleteJob where toHeaders = Prelude.const Prelude.mempty instance Data.ToPath DeleteJob where toPath DeleteJob' {..} = Prelude.mconcat ["/jobs/", Data.toBS jobId] instance Data.ToQuery DeleteJob where toQuery DeleteJob' {..} = Prelude.mconcat [ "force" Data.=: force, "namespaceId" Data.=: namespaceId ] -- | /See:/ 'newDeleteJobResponse' smart constructor. data DeleteJobResponse = DeleteJobResponse' { } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DeleteJobResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. newDeleteJobResponse :: DeleteJobResponse newDeleteJobResponse = DeleteJobResponse' instance Prelude.NFData DeleteJobResponse where rnf _ = ()