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.
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.
Namespace: Amazon.DataPipeline
Assembly: AWSSDK.DataPipeline.dll
Version: 3.x.y.z
public interface IAmazonDataPipeline IAmazonService, IDisposable
The IAmazonDataPipeline type exposes the following members
Name | Type | Description | |
---|---|---|---|
Paginators | Amazon.DataPipeline.Model.IDataPipelinePaginatorFactory |
Paginators for the service |
Name | Description | |
---|---|---|
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. |
|
ActivatePipelineAsync(ActivatePipelineRequest, CancellationToken) |
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. |
|
AddTags(string, List<Tag>) |
Adds or modifies tags for the specified pipeline. |
|
AddTags(AddTagsRequest) |
Adds or modifies tags for the specified pipeline. |
|
AddTagsAsync(string, List<Tag>, CancellationToken) |
Adds or modifies tags for the specified pipeline. |
|
AddTagsAsync(AddTagsRequest, CancellationToken) |
Adds or modifies tags for the specified pipeline. |
|
CreatePipeline(CreatePipelineRequest) |
Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline. |
|
CreatePipelineAsync(CreatePipelineRequest, CancellationToken) |
Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline. |
|
DeactivatePipeline(DeactivatePipelineRequest) |
Deactivates the specified running pipeline. The pipeline is set to the 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. |
|
DeactivatePipelineAsync(DeactivatePipelineRequest, CancellationToken) |
Deactivates the specified running pipeline. The pipeline is set to the 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. |
|
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 |
|
DeletePipelineAsync(DeletePipelineRequest, CancellationToken) |
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 |
|
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. |
|
DescribeObjectsAsync(DescribeObjectsRequest, CancellationToken) |
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. |
|
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. |
|
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. |
|
DescribePipelinesAsync(List<String>, CancellationToken) |
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. |
|
DescribePipelinesAsync(DescribePipelinesRequest, CancellationToken) |
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. |
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
EvaluateExpression(EvaluateExpressionRequest) |
Task runners call |
|
EvaluateExpressionAsync(EvaluateExpressionRequest, CancellationToken) |
Task runners call |
|
GetPipelineDefinition(GetPipelineDefinitionRequest) |
Gets the definition of the specified pipeline. You can call |
|
GetPipelineDefinitionAsync(GetPipelineDefinitionRequest, CancellationToken) |
Gets the definition of the specified pipeline. You can call |
|
ListPipelines() |
Lists the pipeline identifiers for all active pipelines that you have permission to access. |
|
ListPipelines(ListPipelinesRequest) |
Lists the pipeline identifiers for all active pipelines that you have permission to access. |
|
ListPipelinesAsync(CancellationToken) |
Lists the pipeline identifiers for all active pipelines that you have permission to access. |
|
ListPipelinesAsync(ListPipelinesRequest, CancellationToken) |
Lists the pipeline identifiers for all active pipelines that you have permission to access. |
|
PollForTask(PollForTaskRequest) |
Task runners call
If tasks are ready in the work queue, |
|
PollForTaskAsync(PollForTaskRequest, CancellationToken) |
Task runners call
If tasks are ready in the work queue, |
|
PutPipelineDefinition(PutPipelineDefinitionRequest) |
Adds tasks, schedules, and preconditions to the specified pipeline. You can use
Pipeline object definitions are passed to the |
|
PutPipelineDefinitionAsync(PutPipelineDefinitionRequest, CancellationToken) |
Adds tasks, schedules, and preconditions to the specified pipeline. You can use
Pipeline object definitions are passed to the |
|
QueryObjects(QueryObjectsRequest) |
Queries the specified pipeline for the names of objects that match the specified set of conditions. |
|
QueryObjectsAsync(QueryObjectsRequest, CancellationToken) |
Queries the specified pipeline for the names of objects that match the specified set of conditions. |
|
RemoveTags(string, List<String>) |
Removes existing tags from the specified pipeline. |
|
RemoveTags(RemoveTagsRequest) |
Removes existing tags from the specified pipeline. |
|
RemoveTagsAsync(string, List<String>, CancellationToken) |
Removes existing tags from the specified pipeline. |
|
RemoveTagsAsync(RemoveTagsRequest, CancellationToken) |
Removes existing tags from the specified pipeline. |
|
ReportTaskProgress(ReportTaskProgressRequest) |
Task runners call
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 |
|
ReportTaskProgressAsync(ReportTaskProgressRequest, CancellationToken) |
Task runners call
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 |
|
ReportTaskRunnerHeartbeat(ReportTaskRunnerHeartbeatRequest) |
Task runners call |
|
ReportTaskRunnerHeartbeatAsync(ReportTaskRunnerHeartbeatRequest, CancellationToken) |
Task runners call |
|
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 |
|
SetStatusAsync(SetStatusRequest, CancellationToken) |
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 |
|
SetTaskStatus(SetTaskStatusRequest) |
Task runners call |
|
SetTaskStatusAsync(SetTaskStatusRequest, CancellationToken) |
Task runners call |
|
ValidatePipelineDefinition(ValidatePipelineDefinitionRequest) |
Validates the specified pipeline definition to ensure that it is well formed and can be run without error. |
|
ValidatePipelineDefinitionAsync(ValidatePipelineDefinitionRequest, CancellationToken) |
Validates the specified pipeline definition to ensure that it is well formed and can be run without error. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5