libZSservicesZSamazonka-iotZSamazonka-iot
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoT.DeleteJobExecution

Description

Deletes a job execution.

Requires permission to access the DeleteJobExecution action.

Synopsis

Creating a Request

data DeleteJobExecution Source #

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

Instances details
Eq DeleteJobExecution Source # 
Instance details

Defined in Amazonka.IoT.DeleteJobExecution

Methods

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

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

Read DeleteJobExecution Source # 
Instance details

Defined in Amazonka.IoT.DeleteJobExecution

Methods

readsPrec :: Int -> ReadS DeleteJobExecution #

readList :: ReadS [DeleteJobExecution] #

readPrec :: ReadPrec DeleteJobExecution #

readListPrec :: ReadPrec [DeleteJobExecution] #

Show DeleteJobExecution Source # 
Instance details

Defined in Amazonka.IoT.DeleteJobExecution

Methods

showsPrec :: Int -> DeleteJobExecution -> ShowS #

show :: DeleteJobExecution -> String #

showList :: [DeleteJobExecution] -> ShowS #

Generic DeleteJobExecution Source # 
Instance details

Defined in Amazonka.IoT.DeleteJobExecution

Associated Types

type Rep DeleteJobExecution :: Type -> Type #

Methods

from :: DeleteJobExecution -> Rep DeleteJobExecution x #

to :: Rep DeleteJobExecution x -> DeleteJobExecution #

NFData DeleteJobExecution Source # 
Instance details

Defined in Amazonka.IoT.DeleteJobExecution

Methods

rnf :: DeleteJobExecution -> () #

Hashable DeleteJobExecution Source # 
Instance details

Defined in Amazonka.IoT.DeleteJobExecution

Methods

hashWithSalt :: Int -> DeleteJobExecution -> Int #

hash :: DeleteJobExecution -> Int #

AWSRequest DeleteJobExecution Source # 
Instance details

Defined in Amazonka.IoT.DeleteJobExecution

Associated Types

type AWSResponse DeleteJobExecution #

Methods

request :: DeleteJobExecution -> Request DeleteJobExecution #

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

ToHeaders DeleteJobExecution Source # 
Instance details

Defined in Amazonka.IoT.DeleteJobExecution

Methods

toHeaders :: DeleteJobExecution -> [Header] #

ToPath DeleteJobExecution Source # 
Instance details

Defined in Amazonka.IoT.DeleteJobExecution

Methods

toPath :: DeleteJobExecution -> ByteString #

ToQuery DeleteJobExecution Source # 
Instance details

Defined in Amazonka.IoT.DeleteJobExecution

Methods

toQuery :: DeleteJobExecution -> QueryString #

type Rep DeleteJobExecution Source # 
Instance details

Defined in Amazonka.IoT.DeleteJobExecution

type Rep DeleteJobExecution = D1 ('MetaData "DeleteJobExecution" "Amazonka.IoT.DeleteJobExecution" "libZSservicesZSamazonka-iotZSamazonka-iot" '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)))))
type AWSResponse DeleteJobExecution Source # 
Instance details

Defined in Amazonka.IoT.DeleteJobExecution

type AWSResponse DeleteJobExecution = DeleteJobExecutionResponse

newDeleteJobExecution Source #

Arguments

:: Text

$sel:jobId:DeleteJobExecution'

-> Text

$sel:thingName:DeleteJobExecution'

-> Integer

$sel:executionNumber: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.

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

$sel:jobId:DeleteJobExecution', deleteJobExecution_jobId - The ID of the job whose execution on a particular device will be deleted.

$sel:thingName:DeleteJobExecution', deleteJobExecution_thingName - The name of the thing whose job execution will be deleted.

$sel:executionNumber: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) Source #

(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) 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.

deleteJobExecution_jobId :: Lens' DeleteJobExecution Text Source #

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

deleteJobExecution_thingName :: Lens' DeleteJobExecution Text Source #

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

deleteJobExecution_executionNumber :: Lens' DeleteJobExecution Integer Source #

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 Source #

See: newDeleteJobExecutionResponse smart constructor.

Constructors

DeleteJobExecutionResponse' 

Instances

Instances details
Eq DeleteJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoT.DeleteJobExecution

Methods

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

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

Read DeleteJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoT.DeleteJobExecution

Methods

readsPrec :: Int -> ReadS DeleteJobExecutionResponse #

readList :: ReadS [DeleteJobExecutionResponse] #

readPrec :: ReadPrec DeleteJobExecutionResponse #

readListPrec :: ReadPrec [DeleteJobExecutionResponse] #

Show DeleteJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoT.DeleteJobExecution

Methods

showsPrec :: Int -> DeleteJobExecutionResponse -> ShowS #

show :: DeleteJobExecutionResponse -> String #

showList :: [DeleteJobExecutionResponse] -> ShowS #

Generic DeleteJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoT.DeleteJobExecution

Associated Types

type Rep DeleteJobExecutionResponse :: Type -> Type #

Methods

from :: DeleteJobExecutionResponse -> Rep DeleteJobExecutionResponse x #

to :: Rep DeleteJobExecutionResponse x -> DeleteJobExecutionResponse #

NFData DeleteJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoT.DeleteJobExecution

Methods

rnf :: DeleteJobExecutionResponse -> () #

type Rep DeleteJobExecutionResponse Source # 
Instance details

Defined in Amazonka.IoT.DeleteJobExecution

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

newDeleteJobExecutionResponse :: DeleteJobExecutionResponse Source #

Create a value of DeleteJobExecutionResponse with all optional fields omitted.

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