# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [ActivatePipeline](API_ActivatePipeline.md) 
+  [AddTags](API_AddTags.md) 
+  [CreatePipeline](API_CreatePipeline.md) 
+  [DeactivatePipeline](API_DeactivatePipeline.md) 
+  [DeletePipeline](API_DeletePipeline.md) 
+  [DescribeObjects](API_DescribeObjects.md) 
+  [DescribePipelines](API_DescribePipelines.md) 
+  [EvaluateExpression](API_EvaluateExpression.md) 
+  [GetPipelineDefinition](API_GetPipelineDefinition.md) 
+  [ListPipelines](API_ListPipelines.md) 
+  [PollForTask](API_PollForTask.md) 
+  [PutPipelineDefinition](API_PutPipelineDefinition.md) 
+  [QueryObjects](API_QueryObjects.md) 
+  [RemoveTags](API_RemoveTags.md) 
+  [ReportTaskProgress](API_ReportTaskProgress.md) 
+  [ReportTaskRunnerHeartbeat](API_ReportTaskRunnerHeartbeat.md) 
+  [SetStatus](API_SetStatus.md) 
+  [SetTaskStatus](API_SetTaskStatus.md) 
+  [ValidatePipelineDefinition](API_ValidatePipelineDefinition.md) 

# ActivatePipeline
<a name="API_ActivatePipeline"></a>

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](API_DeactivatePipeline.md).

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
<a name="API_ActivatePipeline_RequestSyntax"></a>

```
{
   "parameterValues": [ 
      { 
         "id": "string",
         "stringValue": "string"
      }
   ],
   "pipelineId": "string",
   "startTimestamp": number
}
```

## Request Parameters
<a name="API_ActivatePipeline_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [parameterValues](#API_ActivatePipeline_RequestSyntax) **   <a name="DP-ActivatePipeline-request-parameterValues"></a>
A list of parameter values to pass to the pipeline at activation.  
Type: Array of [ParameterValue](API_ParameterValue.md) objects  
Required: No

 ** [pipelineId](#API_ActivatePipeline_RequestSyntax) **   <a name="DP-ActivatePipeline-request-pipelineId"></a>
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](#API_ActivatePipeline_RequestSyntax) **   <a name="DP-ActivatePipeline-request-startTimestamp"></a>
The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.  
Type: Timestamp  
Required: No

## Response Elements
<a name="API_ActivatePipeline_ResponseElements"></a>

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

## Errors
<a name="API_ActivatePipeline_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
An internal service error occurred.    
 ** message **   
Description of the error message.
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.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineDeletedException **   
The specified pipeline has been deleted.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The specified pipeline was not found. Verify that you used the correct user and account identifiers.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

## Examples
<a name="API_ActivatePipeline_Examples"></a>

### Example
<a name="API_ActivatePipeline_Example_1"></a>

This example illustrates one usage of ActivatePipeline.

#### Sample Request
<a name="API_ActivatePipeline_Example_1_Request"></a>

```
                
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
<a name="API_ActivatePipeline_Example_1_Response"></a>

```
                
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
<a name="API_ActivatePipeline_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datapipeline-2012-10-29/ActivatePipeline) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datapipeline-2012-10-29/ActivatePipeline) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datapipeline-2012-10-29/ActivatePipeline) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datapipeline-2012-10-29/ActivatePipeline) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datapipeline-2012-10-29/ActivatePipeline) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datapipeline-2012-10-29/ActivatePipeline) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datapipeline-2012-10-29/ActivatePipeline) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datapipeline-2012-10-29/ActivatePipeline) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datapipeline-2012-10-29/ActivatePipeline) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datapipeline-2012-10-29/ActivatePipeline) 

# AddTags
<a name="API_AddTags"></a>

Adds or modifies tags for the specified pipeline.

## Request Syntax
<a name="API_AddTags_RequestSyntax"></a>

```
{
   "pipelineId": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_AddTags_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [pipelineId](#API_AddTags_RequestSyntax) **   <a name="DP-AddTags-request-pipelineId"></a>
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

 ** [tags](#API_AddTags_RequestSyntax) **   <a name="DP-AddTags-request-tags"></a>
The tags to add, as key/value pairs.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: Yes

## Response Elements
<a name="API_AddTags_ResponseElements"></a>

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

## Errors
<a name="API_AddTags_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
An internal service error occurred.    
 ** message **   
Description of the error message.
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.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineDeletedException **   
The specified pipeline has been deleted.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The specified pipeline was not found. Verify that you used the correct user and account identifiers.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

## See Also
<a name="API_AddTags_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datapipeline-2012-10-29/AddTags) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datapipeline-2012-10-29/AddTags) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datapipeline-2012-10-29/AddTags) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datapipeline-2012-10-29/AddTags) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datapipeline-2012-10-29/AddTags) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datapipeline-2012-10-29/AddTags) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datapipeline-2012-10-29/AddTags) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datapipeline-2012-10-29/AddTags) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datapipeline-2012-10-29/AddTags) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datapipeline-2012-10-29/AddTags) 

# CreatePipeline
<a name="API_CreatePipeline"></a>

Creates a new, empty pipeline. Use [PutPipelineDefinition](API_PutPipelineDefinition.md) to populate the pipeline.

## Request Syntax
<a name="API_CreatePipeline_RequestSyntax"></a>

```
{
   "description": "string",
   "name": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "uniqueId": "string"
}
```

## Request Parameters
<a name="API_CreatePipeline_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [description](#API_CreatePipeline_RequestSyntax) **   <a name="DP-CreatePipeline-request-description"></a>
The description for the pipeline.  
Type: String  
Required: No

 ** [name](#API_CreatePipeline_RequestSyntax) **   <a name="DP-CreatePipeline-request-name"></a>
The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.  
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

 ** [tags](#API_CreatePipeline_RequestSyntax) **   <a name="DP-CreatePipeline-request-tags"></a>
A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see [Controlling User Access to Pipelines](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) in the *AWS Data Pipeline Developer Guide*.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [uniqueId](#API_CreatePipeline_RequestSyntax) **   <a name="DP-CreatePipeline-request-uniqueId"></a>
A unique identifier. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency during repeated calls to `CreatePipeline`. For example, if the first call to `CreatePipeline` does not succeed, you can pass in the same unique identifier and pipeline name combination on a subsequent call to `CreatePipeline`. `CreatePipeline` ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline is not created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or user credentials.  
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
<a name="API_CreatePipeline_ResponseSyntax"></a>

```
{
   "pipelineId": "string"
}
```

## Response Elements
<a name="API_CreatePipeline_ResponseElements"></a>

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

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

 ** [pipelineId](#API_CreatePipeline_ResponseSyntax) **   <a name="DP-CreatePipeline-response-pipelineId"></a>
The ID that AWS Data Pipeline assigns the newly created pipeline. For example, `df-06372391ZG65EXAMPLE`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\n\t]*` 

## Errors
<a name="API_CreatePipeline_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
An internal service error occurred.    
 ** message **   
Description of the error message.
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.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

## Examples
<a name="API_CreatePipeline_Examples"></a>

### Example
<a name="API_CreatePipeline_Example_1"></a>

This example illustrates one usage of CreatePipeline.

#### Sample Request
<a name="API_CreatePipeline_Example_1_Request"></a>

```
POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: DataPipeline.CreatePipeline
Content-Length: 91
Host: datapipeline.us-east-1.amazonaws.com
X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
Authorization: AuthParams

{"name": "myPipeline",
 "uniqueId": "123456789",
 "description": "This is my first pipeline"}
```

#### Sample Response
<a name="API_CreatePipeline_Example_1_Response"></a>

```
                
HTTP/1.1 200 
x-amzn-RequestId: b16911ce-0774-11e2-af6f-6bc7a6be60d9
Content-Type: application/x-amz-json-1.1
Content-Length: 40
Date: Mon, 12 Nov 2012 17:50:53 GMT

{"pipelineId": "df-06372391ZG65EXAMPLE"}
```

## See Also
<a name="API_CreatePipeline_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datapipeline-2012-10-29/CreatePipeline) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datapipeline-2012-10-29/CreatePipeline) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datapipeline-2012-10-29/CreatePipeline) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datapipeline-2012-10-29/CreatePipeline) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datapipeline-2012-10-29/CreatePipeline) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datapipeline-2012-10-29/CreatePipeline) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datapipeline-2012-10-29/CreatePipeline) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datapipeline-2012-10-29/CreatePipeline) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datapipeline-2012-10-29/CreatePipeline) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datapipeline-2012-10-29/CreatePipeline) 

# DeactivatePipeline
<a name="API_DeactivatePipeline"></a>

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](API_ActivatePipeline.md). By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.

## Request Syntax
<a name="API_DeactivatePipeline_RequestSyntax"></a>

```
{
   "cancelActive": boolean,
   "pipelineId": "string"
}
```

## Request Parameters
<a name="API_DeactivatePipeline_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [cancelActive](#API_DeactivatePipeline_RequestSyntax) **   <a name="DP-DeactivatePipeline-request-cancelActive"></a>
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.  
Type: Boolean  
Required: No

 ** [pipelineId](#API_DeactivatePipeline_RequestSyntax) **   <a name="DP-DeactivatePipeline-request-pipelineId"></a>
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 Elements
<a name="API_DeactivatePipeline_ResponseElements"></a>

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

## Errors
<a name="API_DeactivatePipeline_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
An internal service error occurred.    
 ** message **   
Description of the error message.
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.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineDeletedException **   
The specified pipeline has been deleted.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The specified pipeline was not found. Verify that you used the correct user and account identifiers.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

## See Also
<a name="API_DeactivatePipeline_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datapipeline-2012-10-29/DeactivatePipeline) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datapipeline-2012-10-29/DeactivatePipeline) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datapipeline-2012-10-29/DeactivatePipeline) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datapipeline-2012-10-29/DeactivatePipeline) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datapipeline-2012-10-29/DeactivatePipeline) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datapipeline-2012-10-29/DeactivatePipeline) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datapipeline-2012-10-29/DeactivatePipeline) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datapipeline-2012-10-29/DeactivatePipeline) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datapipeline-2012-10-29/DeactivatePipeline) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datapipeline-2012-10-29/DeactivatePipeline) 

# DeletePipeline
<a name="API_DeletePipeline"></a>

Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners.

Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call [SetStatus](API_SetStatus.md) with the status set to `PAUSE` on individual components. Components that are paused by [SetStatus](API_SetStatus.md) can be resumed.

## Request Syntax
<a name="API_DeletePipeline_RequestSyntax"></a>

```
{
   "pipelineId": "string"
}
```

## Request Parameters
<a name="API_DeletePipeline_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [pipelineId](#API_DeletePipeline_RequestSyntax) **   <a name="DP-DeletePipeline-request-pipelineId"></a>
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 Elements
<a name="API_DeletePipeline_ResponseElements"></a>

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

## Errors
<a name="API_DeletePipeline_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
An internal service error occurred.    
 ** message **   
Description of the error message.
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.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The specified pipeline was not found. Verify that you used the correct user and account identifiers.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

## Examples
<a name="API_DeletePipeline_Examples"></a>

### Example
<a name="API_DeletePipeline_Example_1"></a>

This example illustrates one usage of DeletePipeline.

#### Sample Request
<a name="API_DeletePipeline_Example_1_Request"></a>

```
POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: DataPipeline.DeletePipeline
Content-Length: 50
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
<a name="API_DeletePipeline_Example_1_Response"></a>

```
                 
x-amzn-RequestId: b7a88c81-0754-11e2-af6f-6bc7a6be60d9
Content-Type: application/x-amz-json-1.1
Content-Length: 0
Date: Mon, 12 Nov 2012 17:50:53 GMT

Unexpected response: 200, OK, undefined
```

## See Also
<a name="API_DeletePipeline_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datapipeline-2012-10-29/DeletePipeline) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datapipeline-2012-10-29/DeletePipeline) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datapipeline-2012-10-29/DeletePipeline) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datapipeline-2012-10-29/DeletePipeline) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datapipeline-2012-10-29/DeletePipeline) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datapipeline-2012-10-29/DeletePipeline) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datapipeline-2012-10-29/DeletePipeline) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datapipeline-2012-10-29/DeletePipeline) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datapipeline-2012-10-29/DeletePipeline) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datapipeline-2012-10-29/DeletePipeline) 

# DescribeObjects
<a name="API_DescribeObjects"></a>

Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.

## Request Syntax
<a name="API_DescribeObjects_RequestSyntax"></a>

```
{
   "evaluateExpressions": boolean,
   "marker": "string",
   "objectIds": [ "string" ],
   "pipelineId": "string"
}
```

## Request Parameters
<a name="API_DescribeObjects_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [evaluateExpressions](#API_DescribeObjects_RequestSyntax) **   <a name="DP-DescribeObjects-request-evaluateExpressions"></a>
Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.  
Type: Boolean  
Required: No

 ** [marker](#API_DescribeObjects_RequestSyntax) **   <a name="DP-DescribeObjects-request-marker"></a>
The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call `DescribeObjects` with the marker value from the previous call to retrieve the next set of results.  
Type: String  
Required: No

 ** [objectIds](#API_DescribeObjects_RequestSyntax) **   <a name="DP-DescribeObjects-request-objectIds"></a>
The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to `DescribeObjects`.  
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

 ** [pipelineId](#API_DescribeObjects_RequestSyntax) **   <a name="DP-DescribeObjects-request-pipelineId"></a>
The ID of the pipeline that contains the object definitions.  
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
<a name="API_DescribeObjects_ResponseSyntax"></a>

```
{
   "hasMoreResults": boolean,
   "marker": "string",
   "pipelineObjects": [ 
      { 
         "fields": [ 
            { 
               "key": "string",
               "refValue": "string",
               "stringValue": "string"
            }
         ],
         "id": "string",
         "name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeObjects_ResponseElements"></a>

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

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

 ** [hasMoreResults](#API_DescribeObjects_ResponseSyntax) **   <a name="DP-DescribeObjects-response-hasMoreResults"></a>
Indicates whether there are more results to return.  
Type: Boolean

 ** [marker](#API_DescribeObjects_ResponseSyntax) **   <a name="DP-DescribeObjects-response-marker"></a>
The starting point for the next page of results. To view the next page of results, call `DescribeObjects` again with this marker value. If the value is null, there are no more results.  
Type: String

 ** [pipelineObjects](#API_DescribeObjects_ResponseSyntax) **   <a name="DP-DescribeObjects-response-pipelineObjects"></a>
An array of object definitions.  
Type: Array of [PipelineObject](API_PipelineObject.md) objects

## Errors
<a name="API_DescribeObjects_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
An internal service error occurred.    
 ** message **   
Description of the error message.
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.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineDeletedException **   
The specified pipeline has been deleted.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The specified pipeline was not found. Verify that you used the correct user and account identifiers.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

## Examples
<a name="API_DescribeObjects_Examples"></a>

### Example
<a name="API_DescribeObjects_Example_1"></a>

This example illustrates one usage of DescribeObjects.

#### Sample Request
<a name="API_DescribeObjects_Example_1_Request"></a>

```
POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: DataPipeline.DescribeObjects
Content-Length: 98
Host: datapipeline.us-east-1.amazonaws.com
X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
Authorization: AuthParams

{"pipelineId": "df-06372391ZG65EXAMPLE",
 "objectIds": 
  ["Schedule"],
 "evaluateExpressions": true}
```

#### Sample Response
<a name="API_DescribeObjects_Example_1_Response"></a>

```
x-amzn-RequestId: 4c18ea5d-0777-11e2-8a14-21bb8a1f50ef
Content-Type: application/x-amz-json-1.1
Content-Length: 1488
Date: Mon, 12 Nov 2012 17:50:53 GMT

{"hasMoreResults": false, 
 "pipelineObjects": 
  [
    {"fields": 
      [
        {"key": "startDateTime", 
         "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
<a name="API_DescribeObjects_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datapipeline-2012-10-29/DescribeObjects) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datapipeline-2012-10-29/DescribeObjects) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datapipeline-2012-10-29/DescribeObjects) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datapipeline-2012-10-29/DescribeObjects) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datapipeline-2012-10-29/DescribeObjects) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datapipeline-2012-10-29/DescribeObjects) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datapipeline-2012-10-29/DescribeObjects) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datapipeline-2012-10-29/DescribeObjects) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datapipeline-2012-10-29/DescribeObjects) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datapipeline-2012-10-29/DescribeObjects) 

# DescribePipelines
<a name="API_DescribePipelines"></a>

Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your users have created. As a user, 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](API_GetPipelineDefinition.md).

## Request Syntax
<a name="API_DescribePipelines_RequestSyntax"></a>

```
{
   "pipelineIds": [ "string" ]
}
```

## Request Parameters
<a name="API_DescribePipelines_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [pipelineIds](#API_DescribePipelines_RequestSyntax) **   <a name="DP-DescribePipelines-request-pipelineIds"></a>
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](API_ListPipelines.md).  
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
<a name="API_DescribePipelines_ResponseSyntax"></a>

```
{
   "pipelineDescriptionList": [ 
      { 
         "description": "string",
         "fields": [ 
            { 
               "key": "string",
               "refValue": "string",
               "stringValue": "string"
            }
         ],
         "name": "string",
         "pipelineId": "string",
         "tags": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ]
      }
   ]
}
```

## Response Elements
<a name="API_DescribePipelines_ResponseElements"></a>

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](#API_DescribePipelines_ResponseSyntax) **   <a name="DP-DescribePipelines-response-pipelineDescriptionList"></a>
An array of descriptions for the specified pipelines.  
Type: Array of [PipelineDescription](API_PipelineDescription.md) objects

## Errors
<a name="API_DescribePipelines_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
An internal service error occurred.    
 ** message **   
Description of the error message.
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.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineDeletedException **   
The specified pipeline has been deleted.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The specified pipeline was not found. Verify that you used the correct user and account identifiers.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

## Examples
<a name="API_DescribePipelines_Examples"></a>

### Example
<a name="API_DescribePipelines_Example_1"></a>

This example illustrates one usage of DescribePipelines.

#### Sample Request
<a name="API_DescribePipelines_Example_1_Request"></a>

```
POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: DataPipeline.DescribePipelines
Content-Length: 70
Host: datapipeline.us-east-1.amazonaws.com
X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
Authorization: AuthParams

{"pipelineIds": 
  ["df-08785951KAKJEXAMPLE"]
}
```

#### Sample Response
<a name="API_DescribePipelines_Example_1_Response"></a>

```
             
x-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9
Content-Type: application/x-amz-json-1.1
Content-Length: 767
Date: Mon, 12 Nov 2012 17:50:53 GMT

{"pipelineDescriptionList": 
  [
    {"description": "This is my first pipeline", 
     "fields": 
      [
        {"key": "@pipelineState", 
         "stringValue": "SCHEDULED"}, 
        {"key": "description", 
         "stringValue": "This is my first pipeline"}, 
        {"key": "name", 
         "stringValue": "myPipeline"}, 
        {"key": "@creationTime", 
         "stringValue": "2012-12-13T01:24:06"}, 
        {"key": "@id", 
         "stringValue": "df-0937003356ZJEXAMPLE"}, 
        {"key": "@sphere", 
         "stringValue": "PIPELINE"}, 
        {"key": "@version", 
         "stringValue": "1"}, 
        {"key": "@userId", 
         "stringValue": "924374875933"}, 
        {"key": "@accountId", 
         "stringValue": "924374875933"}, 
        {"key": "uniqueId", 
         "stringValue": "1234567890"}
      ], 
     "name": "myPipeline", 
     "pipelineId": "df-0937003356ZJEXAMPLE"}
  ]
}
```

## See Also
<a name="API_DescribePipelines_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datapipeline-2012-10-29/DescribePipelines) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datapipeline-2012-10-29/DescribePipelines) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datapipeline-2012-10-29/DescribePipelines) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datapipeline-2012-10-29/DescribePipelines) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datapipeline-2012-10-29/DescribePipelines) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datapipeline-2012-10-29/DescribePipelines) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datapipeline-2012-10-29/DescribePipelines) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datapipeline-2012-10-29/DescribePipelines) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datapipeline-2012-10-29/DescribePipelines) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datapipeline-2012-10-29/DescribePipelines) 

# EvaluateExpression
<a name="API_EvaluateExpression"></a>

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
<a name="API_EvaluateExpression_RequestSyntax"></a>

```
{
   "expression": "string",
   "objectId": "string",
   "pipelineId": "string"
}
```

## Request Parameters
<a name="API_EvaluateExpression_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [expression](#API_EvaluateExpression_RequestSyntax) **   <a name="DP-EvaluateExpression-request-expression"></a>
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](#API_EvaluateExpression_RequestSyntax) **   <a name="DP-EvaluateExpression-request-objectId"></a>
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](#API_EvaluateExpression_RequestSyntax) **   <a name="DP-EvaluateExpression-request-pipelineId"></a>
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
<a name="API_EvaluateExpression_ResponseSyntax"></a>

```
{
   "evaluatedExpression": "string"
}
```

## Response Elements
<a name="API_EvaluateExpression_ResponseElements"></a>

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](#API_EvaluateExpression_ResponseSyntax) **   <a name="DP-EvaluateExpression-response-evaluatedExpression"></a>
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
<a name="API_EvaluateExpression_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
An internal service error occurred.    
 ** message **   
Description of the error message.
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.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineDeletedException **   
The specified pipeline has been deleted.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The specified pipeline was not found. Verify that you used the correct user and account identifiers.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** TaskNotFoundException **   
The specified task was not found.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

## Examples
<a name="API_EvaluateExpression_Examples"></a>

### Example
<a name="API_EvaluateExpression_Example_1"></a>

This example illustrates one usage of EvaluateExpression.

#### Sample Request
<a name="API_EvaluateExpression_Example_1_Request"></a>

```
                
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
<a name="API_EvaluateExpression_Example_1_Response"></a>

```
                 
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
<a name="API_EvaluateExpression_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datapipeline-2012-10-29/EvaluateExpression) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datapipeline-2012-10-29/EvaluateExpression) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datapipeline-2012-10-29/EvaluateExpression) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datapipeline-2012-10-29/EvaluateExpression) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datapipeline-2012-10-29/EvaluateExpression) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datapipeline-2012-10-29/EvaluateExpression) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datapipeline-2012-10-29/EvaluateExpression) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datapipeline-2012-10-29/EvaluateExpression) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datapipeline-2012-10-29/EvaluateExpression) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datapipeline-2012-10-29/EvaluateExpression) 

# GetPipelineDefinition
<a name="API_GetPipelineDefinition"></a>

Gets the definition of the specified pipeline. You can call `GetPipelineDefinition` to retrieve the pipeline definition that you provided using [PutPipelineDefinition](API_PutPipelineDefinition.md).

## Request Syntax
<a name="API_GetPipelineDefinition_RequestSyntax"></a>

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

## Request Parameters
<a name="API_GetPipelineDefinition_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [pipelineId](#API_GetPipelineDefinition_RequestSyntax) **   <a name="DP-GetPipelineDefinition-request-pipelineId"></a>
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

 ** [version](#API_GetPipelineDefinition_RequestSyntax) **   <a name="DP-GetPipelineDefinition-request-version"></a>
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
<a name="API_GetPipelineDefinition_ResponseSyntax"></a>

```
{
   "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
<a name="API_GetPipelineDefinition_ResponseElements"></a>

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

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

 ** [parameterObjects](#API_GetPipelineDefinition_ResponseSyntax) **   <a name="DP-GetPipelineDefinition-response-parameterObjects"></a>
The parameter objects used in the pipeline definition.  
Type: Array of [ParameterObject](API_ParameterObject.md) objects

 ** [parameterValues](#API_GetPipelineDefinition_ResponseSyntax) **   <a name="DP-GetPipelineDefinition-response-parameterValues"></a>
The parameter values used in the pipeline definition.  
Type: Array of [ParameterValue](API_ParameterValue.md) objects

 ** [pipelineObjects](#API_GetPipelineDefinition_ResponseSyntax) **   <a name="DP-GetPipelineDefinition-response-pipelineObjects"></a>
The objects defined in the pipeline.  
Type: Array of [PipelineObject](API_PipelineObject.md) objects

## Errors
<a name="API_GetPipelineDefinition_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
An internal service error occurred.    
 ** message **   
Description of the error message.
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.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineDeletedException **   
The specified pipeline has been deleted.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The specified pipeline was not found. Verify that you used the correct user and account identifiers.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

## Examples
<a name="API_GetPipelineDefinition_Examples"></a>

### Example
<a name="API_GetPipelineDefinition_Example_1"></a>

This example illustrates one usage of GetPipelineDefinition.

#### Sample Request
<a name="API_GetPipelineDefinition_Example_1_Request"></a>

```
POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: DataPipeline.GetPipelineDefinition
Content-Length: 40
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
<a name="API_GetPipelineDefinition_Example_1_Response"></a>

```
                
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
<a name="API_GetPipelineDefinition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datapipeline-2012-10-29/GetPipelineDefinition) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datapipeline-2012-10-29/GetPipelineDefinition) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datapipeline-2012-10-29/GetPipelineDefinition) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datapipeline-2012-10-29/GetPipelineDefinition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datapipeline-2012-10-29/GetPipelineDefinition) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datapipeline-2012-10-29/GetPipelineDefinition) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datapipeline-2012-10-29/GetPipelineDefinition) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datapipeline-2012-10-29/GetPipelineDefinition) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datapipeline-2012-10-29/GetPipelineDefinition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datapipeline-2012-10-29/GetPipelineDefinition) 

# ListPipelines
<a name="API_ListPipelines"></a>

Lists the pipeline identifiers for all active pipelines that you have permission to access.

## Request Syntax
<a name="API_ListPipelines_RequestSyntax"></a>

```
{
   "marker": "string"
}
```

## Request Parameters
<a name="API_ListPipelines_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [marker](#API_ListPipelines_RequestSyntax) **   <a name="DP-ListPipelines-request-marker"></a>
The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call `ListPipelines` with the marker value from the previous call to retrieve the next set of results.  
Type: String  
Required: No

## Response Syntax
<a name="API_ListPipelines_ResponseSyntax"></a>

```
{
   "hasMoreResults": boolean,
   "marker": "string",
   "pipelineIdList": [ 
      { 
         "id": "string",
         "name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListPipelines_ResponseElements"></a>

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

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

 ** [hasMoreResults](#API_ListPipelines_ResponseSyntax) **   <a name="DP-ListPipelines-response-hasMoreResults"></a>
Indicates whether there are more results that can be obtained by a subsequent call.  
Type: Boolean

 ** [marker](#API_ListPipelines_ResponseSyntax) **   <a name="DP-ListPipelines-response-marker"></a>
The starting point for the next page of results. To view the next page of results, call `ListPipelinesOutput` again with this marker value. If the value is null, there are no more results.  
Type: String

 ** [pipelineIdList](#API_ListPipelines_ResponseSyntax) **   <a name="DP-ListPipelines-response-pipelineIdList"></a>
The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call [DescribePipelines](API_DescribePipelines.md) and [GetPipelineDefinition](API_GetPipelineDefinition.md).  
Type: Array of [PipelineIdName](API_PipelineIdName.md) objects

## Errors
<a name="API_ListPipelines_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
An internal service error occurred.    
 ** message **   
Description of the error message.
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.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

## Examples
<a name="API_ListPipelines_Examples"></a>

### Example
<a name="API_ListPipelines_Example_1"></a>

This example illustrates one usage of ListPipelines.

#### Sample Request
<a name="API_ListPipelines_Example_1_Request"></a>

```
                
POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: DataPipeline.ListPipelines
Content-Length: 14
Host: datapipeline.us-east-1.amazonaws.com
X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
Authorization: AuthParams

{}
```

#### Sample Response
<a name="API_ListPipelines_Example_1_Response"></a>

```
                
Status:
x-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9
Content-Type: application/x-amz-json-1.1
Content-Length: 39
Date: Mon, 12 Nov 2012 17:50:53 GMT

{"PipelineIdList": 
  [
    {"id": "df-08785951KAKJEXAMPLE",
     "name": "MyPipeline"}, 
    {"id": "df-08662578ISYEXAMPLE", 
     "name": "MySecondPipeline"}
  ]
}
```

## See Also
<a name="API_ListPipelines_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datapipeline-2012-10-29/ListPipelines) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datapipeline-2012-10-29/ListPipelines) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datapipeline-2012-10-29/ListPipelines) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datapipeline-2012-10-29/ListPipelines) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datapipeline-2012-10-29/ListPipelines) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datapipeline-2012-10-29/ListPipelines) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datapipeline-2012-10-29/ListPipelines) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datapipeline-2012-10-29/ListPipelines) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datapipeline-2012-10-29/ListPipelines) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datapipeline-2012-10-29/ListPipelines) 

# PollForTask
<a name="API_PollForTask"></a>

Task runners call `PollForTask` to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the `workerGroup` parameter. The task returned can come from any of the pipelines that match the `workerGroup` value passed in by the task runner and that was launched using the user credentials specified by the task runner.

If tasks are ready in the work queue, `PollForTask` returns a response immediately. If no tasks are available in the queue, `PollForTask` uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call `PollForTask` again on the same `workerGroup` until it receives a response, and this can take up to 90 seconds. 

## Request Syntax
<a name="API_PollForTask_RequestSyntax"></a>

```
{
   "hostname": "string",
   "instanceIdentity": { 
      "document": "string",
      "signature": "string"
   },
   "workerGroup": "string"
}
```

## Request Parameters
<a name="API_PollForTask_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [hostname](#API_PollForTask_RequestSyntax) **   <a name="DP-PollForTask-request-hostname"></a>
The public DNS name of the calling task runner.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\n\t]*`   
Required: No

 ** [instanceIdentity](#API_PollForTask_RequestSyntax) **   <a name="DP-PollForTask-request-instanceIdentity"></a>
Identity information for the EC2 instance that is hosting the task runner. You can get this value from the instance using `http://169.254.169.254/latest/meta-data/instance-id`. For more information, see [Instance Metadata](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html) in the *Amazon Elastic Compute Cloud User Guide.* Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.  
Type: [InstanceIdentity](API_InstanceIdentity.md) object  
Required: No

 ** [workerGroup](#API_PollForTask_RequestSyntax) **   <a name="DP-PollForTask-request-workerGroup"></a>
The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for `workerGroup` in the call to `PollForTask`. There are no wildcard values permitted in `workerGroup`; the string must be an exact, case-sensitive, match.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_PollForTask_ResponseSyntax"></a>

```
{
   "taskObject": { 
      "attemptId": "string",
      "objects": { 
         "string" : { 
            "fields": [ 
               { 
                  "key": "string",
                  "refValue": "string",
                  "stringValue": "string"
               }
            ],
            "id": "string",
            "name": "string"
         }
      },
      "pipelineId": "string",
      "taskId": "string"
   }
}
```

## Response Elements
<a name="API_PollForTask_ResponseElements"></a>

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

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

 ** [taskObject](#API_PollForTask_ResponseSyntax) **   <a name="DP-PollForTask-response-taskObject"></a>
The information needed to complete the task that is being assigned to the task runner. One of the fields returned in this object is `taskId`, which contains an identifier for the task being assigned. The calling task runner uses `taskId` in subsequent calls to [ReportTaskProgress](API_ReportTaskProgress.md) and [SetTaskStatus](API_SetTaskStatus.md).  
Type: [TaskObject](API_TaskObject.md) object

## Errors
<a name="API_PollForTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
An internal service error occurred.    
 ** message **   
Description of the error message.
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.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** TaskNotFoundException **   
The specified task was not found.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

## Examples
<a name="API_PollForTask_Examples"></a>

### Example
<a name="API_PollForTask_Example_1"></a>

This example illustrates one usage of PollForTask.

#### Sample Request
<a name="API_PollForTask_Example_1_Request"></a>

```
POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: DataPipeline.PollForTask
Content-Length: 59
Host: datapipeline.us-east-1.amazonaws.com
X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
Authorization: AuthParams

{"workerGroup": "MyworkerGroup",
 "hostname": "example.com"}
```

#### Sample Response
<a name="API_PollForTask_Example_1_Response"></a>

```
 
x-amzn-RequestId: 41c713d2-0775-11e2-af6f-6bc7a6be60d9
Content-Type: application/x-amz-json-1.1
Content-Length: 39
Date: Mon, 12 Nov 2012 17:50:53 GMT

{"taskObject": 
  {"attemptId": "@SayHello_2012-12-12T00:00:00_Attempt=1", 
   "objects": 
    {"@SayHello_2012-12-12T00:00:00_Attempt=1": 
      {"fields": 
        [
          {"key": "@componentParent", 
           "refValue": "SayHello"}, 
          {"key": "@scheduledStartTime", 
           "stringValue": "2012-12-12T00:00:00"}, 
          {"key": "parent", 
           "refValue": "SayHello"}, 
          {"key": "@sphere", 
           "stringValue": "ATTEMPT"}, 
          {"key": "workerGroup", 
           "stringValue": "workerGroup"}, 
          {"key": "@instanceParent", 
           "refValue": "@SayHello_2012-12-12T00:00:00"}, 
          {"key": "type", 
           "stringValue": "ShellCommandActivity"}, 
          {"key": "@status", 
           "stringValue": "WAITING_FOR_RUNNER"}, 
          {"key": "@version", 
           "stringValue": "1"}, 
          {"key": "schedule", 
           "refValue": "Schedule"}, 
          {"key": "@actualStartTime", 
           "stringValue": "2012-12-13T01:40:50"}, 
          {"key": "command", 
           "stringValue": "echo hello"}, 
          {"key": "@scheduledEndTime", 
           "stringValue": "2012-12-12T01:00:00"}, 
          {"key": "@activeInstances", 
           "refValue": "@SayHello_2012-12-12T00:00:00"}, 
          {"key": "@pipelineId", 
           "stringValue": "df-0937003356ZJEXAMPLE"}
        ], 
       "id": "@SayHello_2012-12-12T00:00:00_Attempt=1", 
       "name": "@SayHello_2012-12-12T00:00:00_Attempt=1"}
    }, 
   "pipelineId": "df-0937003356ZJEXAMPLE", 
   "taskId": "2xaM4wRs5zOsIH+g9U3oVHfAgAlbSqU6XduncB0HhZ3xMnmvfePZPn4dIbYXHyWyRK+cU15MqDHwdrvftx/4wv+sNS4w34vJfv7QA9aOoOazW28l1GYSb2ZRR0N0paiQp+d1MhSKo10hOTWOsVK5S5Lnx9Qm6omFgXHyIvZRIvTlrQMpr1xuUrflyGOfbFOGpOLpvPE172MYdqpZKnbSS4TcuqgQKSWV2833fEubI57DPOP7ghWa2TcYeSIv4pdLYG53fTuwfbnbdc98g2LNUQzSVhSnt7BoqyNwht2aQ6b/UHg9A80+KVpuXuqmz3m1MXwHFgxjdmuesXNOrrlGpeLCcRWD+aGo0RN1NqhQRzNAig8V4GlaPTQzMsRCljKqvrIyAoP3Tt2XEGsHkkQo12rEX8Z90957XX2qKRwhruwYzqGkSLWjINoLdAxUJdpRXRc5DJTrBd3D5mdzn7kY1l7NEh4kFHJDt3Cx4Z3Mk8MYCACyCk/CEyy9DwuPi66cLz0NBcgbCM5LKjTBOwo1m+am+pvM1kSposE9FPP1+RFGb8k6jQBTJx3TRz1yKilnGXQTZ5xvdOFpJrklIT0OXP1MG3+auM9FlJA+1dX90QoNJE5z7axmK//MOGXUdkqFe2kiDkorqjxwDvc0Js9pVKfKvAmW8YqUbmI9l0ERpWCXXnLVHNmPWz3jaPY+OBAmuJWDmxB/Z8p94aEDg4BVXQ7LvsKQ3DLYhaB7yJ390CJT+i0mm+EBqY60V6YikPSWDFrYQ/NPi2b1DgE19mX8zHqw8qprIl4yh1Ckx2Iige4En/N5ktOoIxnASxAw/TzcE2skxdw5KlHDF+UTj71m16CR/dIaKlXijlfNlNzUBo/bNSadCQn3G5NoO501wPKI:XO50TgDNyo8EXAMPLE/g==:1"}
}
```

## See Also
<a name="API_PollForTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datapipeline-2012-10-29/PollForTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datapipeline-2012-10-29/PollForTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datapipeline-2012-10-29/PollForTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datapipeline-2012-10-29/PollForTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datapipeline-2012-10-29/PollForTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datapipeline-2012-10-29/PollForTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datapipeline-2012-10-29/PollForTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datapipeline-2012-10-29/PollForTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datapipeline-2012-10-29/PollForTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datapipeline-2012-10-29/PollForTask) 

# PutPipelineDefinition
<a name="API_PutPipelineDefinition"></a>

Adds tasks, schedules, and preconditions to the specified pipeline. You can use `PutPipelineDefinition` to populate a new pipeline.

 `PutPipelineDefinition` also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following validation errors exist in the pipeline. 

1. An object is missing a name or identifier field.

1. A string or reference field is empty.

1. The number of objects in the pipeline exceeds the allowed maximum number of objects.

1. The pipeline is in a FINISHED state.

 Pipeline object definitions are passed to the `PutPipelineDefinition` action and returned by the [GetPipelineDefinition](API_GetPipelineDefinition.md) action. 

## Request Syntax
<a name="API_PutPipelineDefinition_RequestSyntax"></a>

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

## Request Parameters
<a name="API_PutPipelineDefinition_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [parameterObjects](#API_PutPipelineDefinition_RequestSyntax) **   <a name="DP-PutPipelineDefinition-request-parameterObjects"></a>
The parameter objects used with the pipeline.  
Type: Array of [ParameterObject](API_ParameterObject.md) objects  
Required: No

 ** [parameterValues](#API_PutPipelineDefinition_RequestSyntax) **   <a name="DP-PutPipelineDefinition-request-parameterValues"></a>
The parameter values used with the pipeline.  
Type: Array of [ParameterValue](API_ParameterValue.md) objects  
Required: No

 ** [pipelineId](#API_PutPipelineDefinition_RequestSyntax) **   <a name="DP-PutPipelineDefinition-request-pipelineId"></a>
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

 ** [pipelineObjects](#API_PutPipelineDefinition_RequestSyntax) **   <a name="DP-PutPipelineDefinition-request-pipelineObjects"></a>
The objects that define the pipeline. These objects overwrite the existing pipeline definition.  
Type: Array of [PipelineObject](API_PipelineObject.md) objects  
Required: Yes

## Response Syntax
<a name="API_PutPipelineDefinition_ResponseSyntax"></a>

```
{
   "errored": boolean,
   "validationErrors": [ 
      { 
         "errors": [ "string" ],
         "id": "string"
      }
   ],
   "validationWarnings": [ 
      { 
         "id": "string",
         "warnings": [ "string" ]
      }
   ]
}
```

## Response Elements
<a name="API_PutPipelineDefinition_ResponseElements"></a>

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

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

 ** [errored](#API_PutPipelineDefinition_ResponseSyntax) **   <a name="DP-PutPipelineDefinition-response-errored"></a>
Indicates whether there were validation errors, and the pipeline definition is stored but cannot be activated until you correct the pipeline and call `PutPipelineDefinition` to commit the corrected pipeline.  
Type: Boolean

 ** [validationErrors](#API_PutPipelineDefinition_ResponseSyntax) **   <a name="DP-PutPipelineDefinition-response-validationErrors"></a>
The validation errors that are associated with the objects defined in `pipelineObjects`.  
Type: Array of [ValidationError](API_ValidationError.md) objects

 ** [validationWarnings](#API_PutPipelineDefinition_ResponseSyntax) **   <a name="DP-PutPipelineDefinition-response-validationWarnings"></a>
The validation warnings that are associated with the objects defined in `pipelineObjects`.  
Type: Array of [ValidationWarning](API_ValidationWarning.md) objects

## Errors
<a name="API_PutPipelineDefinition_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
An internal service error occurred.    
 ** message **   
Description of the error message.
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.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineDeletedException **   
The specified pipeline has been deleted.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The specified pipeline was not found. Verify that you used the correct user and account identifiers.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

## Examples
<a name="API_PutPipelineDefinition_Examples"></a>

### Example 1
<a name="API_PutPipelineDefinition_Example_1"></a>

 This example sets a valid pipeline configuration and returns success. 

#### Sample Request
<a name="API_PutPipelineDefinition_Example_1_Request"></a>

```
                
POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: DataPipeline.PutPipelineDefinition
Content-Length: 914
Host: datapipeline.us-east-1.amazonaws.com
X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
Authorization: AuthParams

{"pipelineId": "df-0937003356ZJEXAMPLE",
 "pipelineObjects": 
  [
   {"id": "Default",
     "name": "Default",
     "fields": 
      [
        {"key": "workerGroup", 
         "stringValue": "workerGroup"}
      ]
    }, 
    {"id": "Schedule",
     "name": "Schedule",
     "fields": 
      [
       {"key": "startDateTime", 
         "stringValue": "2012-12-12T00:00:00"}, 
        {"key": "type", 
         "stringValue": "Schedule"}, 
        {"key": "period", 
         "stringValue": "1 hour"}, 
        {"key": "endDateTime", 
         "stringValue": "2012-12-21T18:00:00"}
      ]
    },
    {"id": "SayHello",
     "name": "SayHello",
     "fields": 
      [
        {"key": "type", 
         "stringValue": "ShellCommandActivity"},
        {"key": "command", 
         "stringValue": "echo hello"},
        {"key": "parent", 
         "refValue": "Default"},
        {"key": "schedule", 
         "refValue": "Schedule"}
      ]
    }
  ]
}
```

#### Sample Response
<a name="API_PutPipelineDefinition_Example_1_Response"></a>

```
                
HTTP/1.1 200 
x-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9
Content-Type: application/x-amz-json-1.1
Content-Length: 18
Date: Mon, 12 Nov 2012 17:50:53 GMT

{"errored": false}
```

### Example 2
<a name="API_PutPipelineDefinition_Example_2"></a>

 This example sets an invalid pipeline configuration (the value for `workerGroup` is an empty string) and returns an error message. 

#### Sample Request
<a name="API_PutPipelineDefinition_Example_2_Request"></a>

```
                    
POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: DataPipeline.PutPipelineDefinition
Content-Length: 903
Host: datapipeline.us-east-1.amazonaws.com
X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
Authorization: AuthParams

{"pipelineId": "df-06372391ZG65EXAMPLE",
 "pipelineObjects": 
  [
    {"id": "Default",
     "name": "Default",
     "fields": 
      [
        {"key": "workerGroup", 
         "stringValue": ""}
      ]
    }, 
    {"id": "Schedule",
     "name": "Schedule",
     "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": "SayHello",
     "name": "SayHello",
     "fields": 
      [
        {"key": "type", 
         "stringValue": "ShellCommandActivity"},
        {"key": "command", 
         "stringValue": "echo hello"},
        {"key": "parent", 
         "refValue": "Default"},
        {"key": "schedule", 
         "refValue": "Schedule"}
 
      ]
    }
  ]
}
```

#### Sample Response
<a name="API_PutPipelineDefinition_Example_2_Response"></a>

```
                    
HTTP/1.1 200 
x-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9
Content-Type: application/x-amz-json-1.1
Content-Length: 18
Date: Mon, 12 Nov 2012 17:50:53 GMT

{"__type": "com.amazon.setl.webservice#InvalidRequestException", 
 "message": "Pipeline definition has errors: Could not save the pipeline definition due to FATAL errors: [com.amazon.setl.webservice.ValidationError@108d7ea9] Please call Validate to validate your pipeline"}
```

## See Also
<a name="API_PutPipelineDefinition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datapipeline-2012-10-29/PutPipelineDefinition) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datapipeline-2012-10-29/PutPipelineDefinition) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datapipeline-2012-10-29/PutPipelineDefinition) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datapipeline-2012-10-29/PutPipelineDefinition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datapipeline-2012-10-29/PutPipelineDefinition) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datapipeline-2012-10-29/PutPipelineDefinition) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datapipeline-2012-10-29/PutPipelineDefinition) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datapipeline-2012-10-29/PutPipelineDefinition) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datapipeline-2012-10-29/PutPipelineDefinition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datapipeline-2012-10-29/PutPipelineDefinition) 

# QueryObjects
<a name="API_QueryObjects"></a>

Queries the specified pipeline for the names of objects that match the specified set of conditions.

## Request Syntax
<a name="API_QueryObjects_RequestSyntax"></a>

```
{
   "limit": number,
   "marker": "string",
   "pipelineId": "string",
   "query": { 
      "selectors": [ 
         { 
            "fieldName": "string",
            "operator": { 
               "type": "string",
               "values": [ "string" ]
            }
         }
      ]
   },
   "sphere": "string"
}
```

## Request Parameters
<a name="API_QueryObjects_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [limit](#API_QueryObjects_RequestSyntax) **   <a name="DP-QueryObjects-request-limit"></a>
The maximum number of object names that `QueryObjects` will return in a single call. The default value is 100.   
Type: Integer  
Required: No

 ** [marker](#API_QueryObjects_RequestSyntax) **   <a name="DP-QueryObjects-request-marker"></a>
The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call `QueryObjects` with the marker value from the previous call to retrieve the next set of results.  
Type: String  
Required: No

 ** [pipelineId](#API_QueryObjects_RequestSyntax) **   <a name="DP-QueryObjects-request-pipelineId"></a>
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

 ** [query](#API_QueryObjects_RequestSyntax) **   <a name="DP-QueryObjects-request-query"></a>
The query that defines the objects to be returned. The `Query` object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.  
Type: [Query](API_Query.md) object  
Required: No

 ** [sphere](#API_QueryObjects_RequestSyntax) **   <a name="DP-QueryObjects-request-sphere"></a>
Indicates whether the query applies to components or instances. The possible values are: `COMPONENT`, `INSTANCE`, and `ATTEMPT`.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_QueryObjects_ResponseSyntax"></a>

```
{
   "hasMoreResults": boolean,
   "ids": [ "string" ],
   "marker": "string"
}
```

## Response Elements
<a name="API_QueryObjects_ResponseElements"></a>

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

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

 ** [hasMoreResults](#API_QueryObjects_ResponseSyntax) **   <a name="DP-QueryObjects-response-hasMoreResults"></a>
Indicates whether there are more results that can be obtained by a subsequent call.  
Type: Boolean

 ** [ids](#API_QueryObjects_ResponseSyntax) **   <a name="DP-QueryObjects-response-ids"></a>
The identifiers that match the query selectors.  
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]*` 

 ** [marker](#API_QueryObjects_ResponseSyntax) **   <a name="DP-QueryObjects-response-marker"></a>
The starting point for the next page of results. To view the next page of results, call `QueryObjects` again with this marker value. If the value is null, there are no more results.  
Type: String

## Errors
<a name="API_QueryObjects_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
An internal service error occurred.    
 ** message **   
Description of the error message.
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.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineDeletedException **   
The specified pipeline has been deleted.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The specified pipeline was not found. Verify that you used the correct user and account identifiers.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

## Examples
<a name="API_QueryObjects_Examples"></a>

### Example
<a name="API_QueryObjects_Example_1"></a>

This example illustrates one usage of QueryObjects.

#### Sample Request
<a name="API_QueryObjects_Example_1_Request"></a>

```
POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: DataPipeline.QueryObjects
Content-Length: 123
Host: datapipeline.us-east-1.amazonaws.com
X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
Authorization: AuthParams

{"pipelineId": "df-06372391ZG65EXAMPLE",
 "query": 
  {"selectors": 
    [
    ]
  },
 "sphere": "INSTANCE",
 "marker": "",
 "limit": 10}
```

#### Sample Response
<a name="API_QueryObjects_Example_1_Response"></a>

```
x-amzn-RequestId: 14d704c1-0775-11e2-af6f-6bc7a6be60d9
Content-Type: application/x-amz-json-1.1
Content-Length: 72
Date: Mon, 12 Nov 2012 17:50:53 GMT

{"hasMoreResults": false, 
 "ids": 
  ["@SayHello_1_2012-09-25T17:00:00"]
}
```

## See Also
<a name="API_QueryObjects_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datapipeline-2012-10-29/QueryObjects) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datapipeline-2012-10-29/QueryObjects) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datapipeline-2012-10-29/QueryObjects) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datapipeline-2012-10-29/QueryObjects) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datapipeline-2012-10-29/QueryObjects) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datapipeline-2012-10-29/QueryObjects) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datapipeline-2012-10-29/QueryObjects) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datapipeline-2012-10-29/QueryObjects) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datapipeline-2012-10-29/QueryObjects) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datapipeline-2012-10-29/QueryObjects) 

# RemoveTags
<a name="API_RemoveTags"></a>

Removes existing tags from the specified pipeline.

## Request Syntax
<a name="API_RemoveTags_RequestSyntax"></a>

```
{
   "pipelineId": "string",
   "tagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_RemoveTags_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [pipelineId](#API_RemoveTags_RequestSyntax) **   <a name="DP-RemoveTags-request-pipelineId"></a>
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

 ** [tagKeys](#API_RemoveTags_RequestSyntax) **   <a name="DP-RemoveTags-request-tagKeys"></a>
The keys of the tags to remove.  
Type: Array of strings  
Required: Yes

## Response Elements
<a name="API_RemoveTags_ResponseElements"></a>

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

## Errors
<a name="API_RemoveTags_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
An internal service error occurred.    
 ** message **   
Description of the error message.
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.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineDeletedException **   
The specified pipeline has been deleted.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The specified pipeline was not found. Verify that you used the correct user and account identifiers.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

## See Also
<a name="API_RemoveTags_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datapipeline-2012-10-29/RemoveTags) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datapipeline-2012-10-29/RemoveTags) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datapipeline-2012-10-29/RemoveTags) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datapipeline-2012-10-29/RemoveTags) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datapipeline-2012-10-29/RemoveTags) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datapipeline-2012-10-29/RemoveTags) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datapipeline-2012-10-29/RemoveTags) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datapipeline-2012-10-29/RemoveTags) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datapipeline-2012-10-29/RemoveTags) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datapipeline-2012-10-29/RemoveTags) 

# ReportTaskProgress
<a name="API_ReportTaskProgress"></a>

Task runners call `ReportTaskProgress` when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent [PollForTask](API_PollForTask.md) call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a `reportProgressTimeout` field in your pipeline.

## Request Syntax
<a name="API_ReportTaskProgress_RequestSyntax"></a>

```
{
   "fields": [ 
      { 
         "key": "string",
         "refValue": "string",
         "stringValue": "string"
      }
   ],
   "taskId": "string"
}
```

## Request Parameters
<a name="API_ReportTaskProgress_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [fields](#API_ReportTaskProgress_RequestSyntax) **   <a name="DP-ReportTaskProgress-request-fields"></a>
Key-value pairs that define the properties of the ReportTaskProgressInput object.  
Type: Array of [Field](API_Field.md) objects  
Required: No

 ** [taskId](#API_ReportTaskProgress_RequestSyntax) **   <a name="DP-ReportTaskProgress-request-taskId"></a>
The ID of the task assigned to the task runner. This value is provided in the response for [PollForTask](API_PollForTask.md).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*`   
Required: Yes

## Response Syntax
<a name="API_ReportTaskProgress_ResponseSyntax"></a>

```
{
   "canceled": boolean
}
```

## Response Elements
<a name="API_ReportTaskProgress_ResponseElements"></a>

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

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

 ** [canceled](#API_ReportTaskProgress_ResponseSyntax) **   <a name="DP-ReportTaskProgress-response-canceled"></a>
If true, the calling task runner should cancel processing of the task. The task runner does not need to call [SetTaskStatus](API_SetTaskStatus.md) for canceled tasks.  
Type: Boolean

## Errors
<a name="API_ReportTaskProgress_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
An internal service error occurred.    
 ** message **   
Description of the error message.
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.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineDeletedException **   
The specified pipeline has been deleted.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The specified pipeline was not found. Verify that you used the correct user and account identifiers.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** TaskNotFoundException **   
The specified task was not found.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

## Examples
<a name="API_ReportTaskProgress_Examples"></a>

### Example
<a name="API_ReportTaskProgress_Example_1"></a>

This example illustrates one usage of ReportTaskProgress.

#### Sample Request
<a name="API_ReportTaskProgress_Example_1_Request"></a>

```
POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: DataPipeline.ReportTaskProgress
Content-Length: 832
Host: datapipeline.us-east-1.amazonaws.com
X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
Authorization: AuthParams

{"taskId": "aaGgHT4LuH0T0Y0oLrJRjas5qH0d8cDPADxqq3tn+zCWGELkCdV2JprLreXm1oxeP5EFZHFLJ69kjSsLYE0iYHYBYVGBrB+E/pYq7ANEEeGJFnSBMRiXZVA+8UJ3OzcInvXeinqBmBaKwii7hnnKb/AXjXiNTXyxgydX1KAyg1AxkwBYG4cfPYMZbuEbQJFJvv5C/2+GVXz1w94nKYTeUeepwUOFOuRLS6JVtZoYwpF56E+Yfk1IcGpFOvCZ01B4Bkuu7x3J+MD/j6kJgZLAgbCJQtI3eiW3kdGmX0p0I2BdY1ZsX6b4UiSvM3OMj6NEHJCJL4E0ZfitnhCoe24Kvjo6C2hFbZq+ei/HPgSXBQMSagkr4vS9c0ChzxH2+LNYvec6bY4kymkaZI1dvOzmpa0FcnGf5AjSK4GpsViZ/ujz6zxFv81qBXzjF0/4M1775rjV1VUdyKaixiA/sJiACNezqZqETidp8d24BDPRhGsj6pBCrnelqGFrk/gXEXUsJ+xwMifRC8UVwiKekpAvHUywVk7Ku4jH/n3i2VoLRP6FXwpUbelu34iiZ9czpXyLtyPKwxa87dlrnRVURwkcVjOt2Mcrcaqe+cbWHvNRhyrPkkdfSF3ac8/wfgVbXvLEB2k9mKc67aD9rvdc1PKX09Tk8BKklsMTpZ3TRCd4NzQlJKigMe8Jat9+1tKj4Ole5ZzW6uyTu2s2iFjEV8KXu4MaiRJyNKCdKeGhhZWY37Qk4NBK4Ppgu+C6Y41dpfOh288SLDEVx0/UySlqOEdhba7c6BiPp5r3hKj3mk9lFy5OYp1aoGLeeFmjXveTnPdf2gkWqXXg7AUbJ7jEs1F0lKZQg4szep2gcKyAJXgvXLfJJHcha8Lfb/Ee7wYmyOcAaRpDBoFNSbtoVXar46teIrpho+ZDvynUXvU0grHWGOk=:wn3SgymHZM99bEXAMPLE",
 "fields": 
  [
    {"key": "percentComplete",
     "stringValue": "50"}
  ]
}
```

#### Sample Response
<a name="API_ReportTaskProgress_Example_1_Response"></a>

```
x-amzn-RequestId: 640bd023-0775-11e2-af6f-6bc7a6be60d9
Content-Type: application/x-amz-json-1.1
Content-Length: 18
Date: Mon, 12 Nov 2012 17:50:53 GMT

{"canceled": false}
```

## See Also
<a name="API_ReportTaskProgress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datapipeline-2012-10-29/ReportTaskProgress) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datapipeline-2012-10-29/ReportTaskProgress) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datapipeline-2012-10-29/ReportTaskProgress) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datapipeline-2012-10-29/ReportTaskProgress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datapipeline-2012-10-29/ReportTaskProgress) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datapipeline-2012-10-29/ReportTaskProgress) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datapipeline-2012-10-29/ReportTaskProgress) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datapipeline-2012-10-29/ReportTaskProgress) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datapipeline-2012-10-29/ReportTaskProgress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datapipeline-2012-10-29/ReportTaskProgress) 

# ReportTaskRunnerHeartbeat
<a name="API_ReportTaskRunnerHeartbeat"></a>

Task runners call `ReportTaskRunnerHeartbeat` every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance.

## Request Syntax
<a name="API_ReportTaskRunnerHeartbeat_RequestSyntax"></a>

```
{
   "hostname": "string",
   "taskrunnerId": "string",
   "workerGroup": "string"
}
```

## Request Parameters
<a name="API_ReportTaskRunnerHeartbeat_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [hostname](#API_ReportTaskRunnerHeartbeat_RequestSyntax) **   <a name="DP-ReportTaskRunnerHeartbeat-request-hostname"></a>
The public DNS name of the task runner.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\n\t]*`   
Required: No

 ** [taskrunnerId](#API_ReportTaskRunnerHeartbeat_RequestSyntax) **   <a name="DP-ReportTaskRunnerHeartbeat-request-taskrunnerId"></a>
The ID of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application. If you have written a custom task runner, you should assign a unique identifier for the task runner.  
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

 ** [workerGroup](#API_ReportTaskRunnerHeartbeat_RequestSyntax) **   <a name="DP-ReportTaskRunnerHeartbeat-request-workerGroup"></a>
The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for `workerGroup`. There are no wildcard values permitted in `workerGroup`; the string must be an exact, case-sensitive, match.  
Type: String  
Required: No

## Response Syntax
<a name="API_ReportTaskRunnerHeartbeat_ResponseSyntax"></a>

```
{
   "terminate": boolean
}
```

## Response Elements
<a name="API_ReportTaskRunnerHeartbeat_ResponseElements"></a>

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

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

 ** [terminate](#API_ReportTaskRunnerHeartbeat_ResponseSyntax) **   <a name="DP-ReportTaskRunnerHeartbeat-response-terminate"></a>
Indicates whether the calling task runner should terminate.  
Type: Boolean

## Errors
<a name="API_ReportTaskRunnerHeartbeat_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
An internal service error occurred.    
 ** message **   
Description of the error message.
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.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

## Examples
<a name="API_ReportTaskRunnerHeartbeat_Examples"></a>

### Example
<a name="API_ReportTaskRunnerHeartbeat_Example_1"></a>

This example illustrates one usage of ReportTaskRunnerHeartbeat.

#### Sample Request
<a name="API_ReportTaskRunnerHeartbeat_Example_1_Request"></a>

```
           

POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: DataPipeline.ReportTaskRunnerHeartbeat
Content-Length: 84
Host: datapipeline.us-east-1.amazonaws.com
X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
Authorization: AuthParams

{"taskrunnerId": "1234567890",
 "workerGroup": "wg-12345",
 "hostname": "example.com"}
```

#### Sample Response
<a name="API_ReportTaskRunnerHeartbeat_Example_1_Response"></a>

```
Status:
x-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9
Content-Type: application/x-amz-json-1.1
Content-Length: 20
Date: Mon, 12 Nov 2012 17:50:53 GMT

{"terminate": false}
```

## See Also
<a name="API_ReportTaskRunnerHeartbeat_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datapipeline-2012-10-29/ReportTaskRunnerHeartbeat) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datapipeline-2012-10-29/ReportTaskRunnerHeartbeat) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datapipeline-2012-10-29/ReportTaskRunnerHeartbeat) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datapipeline-2012-10-29/ReportTaskRunnerHeartbeat) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datapipeline-2012-10-29/ReportTaskRunnerHeartbeat) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datapipeline-2012-10-29/ReportTaskRunnerHeartbeat) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datapipeline-2012-10-29/ReportTaskRunnerHeartbeat) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datapipeline-2012-10-29/ReportTaskRunnerHeartbeat) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datapipeline-2012-10-29/ReportTaskRunnerHeartbeat) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datapipeline-2012-10-29/ReportTaskRunnerHeartbeat) 

# SetStatus
<a name="API_SetStatus"></a>

Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on `FINISHED` pipelines and attempting to do so returns `InvalidRequestException`.

## Request Syntax
<a name="API_SetStatus_RequestSyntax"></a>

```
{
   "objectIds": [ "string" ],
   "pipelineId": "string",
   "status": "string"
}
```

## Request Parameters
<a name="API_SetStatus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [objectIds](#API_SetStatus_RequestSyntax) **   <a name="DP-SetStatus-request-objectIds"></a>
The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.  
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

 ** [pipelineId](#API_SetStatus_RequestSyntax) **   <a name="DP-SetStatus-request-pipelineId"></a>
The ID of the pipeline that contains the objects.  
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

 ** [status](#API_SetStatus_RequestSyntax) **   <a name="DP-SetStatus-request-status"></a>
The status to be set on all the objects specified in `objectIds`. For components, use `PAUSE` or `RESUME`. For instances, use `TRY_CANCEL`, `RERUN`, or `MARK_FINISHED`.  
Type: String  
Required: Yes

## Response Elements
<a name="API_SetStatus_ResponseElements"></a>

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

## Errors
<a name="API_SetStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
An internal service error occurred.    
 ** message **   
Description of the error message.
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.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineDeletedException **   
The specified pipeline has been deleted.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The specified pipeline was not found. Verify that you used the correct user and account identifiers.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

## Examples
<a name="API_SetStatus_Examples"></a>

### Example
<a name="API_SetStatus_Example_1"></a>

This example illustrates one usage of SetStatus.

#### Sample Request
<a name="API_SetStatus_Example_1_Request"></a>

```
POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: DataPipeline.SetStatus
Content-Length: 100
Host: datapipeline.us-east-1.amazonaws.com
X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
Authorization: AuthParams

{"pipelineId": "df-0634701J7KEXAMPLE", 
 "objectIds": 
  ["o-08600941GHJWMBR9E2"], 
 "status": "pause"}
```

#### Sample Response
<a name="API_SetStatus_Example_1_Response"></a>

```
x-amzn-RequestId: e83b8ab7-076a-11e2-af6f-6bc7a6be60d9
Content-Type: application/x-amz-json-1.1
Content-Length: 0
Date: Mon, 12 Nov 2012 17:50:53 GMT

Unexpected response: 200, OK, undefined
```

## See Also
<a name="API_SetStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datapipeline-2012-10-29/SetStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datapipeline-2012-10-29/SetStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datapipeline-2012-10-29/SetStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datapipeline-2012-10-29/SetStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datapipeline-2012-10-29/SetStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datapipeline-2012-10-29/SetStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datapipeline-2012-10-29/SetStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datapipeline-2012-10-29/SetStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datapipeline-2012-10-29/SetStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datapipeline-2012-10-29/SetStatus) 

# SetTaskStatus
<a name="API_SetTaskStatus"></a>

Task runners call `SetTaskStatus` to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call `SetTaskStatus` for tasks that are canceled by the web service during a call to [ReportTaskProgress](API_ReportTaskProgress.md).

## Request Syntax
<a name="API_SetTaskStatus_RequestSyntax"></a>

```
{
   "errorId": "string",
   "errorMessage": "string",
   "errorStackTrace": "string",
   "taskId": "string",
   "taskStatus": "string"
}
```

## Request Parameters
<a name="API_SetTaskStatus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [errorId](#API_SetTaskStatus_RequestSyntax) **   <a name="DP-SetTaskStatus-request-errorId"></a>
If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string "Service\$1" which is reserved by the system.  
Type: String  
Required: No

 ** [errorMessage](#API_SetTaskStatus_RequestSyntax) **   <a name="DP-SetTaskStatus-request-errorMessage"></a>
If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.  
Type: String  
Required: No

 ** [errorStackTrace](#API_SetTaskStatus_RequestSyntax) **   <a name="DP-SetTaskStatus-request-errorStackTrace"></a>
If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4095.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*`   
Required: No

 ** [taskId](#API_SetTaskStatus_RequestSyntax) **   <a name="DP-SetTaskStatus-request-taskId"></a>
The ID of the task assigned to the task runner. This value is provided in the response for [PollForTask](API_PollForTask.md).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*`   
Required: Yes

 ** [taskStatus](#API_SetTaskStatus_RequestSyntax) **   <a name="DP-SetTaskStatus-request-taskStatus"></a>
If `FINISHED`, the task successfully completed. If `FAILED`, the task ended unsuccessfully. Preconditions use false.  
Type: String  
Valid Values: `FINISHED | FAILED | FALSE`   
Required: Yes

## Response Elements
<a name="API_SetTaskStatus_ResponseElements"></a>

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

## Errors
<a name="API_SetTaskStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
An internal service error occurred.    
 ** message **   
Description of the error message.
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.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineDeletedException **   
The specified pipeline has been deleted.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The specified pipeline was not found. Verify that you used the correct user and account identifiers.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** TaskNotFoundException **   
The specified task was not found.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

## Examples
<a name="API_SetTaskStatus_Examples"></a>

### Example
<a name="API_SetTaskStatus_Example_1"></a>

This example illustrates one usage of SetTaskStatus.

#### Sample Request
<a name="API_SetTaskStatus_Example_1_Request"></a>

```
POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: DataPipeline.SetTaskStatus
Content-Length: 847
Host: datapipeline.us-east-1.amazonaws.com
X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
Authorization: AuthParams

{"taskId": "aaGgHT4LuH0T0Y0oLrJRjas5qH0d8cDPADxqq3tn+zCWGELkCdV2JprLreXm1oxeP5EFZHFLJ69kjSsLYE0iYHYBYVGBrB+E/pYq7ANEEeGJFnSBMRiXZVA+8UJ3OzcInvXeinqBmBaKwii7hnnKb/AXjXiNTXyxgydX1KAyg1AxkwBYG4cfPYMZbuEbQJFJvv5C/2+GVXz1w94nKYTeUeepwUOFOuRLS6JVtZoYwpF56E+Yfk1IcGpFOvCZ01B4Bkuu7x3J+MD/j6kJgZLAgbCJQtI3eiW3kdGmX0p0I2BdY1ZsX6b4UiSvM3OMj6NEHJCJL4E0ZfitnhCoe24Kvjo6C2hFbZq+ei/HPgSXBQMSagkr4vS9c0ChzxH2+LNYvec6bY4kymkaZI1dvOzmpa0FcnGf5AjSK4GpsViZ/ujz6zxFv81qBXzjF0/4M1775rjV1VUdyKaixiA/sJiACNezqZqETidp8d24BDPRhGsj6pBCrnelqGFrk/gXEXUsJ+xwMifRC8UVwiKekpAvHUywVk7Ku4jH/n3i2VoLRP6FXwpUbelu34iiZ9czpXyLtyPKwxa87dlrnRVURwkcVjOt2Mcrcaqe+cbWHvNRhyrPkkdfSF3ac8/wfgVbXvLEB2k9mKc67aD9rvdc1PKX09Tk8BKklsMTpZ3TRCd4NzQlJKigMe8Jat9+1tKj4Ole5ZzW6uyTu2s2iFjEV8KXu4MaiRJyNKCdKeGhhZWY37Qk4NBK4Ppgu+C6Y41dpfOh288SLDEVx0/UySlqOEdhba7c6BiPp5r3hKj3mk9lFy5OYp1aoGLeeFmjXveTnPdf2gkWqXXg7AUbJ7jEs1F0lKZQg4szep2gcKyAJXgvXLfJJHcha8Lfb/Ee7wYmyOcAaRpDBoFNSbtoVXar46teIrpho+ZDvynUXvU0grHWGOk=:wn3SgymHZM99bEXAMPLE",
 "taskStatus": "FINISHED"}
```

#### Sample Response
<a name="API_SetTaskStatus_Example_1_Response"></a>

```
x-amzn-RequestId: 8c8deb53-0788-11e2-af9c-6bc7a6be6qr8 
Content-Type: application/x-amz-json-1.1
Content-Length: 0
Date: Mon, 12 Nov 2012 17:50:53 GMT

{}
```

## See Also
<a name="API_SetTaskStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datapipeline-2012-10-29/SetTaskStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datapipeline-2012-10-29/SetTaskStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datapipeline-2012-10-29/SetTaskStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datapipeline-2012-10-29/SetTaskStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datapipeline-2012-10-29/SetTaskStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datapipeline-2012-10-29/SetTaskStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datapipeline-2012-10-29/SetTaskStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datapipeline-2012-10-29/SetTaskStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datapipeline-2012-10-29/SetTaskStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datapipeline-2012-10-29/SetTaskStatus) 

# ValidatePipelineDefinition
<a name="API_ValidatePipelineDefinition"></a>

Validates the specified pipeline definition to ensure that it is well formed and can be run without error.

## Request Syntax
<a name="API_ValidatePipelineDefinition_RequestSyntax"></a>

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

## Request Parameters
<a name="API_ValidatePipelineDefinition_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [parameterObjects](#API_ValidatePipelineDefinition_RequestSyntax) **   <a name="DP-ValidatePipelineDefinition-request-parameterObjects"></a>
The parameter objects used with the pipeline.  
Type: Array of [ParameterObject](API_ParameterObject.md) objects  
Required: No

 ** [parameterValues](#API_ValidatePipelineDefinition_RequestSyntax) **   <a name="DP-ValidatePipelineDefinition-request-parameterValues"></a>
The parameter values used with the pipeline.  
Type: Array of [ParameterValue](API_ParameterValue.md) objects  
Required: No

 ** [pipelineId](#API_ValidatePipelineDefinition_RequestSyntax) **   <a name="DP-ValidatePipelineDefinition-request-pipelineId"></a>
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

 ** [pipelineObjects](#API_ValidatePipelineDefinition_RequestSyntax) **   <a name="DP-ValidatePipelineDefinition-request-pipelineObjects"></a>
The objects that define the pipeline changes to validate against the pipeline.  
Type: Array of [PipelineObject](API_PipelineObject.md) objects  
Required: Yes

## Response Syntax
<a name="API_ValidatePipelineDefinition_ResponseSyntax"></a>

```
{
   "errored": boolean,
   "validationErrors": [ 
      { 
         "errors": [ "string" ],
         "id": "string"
      }
   ],
   "validationWarnings": [ 
      { 
         "id": "string",
         "warnings": [ "string" ]
      }
   ]
}
```

## Response Elements
<a name="API_ValidatePipelineDefinition_ResponseElements"></a>

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

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

 ** [errored](#API_ValidatePipelineDefinition_ResponseSyntax) **   <a name="DP-ValidatePipelineDefinition-response-errored"></a>
Indicates whether there were validation errors.  
Type: Boolean

 ** [validationErrors](#API_ValidatePipelineDefinition_ResponseSyntax) **   <a name="DP-ValidatePipelineDefinition-response-validationErrors"></a>
Any validation errors that were found.  
Type: Array of [ValidationError](API_ValidationError.md) objects

 ** [validationWarnings](#API_ValidatePipelineDefinition_ResponseSyntax) **   <a name="DP-ValidatePipelineDefinition-response-validationWarnings"></a>
Any validation warnings that were found.  
Type: Array of [ValidationWarning](API_ValidationWarning.md) objects

## Errors
<a name="API_ValidatePipelineDefinition_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
An internal service error occurred.    
 ** message **   
Description of the error message.
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.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineDeletedException **   
The specified pipeline has been deleted.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The specified pipeline was not found. Verify that you used the correct user and account identifiers.    
 ** message **   
Description of the error message.
HTTP Status Code: 400

## Examples
<a name="API_ValidatePipelineDefinition_Examples"></a>

### Example 1
<a name="API_ValidatePipelineDefinition_Example_1"></a>

 This example sets an valid pipeline configuration and returns success. 

#### Sample Request
<a name="API_ValidatePipelineDefinition_Example_1_Request"></a>

```
                
POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: DataPipeline.ValidatePipelineDefinition
Content-Length: 936
Host: datapipeline.us-east-1.amazonaws.com
X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
Authorization: AuthParams

{"pipelineId": "df-06372391ZG65EXAMPLE",
 "pipelineObjects": 
  [
    {"id": "Default",
     "name": "Default",
     "fields": 
      [
        {"key": "workerGroup", 
         "stringValue": "MyworkerGroup"}
      ]
    }, 
    {"id": "Schedule",
     "name": "Schedule",
     "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": "SayHello",
     "name": "SayHello",
     "fields": 
      [
        {"key": "type", 
         "stringValue": "ShellCommandActivity"},
        {"key": "command", 
         "stringValue": "echo hello"},
        {"key": "parent", 
         "refValue": "Default"},
        {"key": "schedule", 
         "refValue": "Schedule"}
 
      ]
    }
  ]
}
```

#### Sample Response
<a name="API_ValidatePipelineDefinition_Example_1_Response"></a>

```
                
x-amzn-RequestId: 92c9f347-0776-11e2-8a14-21bb8a1f50ef
Content-Type: application/x-amz-json-1.1
Content-Length: 18
Date: Mon, 12 Nov 2012 17:50:53 GMT

{"errored": false}
```

### Example 2
<a name="API_ValidatePipelineDefinition_Example_2"></a>

 This example sets an invalid pipeline configuration and returns the associated set of validation errors. 

#### Sample Request
<a name="API_ValidatePipelineDefinition_Example_2_Request"></a>

```
                
POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: DataPipeline.ValidatePipelineDefinition
Content-Length: 903
Host: datapipeline.us-east-1.amazonaws.com
X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
Authorization: AuthParams

{"pipelineId": "df-06372391ZG65EXAMPLE",
 "pipelineObjects": 
  [
    {"id": "Default",
     "name": "Default",
     "fields": 
      [
        {"key": "workerGroup", 
         "stringValue": "MyworkerGroup"}
      ]
    }, 
    {"id": "Schedule",
     "name": "Schedule",
     "fields": 
      [
       {"key": "startDateTime", 
         "stringValue": "bad-time"}, 
        {"key": "type", 
         "stringValue": "Schedule"}, 
        {"key": "period", 
         "stringValue": "1 hour"}, 
        {"key": "endDateTime", 
         "stringValue": "2012-09-25T18:00:00"}
      ]
    },
    {"id": "SayHello",
     "name": "SayHello",
     "fields": 
      [
        {"key": "type", 
         "stringValue": "ShellCommandActivity"},
        {"key": "command", 
         "stringValue": "echo hello"},
        {"key": "parent", 
         "refValue": "Default"},
        {"key": "schedule", 
         "refValue": "Schedule"}
 
      ]
    }
  ]
}
```

#### Sample Response
<a name="API_ValidatePipelineDefinition_Example_2_Response"></a>

```
                
x-amzn-RequestId: 496a1f5a-0e6a-11e2-a61c-bd6312c92ddd
Content-Type: application/x-amz-json-1.1
Content-Length: 278
Date: Mon, 12 Nov 2012 17:50:53 GMT

{"errored": true, 
 "validationErrors": 
  [
    {"errors": 
      ["INVALID_FIELD_VALUE:  'startDateTime' value must be a literal datetime value."], 
     "id": "Schedule"}
  ]
}
```

## See Also
<a name="API_ValidatePipelineDefinition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datapipeline-2012-10-29/ValidatePipelineDefinition) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datapipeline-2012-10-29/ValidatePipelineDefinition) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datapipeline-2012-10-29/ValidatePipelineDefinition) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datapipeline-2012-10-29/ValidatePipelineDefinition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datapipeline-2012-10-29/ValidatePipelineDefinition) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datapipeline-2012-10-29/ValidatePipelineDefinition) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datapipeline-2012-10-29/ValidatePipelineDefinition) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datapipeline-2012-10-29/ValidatePipelineDefinition) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datapipeline-2012-10-29/ValidatePipelineDefinition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datapipeline-2012-10-29/ValidatePipelineDefinition)