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 .

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

Methods

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

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

Data 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

Methods

readsPrec :: Int -> ReadS SetTaskStatus

readList :: ReadS [SetTaskStatus]

readPrec :: ReadPrec SetTaskStatus

readListPrec :: ReadPrec [SetTaskStatus]

Show SetTaskStatus

Methods

showsPrec :: Int -> SetTaskStatus -> ShowS

show :: SetTaskStatus -> String

showList :: [SetTaskStatus] -> ShowS

Generic SetTaskStatus

Associated Types

type Rep SetTaskStatus :: * -> *

Methods

from :: SetTaskStatus -> Rep SetTaskStatus x

to :: Rep SetTaskStatus x -> SetTaskStatus

Hashable SetTaskStatus

Methods

hashWithSalt :: Int -> SetTaskStatus -> Int

hash :: SetTaskStatus -> Int

ToJSON SetTaskStatus

Methods

toJSON :: SetTaskStatus -> Value

toEncoding :: SetTaskStatus -> Encoding

toJSONList :: [SetTaskStatus] -> Value

toEncodingList :: [SetTaskStatus] -> Encoding

NFData SetTaskStatus

Methods

rnf :: SetTaskStatus -> ()

AWSRequest SetTaskStatus

Associated Types

type Rs SetTaskStatus :: *

Methods

request :: SetTaskStatus -> Request SetTaskStatus

response :: MonadResource m => Logger -> Service -> Proxy * SetTaskStatus -> ClientResponse -> m (Response SetTaskStatus)

ToQuery SetTaskStatus

Methods

toQuery :: SetTaskStatus -> QueryString

ToPath SetTaskStatus

Methods

toPath :: SetTaskStatus -> ByteString

ToHeaders SetTaskStatus

Methods

toHeaders :: SetTaskStatus -> [Header]

type Rep SetTaskStatus

type Rep SetTaskStatus = D1 (MetaData "SetTaskStatus" "Network.AWS.DataPipeline.SetTaskStatus" "amazonka-datapipeline-1.5.0-1cvcRuECh7Cyyd6yqX05B" False) (C1 (MetaCons "SetTaskStatus'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_stsErrorStackTrace") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_stsErrorId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_stsErrorMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_stsTaskId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_stsTaskStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TaskStatus))))))

type Rs 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

Methods

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

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

Data SetTaskStatusResponse

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

Methods

readsPrec :: Int -> ReadS SetTaskStatusResponse

readList :: ReadS [SetTaskStatusResponse]

readPrec :: ReadPrec SetTaskStatusResponse

readListPrec :: ReadPrec [SetTaskStatusResponse]

Show SetTaskStatusResponse

Methods

showsPrec :: Int -> SetTaskStatusResponse -> ShowS

show :: SetTaskStatusResponse -> String

showList :: [SetTaskStatusResponse] -> ShowS

Generic SetTaskStatusResponse

Associated Types

type Rep SetTaskStatusResponse :: * -> *

Methods

from :: SetTaskStatusResponse -> Rep SetTaskStatusResponse x

to :: Rep SetTaskStatusResponse x -> SetTaskStatusResponse

NFData SetTaskStatusResponse

Methods

rnf :: SetTaskStatusResponse -> ()

type Rep SetTaskStatusResponse

type Rep SetTaskStatusResponse = D1 (MetaData "SetTaskStatusResponse" "Network.AWS.DataPipeline.SetTaskStatus" "amazonka-datapipeline-1.5.0-1cvcRuECh7Cyyd6yqX05B" True) (C1 (MetaCons "SetTaskStatusResponse'" PrefixI True) (S1 (MetaSel (Just Symbol "_stsrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

stsrsResponseStatus :: Lens' SetTaskStatusResponse Int

• - | The response status code.