Class: Aws::DataPipeline::Types::SetTaskStatusInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::DataPipeline::Types::SetTaskStatusInput
- Defined in:
- gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb
Overview
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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#error_id ⇒ String
If an error occurred during the task, this value specifies the error code.
-
#error_message ⇒ String
If an error occurred during the task, this value specifies a text description of the error.
-
#error_stack_trace ⇒ String
If an error occurred during the task, this value specifies the stack trace associated with the error.
-
#task_id ⇒ String
The ID of the task assigned to the task runner.
-
#task_status ⇒ String
If
FINISHED
, the task successfully completed.
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.
1422 1423 1424 1425 1426 1427 1428 1429 1430 |
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1422 class SetTaskStatusInput < Struct.new( :task_id, :task_status, :error_id, :error_message, :error_stack_trace) SENSITIVE = [] 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.
1422 1423 1424 1425 1426 1427 1428 1429 1430 |
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1422 class SetTaskStatusInput < Struct.new( :task_id, :task_status, :error_id, :error_message, :error_stack_trace) SENSITIVE = [] 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.
1422 1423 1424 1425 1426 1427 1428 1429 1430 |
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1422 class SetTaskStatusInput < Struct.new( :task_id, :task_status, :error_id, :error_message, :error_stack_trace) SENSITIVE = [] 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.
1422 1423 1424 1425 1426 1427 1428 1429 1430 |
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1422 class SetTaskStatusInput < Struct.new( :task_id, :task_status, :error_id, :error_message, :error_stack_trace) SENSITIVE = [] include Aws::Structure end |
#task_status ⇒ String
If FINISHED
, the task successfully completed. If FAILED
, the
task ended unsuccessfully. Preconditions use false.
1422 1423 1424 1425 1426 1427 1428 1429 1430 |
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1422 class SetTaskStatusInput < Struct.new( :task_id, :task_status, :error_id, :error_message, :error_stack_trace) SENSITIVE = [] include Aws::Structure end |