"stringValue": "2012-12-12T00:00:00"}, {"key": "parent",
"refValue": "Default"}, {"key": "@sphere",
"stringValue": "COMPONENT"}, {"key": "type",
"stringValue": "Schedule"}, {"key": "period",
"stringValue": "1 hour"}, {"key": "endDateTime",
"stringValue": "2012-12-21T18:00:00"}, {"key": "@version",
"stringValue": "1"}, {"key": "@status",
"stringValue": "PENDING"}, {"key": "@pipelineId",
"stringValue": "df-06372391ZG65EXAMPLE"}
],
"id": "Schedule", "name": "Schedule"}
] }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribePipelines
DescribePipelines
Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created.
If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions.
To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition (p. 27).
Request Syntax
{
"pipelineIds": [ "string" ] }
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 88).
The request accepts the following data in JSON format.
pipelineIds (p. 20)
The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call ListPipelines (p. 31).
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\n\t]*
Required: Yes
Response Syntax
{ "pipelineDescriptionList": [ {
Response Elements
} ] } ] }
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.
pipelineDescriptionList (p. 20)
An array of descriptions for the specified pipelines.
Type: Array of PipelineDescription (p. 77) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 90).
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 DescribePipelines.
Sample Request
See Also X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams
Date: Mon, 12 Nov 2012 17:50:53 GMT {"pipelineDescriptionList":
[
{"description": "This is my first pipeline", "fields":
"stringValue": "df-0937003356ZJEXAMPLE"}, {"key": "@sphere",
"pipelineId": "df-0937003356ZJEXAMPLE"}
]}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
See Also
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
EvaluateExpression
EvaluateExpression
Task runners call EvaluateExpression to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3.
Request Syntax
{ "expression": "string", "objectId": "string", "pipelineId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 88).
The request accepts the following data in JSON format.
expression (p. 24)
The expression to evaluate.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 20971520.
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: Yes objectId (p. 24)
The ID of the object.
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 pipelineId (p. 24)
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
Response Syntax
{
Response Elements
"evaluatedExpression": "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.
evaluatedExpression (p. 24) The evaluated expression.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 20971520.
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Errors
For information about the errors that are common to all actions, see Common Errors (p. 90).
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 TaskNotFoundException
The specified task was not found.
HTTP Status Code: 400
Examples
Example
See Also
Sample Request
POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.DescribePipelines Content-Length: 164
Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams
{"pipelineId": "df-08785951KAKJEXAMPLE", "objectId": "Schedule",
"expression": "Transform started at #{startDateTime} and finished at #{endDateTime}"}
Sample Response
x-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9 Content-Type: application/x-amz-json-1.1
Content-Length: 103
Date: Mon, 12 Nov 2012 17:50:53 GMT
{"evaluatedExpression": "Transform started at 2012-12-12T00:00:00 and finished at 2012-12-21T18:00:00"}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3