Amazonka.IoT.DeleteJobExecution

Deletes a job execution.

Requires permission to access the DeleteJobExecution action.

Creating a Request

data DeleteJobExecution

See: newDeleteJobExecution smart constructor.

Constructors

DeleteJobExecution'

Fields

• force :: Maybe Bool

  (Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.

  Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device 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 whose execution on a particular device will be deleted.

• thingName :: Text

  The name of the thing whose job execution will be deleted.

• executionNumber :: Integer

  The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device.

  Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.

Instances

ToHeaders DeleteJobExecution

Defined in Amazonka.IoT.DeleteJobExecution

Methods

toHeaders :: DeleteJobExecution -> [Header]

ToPath DeleteJobExecution

Defined in Amazonka.IoT.DeleteJobExecution

Methods

toPath :: DeleteJobExecution -> ByteString

ToQuery DeleteJobExecution

Defined in Amazonka.IoT.DeleteJobExecution

Methods

toQuery :: DeleteJobExecution -> QueryString

AWSRequest DeleteJobExecution

Defined in Amazonka.IoT.DeleteJobExecution

Associated Types

type AWSResponse DeleteJobExecution

Methods

request :: (Service -> Service) -> DeleteJobExecution -> Request DeleteJobExecution

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteJobExecution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteJobExecution)))

Generic DeleteJobExecution

Defined in Amazonka.IoT.DeleteJobExecution

Associated Types

type Rep DeleteJobExecution :: Type -> Type

Methods

from :: DeleteJobExecution -> Rep DeleteJobExecution x

to :: Rep DeleteJobExecution x -> DeleteJobExecution

Read DeleteJobExecution

Defined in Amazonka.IoT.DeleteJobExecution

Methods

readsPrec :: Int -> ReadS DeleteJobExecution

readList :: ReadS [DeleteJobExecution]

readPrec :: ReadPrec DeleteJobExecution

readListPrec :: ReadPrec [DeleteJobExecution]

Show DeleteJobExecution

Defined in Amazonka.IoT.DeleteJobExecution

Methods

showsPrec :: Int -> DeleteJobExecution -> ShowS

show :: DeleteJobExecution -> String

showList :: [DeleteJobExecution] -> ShowS

NFData DeleteJobExecution

Defined in Amazonka.IoT.DeleteJobExecution

Methods

rnf :: DeleteJobExecution -> ()

Eq DeleteJobExecution

Defined in Amazonka.IoT.DeleteJobExecution

Methods

(==) :: DeleteJobExecution -> DeleteJobExecution -> Bool

(/=) :: DeleteJobExecution -> DeleteJobExecution -> Bool

Hashable DeleteJobExecution

Defined in Amazonka.IoT.DeleteJobExecution

Methods

hashWithSalt :: Int -> DeleteJobExecution -> Int

hash :: DeleteJobExecution -> Int

type AWSResponse DeleteJobExecution

Defined in Amazonka.IoT.DeleteJobExecution

type AWSResponse DeleteJobExecution = DeleteJobExecutionResponse

type Rep DeleteJobExecution

Defined in Amazonka.IoT.DeleteJobExecution

type Rep DeleteJobExecution = D1 ('MetaData "DeleteJobExecution" "Amazonka.IoT.DeleteJobExecution" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DeleteJobExecution'" '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) :*: (S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "executionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)))))

newDeleteJobExecution

Arguments

:: Text

DeleteJobExecution

-> Text

DeleteJobExecution

-> Integer

DeleteJobExecution

-> DeleteJobExecution

Create a value of DeleteJobExecution 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:DeleteJobExecution', deleteJobExecution_force - (Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.

Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

DeleteJobExecution, deleteJobExecution_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.

DeleteJobExecution, deleteJobExecution_jobId - The ID of the job whose execution on a particular device will be deleted.

DeleteJobExecution, deleteJobExecution_thingName - The name of the thing whose job execution will be deleted.

DeleteJobExecution, deleteJobExecution_executionNumber - The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device.

Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.

Request Lenses

deleteJobExecution_force :: Lens' DeleteJobExecution (Maybe Bool)

(Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.

Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

deleteJobExecution_namespaceId :: Lens' DeleteJobExecution (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.

deleteJobExecution_jobId :: Lens' DeleteJobExecution Text

The ID of the job whose execution on a particular device will be deleted.

deleteJobExecution_thingName :: Lens' DeleteJobExecution Text

The name of the thing whose job execution will be deleted.

deleteJobExecution_executionNumber :: Lens' DeleteJobExecution Integer

The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device.

Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.

Destructuring the Response

data DeleteJobExecutionResponse

See: newDeleteJobExecutionResponse smart constructor.

Constructors

DeleteJobExecutionResponse'

Instances

Generic DeleteJobExecutionResponse

Defined in Amazonka.IoT.DeleteJobExecution

Associated Types

type Rep DeleteJobExecutionResponse :: Type -> Type

Methods

from :: DeleteJobExecutionResponse -> Rep DeleteJobExecutionResponse x

to :: Rep DeleteJobExecutionResponse x -> DeleteJobExecutionResponse

Read DeleteJobExecutionResponse

Defined in Amazonka.IoT.DeleteJobExecution

Methods

readsPrec :: Int -> ReadS DeleteJobExecutionResponse

readList :: ReadS [DeleteJobExecutionResponse]

readPrec :: ReadPrec DeleteJobExecutionResponse

readListPrec :: ReadPrec [DeleteJobExecutionResponse]

Show DeleteJobExecutionResponse

Defined in Amazonka.IoT.DeleteJobExecution

Methods

showsPrec :: Int -> DeleteJobExecutionResponse -> ShowS

show :: DeleteJobExecutionResponse -> String

showList :: [DeleteJobExecutionResponse] -> ShowS

NFData DeleteJobExecutionResponse

Defined in Amazonka.IoT.DeleteJobExecution

Methods

rnf :: DeleteJobExecutionResponse -> ()

Eq DeleteJobExecutionResponse

Defined in Amazonka.IoT.DeleteJobExecution

Methods

(==) :: DeleteJobExecutionResponse -> DeleteJobExecutionResponse -> Bool

(/=) :: DeleteJobExecutionResponse -> DeleteJobExecutionResponse -> Bool

type Rep DeleteJobExecutionResponse

Defined in Amazonka.IoT.DeleteJobExecution

type Rep DeleteJobExecutionResponse = D1 ('MetaData "DeleteJobExecutionResponse" "Amazonka.IoT.DeleteJobExecution" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DeleteJobExecutionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteJobExecutionResponse :: DeleteJobExecutionResponse

Create a value of DeleteJobExecutionResponse with all optional fields omitted.

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