Set Status
datapipeline_set_status | R Documentation |
Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline¶
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
.
Usage¶
Arguments¶
pipelineId
[required] The ID of the pipeline that contains the objects.
objectIds
[required] The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.
status
[required] The status to be set on all the objects specified in
objectIds
. For components, usePAUSE
orRESUME
. For instances, useTRY_CANCEL
,RERUN
, orMARK_FINISHED
.
Value¶
An empty list.