AWS Data Pipeline

Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes.

To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.

Request Syntax

client.deactivate_pipeline(
    pipelineId='string',
    cancelActive=True|False
)

type pipelineId

string

param pipelineId

[REQUIRED]

The ID of the pipeline.

type cancelActive

boolean

param cancelActive

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED . If this value is false, the pipeline is deactivated after all running objects finish.

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

  Contains the output of DeactivatePipeline.

{'startTimestamp': 'timestamp'}

Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails.

If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call DeactivatePipeline.

To activate a finished pipeline, modify the end date for the pipeline and then activate it.

Request Syntax

client.activate_pipeline(
    pipelineId='string',
    parameterValues=[
        {
            'id': 'string',
            'stringValue': 'string'
        },
    ],
    startTimestamp=datetime(2015, 1, 1)
)

type pipelineId

string

param pipelineId

[REQUIRED]

The ID of the pipeline.

type parameterValues

list

param parameterValues

A list of parameter values to pass to the pipeline at activation.

• (dict) --

  A value or list of parameter values.

  • id (string) -- [REQUIRED]

    The ID of the parameter value.

  • stringValue (string) -- [REQUIRED]

    The field value, expressed as a String.

type startTimestamp

datetime

param startTimestamp

The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

  Contains the output of ActivatePipeline.