public class DataPipelineClient extends AmazonWebServiceClient implements DataPipeline
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.
| Constructor and Description |
|---|
DataPipelineClient()
Constructs a new client to invoke service methods on
DataPipeline.
|
DataPipelineClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on
DataPipeline using the specified AWS account credentials.
|
DataPipelineClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
DataPipeline using the specified AWS account credentials
and client configuration options.
|
DataPipelineClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on
DataPipeline using the specified AWS account credentials provider.
|
DataPipelineClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
DataPipeline using the specified AWS account credentials
provider and client configuration options.
|
DataPipelineClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
DataPipeline.
|
| Modifier and Type | Method and Description |
|---|---|
ActivatePipelineResult |
activatePipeline(ActivatePipelineRequest activatePipelineRequest)
Validates a pipeline and initiates processing.
|
CreatePipelineResult |
createPipeline(CreatePipelineRequest createPipelineRequest)
Creates a new empty pipeline.
|
void |
deletePipeline(DeletePipelineRequest deletePipelineRequest)
Permanently deletes a pipeline, its pipeline definition and its run
history.
|
DescribeObjectsResult |
describeObjects(DescribeObjectsRequest describeObjectsRequest)
Returns the object definitions for a set of objects associated with
the pipeline.
|
DescribePipelinesResult |
describePipelines(DescribePipelinesRequest describePipelinesRequest)
Retrieve metadata about one or more pipelines.
|
EvaluateExpressionResult |
evaluateExpression(EvaluateExpressionRequest evaluateExpressionRequest)
Evaluates a string in the context of a specified object.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for
debugging issues where a service isn't acting as expected.
|
GetPipelineDefinitionResult |
getPipelineDefinition(GetPipelineDefinitionRequest getPipelineDefinitionRequest)
Returns the definition of the specified pipeline.
|
ListPipelinesResult |
listPipelines()
Returns a list of pipeline identifiers for all active pipelines.
|
ListPipelinesResult |
listPipelines(ListPipelinesRequest listPipelinesRequest)
Returns a list of pipeline identifiers for all active pipelines.
|
PollForTaskResult |
pollForTask(PollForTaskRequest pollForTaskRequest)
Task runners call this action to receive a task to perform from AWS
Data Pipeline.
|
PutPipelineDefinitionResult |
putPipelineDefinition(PutPipelineDefinitionRequest putPipelineDefinitionRequest)
Adds tasks, schedules, and preconditions that control the behavior of
the pipeline.
|
QueryObjectsResult |
queryObjects(QueryObjectsRequest queryObjectsRequest)
Queries a pipeline for the names of objects that match a specified set
of conditions.
|
ReportTaskProgressResult |
reportTaskProgress(ReportTaskProgressRequest reportTaskProgressRequest)
Updates the AWS Data Pipeline service on the progress of the calling
task runner.
|
ReportTaskRunnerHeartbeatResult |
reportTaskRunnerHeartbeat(ReportTaskRunnerHeartbeatRequest reportTaskRunnerHeartbeatRequest)
Task runners call ReportTaskRunnerHeartbeat every 15 minutes to
indicate that they are operational.
|
void |
setEndpoint(String endpoint,
String serviceName,
String regionId)
Overrides the default endpoint for this client ("datapipeline.us-east-1.amazonaws.com") and explicitly provides
an AWS region ID and AWS service name to use when the client calculates a signature
for requests.
|
void |
setStatus(SetStatusRequest setStatusRequest)
Requests that the status of an array of physical or logical pipeline
objects be updated in the pipeline.
|
SetTaskStatusResult |
setTaskStatus(SetTaskStatusRequest setTaskStatusRequest)
Notifies AWS Data Pipeline that a task is completed and provides
information about the final status.
|
ValidatePipelineDefinitionResult |
validatePipelineDefinition(ValidatePipelineDefinitionRequest validatePipelineDefinitionRequest)
Tests the pipeline definition with a set of validation checks to
ensure that it is well formed and can run without error.
|
addRequestHandler, getRequestMetricsCollector, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, shutdown, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdownpublic DataPipelineClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChainpublic DataPipelineClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this
client connects to DataPipeline
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChainpublic DataPipelineClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public DataPipelineClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this
client connects to DataPipeline
(ex: proxy settings, retry counts, etc.).public DataPipelineClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public DataPipelineClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this
client connects to DataPipeline
(ex: proxy settings, retry counts, etc.).public ActivatePipelineResult activatePipeline(ActivatePipelineRequest activatePipelineRequest) throws AmazonServiceException, AmazonClientException
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.
activatePipeline in interface DataPipelineactivatePipelineRequest - Container for the necessary parameters
to execute the ActivatePipeline service method on DataPipeline.PipelineNotFoundExceptionInternalServiceErrorExceptionInvalidRequestExceptionPipelineDeletedExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by DataPipeline indicating
either a problem with the data in the request, or a server side issue.public ListPipelinesResult listPipelines(ListPipelinesRequest listPipelinesRequest) throws AmazonServiceException, AmazonClientException
Returns a list of pipeline identifiers for all active pipelines. Identifiers are returned only for pipelines you have permission to access.
listPipelines in interface DataPipelinelistPipelinesRequest - Container for the necessary parameters to
execute the ListPipelines service method on DataPipeline.InternalServiceErrorExceptionInvalidRequestExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by DataPipeline indicating
either a problem with the data in the request, or a server side issue.public ReportTaskProgressResult reportTaskProgress(ReportTaskProgressRequest reportTaskProgressRequest) throws AmazonServiceException, AmazonClientException
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.
reportTaskProgress in interface DataPipelinereportTaskProgressRequest - Container for the necessary
parameters to execute the ReportTaskProgress service method on
DataPipeline.PipelineNotFoundExceptionInternalServiceErrorExceptionInvalidRequestExceptionTaskNotFoundExceptionPipelineDeletedExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by DataPipeline indicating
either a problem with the data in the request, or a server side issue.public ValidatePipelineDefinitionResult validatePipelineDefinition(ValidatePipelineDefinitionRequest validatePipelineDefinitionRequest) throws AmazonServiceException, AmazonClientException
Tests the pipeline definition with a set of validation checks to ensure that it is well formed and can run without error.
validatePipelineDefinition in interface DataPipelinevalidatePipelineDefinitionRequest - Container for the necessary
parameters to execute the ValidatePipelineDefinition service method on
DataPipeline.PipelineNotFoundExceptionInternalServiceErrorExceptionInvalidRequestExceptionPipelineDeletedExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by DataPipeline indicating
either a problem with the data in the request, or a server side issue.public PollForTaskResult pollForTask(PollForTaskRequest pollForTaskRequest) throws AmazonServiceException, AmazonClientException
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.
pollForTask in interface DataPipelinepollForTaskRequest - Container for the necessary parameters to
execute the PollForTask service method on DataPipeline.InternalServiceErrorExceptionInvalidRequestExceptionTaskNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by DataPipeline indicating
either a problem with the data in the request, or a server side issue.public QueryObjectsResult queryObjects(QueryObjectsRequest queryObjectsRequest) throws AmazonServiceException, AmazonClientException
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 .
queryObjects in interface DataPipelinequeryObjectsRequest - Container for the necessary parameters to
execute the QueryObjects service method on DataPipeline.PipelineNotFoundExceptionInternalServiceErrorExceptionInvalidRequestExceptionPipelineDeletedExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by DataPipeline indicating
either a problem with the data in the request, or a server side issue.public void setStatus(SetStatusRequest setStatusRequest) throws AmazonServiceException, AmazonClientException
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.
setStatus in interface DataPipelinesetStatusRequest - Container for the necessary parameters to
execute the SetStatus service method on DataPipeline.PipelineNotFoundExceptionInternalServiceErrorExceptionInvalidRequestExceptionPipelineDeletedExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by DataPipeline indicating
either a problem with the data in the request, or a server side issue.public void deletePipeline(DeletePipelineRequest deletePipelineRequest) throws AmazonServiceException, AmazonClientException
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.
deletePipeline in interface DataPipelinedeletePipelineRequest - Container for the necessary parameters to
execute the DeletePipeline service method on DataPipeline.PipelineNotFoundExceptionInternalServiceErrorExceptionInvalidRequestExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by DataPipeline indicating
either a problem with the data in the request, or a server side issue.public GetPipelineDefinitionResult getPipelineDefinition(GetPipelineDefinitionRequest getPipelineDefinitionRequest) throws AmazonServiceException, AmazonClientException
Returns the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition you provided using PutPipelineDefinition.
getPipelineDefinition in interface DataPipelinegetPipelineDefinitionRequest - Container for the necessary
parameters to execute the GetPipelineDefinition service method on
DataPipeline.PipelineNotFoundExceptionInternalServiceErrorExceptionInvalidRequestExceptionPipelineDeletedExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by DataPipeline indicating
either a problem with the data in the request, or a server side issue.public SetTaskStatusResult setTaskStatus(SetTaskStatusRequest setTaskStatusRequest) throws AmazonServiceException, AmazonClientException
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.
setTaskStatus in interface DataPipelinesetTaskStatusRequest - Container for the necessary parameters to
execute the SetTaskStatus service method on DataPipeline.PipelineNotFoundExceptionInternalServiceErrorExceptionInvalidRequestExceptionTaskNotFoundExceptionPipelineDeletedExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by DataPipeline indicating
either a problem with the data in the request, or a server side issue.public EvaluateExpressionResult evaluateExpression(EvaluateExpressionRequest evaluateExpressionRequest) throws AmazonServiceException, AmazonClientException
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.
evaluateExpression in interface DataPipelineevaluateExpressionRequest - Container for the necessary
parameters to execute the EvaluateExpression service method on
DataPipeline.PipelineNotFoundExceptionInternalServiceErrorExceptionInvalidRequestExceptionTaskNotFoundExceptionPipelineDeletedExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by DataPipeline indicating
either a problem with the data in the request, or a server side issue.public DescribePipelinesResult describePipelines(DescribePipelinesRequest describePipelinesRequest) throws AmazonServiceException, AmazonClientException
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.
describePipelines in interface DataPipelinedescribePipelinesRequest - Container for the necessary parameters
to execute the DescribePipelines service method on DataPipeline.PipelineNotFoundExceptionInternalServiceErrorExceptionInvalidRequestExceptionPipelineDeletedExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by DataPipeline indicating
either a problem with the data in the request, or a server side issue.public CreatePipelineResult createPipeline(CreatePipelineRequest createPipelineRequest) throws AmazonServiceException, AmazonClientException
Creates a new empty pipeline. When this action succeeds, you can then use the PutPipelineDefinition action to populate the pipeline.
createPipeline in interface DataPipelinecreatePipelineRequest - Container for the necessary parameters to
execute the CreatePipeline service method on DataPipeline.InternalServiceErrorExceptionInvalidRequestExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by DataPipeline indicating
either a problem with the data in the request, or a server side issue.public DescribeObjectsResult describeObjects(DescribeObjectsRequest describeObjectsRequest) throws AmazonServiceException, AmazonClientException
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.
describeObjects in interface DataPipelinedescribeObjectsRequest - Container for the necessary parameters
to execute the DescribeObjects service method on DataPipeline.PipelineNotFoundExceptionInternalServiceErrorExceptionInvalidRequestExceptionPipelineDeletedExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by DataPipeline indicating
either a problem with the data in the request, or a server side issue.public ReportTaskRunnerHeartbeatResult reportTaskRunnerHeartbeat(ReportTaskRunnerHeartbeatRequest reportTaskRunnerHeartbeatRequest) throws AmazonServiceException, AmazonClientException
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.
reportTaskRunnerHeartbeat in interface DataPipelinereportTaskRunnerHeartbeatRequest - Container for the necessary
parameters to execute the ReportTaskRunnerHeartbeat service method on
DataPipeline.InternalServiceErrorExceptionInvalidRequestExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by DataPipeline indicating
either a problem with the data in the request, or a server side issue.public PutPipelineDefinitionResult putPipelineDefinition(PutPipelineDefinitionRequest putPipelineDefinitionRequest) throws AmazonServiceException, AmazonClientException
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.
Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.
putPipelineDefinition in interface DataPipelineputPipelineDefinitionRequest - Container for the necessary
parameters to execute the PutPipelineDefinition service method on
DataPipeline.PipelineNotFoundExceptionInternalServiceErrorExceptionInvalidRequestExceptionPipelineDeletedExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by DataPipeline indicating
either a problem with the data in the request, or a server side issue.public ListPipelinesResult listPipelines() throws AmazonServiceException, AmazonClientException
Returns a list of pipeline identifiers for all active pipelines. Identifiers are returned only for pipelines you have permission to access.
listPipelines in interface DataPipelineInternalServiceErrorExceptionInvalidRequestExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by DataPipeline indicating
either a problem with the data in the request, or a server side issue.public void setEndpoint(String endpoint, String serviceName, String regionId) throws IllegalArgumentException
This method is not threadsafe. Endpoints should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit.
Callers can pass in just the endpoint (ex: "datapipeline.us-east-1.amazonaws.com") or a full
URL, including the protocol (ex: "datapipeline.us-east-1.amazonaws.com"). If the
protocol is not specified here, the default protocol from this client's
ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
endpoint - The endpoint (ex: "datapipeline.us-east-1.amazonaws.com") or a full URL,
including the protocol (ex: "datapipeline.us-east-1.amazonaws.com") of
the region specific AWS endpoint this client will communicate
with.serviceName - The name of the AWS service to use when signing requests.regionId - The ID of the region in which this service resides.IllegalArgumentException - If any problems are detected with the specified endpoint.AmazonDynamoDB#setRegion(Region)public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface DataPipelinerequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.