Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.DataPipeline.SetTaskStatus

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

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 - 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 - 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 - 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 - The ID of the task assigned to the task runner. This value is provided in the response for PollForTask .
stsTaskStatus - If FINISHED , the task successfully completed. If FAILED , the task ended unsuccessfully. Preconditions use false.

data SetTaskStatus #

Contains the parameters for SetTaskStatus.

See: setTaskStatus smart constructor.

Instances

Eq SetTaskStatus #
Instance details Defined in Network.AWS.DataPipeline.SetTaskStatus Methods (==) :: SetTaskStatus -> SetTaskStatus -> Bool # (/=) :: SetTaskStatus -> SetTaskStatus -> Bool #
Data SetTaskStatus #
Instance details Defined in Network.AWS.DataPipeline.SetTaskStatus Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SetTaskStatus -> c SetTaskStatus # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SetTaskStatus # toConstr :: SetTaskStatus -> Constr # dataTypeOf :: SetTaskStatus -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SetTaskStatus) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SetTaskStatus) # gmapT :: (forall b. Data b => b -> b) -> SetTaskStatus -> SetTaskStatus # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SetTaskStatus -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SetTaskStatus -> r # gmapQ :: (forall d. Data d => d -> u) -> SetTaskStatus -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SetTaskStatus -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SetTaskStatus -> m SetTaskStatus # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SetTaskStatus -> m SetTaskStatus # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SetTaskStatus -> m SetTaskStatus #
Read SetTaskStatus #
Instance details Defined in Network.AWS.DataPipeline.SetTaskStatus Methods readsPrec :: Int -> ReadS SetTaskStatus # readList :: ReadS [SetTaskStatus] # readPrec :: ReadPrec SetTaskStatus # readListPrec :: ReadPrec [SetTaskStatus] #
Show SetTaskStatus #
Instance details Defined in Network.AWS.DataPipeline.SetTaskStatus Methods showsPrec :: Int -> SetTaskStatus -> ShowS # show :: SetTaskStatus -> String # showList :: [SetTaskStatus] -> ShowS #
Generic SetTaskStatus #
Instance details Defined in Network.AWS.DataPipeline.SetTaskStatus Associated Types type Rep SetTaskStatus :: Type -> Type # Methods from :: SetTaskStatus -> Rep SetTaskStatus x # to :: Rep SetTaskStatus x -> SetTaskStatus #
Hashable SetTaskStatus #
Instance details Defined in Network.AWS.DataPipeline.SetTaskStatus Methods hashWithSalt :: Int -> SetTaskStatus -> Int # hash :: SetTaskStatus -> Int #
ToJSON SetTaskStatus #
Instance details Defined in Network.AWS.DataPipeline.SetTaskStatus Methods toJSON :: SetTaskStatus -> Value # toEncoding :: SetTaskStatus -> Encoding # toJSONList :: [SetTaskStatus] -> Value # toEncodingList :: [SetTaskStatus] -> Encoding #
AWSRequest SetTaskStatus #
Instance details Defined in Network.AWS.DataPipeline.SetTaskStatus Associated Types type Rs SetTaskStatus :: Type # Methods request :: SetTaskStatus -> Request SetTaskStatus # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy SetTaskStatus -> ClientResponse -> m (Response SetTaskStatus) #
ToHeaders SetTaskStatus #
Instance details Defined in Network.AWS.DataPipeline.SetTaskStatus Methods toHeaders :: SetTaskStatus -> [Header] #
ToPath SetTaskStatus #
Instance details Defined in Network.AWS.DataPipeline.SetTaskStatus Methods toPath :: SetTaskStatus -> ByteString #
ToQuery SetTaskStatus #
Instance details Defined in Network.AWS.DataPipeline.SetTaskStatus Methods toQuery :: SetTaskStatus -> QueryString #
NFData SetTaskStatus #
Instance details Defined in Network.AWS.DataPipeline.SetTaskStatus Methods rnf :: SetTaskStatus -> () #
type Rep SetTaskStatus #
Instance details Defined in Network.AWS.DataPipeline.SetTaskStatus type Rep SetTaskStatus = D1 (MetaData "SetTaskStatus" "Network.AWS.DataPipeline.SetTaskStatus" "amazonka-datapipeline-1.6.1-4OlZZr9txnv4YAc3mX4olh" False) (C1 (MetaCons "SetTaskStatus'" PrefixI True) ((S1 (MetaSel (Just "_stsErrorStackTrace") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_stsErrorId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_stsErrorMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_stsTaskId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_stsTaskStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TaskStatus)))))
type Rs SetTaskStatus #
Instance details Defined in Network.AWS.DataPipeline.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	`stsrsResponseStatus`
-> 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:

stsrsResponseStatus - -- | The response status code.

data SetTaskStatusResponse #

Contains the output of SetTaskStatus.

See: setTaskStatusResponse smart constructor.

Instances

Eq SetTaskStatusResponse #
Instance details Defined in Network.AWS.DataPipeline.SetTaskStatus Methods (==) :: SetTaskStatusResponse -> SetTaskStatusResponse -> Bool # (/=) :: SetTaskStatusResponse -> SetTaskStatusResponse -> Bool #
Data SetTaskStatusResponse #
Instance details Defined in Network.AWS.DataPipeline.SetTaskStatus Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SetTaskStatusResponse -> c SetTaskStatusResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SetTaskStatusResponse # toConstr :: SetTaskStatusResponse -> Constr # dataTypeOf :: SetTaskStatusResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SetTaskStatusResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SetTaskStatusResponse) # gmapT :: (forall b. Data b => b -> b) -> SetTaskStatusResponse -> SetTaskStatusResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SetTaskStatusResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SetTaskStatusResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> SetTaskStatusResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SetTaskStatusResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SetTaskStatusResponse -> m SetTaskStatusResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SetTaskStatusResponse -> m SetTaskStatusResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SetTaskStatusResponse -> m SetTaskStatusResponse #
Read SetTaskStatusResponse #
Instance details Defined in Network.AWS.DataPipeline.SetTaskStatus Methods readsPrec :: Int -> ReadS SetTaskStatusResponse # readList :: ReadS [SetTaskStatusResponse] # readPrec :: ReadPrec SetTaskStatusResponse # readListPrec :: ReadPrec [SetTaskStatusResponse] #
Show SetTaskStatusResponse #
Instance details Defined in Network.AWS.DataPipeline.SetTaskStatus Methods showsPrec :: Int -> SetTaskStatusResponse -> ShowS # show :: SetTaskStatusResponse -> String # showList :: [SetTaskStatusResponse] -> ShowS #
Generic SetTaskStatusResponse #
Instance details Defined in Network.AWS.DataPipeline.SetTaskStatus Associated Types type Rep SetTaskStatusResponse :: Type -> Type # Methods from :: SetTaskStatusResponse -> Rep SetTaskStatusResponse x # to :: Rep SetTaskStatusResponse x -> SetTaskStatusResponse #
NFData SetTaskStatusResponse #
Instance details Defined in Network.AWS.DataPipeline.SetTaskStatus Methods rnf :: SetTaskStatusResponse -> () #
type Rep SetTaskStatusResponse #
Instance details Defined in Network.AWS.DataPipeline.SetTaskStatus type Rep SetTaskStatusResponse = D1 (MetaData "SetTaskStatusResponse" "Network.AWS.DataPipeline.SetTaskStatus" "amazonka-datapipeline-1.6.1-4OlZZr9txnv4YAc3mX4olh" True) (C1 (MetaCons "SetTaskStatusResponse'" PrefixI True) (S1 (MetaSel (Just "_stsrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

stsrsResponseStatus :: Lens' SetTaskStatusResponse Int #

- | The response status code.