Network.AWS.DataPipeline.ReportTaskRunnerHeartbeat

Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance.

Creating a Request

reportTaskRunnerHeartbeat

Arguments

:: Text

rtrhTaskrunnerId

-> ReportTaskRunnerHeartbeat

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

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

• rtrhHostname - The public DNS name of the task runner.
• rtrhWorkerGroup - The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup . There are no wildcard values permitted in workerGroup ; the string must be an exact, case-sensitive, match.
• rtrhTaskrunnerId - The ID of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application. If you have written a custom task runner, you should assign a unique identifier for the task runner.

data ReportTaskRunnerHeartbeat

Contains the parameters for ReportTaskRunnerHeartbeat.

See: reportTaskRunnerHeartbeat smart constructor.

Instances

Eq ReportTaskRunnerHeartbeat

Methods

(==) :: ReportTaskRunnerHeartbeat -> ReportTaskRunnerHeartbeat -> Bool

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

Data ReportTaskRunnerHeartbeat

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ReportTaskRunnerHeartbeat -> c ReportTaskRunnerHeartbeat

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ReportTaskRunnerHeartbeat

toConstr :: ReportTaskRunnerHeartbeat -> Constr

dataTypeOf :: ReportTaskRunnerHeartbeat -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ReportTaskRunnerHeartbeat)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ReportTaskRunnerHeartbeat)

gmapT :: (forall b. Data b => b -> b) -> ReportTaskRunnerHeartbeat -> ReportTaskRunnerHeartbeat

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ReportTaskRunnerHeartbeat -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ReportTaskRunnerHeartbeat -> r

gmapQ :: (forall d. Data d => d -> u) -> ReportTaskRunnerHeartbeat -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ReportTaskRunnerHeartbeat -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ReportTaskRunnerHeartbeat -> m ReportTaskRunnerHeartbeat

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ReportTaskRunnerHeartbeat -> m ReportTaskRunnerHeartbeat

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ReportTaskRunnerHeartbeat -> m ReportTaskRunnerHeartbeat

Read ReportTaskRunnerHeartbeat

Methods

readsPrec :: Int -> ReadS ReportTaskRunnerHeartbeat

readList :: ReadS [ReportTaskRunnerHeartbeat]

readPrec :: ReadPrec ReportTaskRunnerHeartbeat

readListPrec :: ReadPrec [ReportTaskRunnerHeartbeat]

Show ReportTaskRunnerHeartbeat

Methods

showsPrec :: Int -> ReportTaskRunnerHeartbeat -> ShowS

show :: ReportTaskRunnerHeartbeat -> String

showList :: [ReportTaskRunnerHeartbeat] -> ShowS

Generic ReportTaskRunnerHeartbeat

Associated Types

type Rep ReportTaskRunnerHeartbeat :: * -> *

Methods

from :: ReportTaskRunnerHeartbeat -> Rep ReportTaskRunnerHeartbeat x

to :: Rep ReportTaskRunnerHeartbeat x -> ReportTaskRunnerHeartbeat

Hashable ReportTaskRunnerHeartbeat

Methods

hashWithSalt :: Int -> ReportTaskRunnerHeartbeat -> Int

hash :: ReportTaskRunnerHeartbeat -> Int

ToJSON ReportTaskRunnerHeartbeat

Methods

toJSON :: ReportTaskRunnerHeartbeat -> Value

toEncoding :: ReportTaskRunnerHeartbeat -> Encoding

toJSONList :: [ReportTaskRunnerHeartbeat] -> Value

toEncodingList :: [ReportTaskRunnerHeartbeat] -> Encoding

NFData ReportTaskRunnerHeartbeat

Methods

rnf :: ReportTaskRunnerHeartbeat -> ()

AWSRequest ReportTaskRunnerHeartbeat

Associated Types

type Rs ReportTaskRunnerHeartbeat :: *

Methods

request :: ReportTaskRunnerHeartbeat -> Request ReportTaskRunnerHeartbeat

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

ToPath ReportTaskRunnerHeartbeat

Methods

toPath :: ReportTaskRunnerHeartbeat -> ByteString

ToHeaders ReportTaskRunnerHeartbeat

Methods

toHeaders :: ReportTaskRunnerHeartbeat -> [Header]

ToQuery ReportTaskRunnerHeartbeat

Methods

toQuery :: ReportTaskRunnerHeartbeat -> QueryString

type Rep ReportTaskRunnerHeartbeat

type Rep ReportTaskRunnerHeartbeat = D1 (MetaData "ReportTaskRunnerHeartbeat" "Network.AWS.DataPipeline.ReportTaskRunnerHeartbeat" "amazonka-datapipeline-1.4.5-2XRiHlI7YUG6vzXDlJG8tH" False) (C1 (MetaCons "ReportTaskRunnerHeartbeat'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rtrhHostname") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_rtrhWorkerGroup") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rtrhTaskrunnerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs ReportTaskRunnerHeartbeat

type Rs ReportTaskRunnerHeartbeat = ReportTaskRunnerHeartbeatResponse

Request Lenses

rtrhHostname :: Lens' ReportTaskRunnerHeartbeat (Maybe Text)

The public DNS name of the task runner.

rtrhWorkerGroup :: Lens' ReportTaskRunnerHeartbeat (Maybe Text)

The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup . There are no wildcard values permitted in workerGroup ; the string must be an exact, case-sensitive, match.

rtrhTaskrunnerId :: Lens' ReportTaskRunnerHeartbeat Text

The ID of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application. If you have written a custom task runner, you should assign a unique identifier for the task runner.

Destructuring the Response

reportTaskRunnerHeartbeatResponse

Arguments

:: Int

rtrhrsResponseStatus

-> Bool

rtrhrsTerminate

-> ReportTaskRunnerHeartbeatResponse

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

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

• rtrhrsResponseStatus - -- | The response status code.
• rtrhrsTerminate - Indicates whether the calling task runner should terminate.

data ReportTaskRunnerHeartbeatResponse

Contains the output of ReportTaskRunnerHeartbeat.

See: reportTaskRunnerHeartbeatResponse smart constructor.

Instances

Eq ReportTaskRunnerHeartbeatResponse

Methods

(==) :: ReportTaskRunnerHeartbeatResponse -> ReportTaskRunnerHeartbeatResponse -> Bool

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

Data ReportTaskRunnerHeartbeatResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ReportTaskRunnerHeartbeatResponse -> c ReportTaskRunnerHeartbeatResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ReportTaskRunnerHeartbeatResponse

toConstr :: ReportTaskRunnerHeartbeatResponse -> Constr

dataTypeOf :: ReportTaskRunnerHeartbeatResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ReportTaskRunnerHeartbeatResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ReportTaskRunnerHeartbeatResponse)

gmapT :: (forall b. Data b => b -> b) -> ReportTaskRunnerHeartbeatResponse -> ReportTaskRunnerHeartbeatResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ReportTaskRunnerHeartbeatResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ReportTaskRunnerHeartbeatResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ReportTaskRunnerHeartbeatResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ReportTaskRunnerHeartbeatResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ReportTaskRunnerHeartbeatResponse -> m ReportTaskRunnerHeartbeatResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ReportTaskRunnerHeartbeatResponse -> m ReportTaskRunnerHeartbeatResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ReportTaskRunnerHeartbeatResponse -> m ReportTaskRunnerHeartbeatResponse

Read ReportTaskRunnerHeartbeatResponse

Methods

readsPrec :: Int -> ReadS ReportTaskRunnerHeartbeatResponse

readList :: ReadS [ReportTaskRunnerHeartbeatResponse]

readPrec :: ReadPrec ReportTaskRunnerHeartbeatResponse

readListPrec :: ReadPrec [ReportTaskRunnerHeartbeatResponse]

Show ReportTaskRunnerHeartbeatResponse

Methods

showsPrec :: Int -> ReportTaskRunnerHeartbeatResponse -> ShowS

show :: ReportTaskRunnerHeartbeatResponse -> String

showList :: [ReportTaskRunnerHeartbeatResponse] -> ShowS

Generic ReportTaskRunnerHeartbeatResponse

Associated Types

type Rep ReportTaskRunnerHeartbeatResponse :: * -> *

Methods

from :: ReportTaskRunnerHeartbeatResponse -> Rep ReportTaskRunnerHeartbeatResponse x

to :: Rep ReportTaskRunnerHeartbeatResponse x -> ReportTaskRunnerHeartbeatResponse

NFData ReportTaskRunnerHeartbeatResponse

Methods

rnf :: ReportTaskRunnerHeartbeatResponse -> ()

type Rep ReportTaskRunnerHeartbeatResponse

type Rep ReportTaskRunnerHeartbeatResponse = D1 (MetaData "ReportTaskRunnerHeartbeatResponse" "Network.AWS.DataPipeline.ReportTaskRunnerHeartbeat" "amazonka-datapipeline-1.4.5-2XRiHlI7YUG6vzXDlJG8tH" False) (C1 (MetaCons "ReportTaskRunnerHeartbeatResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rtrhrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_rtrhrsTerminate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool))))

Response Lenses

rtrhrsResponseStatus :: Lens' ReportTaskRunnerHeartbeatResponse Int

• - | The response status code.

rtrhrsTerminate :: Lens' ReportTaskRunnerHeartbeatResponse Bool

Indicates whether the calling task runner should terminate.