DataPipeline / Client / set_status

set_status#

DataPipeline.Client.set_status(**kwargs)#

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 also: AWS API Documentation

Request Syntax

response = client.set_status(
    pipelineId='string',
    objectIds=[
        'string',
    ],
    status='string'
)
Parameters:

  • pipelineId (string) –

    [REQUIRED]

    The ID of the pipeline that contains the objects.

  • objectIds (list) –

    [REQUIRED]

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

    • (string) –

  • status (string) –

    [REQUIRED]

    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.

Returns:

None

Exceptions

  • DataPipeline.Client.exceptions.PipelineNotFoundException

  • DataPipeline.Client.exceptions.PipelineDeletedException

  • DataPipeline.Client.exceptions.InternalServiceError

  • DataPipeline.Client.exceptions.InvalidRequestException