GetPipelineDefinition - AWS Data Pipeline


Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition.

Request Syntax

{ "pipelineId": "string", "version": "string" }

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.


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


The version of the pipeline definition to retrieve. Set this parameter to latest (default) to use the last definition saved to the pipeline or active to use the last definition that was activated.

Type: String

Required: No

Response Syntax

{ "parameterObjects": [ { "attributes": [ { "key": "string", "stringValue": "string" } ], "id": "string" } ], "parameterValues": [ { "id": "string", "stringValue": "string" } ], "pipelineObjects": [ { "fields": [ { "key": "string", "refValue": "string", "stringValue": "string" } ], "id": "string", "name": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The parameter objects used in the pipeline definition.

Type: Array of ParameterObject objects


The parameter values used in the pipeline definition.

Type: Array of ParameterValue objects


The objects defined in the pipeline.

Type: Array of PipelineObject objects


For information about the errors that are common to all actions, see Common Errors.


An internal service error occurred.

HTTP Status Code: 500


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


The specified pipeline has been deleted.

HTTP Status Code: 400


The specified pipeline was not found. Verify that you used the correct user and account identifiers.

HTTP Status Code: 400



This example illustrates one usage of GetPipelineDefinition.

Sample Request

POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.GetPipelineDefinition Content-Length: 40 Host: X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams {"pipelineId": "df-06372391ZG65EXAMPLE"}

Sample Response

x-amzn-RequestId: e28309e5-0776-11e2-8a14-21bb8a1f50ef Content-Type: application/x-amz-json-1.1 Content-Length: 890 Date: Mon, 12 Nov 2012 17:50:53 GMT {"pipelineObjects": [ {"fields": [ {"key": "workerGroup", "stringValue": "workerGroup"} ], "id": "Default", "name": "Default"}, {"fields": [ {"key": "startDateTime", "stringValue": "2012-09-25T17:00:00"}, {"key": "type", "stringValue": "Schedule"}, {"key": "period", "stringValue": "1 hour"}, {"key": "endDateTime", "stringValue": "2012-09-25T18:00:00"} ], "id": "Schedule", "name": "Schedule"}, {"fields": [ {"key": "schedule", "refValue": "Schedule"}, {"key": "command", "stringValue": "echo hello"}, {"key": "parent", "refValue": "Default"}, {"key": "type", "stringValue": "ShellCommandActivity"} ], "id": "SayHello", "name": "SayHello"} ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: