NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $iot = Paws->service('IoT');
    $iot->DeleteJob(
      JobId       => 'MyJobId',
      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/DeleteJob>

ATTRIBUTES

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

REQUIRED JobId => Str

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.

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.

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>