DataPipeline / Client / activate_pipeline

activate_pipeline#

DataPipeline.Client.activate_pipeline(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

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

  • pipelineId (string) –

    [REQUIRED]

    The ID of the pipeline.

  • parameterValues (list) –

    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.

  • startTimestamp (datetime) – The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    Contains the output of ActivatePipeline.

Exceptions

  • DataPipeline.Client.exceptions.PipelineNotFoundException

  • DataPipeline.Client.exceptions.PipelineDeletedException

  • DataPipeline.Client.exceptions.InternalServiceError

  • DataPipeline.Client.exceptions.InvalidRequestException