/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::IoT::DeleteJobExecution

NAME

Paws::IoT::DeleteJobExecution - Arguments for method DeleteJobExecution on Paws::IoT

DESCRIPTION

This class represents the parameters used for calling the method DeleteJobExecution on the AWS IoT service. Use the attributes of this class as arguments to method DeleteJobExecution.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteJobExecution.

SYNOPSIS

my $iot = Paws->service('IoT');
$iot->DeleteJobExecution(
  ExecutionNumber => 1,
  JobId           => 'MyJobId',
  ThingName       => 'MyThingName',
  Force           => 1,                  # OPTIONAL
  NamespaceId     => 'MyNamespaceId',    # OPTIONAL
);

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/iot/DeleteJobExecution

ATTRIBUTES

REQUIRED ExecutionNumber => Int

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.

Force => 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.

REQUIRED JobId => Str

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

NamespaceId => Str

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS 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.

REQUIRED ThingName => Str

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

SEE ALSO

This class forms part of Paws, documenting arguments for method DeleteJobExecution in Paws::IoT

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues