Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14198974.1 KB

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 <code>FINISHED</code> pipelines and attempting to do so returns <code>InvalidRequestException</code>.

post/#X-Amz-Target=DataPipeline.SetStatus

Headers

X-Amz-Target'DataPipeline.SetStatus' required

Request body

pipelineIdstring required

The ID of the pipeline that contains the objects.

objectIdsId[] required

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

statusstring required

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

Response

Success