libZSservicesZSamazonka-datapipelineZSamazonka-datapipeline
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DataPipeline.SetTaskStatus

Description

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.

Synopsis

Creating a Request

data SetTaskStatus Source #

Contains the parameters for SetTaskStatus.

See: newSetTaskStatus smart constructor.

Constructors

SetTaskStatus' 

Fields

  • errorStackTrace :: 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.

  • errorId :: 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.

  • errorMessage :: 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.

  • taskId :: Text

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

  • taskStatus :: TaskStatus

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

Instances

Instances details
Eq SetTaskStatus Source # 
Instance details

Defined in Amazonka.DataPipeline.SetTaskStatus

Methods

(==) :: SetTaskStatus -> SetTaskStatus -> Bool #

(/=) :: SetTaskStatus -> SetTaskStatus -> Bool #

Read SetTaskStatus Source # 
Instance details

Defined in Amazonka.DataPipeline.SetTaskStatus

Methods

readsPrec :: Int -> ReadS SetTaskStatus #

readList :: ReadS [SetTaskStatus] #

readPrec :: ReadPrec SetTaskStatus #

readListPrec :: ReadPrec [SetTaskStatus] #

Show SetTaskStatus Source # 
Instance details

Defined in Amazonka.DataPipeline.SetTaskStatus

Methods

showsPrec :: Int -> SetTaskStatus -> ShowS #

show :: SetTaskStatus -> String #

showList :: [SetTaskStatus] -> ShowS #

Generic SetTaskStatus Source # 
Instance details

Defined in Amazonka.DataPipeline.SetTaskStatus

Associated Types

type Rep SetTaskStatus :: Type -> Type #

Methods

from :: SetTaskStatus -> Rep SetTaskStatus x #

to :: Rep SetTaskStatus x -> SetTaskStatus #

NFData SetTaskStatus Source # 
Instance details

Defined in Amazonka.DataPipeline.SetTaskStatus

Methods

rnf :: SetTaskStatus -> () #

Hashable SetTaskStatus Source # 
Instance details

Defined in Amazonka.DataPipeline.SetTaskStatus

Methods

hashWithSalt :: Int -> SetTaskStatus -> Int #

hash :: SetTaskStatus -> Int #

ToJSON SetTaskStatus Source # 
Instance details

Defined in Amazonka.DataPipeline.SetTaskStatus

Methods

toJSON :: SetTaskStatus -> Value #

toEncoding :: SetTaskStatus -> Encoding #

toJSONList :: [SetTaskStatus] -> Value #

toEncodingList :: [SetTaskStatus] -> Encoding #

AWSRequest SetTaskStatus Source # 
Instance details

Defined in Amazonka.DataPipeline.SetTaskStatus

Associated Types

type AWSResponse SetTaskStatus #

Methods

request :: SetTaskStatus -> Request SetTaskStatus #

response :: MonadResource m => Logger -> Service -> Proxy SetTaskStatus -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SetTaskStatus))) #

ToHeaders SetTaskStatus Source # 
Instance details

Defined in Amazonka.DataPipeline.SetTaskStatus

Methods

toHeaders :: SetTaskStatus -> [Header] #

ToPath SetTaskStatus Source # 
Instance details

Defined in Amazonka.DataPipeline.SetTaskStatus

Methods

toPath :: SetTaskStatus -> ByteString #

ToQuery SetTaskStatus Source # 
Instance details

Defined in Amazonka.DataPipeline.SetTaskStatus

Methods

toQuery :: SetTaskStatus -> QueryString #

type Rep SetTaskStatus Source # 
Instance details

Defined in Amazonka.DataPipeline.SetTaskStatus

type Rep SetTaskStatus = D1 ('MetaData "SetTaskStatus" "Amazonka.DataPipeline.SetTaskStatus" "libZSservicesZSamazonka-datapipelineZSamazonka-datapipeline" 'False) (C1 ('MetaCons "SetTaskStatus'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "errorStackTrace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "errorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "taskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "taskStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TaskStatus)))))
type AWSResponse SetTaskStatus Source # 
Instance details

Defined in Amazonka.DataPipeline.SetTaskStatus

type AWSResponse SetTaskStatus = SetTaskStatusResponse

newSetTaskStatus Source #

Arguments

:: Text

$sel:taskId:SetTaskStatus'

-> TaskStatus

$sel:taskStatus:SetTaskStatus'

-> SetTaskStatus 

Create a value of SetTaskStatus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:errorStackTrace:SetTaskStatus', setTaskStatus_errorStackTrace - 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.

$sel:errorId:SetTaskStatus', setTaskStatus_errorId - 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.

$sel:errorMessage:SetTaskStatus', setTaskStatus_errorMessage - 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.

$sel:taskId:SetTaskStatus', setTaskStatus_taskId - The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

$sel:taskStatus:SetTaskStatus', setTaskStatus_taskStatus - If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.

Request Lenses

setTaskStatus_errorStackTrace :: Lens' SetTaskStatus (Maybe Text) Source #

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.

setTaskStatus_errorId :: Lens' SetTaskStatus (Maybe Text) Source #

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.

setTaskStatus_errorMessage :: Lens' SetTaskStatus (Maybe Text) Source #

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.

setTaskStatus_taskId :: Lens' SetTaskStatus Text Source #

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

setTaskStatus_taskStatus :: Lens' SetTaskStatus TaskStatus Source #

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

Destructuring the Response

data SetTaskStatusResponse Source #

Contains the output of SetTaskStatus.

See: newSetTaskStatusResponse smart constructor.

Constructors

SetTaskStatusResponse' 

Fields

Instances

Instances details
Eq SetTaskStatusResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.SetTaskStatus

Methods

(==) :: SetTaskStatusResponse -> SetTaskStatusResponse -> Bool #

(/=) :: SetTaskStatusResponse -> SetTaskStatusResponse -> Bool #

Read SetTaskStatusResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.SetTaskStatus

Methods

readsPrec :: Int -> ReadS SetTaskStatusResponse #

readList :: ReadS [SetTaskStatusResponse] #

readPrec :: ReadPrec SetTaskStatusResponse #

readListPrec :: ReadPrec [SetTaskStatusResponse] #

Show SetTaskStatusResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.SetTaskStatus

Methods

showsPrec :: Int -> SetTaskStatusResponse -> ShowS #

show :: SetTaskStatusResponse -> String #

showList :: [SetTaskStatusResponse] -> ShowS #

Generic SetTaskStatusResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.SetTaskStatus

Associated Types

type Rep SetTaskStatusResponse :: Type -> Type #

Methods

from :: SetTaskStatusResponse -> Rep SetTaskStatusResponse x #

to :: Rep SetTaskStatusResponse x -> SetTaskStatusResponse #

NFData SetTaskStatusResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.SetTaskStatus

Methods

rnf :: SetTaskStatusResponse -> () #

type Rep SetTaskStatusResponse Source # 
Instance details

Defined in Amazonka.DataPipeline.SetTaskStatus

type Rep SetTaskStatusResponse = D1 ('MetaData "SetTaskStatusResponse" "Amazonka.DataPipeline.SetTaskStatus" "libZSservicesZSamazonka-datapipelineZSamazonka-datapipeline" 'False) (C1 ('MetaCons "SetTaskStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSetTaskStatusResponse Source #

Arguments

:: Int

$sel:httpStatus:SetTaskStatusResponse'

-> SetTaskStatusResponse 

Create a value of SetTaskStatusResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:SetTaskStatusResponse', setTaskStatusResponse_httpStatus - The response's http status code.

Response Lenses

setTaskStatusResponse_httpStatus :: Lens' SetTaskStatusResponse Int Source #

The response's http status code.