Network.AWS.DataPipeline.DeactivatePipeline

Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes.

To resume a deactivated pipeline, use ActivatePipeline . By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.

Creating a Request

deactivatePipeline

Arguments

:: Text

dPipelineId

-> DeactivatePipeline

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

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

• dCancelActive - Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED . If this value is false, the pipeline is deactivated after all running objects finish.
• dPipelineId - The ID of the pipeline.

data DeactivatePipeline

Contains the parameters for DeactivatePipeline.

See: deactivatePipeline smart constructor.

Instances

Eq DeactivatePipeline

Methods

(==) :: DeactivatePipeline -> DeactivatePipeline -> Bool

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

Data DeactivatePipeline

Methods

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

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

toConstr :: DeactivatePipeline -> Constr

dataTypeOf :: DeactivatePipeline -> DataType

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

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

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

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

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

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

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

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

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

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

Read DeactivatePipeline

Methods

readsPrec :: Int -> ReadS DeactivatePipeline

readList :: ReadS [DeactivatePipeline]

readPrec :: ReadPrec DeactivatePipeline

readListPrec :: ReadPrec [DeactivatePipeline]

Show DeactivatePipeline

Methods

showsPrec :: Int -> DeactivatePipeline -> ShowS

show :: DeactivatePipeline -> String

showList :: [DeactivatePipeline] -> ShowS

Generic DeactivatePipeline

Associated Types

type Rep DeactivatePipeline :: * -> *

Methods

from :: DeactivatePipeline -> Rep DeactivatePipeline x

to :: Rep DeactivatePipeline x -> DeactivatePipeline

Hashable DeactivatePipeline

Methods

hashWithSalt :: Int -> DeactivatePipeline -> Int

hash :: DeactivatePipeline -> Int

ToJSON DeactivatePipeline

Methods

toJSON :: DeactivatePipeline -> Value

toEncoding :: DeactivatePipeline -> Encoding

toJSONList :: [DeactivatePipeline] -> Value

toEncodingList :: [DeactivatePipeline] -> Encoding

NFData DeactivatePipeline

Methods

rnf :: DeactivatePipeline -> ()

AWSRequest DeactivatePipeline

Associated Types

type Rs DeactivatePipeline :: *

Methods

request :: DeactivatePipeline -> Request DeactivatePipeline

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DeactivatePipeline -> ClientResponse -> m (Response DeactivatePipeline)

ToHeaders DeactivatePipeline

Methods

toHeaders :: DeactivatePipeline -> [Header]

ToPath DeactivatePipeline

Methods

toPath :: DeactivatePipeline -> ByteString

ToQuery DeactivatePipeline

Methods

toQuery :: DeactivatePipeline -> QueryString

type Rep DeactivatePipeline

type Rep DeactivatePipeline = D1 * (MetaData "DeactivatePipeline" "Network.AWS.DataPipeline.DeactivatePipeline" "amazonka-datapipeline-1.6.0-kGxEPwUUMy5Qs3ShWYQqJ" False) (C1 * (MetaCons "DeactivatePipeline'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dCancelActive") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_dPipelineId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))

type Rs DeactivatePipeline

type Rs DeactivatePipeline = DeactivatePipelineResponse

Request Lenses

dCancelActive :: Lens' DeactivatePipeline (Maybe Bool)

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED . If this value is false, the pipeline is deactivated after all running objects finish.

dPipelineId :: Lens' DeactivatePipeline Text

The ID of the pipeline.

Destructuring the Response

deactivatePipelineResponse

Arguments

:: Int

drsResponseStatus

-> DeactivatePipelineResponse

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

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

• drsResponseStatus - -- | The response status code.

data DeactivatePipelineResponse

Contains the output of DeactivatePipeline.

See: deactivatePipelineResponse smart constructor.

Instances

Eq DeactivatePipelineResponse

Methods

(==) :: DeactivatePipelineResponse -> DeactivatePipelineResponse -> Bool

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

Data DeactivatePipelineResponse

Methods

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

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

toConstr :: DeactivatePipelineResponse -> Constr

dataTypeOf :: DeactivatePipelineResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read DeactivatePipelineResponse

Methods

readsPrec :: Int -> ReadS DeactivatePipelineResponse

readList :: ReadS [DeactivatePipelineResponse]

readPrec :: ReadPrec DeactivatePipelineResponse

readListPrec :: ReadPrec [DeactivatePipelineResponse]

Show DeactivatePipelineResponse

Methods

showsPrec :: Int -> DeactivatePipelineResponse -> ShowS

show :: DeactivatePipelineResponse -> String

showList :: [DeactivatePipelineResponse] -> ShowS

Generic DeactivatePipelineResponse

Associated Types

type Rep DeactivatePipelineResponse :: * -> *

Methods

from :: DeactivatePipelineResponse -> Rep DeactivatePipelineResponse x

to :: Rep DeactivatePipelineResponse x -> DeactivatePipelineResponse

NFData DeactivatePipelineResponse

Methods

rnf :: DeactivatePipelineResponse -> ()

type Rep DeactivatePipelineResponse

type Rep DeactivatePipelineResponse = D1 * (MetaData "DeactivatePipelineResponse" "Network.AWS.DataPipeline.DeactivatePipeline" "amazonka-datapipeline-1.6.0-kGxEPwUUMy5Qs3ShWYQqJ" True) (C1 * (MetaCons "DeactivatePipelineResponse'" PrefixI True) (S1 * (MetaSel (Just Symbol "_drsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)))

Response Lenses

drsResponseStatus :: Lens' DeactivatePipelineResponse Int

• - | The response status code.