Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoT.DeleteJob

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

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 DeleteJob action.

Synopsis

data DeleteJob = DeleteJob' {
- force :: Maybe Bool
- namespaceId :: Maybe Text
- jobId :: Text
}
newDeleteJob :: Text -> DeleteJob
deleteJob_force :: Lens' DeleteJob (Maybe Bool)
deleteJob_namespaceId :: Lens' DeleteJob (Maybe Text)
deleteJob_jobId :: Lens' DeleteJob Text
data DeleteJobResponse = DeleteJobResponse' {
}
newDeleteJobResponse :: DeleteJobResponse

Creating a Request

data DeleteJob Source #

See: newDeleteJob smart constructor.

Constructors

DeleteJob'

Fields

force :: Maybe Bool
(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 :: Maybe Text
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 :: 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.

Instances

Instances details

Eq DeleteJob Source #
Instance details Defined in Amazonka.IoT.DeleteJob Methods (==) :: DeleteJob -> DeleteJob -> Bool # (/=) :: DeleteJob -> DeleteJob -> Bool #
Read DeleteJob Source #
Instance details Defined in Amazonka.IoT.DeleteJob Methods readsPrec :: Int -> ReadS DeleteJob # readList :: ReadS [DeleteJob] # readPrec :: ReadPrec DeleteJob # readListPrec :: ReadPrec [DeleteJob] #
Show DeleteJob Source #
Instance details Defined in Amazonka.IoT.DeleteJob Methods showsPrec :: Int -> DeleteJob -> ShowS # show :: DeleteJob -> String # showList :: [DeleteJob] -> ShowS #
Generic DeleteJob Source #
Instance details Defined in Amazonka.IoT.DeleteJob Associated Types type Rep DeleteJob :: Type -> Type # Methods from :: DeleteJob -> Rep DeleteJob x # to :: Rep DeleteJob x -> DeleteJob #
NFData DeleteJob Source #
Instance details Defined in Amazonka.IoT.DeleteJob Methods rnf :: DeleteJob -> () #
Hashable DeleteJob Source #
Instance details Defined in Amazonka.IoT.DeleteJob Methods hashWithSalt :: Int -> DeleteJob -> Int # hash :: DeleteJob -> Int #
AWSRequest DeleteJob Source #
Instance details Defined in Amazonka.IoT.DeleteJob Associated Types type AWSResponse DeleteJob # Methods request :: DeleteJob -> Request DeleteJob # response :: MonadResource m => Logger -> Service -> Proxy DeleteJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteJob))) #
ToHeaders DeleteJob Source #
Instance details Defined in Amazonka.IoT.DeleteJob Methods toHeaders :: DeleteJob -> [Header] #
ToPath DeleteJob Source #
Instance details Defined in Amazonka.IoT.DeleteJob Methods toPath :: DeleteJob -> ByteString #
ToQuery DeleteJob Source #
Instance details Defined in Amazonka.IoT.DeleteJob Methods toQuery :: DeleteJob -> QueryString #
type Rep DeleteJob Source #
Instance details Defined in Amazonka.IoT.DeleteJob type Rep DeleteJob = D1 ('MetaData "DeleteJob" "Amazonka.IoT.DeleteJob" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "DeleteJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "force") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "namespaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DeleteJob Source #
Instance details Defined in Amazonka.IoT.DeleteJob type AWSResponse DeleteJob = DeleteJobResponse

newDeleteJob Source #

Arguments

:: Text	`$sel:jobId:DeleteJob'`
-> DeleteJob

Create a value of DeleteJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:force:DeleteJob', 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.

$sel:namespaceId:DeleteJob', 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.

$sel:jobId:DeleteJob', 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.

Request Lenses

deleteJob_force :: Lens' DeleteJob (Maybe Bool) Source #

(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_namespaceId :: Lens' DeleteJob (Maybe Text) Source #

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_jobId :: Lens' DeleteJob Text Source #

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.

Destructuring the Response

data DeleteJobResponse Source #

See: newDeleteJobResponse smart constructor.

Constructors

DeleteJobResponse'

Instances

Instances details

Eq DeleteJobResponse Source #
Instance details Defined in Amazonka.IoT.DeleteJob Methods (==) :: DeleteJobResponse -> DeleteJobResponse -> Bool # (/=) :: DeleteJobResponse -> DeleteJobResponse -> Bool #
Read DeleteJobResponse Source #
Instance details Defined in Amazonka.IoT.DeleteJob Methods readsPrec :: Int -> ReadS DeleteJobResponse # readList :: ReadS [DeleteJobResponse] # readPrec :: ReadPrec DeleteJobResponse # readListPrec :: ReadPrec [DeleteJobResponse] #
Show DeleteJobResponse Source #
Instance details Defined in Amazonka.IoT.DeleteJob Methods showsPrec :: Int -> DeleteJobResponse -> ShowS # show :: DeleteJobResponse -> String # showList :: [DeleteJobResponse] -> ShowS #
Generic DeleteJobResponse Source #
Instance details Defined in Amazonka.IoT.DeleteJob Associated Types type Rep DeleteJobResponse :: Type -> Type # Methods from :: DeleteJobResponse -> Rep DeleteJobResponse x # to :: Rep DeleteJobResponse x -> DeleteJobResponse #
NFData DeleteJobResponse Source #
Instance details Defined in Amazonka.IoT.DeleteJob Methods rnf :: DeleteJobResponse -> () #
type Rep DeleteJobResponse Source #
Instance details Defined in Amazonka.IoT.DeleteJob type Rep DeleteJobResponse = D1 ('MetaData "DeleteJobResponse" "Amazonka.IoT.DeleteJob" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "DeleteJobResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteJobResponse :: DeleteJobResponse Source #

Create a value of DeleteJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.