AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SetTaskStatusInput as input to an Aws::Client method, you can use a vanilla 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.

Instance Attribute Summary collapse

Instance Attribute Details

#error_idString

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)

    If an error occurred during the task, this value specifies the error code.

#error_messageString

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)

    If an error occurred during the task, this value specifies a text description of the error.

#error_stack_traceString

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)

    If an error occurred during the task, this value specifies the stack trace associated with the error.

#task_idString

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

Returns:

  • (String)

    The ID of the task assigned to the task runner.

#task_statusString

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

Possible values:

  • FINISHED
  • FAILED
  • FALSE

Returns:

  • (String)

    If FINISHED, the task successfully completed.