NAME
Paws::IoTJobsData::UpdateJobExecution - Arguments for method UpdateJobExecution on Paws::IoTJobsData
DESCRIPTION
This class represents the parameters used for calling the method UpdateJobExecution on the AWS IoT Jobs Data Plane service. Use the attributes of this class as arguments to method UpdateJobExecution.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateJobExecution.
SYNOPSIS
my $data.jobs.iot = Paws->service('IoTJobsData');
my $UpdateJobExecutionResponse = $data . jobs . iot->UpdateJobExecution(
JobId => 'MyJobId',
Status => 'QUEUED',
ThingName => 'MyThingName',
ExecutionNumber => 1, # OPTIONAL
ExpectedVersion => 1, # OPTIONAL
IncludeJobDocument => 1, # OPTIONAL
IncludeJobExecutionState => 1, # OPTIONAL
StatusDetails => {
'MyDetailsKey' =>
'MyDetailsValue', # key: min: 1, max: 128, value: min: 1, max: 1024
}, # OPTIONAL
StepTimeoutInMinutes => 1, # OPTIONAL
);
# Results:
my $ExecutionState = $UpdateJobExecutionResponse->ExecutionState;
my $JobDocument = $UpdateJobExecutionResponse->JobDocument;
# Returns a L<Paws::IoTJobsData::UpdateJobExecutionResponse> 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/data.jobs.iot/UpdateJobExecution
ATTRIBUTES
ExecutionNumber => Int
Optional. A number that identifies a particular job execution on a particular device.
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.)
IncludeJobDocument => Bool
Optional. When set to true, the response contains the job document. The default is false.
IncludeJobExecutionState => Bool
Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.
REQUIRED JobId => Str
The unique identifier assigned to this job when it was created.
REQUIRED Status => Str
The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.
Valid values are: "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "TIMED_OUT", "REJECTED", "REMOVED", "CANCELED"
StatusDetails => Paws::IoTJobsData::DetailsMap
Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.
StepTimeoutInMinutes => Int
Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).
REQUIRED ThingName => Str
The name of the thing associated with the device.
SEE ALSO
This class forms part of Paws, documenting arguments for method UpdateJobExecution in Paws::IoTJobsData
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