NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $iot = Paws->service('IoT');
    $iot->CancelJobExecution(
      JobId           => 'MyJobId',
      ThingName       => 'MyThingName',
      ExpectedVersion => 1,               # OPTIONAL
      Force           => 1,               # OPTIONAL
      StatusDetails   => {
        'MyDetailsKey' =>
          'MyDetailsValue',               # key: min: 1, max: 128, value: min: 1
      },    # 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/CancelJobExecution

ATTRIBUTES

ExpectedVersion => Int

(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

Force => Bool

(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to 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 to be canceled.

StatusDetails => Paws::IoT::DetailsMap

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

REQUIRED ThingName => Str

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

SEE ALSO

This class forms part of Paws, documenting arguments for method CancelJobExecution 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