amazonka-datapipeline-0.3.5: Amazon Data Pipeline SDK.

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.

http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_SetStatus.html

Synopsis

Request

Request constructor

setStatus Source

SetStatus constructor.

The fields accessible through corresponding lenses are:

Request lenses

ssObjectIds :: 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.

ssPipelineId :: Lens' SetStatus Text Source

The ID of the pipeline that contains the objects.

ssStatus :: 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.

Response

Response constructor