You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::IoTJobsDataPlane::Types::UpdateJobExecutionRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb

Overview

Note:

When making an API call, you may pass UpdateJobExecutionRequest data as a hash:

{
  job_id: "JobId", # required
  thing_name: "ThingName", # required
  status: "QUEUED", # required, accepts QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, REJECTED, REMOVED, CANCELED
  status_details: {
    "DetailsKey" => "DetailsValue",
  },
  expected_version: 1,
  include_job_execution_state: false,
  include_job_document: false,
  execution_number: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#execution_numberInteger

Optional. A number that identifies a particular job execution on a particular device.

Returns:

  • (Integer)


314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 314

class UpdateJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :status,
  :status_details,
  :expected_version,
  :include_job_execution_state,
  :include_job_document,
  :execution_number)
  include Aws::Structure
end

#expected_versionInteger

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.)

Returns:

  • (Integer)


314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 314

class UpdateJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :status,
  :status_details,
  :expected_version,
  :include_job_execution_state,
  :include_job_document,
  :execution_number)
  include Aws::Structure
end

#include_job_documentBoolean

Optional. When set to true, the response contains the job document. The default is false.

Returns:

  • (Boolean)


314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 314

class UpdateJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :status,
  :status_details,
  :expected_version,
  :include_job_execution_state,
  :include_job_document,
  :execution_number)
  include Aws::Structure
end

#include_job_execution_stateBoolean

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

Returns:

  • (Boolean)


314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 314

class UpdateJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :status,
  :status_details,
  :expected_version,
  :include_job_execution_state,
  :include_job_document,
  :execution_number)
  include Aws::Structure
end

#job_idString

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

Returns:

  • (String)


314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 314

class UpdateJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :status,
  :status_details,
  :expected_version,
  :include_job_execution_state,
  :include_job_document,
  :execution_number)
  include Aws::Structure
end

#statusString

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

Returns:

  • (String)


314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 314

class UpdateJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :status,
  :status_details,
  :expected_version,
  :include_job_execution_state,
  :include_job_document,
  :execution_number)
  include Aws::Structure
end

#status_detailsHash<String,String>

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

Returns:

  • (Hash<String,String>)


314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 314

class UpdateJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :status,
  :status_details,
  :expected_version,
  :include_job_execution_state,
  :include_job_document,
  :execution_number)
  include Aws::Structure
end

#thing_nameString

The name of the thing associated with the device.

Returns:

  • (String)


314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/types.rb', line 314

class UpdateJobExecutionRequest < Struct.new(
  :job_id,
  :thing_name,
  :status,
  :status_details,
  :expected_version,
  :include_job_execution_state,
  :include_job_document,
  :execution_number)
  include Aws::Structure
end