NAME

Paws::IoT::Job

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::IoT::Job object:

  $service_obj->Method(Att1 => { AbortConfig => $value, ..., TimeoutConfig => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::IoT::Job object:

  $result = $service_obj->Method(...);
  $result->Att1->AbortConfig

DESCRIPTION

The "Job" object contains details about a job.

ATTRIBUTES

AbortConfig => Paws::IoT::AbortConfig

Configuration for criteria to abort the job.

Comment => Str

If the job was updated, describes the reason for the update.

CompletedAt => Str

The time, in seconds since the epoch, when the job was completed.

CreatedAt => Str

The time, in seconds since the epoch, when the job was created.

ForceCanceled => Bool

Will be "true" if the job was canceled with the optional "force" parameter set to "true".

JobArn => Str

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

JobExecutionsRolloutConfig => Paws::IoT::JobExecutionsRolloutConfig

Allows you to create a staged rollout of a job.

JobId => Str

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

JobProcessDetails => Paws::IoT::JobProcessDetails

Details about the job process.

JobTemplateArn => Str

The ARN of the job template used to create the job.

LastUpdatedAt => Str

The time, in seconds since the epoch, when the job was last updated.

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.

PresignedUrlConfig => Paws::IoT::PresignedUrlConfig

Configuration for pre-signed S3 URLs.

ReasonCode => Str

If the job was updated, provides the reason code for the update.

Status => Str

The status of the job, one of "IN_PROGRESS", "CANCELED", "DELETION_IN_PROGRESS" or "COMPLETED".

Targets => ArrayRef[Str|Undef]

A list of IoT things and thing groups to which the job should be sent.

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

TimeoutConfig => Paws::IoT::TimeoutConfig

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to "IN_PROGRESS". If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to "TIMED_OUT".

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>