AWS SDK for .NET Documentation
AmazonDataPipelineClient Class
AmazonAmazon.DataPipelineAmazonDataPipelineClient Did this page help you?   Yes   No    Tell us about it...
Implementation for accessing AmazonDataPipeline.

This is the AWS Data Pipeline API Reference . This guide provides descriptions and samples of the AWS Data Pipeline API.

AWS Data Pipeline is a web service that 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 your application can focus on processing the data.

The AWS Data Pipeline API implements two main sets of functionality. The first set of actions configure the pipeline in the web service. You call these actions to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data.

The second set of actions are used by a task runner application that calls the AWS Data Pipeline API 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.

AWS Data Pipeline provides an open-source 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.

The AWS Data Pipeline API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see Signature Version 4 Signing Process. In the code examples in this reference, the Signature Version 4 Request parameters are represented as AuthParams.

Declaration Syntax
C#
public class AmazonDataPipelineClient : AmazonWebServiceClient, 
	AmazonDataPipeline, IDisposable
Members
All MembersConstructorsMethodsEvents



IconMemberDescription
AmazonDataPipelineClient()()()()
Constructs AmazonDataPipelineClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

AmazonDataPipelineClient(RegionEndpoint)
Constructs AmazonDataPipelineClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

AmazonDataPipelineClient(AmazonDataPipelineConfig)
Constructs AmazonDataPipelineClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

AmazonDataPipelineClient(AWSCredentials)
Constructs AmazonDataPipelineClient with AWS Credentials

AmazonDataPipelineClient(AWSCredentials, RegionEndpoint)
Constructs AmazonDataPipelineClient with AWS Credentials

AmazonDataPipelineClient(AWSCredentials, AmazonDataPipelineConfig)
Constructs AmazonDataPipelineClient with AWS Credentials and an AmazonDataPipelineClient Configuration object.

AmazonDataPipelineClient(String, String)
Constructs AmazonDataPipelineClient with AWS Access Key ID and AWS Secret Key

AmazonDataPipelineClient(String, String, RegionEndpoint)
Constructs AmazonDataPipelineClient with AWS Access Key ID and AWS Secret Key

AmazonDataPipelineClient(String, String, AmazonDataPipelineConfig)
Constructs AmazonDataPipelineClient with AWS Access Key ID, AWS Secret Key and an AmazonDataPipelineClient Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings.

AmazonDataPipelineClient(String, String, String)
Constructs AmazonDataPipelineClient with AWS Access Key ID and AWS Secret Key

AmazonDataPipelineClient(String, String, String, RegionEndpoint)
Constructs AmazonDataPipelineClient with AWS Access Key ID and AWS Secret Key

AmazonDataPipelineClient(String, String, String, AmazonDataPipelineConfig)
Constructs AmazonDataPipelineClient with AWS Access Key ID, AWS Secret Key and an AmazonDataPipelineClient Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings.

ActivatePipeline(ActivatePipelineRequest)

Validates a pipeline and initiates processing. If the pipeline does not pass validation, activation fails.

Call this action to start processing pipeline tasks of a pipeline you've created using the CreatePipeline and PutPipelineDefinition actions. A pipeline cannot be modified after it has been successfully activated.


AfterResponseEvent
Occurs after a response is received from the service.
(Inherited from AmazonWebServiceClient.)
BeforeRequestEvent
Occurs before a request is issued against the service.
(Inherited from AmazonWebServiceClient.)
BeginActivatePipeline(ActivatePipelineRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ActivatePipeline operation.

BeginCreatePipeline(CreatePipelineRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreatePipeline operation.

BeginDeletePipeline(DeletePipelineRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeletePipeline operation.

BeginDescribeObjects(DescribeObjectsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeObjects operation.

BeginDescribePipelines(DescribePipelinesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribePipelines operation.

BeginEvaluateExpression(EvaluateExpressionRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the EvaluateExpression operation.

BeginGetPipelineDefinition(GetPipelineDefinitionRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the GetPipelineDefinition operation.

BeginListPipelines(ListPipelinesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListPipelines operation.

BeginPollForTask(PollForTaskRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the PollForTask operation.

BeginPutPipelineDefinition(PutPipelineDefinitionRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the PutPipelineDefinition operation.

BeginQueryObjects(QueryObjectsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the QueryObjects operation.

BeginReportTaskProgress(ReportTaskProgressRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ReportTaskProgress operation.

BeginReportTaskRunnerHeartbeat(ReportTaskRunnerHeartbeatRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ReportTaskRunnerHeartbeat operation.

BeginSetStatus(SetStatusRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the SetStatus operation.

BeginSetTaskStatus(SetTaskStatusRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the SetTaskStatus operation.

BeginValidatePipelineDefinition(ValidatePipelineDefinitionRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ValidatePipelineDefinition operation.

CreatePipeline(CreatePipelineRequest)

Creates a new empty pipeline. When this action succeeds, you can then use the PutPipelineDefinition action to populate the pipeline.


DeletePipeline(DeletePipelineRequest)

Permanently deletes a pipeline, its pipeline definition and its run history. You cannot query or restore a deleted pipeline. AWS Data Pipeline will attempt to cancel instances associated with the pipeline that are currently being processed by task runners. Deleting a pipeline cannot be undone.

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.


DescribeObjects(DescribeObjectsRequest)

Returns 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.


DescribePipelines(DescribePipelinesRequest)

Retrieve 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 you have read permission for.

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


Dispose()()()()
Disposes of all managed and unmanaged resources.
(Inherited from AmazonWebServiceClient.)
EndActivatePipeline(IAsyncResult)
Finishes the asynchronous execution of the ActivatePipeline operation.

EndCreatePipeline(IAsyncResult)
Finishes the asynchronous execution of the CreatePipeline operation.

EndDeletePipeline(IAsyncResult)
Finishes the asynchronous execution of the DeletePipeline operation.

EndDescribeObjects(IAsyncResult)
Finishes the asynchronous execution of the DescribeObjects operation.

EndDescribePipelines(IAsyncResult)
Finishes the asynchronous execution of the DescribePipelines operation.

EndEvaluateExpression(IAsyncResult)
Finishes the asynchronous execution of the EvaluateExpression operation.

EndGetPipelineDefinition(IAsyncResult)
Finishes the asynchronous execution of the GetPipelineDefinition operation.

EndListPipelines(IAsyncResult)
Finishes the asynchronous execution of the ListPipelines operation.

EndPollForTask(IAsyncResult)
Finishes the asynchronous execution of the PollForTask operation.

EndPutPipelineDefinition(IAsyncResult)
Finishes the asynchronous execution of the PutPipelineDefinition operation.

EndQueryObjects(IAsyncResult)
Finishes the asynchronous execution of the QueryObjects operation.

EndReportTaskProgress(IAsyncResult)
Finishes the asynchronous execution of the ReportTaskProgress operation.

EndReportTaskRunnerHeartbeat(IAsyncResult)
Finishes the asynchronous execution of the ReportTaskRunnerHeartbeat operation.

EndSetStatus(IAsyncResult)
Finishes the asynchronous execution of the SetStatus operation.

EndSetTaskStatus(IAsyncResult)
Finishes the asynchronous execution of the SetTaskStatus operation.

EndValidatePipelineDefinition(IAsyncResult)
Finishes the asynchronous execution of the ValidatePipelineDefinition operation.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
EvaluateExpression(EvaluateExpressionRequest)

Evaluates a string in the context of a specified object. A task runner can use this action to evaluate SQL queries stored in Amazon S3.


ExceptionEvent
Occurs after an exception is encountered.
(Inherited from AmazonWebServiceClient.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetPipelineDefinition(GetPipelineDefinitionRequest)

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


GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
ListPipelines(ListPipelinesRequest)

Returns a list of pipeline identifiers for all active pipelines. Identifiers are returned only for pipelines you have permission to access.


ListPipelines()()()()

Returns a list of pipeline identifiers for all active pipelines. Identifiers are returned only for pipelines you have permission to access.


PollForTask(PollForTaskRequest)

Task runners call this action 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 of the PollForTask call. The task returned by PollForTask may 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 may take up to 90 seconds.


PutPipelineDefinition(PutPipelineDefinitionRequest)

Adds tasks, schedules, and preconditions that control the behavior of the pipeline. You can use PutPipelineDefinition to populate a new pipeline or to update an existing pipeline that has not yet been activated.

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.

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


QueryObjects(QueryObjectsRequest)

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

The objects returned by QueryObjects are paginated and then filtered by the value you set for query. This means the action may return an empty result set with a value set for marker. If HasMoreResults is set to True , you should continue to call QueryObjects, passing in the returned value for marker, until HasMoreResults returns False .


ReportTaskProgress(ReportTaskProgressRequest)

Updates the AWS Data Pipeline service on the progress of the calling task runner. When the task runner is assigned a task, it should call ReportTaskProgress to acknowledge that it has the task within 2 minutes. If the web service does not recieve this acknowledgement within the 2 minute window, it will assign 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 will assume that the task runner is unable to process the task and will reassign the task in a subsequent response to PollForTask. task runners should call ReportTaskProgress every 60 seconds.


ReportTaskRunnerHeartbeat(ReportTaskRunnerHeartbeatRequest)

Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. In the case of AWS Data Pipeline Task Runner 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.


SetStatus(SetStatusRequest)

Requests that the status of an array of physical or logical pipeline objects be updated in the pipeline. This update may not occur immediately, but is eventually consistent. The status that can be set depends on the type of object.


SetTaskStatus(SetTaskStatusRequest)

Notifies AWS Data Pipeline that a task is completed and provides information about the final status. The task runner calls this action regardless of whether the task was sucessful. The task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress.


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
ValidatePipelineDefinition(ValidatePipelineDefinitionRequest)

Tests the pipeline definition with a set of validation checks to ensure that it is well formed and can run without error.


Inheritance Hierarchy
Object
AmazonWebServiceClient
 AmazonDataPipelineClient

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)