ActivatePipeline
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.
If you activate an on-demand pipeline that is already running, it will cancel all running objects and re-run the pipeline. StartTimestamp does not apply to on-demand pipelines.
Request Syntax
{
"parameterValues": [
{
"id": "string",
"stringValue": "string"
}
],
"pipelineId": "string",
"startTimestamp": number
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- parameterValues
-
A list of parameter values to pass to the pipeline at activation.
Type: Array of ParameterValue objects
Required: No
- pipelineId
-
The ID of the pipeline.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\n\t]*Required: Yes
- startTimestamp
-
The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.
Type: Timestamp
Required: No
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceError
-
An internal service error occurred.
HTTP Status Code: 500
- InvalidRequestException
-
The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
HTTP Status Code: 400
- PipelineDeletedException
-
The specified pipeline has been deleted.
HTTP Status Code: 400
- PipelineNotFoundException
-
The specified pipeline was not found. Verify that you used the correct user and account identifiers.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of ActivatePipeline.
Sample Request
POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: DataPipeline.ActivatePipeline
Content-Length: 39
Host: datapipeline.us-east-1.amazonaws.com
X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
Authorization: AuthParams
{"pipelineId": "df-06372391ZG65EXAMPLE"}
Sample Response
HTTP/1.1 200
x-amzn-RequestId: ee19d5bf-074e-11e2-af6f-6bc7a6be60d9
Content-Type: application/x-amz-json-1.1
Content-Length: 2
Date: Mon, 12 Nov 2012 17:50:53 GMT
{}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
