amazonka-datapipeline-1.3.0: Amazon Data Pipeline SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <>
Portabilitynon-portable (GHC extensions)
Safe HaskellNone




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.

See: AWS API Reference for SetStatus.


Creating a Request

setStatus Source

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:

Request Lenses

ssPipelineId :: Lens' SetStatus Text Source

The ID of the pipeline that contains the objects.

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.

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.

Destructuring the Response

setStatusResponse :: SetStatusResponse Source

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