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

Class: Aws::DataPipeline::Types::SetTaskStatusInput

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

Overview

Note:

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

{
  task_id: "taskId", # required
  task_status: "FINISHED", # required, accepts FINISHED, FAILED, FALSE
  error_id: "string",
  error_message: "errorMessage",
  error_stack_trace: "string",
}

Contains the parameters for SetTaskStatus.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#error_id ⇒ String

If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system.

Returns:

  • (String) 


1321
1322
1323
1324
1325
1326
1327
1328
 
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1321

class SetTaskStatusInput < Struct.new(
  :task_id,
  :task_status,
  :error_id,
  :error_message,
  :error_stack_trace)
  include Aws::Structure
end

#error_message ⇒ String

If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

Returns:

  • (String) 


1321
1322
1323
1324
1325
1326
1327
1328
 
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1321

class SetTaskStatusInput < Struct.new(
  :task_id,
  :task_status,
  :error_id,
  :error_message,
  :error_stack_trace)
  include Aws::Structure
end

#error_stack_trace ⇒ String

If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

Returns:

  • (String) 


1321
1322
1323
1324
1325
1326
1327
1328
 
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1321

class SetTaskStatusInput < Struct.new(
  :task_id,
  :task_status,
  :error_id,
  :error_message,
  :error_stack_trace)
  include Aws::Structure
end

#task_id ⇒ String

The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

Returns:

  • (String) 


1321
1322
1323
1324
1325
1326
1327
1328
 
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1321

class SetTaskStatusInput < Struct.new(
  :task_id,
  :task_status,
  :error_id,
  :error_message,
  :error_stack_trace)
  include Aws::Structure
end

#task_status ⇒ String

If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.

Returns:

  • (String) 


1321
1322
1323
1324
1325
1326
1327
1328
 
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1321

class SetTaskStatusInput < Struct.new(
  :task_id,
  :task_status,
  :error_id,
  :error_message,
  :error_stack_trace)
  include Aws::Structure
end