Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DataPipeline.SetStatus

Contents

Creating a Request
Request Lenses
Destructuring the Response

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

data SetStatus = SetStatus' {
- pipelineId :: Text
- objectIds :: [Text]
- status :: Text
}
newSetStatus :: Text -> Text -> SetStatus
setStatus_pipelineId :: Lens' SetStatus Text
setStatus_objectIds :: Lens' SetStatus [Text]
setStatus_status :: Lens' SetStatus Text
data SetStatusResponse = SetStatusResponse' {
}
newSetStatusResponse :: SetStatusResponse

Creating a Request

data SetStatus Source #

Contains the parameters for SetStatus.

See: newSetStatus smart constructor.

Constructors

SetStatus'
Fields pipelineId :: Text The ID of the pipeline that contains the objects. objectIds :: [Text] The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types. status :: 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`.

Instances

Instances details

ToJSON SetStatus Source #
Instance details Defined in Amazonka.DataPipeline.SetStatus Methods toJSON :: SetStatus -> Value # toEncoding :: SetStatus -> Encoding # toJSONList :: [SetStatus] -> Value # toEncodingList :: [SetStatus] -> Encoding #
ToHeaders SetStatus Source #
Instance details Defined in Amazonka.DataPipeline.SetStatus Methods toHeaders :: SetStatus -> [Header] #
ToPath SetStatus Source #
Instance details Defined in Amazonka.DataPipeline.SetStatus Methods toPath :: SetStatus -> ByteString #
ToQuery SetStatus Source #
Instance details Defined in Amazonka.DataPipeline.SetStatus Methods toQuery :: SetStatus -> QueryString #
AWSRequest SetStatus Source #
Instance details Defined in Amazonka.DataPipeline.SetStatus Associated Types type AWSResponse SetStatus # Methods request :: (Service -> Service) -> SetStatus -> Request SetStatus # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SetStatus -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SetStatus))) #
Generic SetStatus Source #
Instance details Defined in Amazonka.DataPipeline.SetStatus Associated Types type Rep SetStatus :: Type -> Type # Methods from :: SetStatus -> Rep SetStatus x # to :: Rep SetStatus x -> SetStatus #
Read SetStatus Source #
Instance details Defined in Amazonka.DataPipeline.SetStatus Methods readsPrec :: Int -> ReadS SetStatus # readList :: ReadS [SetStatus] # readPrec :: ReadPrec SetStatus # readListPrec :: ReadPrec [SetStatus] #
Show SetStatus Source #
Instance details Defined in Amazonka.DataPipeline.SetStatus Methods showsPrec :: Int -> SetStatus -> ShowS # show :: SetStatus -> String # showList :: [SetStatus] -> ShowS #
NFData SetStatus Source #
Instance details Defined in Amazonka.DataPipeline.SetStatus Methods rnf :: SetStatus -> () #
Eq SetStatus Source #
Instance details Defined in Amazonka.DataPipeline.SetStatus Methods (==) :: SetStatus -> SetStatus -> Bool # (/=) :: SetStatus -> SetStatus -> Bool #
Hashable SetStatus Source #
Instance details Defined in Amazonka.DataPipeline.SetStatus Methods hashWithSalt :: Int -> SetStatus -> Int # hash :: SetStatus -> Int #
type AWSResponse SetStatus Source #
Instance details Defined in Amazonka.DataPipeline.SetStatus type AWSResponse SetStatus = SetStatusResponse
type Rep SetStatus Source #
Instance details Defined in Amazonka.DataPipeline.SetStatus type Rep SetStatus = D1 ('MetaData "SetStatus" "Amazonka.DataPipeline.SetStatus" "amazonka-datapipeline-2.0-1cySuAk2jmdDRpZSxMUuos" 'False) (C1 ('MetaCons "SetStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pipelineId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "objectIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSetStatus Source #

Arguments

:: Text	`SetStatus`
-> Text	`$sel:status:SetStatus'`
-> SetStatus

Create a value of SetStatus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

SetStatus, setStatus_pipelineId - The ID of the pipeline that contains the objects.

$sel:objectIds:SetStatus', setStatus_objectIds - The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

$sel:status:SetStatus', setStatus_status - 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.

Request Lenses

setStatus_pipelineId :: Lens' SetStatus Text Source #

The ID of the pipeline that contains the objects.

setStatus_objectIds :: Lens' SetStatus [Text] Source #

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

setStatus_status :: Lens' SetStatus Text Source #

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

data SetStatusResponse Source #

See: newSetStatusResponse smart constructor.

Constructors

SetStatusResponse'

Instances

Instances details

Generic SetStatusResponse Source #
Instance details Defined in Amazonka.DataPipeline.SetStatus Associated Types type Rep SetStatusResponse :: Type -> Type # Methods from :: SetStatusResponse -> Rep SetStatusResponse x # to :: Rep SetStatusResponse x -> SetStatusResponse #
Read SetStatusResponse Source #
Instance details Defined in Amazonka.DataPipeline.SetStatus Methods readsPrec :: Int -> ReadS SetStatusResponse # readList :: ReadS [SetStatusResponse] # readPrec :: ReadPrec SetStatusResponse # readListPrec :: ReadPrec [SetStatusResponse] #
Show SetStatusResponse Source #
Instance details Defined in Amazonka.DataPipeline.SetStatus Methods showsPrec :: Int -> SetStatusResponse -> ShowS # show :: SetStatusResponse -> String # showList :: [SetStatusResponse] -> ShowS #
NFData SetStatusResponse Source #
Instance details Defined in Amazonka.DataPipeline.SetStatus Methods rnf :: SetStatusResponse -> () #
Eq SetStatusResponse Source #
Instance details Defined in Amazonka.DataPipeline.SetStatus Methods (==) :: SetStatusResponse -> SetStatusResponse -> Bool # (/=) :: SetStatusResponse -> SetStatusResponse -> Bool #
type Rep SetStatusResponse Source #
Instance details Defined in Amazonka.DataPipeline.SetStatus type Rep SetStatusResponse = D1 ('MetaData "SetStatusResponse" "Amazonka.DataPipeline.SetStatus" "amazonka-datapipeline-2.0-1cySuAk2jmdDRpZSxMUuos" 'False) (C1 ('MetaCons "SetStatusResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newSetStatusResponse :: SetStatusResponse Source #

Create a value of SetStatusResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.