com.amazonaws.services.datapipeline

Class DataPipelineClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.datapipeline.DataPipelineClient

All Implemented Interfaces:

DataPipeline

Direct Known Subclasses:

DataPipelineAsyncClient

public class DataPipelineClient
extends AmazonWebServiceClient
implements DataPipeline

Client for accessing DataPipeline. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all DataPipeline exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

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(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on DataPipeline using the specified AWS account credentials provider, client configuration options and request metric collector.
DataPipelineClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on DataPipeline.

Method Summary

Methods

Modifier and Type	Method and Description
ActivatePipelineResult	activatePipeline(ActivatePipelineRequest activatePipelineRequest) Validates the specified pipeline and starts processing pipeline tasks.
AddTagsResult	addTags(AddTagsRequest addTagsRequest) Adds or modifies tags for the specified pipeline.
CreatePipelineResult	createPipeline(CreatePipelineRequest createPipelineRequest) Creates a new, empty pipeline.
DeactivatePipelineResult	deactivatePipeline(DeactivatePipelineRequest deactivatePipelineRequest) Deactivates the specified running pipeline.
void	deletePipeline(DeletePipelineRequest deletePipelineRequest) Deletes a pipeline, its pipeline definition, and its run history.
DescribeObjectsResult	describeObjects(DescribeObjectsRequest describeObjectsRequest) Gets the object definitions for a set of objects associated with the pipeline.
DescribePipelinesResult	describePipelines(DescribePipelinesRequest describePipelinesRequest) Retrieves metadata about one or more pipelines.
EvaluateExpressionResult	evaluateExpression(EvaluateExpressionRequest evaluateExpressionRequest) Task runners call EvaluateExpression to evaluate a string in the context of the 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) Gets the definition of the specified pipeline.
ListPipelinesResult	listPipelines() Lists the pipeline identifiers for all active pipelines that you have permission to access.
ListPipelinesResult	listPipelines(ListPipelinesRequest listPipelinesRequest) Lists the pipeline identifiers for all active pipelines that you have permission to access.
PollForTaskResult	pollForTask(PollForTaskRequest pollForTaskRequest) Task runners call PollForTask to receive a task to perform from AWS Data Pipeline.
PutPipelineDefinitionResult	putPipelineDefinition(PutPipelineDefinitionRequest putPipelineDefinitionRequest) Adds tasks, schedules, and preconditions to the specified pipeline.
QueryObjectsResult	queryObjects(QueryObjectsRequest queryObjectsRequest) Queries the specified pipeline for the names of objects that match the specified set of conditions.
RemoveTagsResult	removeTags(RemoveTagsRequest removeTagsRequest) Removes existing tags from the specified pipeline.
ReportTaskProgressResult	reportTaskProgress(ReportTaskProgressRequest reportTaskProgressRequest) Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task.
ReportTaskRunnerHeartbeatResult	reportTaskRunnerHeartbeat(ReportTaskRunnerHeartbeatRequest reportTaskRunnerHeartbeatRequest) Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client.
void	setEndpoint(String endpoint, String serviceName, String regionId) An internal method that is not expected to be normally called except for AWS internal development purposes.
void	setStatus(SetStatusRequest setStatusRequest) Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline.
SetTaskStatusResult	setTaskStatus(SetTaskStatusRequest setTaskStatusRequest) Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status.
ValidatePipelineDefinitionResult	validatePipelineDefinition(ValidatePipelineDefinitionRequest validatePipelineDefinitionRequest) Validates the specified pipeline definition to ensure that it is well formed and can be run without error.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.datapipeline.DataPipeline

setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all DataPipeline exceptions.

Constructor Detail

DataPipelineClient

public DataPipelineClient()

Constructs a new client to invoke service methods on DataPipeline. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

DataPipelineClient

public DataPipelineClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on DataPipeline. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to DataPipeline (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

DataPipelineClient

public DataPipelineClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on DataPipeline using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

DataPipelineClient

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

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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

DataPipelineClient

public DataPipelineClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on DataPipeline using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

DataPipelineClient

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

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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

DataPipelineClient

public DataPipelineClient(AWSCredentialsProvider awsCredentialsProvider,
                  ClientConfiguration clientConfiguration,
                  RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on DataPipeline using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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

requestMetricCollector - optional request metric collector

Method Detail

activatePipeline

public ActivatePipelineResult activatePipeline(ActivatePipelineRequest 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.

Specified by:

activatePipeline in interface DataPipeline

Parameters:

activatePipelineRequest - Container for the necessary parameters to execute the ActivatePipeline service method on DataPipeline.

Returns:

The response from the ActivatePipeline service method, as returned by DataPipeline.

Throws:

PipelineNotFoundException

InternalServiceErrorException

InvalidRequestException

PipelineDeletedException

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

listPipelines

public ListPipelinesResult listPipelines(ListPipelinesRequest listPipelinesRequest)

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

Specified by:

listPipelines in interface DataPipeline

Parameters:

listPipelinesRequest - Container for the necessary parameters to execute the ListPipelines service method on DataPipeline.

Returns:

The response from the ListPipelines service method, as returned by DataPipeline.

Throws:

InternalServiceErrorException

InvalidRequestException

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

reportTaskProgress

public ReportTaskProgressResult reportTaskProgress(ReportTaskProgressRequest 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.

Specified by:

reportTaskProgress in interface DataPipeline

Parameters:

reportTaskProgressRequest - Container for the necessary parameters to execute the ReportTaskProgress service method on DataPipeline.

Returns:

The response from the ReportTaskProgress service method, as returned by DataPipeline.

Throws:

PipelineNotFoundException

InternalServiceErrorException

InvalidRequestException

TaskNotFoundException

PipelineDeletedException

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

pollForTask

public PollForTaskResult pollForTask(PollForTaskRequest 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.

Specified by:

pollForTask in interface DataPipeline

Parameters:

pollForTaskRequest - Container for the necessary parameters to execute the PollForTask service method on DataPipeline.

Returns:

The response from the PollForTask service method, as returned by DataPipeline.

Throws:

InternalServiceErrorException

InvalidRequestException

TaskNotFoundException

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

validatePipelineDefinition

public ValidatePipelineDefinitionResult validatePipelineDefinition(ValidatePipelineDefinitionRequest validatePipelineDefinitionRequest)

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

Specified by:

validatePipelineDefinition in interface DataPipeline

Parameters:

validatePipelineDefinitionRequest - Container for the necessary parameters to execute the ValidatePipelineDefinition service method on DataPipeline.

Returns:

The response from the ValidatePipelineDefinition service method, as returned by DataPipeline.

Throws:

PipelineNotFoundException

InternalServiceErrorException

InvalidRequestException

PipelineDeletedException

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

queryObjects

public QueryObjectsResult queryObjects(QueryObjectsRequest queryObjectsRequest)

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

Specified by:

queryObjects in interface DataPipeline

Parameters:

queryObjectsRequest - Container for the necessary parameters to execute the QueryObjects service method on DataPipeline.

Returns:

The response from the QueryObjects service method, as returned by DataPipeline.

Throws:

PipelineNotFoundException

InternalServiceErrorException

InvalidRequestException

PipelineDeletedException

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

setStatus

public void setStatus(SetStatusRequest 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 .

Specified by:

setStatus in interface DataPipeline

Parameters:

setStatusRequest - Container for the necessary parameters to execute the SetStatus service method on DataPipeline.

Throws:

PipelineNotFoundException

InternalServiceErrorException

InvalidRequestException

PipelineDeletedException

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

deletePipeline

public void deletePipeline(DeletePipelineRequest 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.

Specified by:

deletePipeline in interface DataPipeline

Parameters:

deletePipelineRequest - Container for the necessary parameters to execute the DeletePipeline service method on DataPipeline.

Throws:

PipelineNotFoundException

InternalServiceErrorException

InvalidRequestException

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

deactivatePipeline

public DeactivatePipelineResult deactivatePipeline(DeactivatePipelineRequest 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.

Specified by:

deactivatePipeline in interface DataPipeline

Parameters:

deactivatePipelineRequest - Container for the necessary parameters to execute the DeactivatePipeline service method on DataPipeline.

Returns:

The response from the DeactivatePipeline service method, as returned by DataPipeline.

Throws:

PipelineNotFoundException

InternalServiceErrorException

InvalidRequestException

PipelineDeletedException

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

getPipelineDefinition

public GetPipelineDefinitionResult getPipelineDefinition(GetPipelineDefinitionRequest getPipelineDefinitionRequest)

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

Specified by:

getPipelineDefinition in interface DataPipeline

Parameters:

getPipelineDefinitionRequest - Container for the necessary parameters to execute the GetPipelineDefinition service method on DataPipeline.

Returns:

The response from the GetPipelineDefinition service method, as returned by DataPipeline.

Throws:

PipelineNotFoundException

InternalServiceErrorException

InvalidRequestException

PipelineDeletedException

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

setTaskStatus

public SetTaskStatusResult setTaskStatus(SetTaskStatusRequest 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.

Specified by:

setTaskStatus in interface DataPipeline

Parameters:

setTaskStatusRequest - Container for the necessary parameters to execute the SetTaskStatus service method on DataPipeline.

Returns:

The response from the SetTaskStatus service method, as returned by DataPipeline.

Throws:

PipelineNotFoundException

InternalServiceErrorException

InvalidRequestException

TaskNotFoundException

PipelineDeletedException

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

describePipelines

public DescribePipelinesResult describePipelines(DescribePipelinesRequest 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.

Specified by:

describePipelines in interface DataPipeline

Parameters:

describePipelinesRequest - Container for the necessary parameters to execute the DescribePipelines service method on DataPipeline.

Returns:

The response from the DescribePipelines service method, as returned by DataPipeline.

Throws:

PipelineNotFoundException

InternalServiceErrorException

InvalidRequestException

PipelineDeletedException

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

evaluateExpression

public EvaluateExpressionResult evaluateExpression(EvaluateExpressionRequest 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.

Specified by:

evaluateExpression in interface DataPipeline

Parameters:

evaluateExpressionRequest - Container for the necessary parameters to execute the EvaluateExpression service method on DataPipeline.

Returns:

The response from the EvaluateExpression service method, as returned by DataPipeline.

Throws:

PipelineNotFoundException

InternalServiceErrorException

InvalidRequestException

TaskNotFoundException

PipelineDeletedException

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

createPipeline

public CreatePipelineResult createPipeline(CreatePipelineRequest createPipelineRequest)

Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.

Specified by:

createPipeline in interface DataPipeline

Parameters:

createPipelineRequest - Container for the necessary parameters to execute the CreatePipeline service method on DataPipeline.

Returns:

The response from the CreatePipeline service method, as returned by DataPipeline.

Throws:

InternalServiceErrorException

InvalidRequestException

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

describeObjects

public DescribeObjectsResult describeObjects(DescribeObjectsRequest 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.

Specified by:

describeObjects in interface DataPipeline

Parameters:

describeObjectsRequest - Container for the necessary parameters to execute the DescribeObjects service method on DataPipeline.

Returns:

The response from the DescribeObjects service method, as returned by DataPipeline.

Throws:

PipelineNotFoundException

InternalServiceErrorException

InvalidRequestException

PipelineDeletedException

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

removeTags

public RemoveTagsResult removeTags(RemoveTagsRequest removeTagsRequest)

Removes existing tags from the specified pipeline.

Specified by:

removeTags in interface DataPipeline

Parameters:

removeTagsRequest - Container for the necessary parameters to execute the RemoveTags service method on DataPipeline.

Returns:

The response from the RemoveTags service method, as returned by DataPipeline.

Throws:

PipelineNotFoundException

InternalServiceErrorException

InvalidRequestException

PipelineDeletedException

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

reportTaskRunnerHeartbeat

public ReportTaskRunnerHeartbeatResult reportTaskRunnerHeartbeat(ReportTaskRunnerHeartbeatRequest 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.

Specified by:

reportTaskRunnerHeartbeat in interface DataPipeline

Parameters:

reportTaskRunnerHeartbeatRequest - Container for the necessary parameters to execute the ReportTaskRunnerHeartbeat service method on DataPipeline.

Returns:

The response from the ReportTaskRunnerHeartbeat service method, as returned by DataPipeline.

Throws:

InternalServiceErrorException

InvalidRequestException

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

putPipelineDefinition

public PutPipelineDefinitionResult putPipelineDefinition(PutPipelineDefinitionRequest 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.

Specified by:

putPipelineDefinition in interface DataPipeline

Parameters:

putPipelineDefinitionRequest - Container for the necessary parameters to execute the PutPipelineDefinition service method on DataPipeline.

Returns:

The response from the PutPipelineDefinition service method, as returned by DataPipeline.

Throws:

PipelineNotFoundException

InternalServiceErrorException

InvalidRequestException

PipelineDeletedException

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

addTags

public AddTagsResult addTags(AddTagsRequest addTagsRequest)

Adds or modifies tags for the specified pipeline.

Specified by:

addTags in interface DataPipeline

Parameters:

addTagsRequest - Container for the necessary parameters to execute the AddTags service method on DataPipeline.

Returns:

The response from the AddTags service method, as returned by DataPipeline.

Throws:

PipelineNotFoundException

InternalServiceErrorException

InvalidRequestException

PipelineDeletedException

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

listPipelines

public ListPipelinesResult listPipelines()
                                  throws AmazonServiceException,
                                         AmazonClientException

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

Specified by:

listPipelines in interface DataPipeline

Returns:

The response from the ListPipelines service method, as returned by DataPipeline.

Throws:

InternalServiceErrorException

InvalidRequestException

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

setEndpoint

public void setEndpoint(String endpoint)

Description copied from class: AmazonWebServiceClient

Overrides the default endpoint for this client. Callers can use this method to control which AWS region they want to work with.

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: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.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

Specified by:

setEndpoint in interface DataPipeline

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

endpoint - The endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setEndpoint

public void setEndpoint(String endpoint,
               String serviceName,
               String regionId)
                 throws IllegalArgumentException

Description copied from class: AmazonWebServiceClient

An internal method that is not expected to be normally called except for AWS internal development purposes.

Overrides the default endpoint for this client ("http://dynamodb.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. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.

Callers can pass in just the endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.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

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

endpoint - The endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.

serviceName - This parameter is ignored.

regionId - The ID of the region in which this service resides AND the overriding region for signing purposes.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

getCachedResponseMetadata

public 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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Specified by:

getCachedResponseMetadata in interface DataPipeline

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.