AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 4.5
 
Interface for accessing DataPipeline AWS Data Pipeline configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline handles the details of scheduling and ensuring that data dependencies are met so that your application can focus on processing the data.

AWS Data Pipeline provides a JAR implementation of a task runner called AWS Data Pipeline Task Runner. AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide custom data management.

AWS Data Pipeline implements two main sets of functionality. Use the first set to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data. Use the second set in your task runner application to receive the next task ready for processing. The logic for performing the task, such as querying the data, running data analysis, or converting the data from one format to another, is contained within the task runner. The task runner performs the task assigned to it by the web service, reporting progress to the web service as it does so. When the task is done, the task runner reports the final success or failure of the task to the web service.

Inheritance Hierarchy

Amazon.DataPipeline.IAmazonDataPipeline

Namespace: Amazon.DataPipeline
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public interface IAmazonDataPipeline
         IDisposable

The IAmazonDataPipeline type exposes the following members

Methods

NameDescription
Public Method ActivatePipeline(ActivatePipelineRequest) Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails.

If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call DeactivatePipeline.

To activate a finished pipeline, modify the end date for the pipeline and then activate it.

Public Method ActivatePipelineAsync(ActivatePipelineRequest, CancellationToken) Initiates the asynchronous execution of the ActivatePipeline operation.
Public Method AddTags(string, List<Tag>) Adds or modifies tags for the specified pipeline.
Public Method AddTags(AddTagsRequest) Adds or modifies tags for the specified pipeline.
Public Method AddTagsAsync(AddTagsRequest, CancellationToken) Initiates the asynchronous execution of the AddTags operation.
Public Method CreatePipeline(CreatePipelineRequest) Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
Public Method CreatePipelineAsync(CreatePipelineRequest, CancellationToken) Initiates the asynchronous execution of the CreatePipeline operation.
Public Method DeactivatePipeline(DeactivatePipelineRequest) 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. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.

Public Method DeactivatePipelineAsync(DeactivatePipelineRequest, CancellationToken) Initiates the asynchronous execution of the DeactivatePipeline operation.
Public Method DeletePipeline(DeletePipelineRequest) 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 with the status set to PAUSE on individual components. Components that are paused by SetStatus can be resumed.

Public Method DeletePipelineAsync(DeletePipelineRequest, CancellationToken) Initiates the asynchronous execution of the DeletePipeline operation.
Public Method DescribeObjects(DescribeObjectsRequest) 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.
Public Method DescribeObjectsAsync(DescribeObjectsRequest, CancellationToken) Initiates the asynchronous execution of the DescribeObjects operation.
Public Method DescribePipelines(List<String>) Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions.

To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition.

Public Method DescribePipelines(DescribePipelinesRequest) Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions.

To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition.

Public Method DescribePipelinesAsync(DescribePipelinesRequest, CancellationToken) Initiates the asynchronous execution of the DescribePipelines operation.
Public Method EvaluateExpression(EvaluateExpressionRequest) 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.
Public Method EvaluateExpressionAsync(EvaluateExpressionRequest, CancellationToken) Initiates the asynchronous execution of the EvaluateExpression operation.
Public Method GetPipelineDefinition(GetPipelineDefinitionRequest) Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition.
Public Method GetPipelineDefinitionAsync(GetPipelineDefinitionRequest, CancellationToken) Initiates the asynchronous execution of the GetPipelineDefinition operation.
Public Method ListPipelines() Lists the pipeline identifiers for all active pipelines that you have permission to access.
Public Method ListPipelines(ListPipelinesRequest) Lists the pipeline identifiers for all active pipelines that you have permission to access.
Public Method ListPipelinesAsync(ListPipelinesRequest, CancellationToken) Initiates the asynchronous execution of the ListPipelines operation.
Public Method PollForTask(PollForTaskRequest) 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 IAM 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.

Public Method PollForTaskAsync(PollForTaskRequest, CancellationToken) Initiates the asynchronous execution of the PollForTask operation.
Public Method PutPipelineDefinition(PutPipelineDefinitionRequest) 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 three validation errors exists in the pipeline.

  1. An object is missing a name or identifier field.
  2. A string or reference field is empty.
  3. The number of objects in the pipeline exceeds the maximum allowed objects.
  4. The pipeline is in a FINISHED state.

Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.

Public Method PutPipelineDefinitionAsync(PutPipelineDefinitionRequest, CancellationToken) Initiates the asynchronous execution of the PutPipelineDefinition operation.
Public Method QueryObjects(QueryObjectsRequest) Queries the specified pipeline for the names of objects that match the specified set of conditions.
Public Method QueryObjectsAsync(QueryObjectsRequest, CancellationToken) Initiates the asynchronous execution of the QueryObjects operation.
Public Method RemoveTags(string, List<String>) Removes existing tags from the specified pipeline.
Public Method RemoveTags(RemoveTagsRequest) Removes existing tags from the specified pipeline.
Public Method RemoveTagsAsync(RemoveTagsRequest, CancellationToken) Initiates the asynchronous execution of the RemoveTags operation.
Public Method ReportTaskProgress(ReportTaskProgressRequest) 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 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.

If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to PollForTask. Task runners should call ReportTaskProgress every 60 seconds.

Public Method ReportTaskProgressAsync(ReportTaskProgressRequest, CancellationToken) Initiates the asynchronous execution of the ReportTaskProgress operation.
Public Method ReportTaskRunnerHeartbeat(ReportTaskRunnerHeartbeatRequest) 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.
Public Method ReportTaskRunnerHeartbeatAsync(ReportTaskRunnerHeartbeatRequest, CancellationToken) Initiates the asynchronous execution of the ReportTaskRunnerHeartbeat operation.
Public Method SetStatus(SetStatusRequest) 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.
Public Method SetStatusAsync(SetStatusRequest, CancellationToken) Initiates the asynchronous execution of the SetStatus operation.
Public Method SetTaskStatus(SetTaskStatusRequest) 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.
Public Method SetTaskStatusAsync(SetTaskStatusRequest, CancellationToken) Initiates the asynchronous execution of the SetTaskStatus operation.
Public Method ValidatePipelineDefinition(ValidatePipelineDefinitionRequest) Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
Public Method ValidatePipelineDefinitionAsync(ValidatePipelineDefinitionRequest, CancellationToken) Initiates the asynchronous execution of the ValidatePipelineDefinition operation.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8