DataPipelineClient (AWS SDK for Java

Overview

Package

Class

Index

Help

Did this page help you?
Yes No Tell us about it...

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

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 Summary
`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.

Method Summary
`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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
`addRequestHandler, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, shutdown, withTimeOffset`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.amazonaws.services.datapipeline.DataPipeline
`setEndpoint, setRegion, shutdown`

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