NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $iot = Paws->service('IoT');
    my $CancelJobResponse = $iot->CancelJob(
      JobId      => 'MyJobId',
      Comment    => 'MyComment',       # OPTIONAL
      Force      => 1,                 # OPTIONAL
      ReasonCode => 'MyReasonCode',    # OPTIONAL
    );

    # Results:
    my $Description = $CancelJobResponse->Description;
    my $JobArn      = $CancelJobResponse->JobArn;
    my $JobId       = $CancelJobResponse->JobId;

    # Returns a L<Paws::IoT::CancelJobResponse> object.

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/CancelJob

ATTRIBUTES

Comment => Str

An optional comment string describing why the job was canceled.

Force => Bool

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

REQUIRED JobId => Str

The unique identifier you assigned to this job when it was created.

ReasonCode => Str

(Optional)A reason code string that explains why the job was canceled.

SEE ALSO

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