Network.AWS.DataPipeline.SetTaskStatus

Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress.

See: AWS API Reference for SetTaskStatus.

Creating a Request

setTaskStatus

Arguments

:: Text

stsTaskId

-> TaskStatus

stsTaskStatus

-> SetTaskStatus

Creates a value of SetTaskStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• stsErrorStackTrace
• stsErrorId
• stsErrorMessage
• stsTaskId
• stsTaskStatus

data SetTaskStatus

Contains the parameters for SetTaskStatus.

See: setTaskStatus smart constructor.

Instances

Eq SetTaskStatus

Data SetTaskStatus

Read SetTaskStatus

Show SetTaskStatus

Generic SetTaskStatus

ToJSON SetTaskStatus

AWSRequest SetTaskStatus

ToPath SetTaskStatus

ToHeaders SetTaskStatus

ToQuery SetTaskStatus

Typeable * SetTaskStatus

type Rep SetTaskStatus

type Rs SetTaskStatus = SetTaskStatusResponse

Request Lenses

stsErrorStackTrace :: Lens' SetTaskStatus (Maybe Text)

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.

stsErrorId :: Lens' SetTaskStatus (Maybe Text)

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.

stsErrorMessage :: Lens' SetTaskStatus (Maybe Text)

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.

stsTaskId :: Lens' SetTaskStatus Text

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

stsTaskStatus :: Lens' SetTaskStatus TaskStatus

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

Destructuring the Response

setTaskStatusResponse

Arguments

:: Int

stsrsStatus

-> SetTaskStatusResponse

Creates a value of SetTaskStatusResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• stsrsStatus

data SetTaskStatusResponse

Contains the output of SetTaskStatus.

See: setTaskStatusResponse smart constructor.

Instances

Eq SetTaskStatusResponse

Data SetTaskStatusResponse

Read SetTaskStatusResponse

Show SetTaskStatusResponse

Generic SetTaskStatusResponse

Typeable * SetTaskStatusResponse

type Rep SetTaskStatusResponse

Response Lenses

stsrsStatus :: Lens' SetTaskStatusResponse Int

The response status code.