amazonka-datapipeline-1.4.5: Amazon Data Pipeline SDK.

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

Network.AWS.DataPipeline.SetStatus

Contents

Description

Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on FINISHED pipelines and attempting to do so returns InvalidRequestException .

Synopsis

Creating a Request

setStatus #

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

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

  • ssPipelineId - The ID of the pipeline that contains the objects.
  • ssObjectIds - The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.
  • ssStatus - The status to be set on all the objects specified in objectIds . For components, use PAUSE or RESUME . For instances, use TRY_CANCEL , RERUN , or MARK_FINISHED .

data SetStatus #

Contains the parameters for SetStatus.

See: setStatus smart constructor.

Instances

Eq SetStatus # 
Data SetStatus # 

Methods

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

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

toConstr :: SetStatus -> Constr #

dataTypeOf :: SetStatus -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> SetStatus -> SetStatus #

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

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

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

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

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

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

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

Read SetStatus # 
Show SetStatus # 
Generic SetStatus # 

Associated Types

type Rep SetStatus :: * -> * #

Hashable SetStatus # 
ToJSON SetStatus # 
NFData SetStatus # 

Methods

rnf :: SetStatus -> () #

AWSRequest SetStatus # 
ToQuery SetStatus # 
ToPath SetStatus # 
ToHeaders SetStatus # 

Methods

toHeaders :: SetStatus -> [Header] #

type Rep SetStatus # 
type Rep SetStatus = D1 (MetaData "SetStatus" "Network.AWS.DataPipeline.SetStatus" "amazonka-datapipeline-1.4.5-BJaoECYz4XDHL06I8wcb9o" False) (C1 (MetaCons "SetStatus'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ssPipelineId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_ssObjectIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Text])) (S1 (MetaSel (Just Symbol "_ssStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs SetStatus # 

Request Lenses

ssPipelineId :: Lens' SetStatus Text #

The ID of the pipeline that contains the objects.

ssObjectIds :: Lens' SetStatus [Text] #

The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

ssStatus :: Lens' SetStatus Text #

The status to be set on all the objects specified in objectIds . For components, use PAUSE or RESUME . For instances, use TRY_CANCEL , RERUN , or MARK_FINISHED .

Destructuring the Response

setStatusResponse :: SetStatusResponse #

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

data SetStatusResponse #

See: setStatusResponse smart constructor.

Instances

Eq SetStatusResponse # 
Data SetStatusResponse # 

Methods

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

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

toConstr :: SetStatusResponse -> Constr #

dataTypeOf :: SetStatusResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> SetStatusResponse -> SetStatusResponse #

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

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

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

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

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

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

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

Read SetStatusResponse # 
Show SetStatusResponse # 
Generic SetStatusResponse # 
NFData SetStatusResponse # 

Methods

rnf :: SetStatusResponse -> () #

type Rep SetStatusResponse # 
type Rep SetStatusResponse = D1 (MetaData "SetStatusResponse" "Network.AWS.DataPipeline.SetStatus" "amazonka-datapipeline-1.4.5-BJaoECYz4XDHL06I8wcb9o" False) (C1 (MetaCons "SetStatusResponse'" PrefixI False) U1)