public class DataPipelineAsyncClient extends DataPipelineClient implements DataPipelineAsync
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.
jsonErrorUnmarshallers
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
Constructor and Description |
---|
DataPipelineAsyncClient()
Constructs a new asynchronous client to invoke service methods on
DataPipeline.
|
DataPipelineAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on
DataPipeline using the specified AWS account credentials.
|
DataPipelineAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on
DataPipeline using the specified AWS account credentials,
executor service, and client configuration options.
|
DataPipelineAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on
DataPipeline using the specified AWS account credentials
and executor service.
|
DataPipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on
DataPipeline using the specified AWS account credentials provider.
|
DataPipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on
DataPipeline using the specified AWS account credentials
provider and client configuration options.
|
DataPipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on
DataPipeline using the specified AWS account credentials
provider, executor service, and client configuration options.
|
DataPipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on
DataPipeline using the specified AWS account credentials provider
and executor service.
|
DataPipelineAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on
DataPipeline.
|
Modifier and Type | Method and Description |
---|---|
Future<ActivatePipelineResult> |
activatePipelineAsync(ActivatePipelineRequest activatePipelineRequest)
Validates the specified pipeline and starts processing pipeline
tasks.
|
Future<ActivatePipelineResult> |
activatePipelineAsync(ActivatePipelineRequest activatePipelineRequest,
AsyncHandler<ActivatePipelineRequest,ActivatePipelineResult> asyncHandler)
Validates the specified pipeline and starts processing pipeline
tasks.
|
Future<AddTagsResult> |
addTagsAsync(AddTagsRequest addTagsRequest)
Adds or modifies tags for the specified pipeline.
|
Future<AddTagsResult> |
addTagsAsync(AddTagsRequest addTagsRequest,
AsyncHandler<AddTagsRequest,AddTagsResult> asyncHandler)
Adds or modifies tags for the specified pipeline.
|
Future<CreatePipelineResult> |
createPipelineAsync(CreatePipelineRequest createPipelineRequest)
Creates a new, empty pipeline.
|
Future<CreatePipelineResult> |
createPipelineAsync(CreatePipelineRequest createPipelineRequest,
AsyncHandler<CreatePipelineRequest,CreatePipelineResult> asyncHandler)
Creates a new, empty pipeline.
|
Future<DeactivatePipelineResult> |
deactivatePipelineAsync(DeactivatePipelineRequest deactivatePipelineRequest)
Deactivates the specified running pipeline.
|
Future<DeactivatePipelineResult> |
deactivatePipelineAsync(DeactivatePipelineRequest deactivatePipelineRequest,
AsyncHandler<DeactivatePipelineRequest,DeactivatePipelineResult> asyncHandler)
Deactivates the specified running pipeline.
|
Future<Void> |
deletePipelineAsync(DeletePipelineRequest deletePipelineRequest)
Deletes a pipeline, its pipeline definition, and its run history.
|
Future<Void> |
deletePipelineAsync(DeletePipelineRequest deletePipelineRequest,
AsyncHandler<DeletePipelineRequest,Void> asyncHandler)
Deletes a pipeline, its pipeline definition, and its run history.
|
Future<DescribeObjectsResult> |
describeObjectsAsync(DescribeObjectsRequest describeObjectsRequest)
Gets the object definitions for a set of objects associated with the
pipeline.
|
Future<DescribeObjectsResult> |
describeObjectsAsync(DescribeObjectsRequest describeObjectsRequest,
AsyncHandler<DescribeObjectsRequest,DescribeObjectsResult> asyncHandler)
Gets the object definitions for a set of objects associated with the
pipeline.
|
Future<DescribePipelinesResult> |
describePipelinesAsync(DescribePipelinesRequest describePipelinesRequest)
Retrieves metadata about one or more pipelines.
|
Future<DescribePipelinesResult> |
describePipelinesAsync(DescribePipelinesRequest describePipelinesRequest,
AsyncHandler<DescribePipelinesRequest,DescribePipelinesResult> asyncHandler)
Retrieves metadata about one or more pipelines.
|
Future<EvaluateExpressionResult> |
evaluateExpressionAsync(EvaluateExpressionRequest evaluateExpressionRequest)
Task runners call
EvaluateExpression to evaluate a
string in the context of the specified object. |
Future<EvaluateExpressionResult> |
evaluateExpressionAsync(EvaluateExpressionRequest evaluateExpressionRequest,
AsyncHandler<EvaluateExpressionRequest,EvaluateExpressionResult> asyncHandler)
Task runners call
EvaluateExpression to evaluate a
string in the context of the specified object. |
ExecutorService |
getExecutorService()
Returns the executor service used by this async client to execute
requests.
|
Future<GetPipelineDefinitionResult> |
getPipelineDefinitionAsync(GetPipelineDefinitionRequest getPipelineDefinitionRequest)
Gets the definition of the specified pipeline.
|
Future<GetPipelineDefinitionResult> |
getPipelineDefinitionAsync(GetPipelineDefinitionRequest getPipelineDefinitionRequest,
AsyncHandler<GetPipelineDefinitionRequest,GetPipelineDefinitionResult> asyncHandler)
Gets the definition of the specified pipeline.
|
Future<ListPipelinesResult> |
listPipelinesAsync(ListPipelinesRequest listPipelinesRequest)
Lists the pipeline identifiers for all active pipelines that you have
permission to access.
|
Future<ListPipelinesResult> |
listPipelinesAsync(ListPipelinesRequest listPipelinesRequest,
AsyncHandler<ListPipelinesRequest,ListPipelinesResult> asyncHandler)
Lists the pipeline identifiers for all active pipelines that you have
permission to access.
|
Future<PollForTaskResult> |
pollForTaskAsync(PollForTaskRequest pollForTaskRequest)
Task runners call
PollForTask to receive a task to
perform from AWS Data Pipeline. |
Future<PollForTaskResult> |
pollForTaskAsync(PollForTaskRequest pollForTaskRequest,
AsyncHandler<PollForTaskRequest,PollForTaskResult> asyncHandler)
Task runners call
PollForTask to receive a task to
perform from AWS Data Pipeline. |
Future<PutPipelineDefinitionResult> |
putPipelineDefinitionAsync(PutPipelineDefinitionRequest putPipelineDefinitionRequest)
Adds tasks, schedules, and preconditions to the specified pipeline.
|
Future<PutPipelineDefinitionResult> |
putPipelineDefinitionAsync(PutPipelineDefinitionRequest putPipelineDefinitionRequest,
AsyncHandler<PutPipelineDefinitionRequest,PutPipelineDefinitionResult> asyncHandler)
Adds tasks, schedules, and preconditions to the specified pipeline.
|
Future<QueryObjectsResult> |
queryObjectsAsync(QueryObjectsRequest queryObjectsRequest)
Queries the specified pipeline for the names of objects that match
the specified set of conditions.
|
Future<QueryObjectsResult> |
queryObjectsAsync(QueryObjectsRequest queryObjectsRequest,
AsyncHandler<QueryObjectsRequest,QueryObjectsResult> asyncHandler)
Queries the specified pipeline for the names of objects that match
the specified set of conditions.
|
Future<RemoveTagsResult> |
removeTagsAsync(RemoveTagsRequest removeTagsRequest)
Removes existing tags from the specified pipeline.
|
Future<RemoveTagsResult> |
removeTagsAsync(RemoveTagsRequest removeTagsRequest,
AsyncHandler<RemoveTagsRequest,RemoveTagsResult> asyncHandler)
Removes existing tags from the specified pipeline.
|
Future<ReportTaskProgressResult> |
reportTaskProgressAsync(ReportTaskProgressRequest reportTaskProgressRequest)
Task runners call
ReportTaskProgress when assigned a
task to acknowledge that it has the task. |
Future<ReportTaskProgressResult> |
reportTaskProgressAsync(ReportTaskProgressRequest reportTaskProgressRequest,
AsyncHandler<ReportTaskProgressRequest,ReportTaskProgressResult> asyncHandler)
Task runners call
ReportTaskProgress when assigned a
task to acknowledge that it has the task. |
Future<ReportTaskRunnerHeartbeatResult> |
reportTaskRunnerHeartbeatAsync(ReportTaskRunnerHeartbeatRequest reportTaskRunnerHeartbeatRequest)
Task runners call
ReportTaskRunnerHeartbeat every 15
minutes to indicate that they are operational. |
Future<ReportTaskRunnerHeartbeatResult> |
reportTaskRunnerHeartbeatAsync(ReportTaskRunnerHeartbeatRequest reportTaskRunnerHeartbeatRequest,
AsyncHandler<ReportTaskRunnerHeartbeatRequest,ReportTaskRunnerHeartbeatResult> asyncHandler)
Task runners call
ReportTaskRunnerHeartbeat every 15
minutes to indicate that they are operational. |
Future<Void> |
setStatusAsync(SetStatusRequest setStatusRequest)
Requests that the status of the specified physical or logical
pipeline objects be updated in the specified pipeline.
|
Future<Void> |
setStatusAsync(SetStatusRequest setStatusRequest,
AsyncHandler<SetStatusRequest,Void> asyncHandler)
Requests that the status of the specified physical or logical
pipeline objects be updated in the specified pipeline.
|
Future<SetTaskStatusResult> |
setTaskStatusAsync(SetTaskStatusRequest setTaskStatusRequest)
Task runners call
SetTaskStatus to notify AWS Data
Pipeline that a task is completed and provide information about the
final status. |
Future<SetTaskStatusResult> |
setTaskStatusAsync(SetTaskStatusRequest setTaskStatusRequest,
AsyncHandler<SetTaskStatusRequest,SetTaskStatusResult> asyncHandler)
Task runners call
SetTaskStatus to notify AWS Data
Pipeline that a task is completed and provide information about the
final status. |
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
Future<ValidatePipelineDefinitionResult> |
validatePipelineDefinitionAsync(ValidatePipelineDefinitionRequest validatePipelineDefinitionRequest)
Validates the specified pipeline definition to ensure that it is well
formed and can be run without error.
|
Future<ValidatePipelineDefinitionResult> |
validatePipelineDefinitionAsync(ValidatePipelineDefinitionRequest validatePipelineDefinitionRequest,
AsyncHandler<ValidatePipelineDefinitionRequest,ValidatePipelineDefinitionResult> asyncHandler)
Validates the specified pipeline definition to ensure that it is well
formed and can be run without error.
|
activatePipeline, addTags, createPipeline, deactivatePipeline, deletePipeline, describeObjects, describePipelines, evaluateExpression, getCachedResponseMetadata, getPipelineDefinition, listPipelines, listPipelines, pollForTask, putPipelineDefinition, queryObjects, removeTags, reportTaskProgress, reportTaskRunnerHeartbeat, setEndpoint, setEndpoint, setStatus, setTaskStatus, validatePipelineDefinition
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, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
activatePipeline, addTags, createPipeline, deactivatePipeline, deletePipeline, describeObjects, describePipelines, evaluateExpression, getCachedResponseMetadata, getPipelineDefinition, listPipelines, listPipelines, pollForTask, putPipelineDefinition, queryObjects, removeTags, reportTaskProgress, reportTaskRunnerHeartbeat, setEndpoint, setRegion, setStatus, setTaskStatus, validatePipelineDefinition
public DataPipelineAsyncClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public DataPipelineAsyncClient(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.).DefaultAWSCredentialsProviderChain
public DataPipelineAsyncClient(AWSCredentials awsCredentials)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public DataPipelineAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.executorService
- The executor service by which all asynchronous requests will
be executed.public DataPipelineAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy
settings, etc).executorService
- The executor service by which all asynchronous requests will
be executed.public DataPipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public DataPipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.executorService
- The executor service by which all asynchronous requests will
be executed.public DataPipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy
settings, etc).public DataPipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy
settings, etc).executorService
- The executor service by which all asynchronous requests will
be executed.public ExecutorService getExecutorService()
public void shutdown()
shutdown
in interface DataPipeline
shutdown
in class AmazonWebServiceClient
public Future<ActivatePipelineResult> activatePipelineAsync(ActivatePipelineRequest activatePipelineRequest) throws AmazonServiceException, AmazonClientException
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
in interface DataPipelineAsync
activatePipelineRequest
- Container for the necessary parameters
to execute the ActivatePipeline operation on DataPipeline.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.public Future<ActivatePipelineResult> activatePipelineAsync(ActivatePipelineRequest activatePipelineRequest, AsyncHandler<ActivatePipelineRequest,ActivatePipelineResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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
in interface DataPipelineAsync
activatePipelineRequest
- Container for the necessary parameters
to execute the ActivatePipeline operation on DataPipeline.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.public Future<ListPipelinesResult> listPipelinesAsync(ListPipelinesRequest listPipelinesRequest) throws AmazonServiceException, AmazonClientException
Lists the pipeline identifiers for all active pipelines that you have permission to access.
listPipelinesAsync
in interface DataPipelineAsync
listPipelinesRequest
- Container for the necessary parameters to
execute the ListPipelines operation on DataPipeline.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.public Future<ListPipelinesResult> listPipelinesAsync(ListPipelinesRequest listPipelinesRequest, AsyncHandler<ListPipelinesRequest,ListPipelinesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Lists the pipeline identifiers for all active pipelines that you have permission to access.
listPipelinesAsync
in interface DataPipelineAsync
listPipelinesRequest
- Container for the necessary parameters to
execute the ListPipelines operation on DataPipeline.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.public Future<ReportTaskProgressResult> reportTaskProgressAsync(ReportTaskProgressRequest reportTaskProgressRequest) throws AmazonServiceException, AmazonClientException
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.
reportTaskProgressAsync
in interface DataPipelineAsync
reportTaskProgressRequest
- Container for the necessary
parameters to execute the ReportTaskProgress operation on
DataPipeline.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.public Future<ReportTaskProgressResult> reportTaskProgressAsync(ReportTaskProgressRequest reportTaskProgressRequest, AsyncHandler<ReportTaskProgressRequest,ReportTaskProgressResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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.
reportTaskProgressAsync
in interface DataPipelineAsync
reportTaskProgressRequest
- Container for the necessary
parameters to execute the ReportTaskProgress operation on
DataPipeline.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.public Future<PollForTaskResult> pollForTaskAsync(PollForTaskRequest pollForTaskRequest) throws AmazonServiceException, AmazonClientException
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.
pollForTaskAsync
in interface DataPipelineAsync
pollForTaskRequest
- Container for the necessary parameters to
execute the PollForTask operation on DataPipeline.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.public Future<PollForTaskResult> pollForTaskAsync(PollForTaskRequest pollForTaskRequest, AsyncHandler<PollForTaskRequest,PollForTaskResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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.
pollForTaskAsync
in interface DataPipelineAsync
pollForTaskRequest
- Container for the necessary parameters to
execute the PollForTask operation on DataPipeline.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.public Future<ValidatePipelineDefinitionResult> validatePipelineDefinitionAsync(ValidatePipelineDefinitionRequest validatePipelineDefinitionRequest) throws AmazonServiceException, AmazonClientException
Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
validatePipelineDefinitionAsync
in interface DataPipelineAsync
validatePipelineDefinitionRequest
- Container for the necessary
parameters to execute the ValidatePipelineDefinition operation on
DataPipeline.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.public Future<ValidatePipelineDefinitionResult> validatePipelineDefinitionAsync(ValidatePipelineDefinitionRequest validatePipelineDefinitionRequest, AsyncHandler<ValidatePipelineDefinitionRequest,ValidatePipelineDefinitionResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
validatePipelineDefinitionAsync
in interface DataPipelineAsync
validatePipelineDefinitionRequest
- Container for the necessary
parameters to execute the ValidatePipelineDefinition operation on
DataPipeline.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.public Future<QueryObjectsResult> queryObjectsAsync(QueryObjectsRequest queryObjectsRequest) throws AmazonServiceException, AmazonClientException
Queries the specified pipeline for the names of objects that match the specified set of conditions.
queryObjectsAsync
in interface DataPipelineAsync
queryObjectsRequest
- Container for the necessary parameters to
execute the QueryObjects operation on DataPipeline.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.public Future<QueryObjectsResult> queryObjectsAsync(QueryObjectsRequest queryObjectsRequest, AsyncHandler<QueryObjectsRequest,QueryObjectsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Queries the specified pipeline for the names of objects that match the specified set of conditions.
queryObjectsAsync
in interface DataPipelineAsync
queryObjectsRequest
- Container for the necessary parameters to
execute the QueryObjects operation on DataPipeline.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.public Future<Void> setStatusAsync(SetStatusRequest setStatusRequest) throws AmazonServiceException, AmazonClientException
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
.
setStatusAsync
in interface DataPipelineAsync
setStatusRequest
- Container for the necessary parameters to
execute the SetStatus operation on DataPipeline.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.public Future<Void> setStatusAsync(SetStatusRequest setStatusRequest, AsyncHandler<SetStatusRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
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
.
setStatusAsync
in interface DataPipelineAsync
setStatusRequest
- Container for the necessary parameters to
execute the SetStatus operation on DataPipeline.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.public Future<Void> deletePipelineAsync(DeletePipelineRequest deletePipelineRequest) throws AmazonServiceException, AmazonClientException
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.
deletePipelineAsync
in interface DataPipelineAsync
deletePipelineRequest
- Container for the necessary parameters to
execute the DeletePipeline operation on DataPipeline.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.public Future<Void> deletePipelineAsync(DeletePipelineRequest deletePipelineRequest, AsyncHandler<DeletePipelineRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
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.
deletePipelineAsync
in interface DataPipelineAsync
deletePipelineRequest
- Container for the necessary parameters to
execute the DeletePipeline operation on DataPipeline.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.public Future<DeactivatePipelineResult> deactivatePipelineAsync(DeactivatePipelineRequest deactivatePipelineRequest) throws AmazonServiceException, AmazonClientException
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.
deactivatePipelineAsync
in interface DataPipelineAsync
deactivatePipelineRequest
- Container for the necessary
parameters to execute the DeactivatePipeline operation on
DataPipeline.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.public Future<DeactivatePipelineResult> deactivatePipelineAsync(DeactivatePipelineRequest deactivatePipelineRequest, AsyncHandler<DeactivatePipelineRequest,DeactivatePipelineResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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.
deactivatePipelineAsync
in interface DataPipelineAsync
deactivatePipelineRequest
- Container for the necessary
parameters to execute the DeactivatePipeline operation on
DataPipeline.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.public Future<GetPipelineDefinitionResult> getPipelineDefinitionAsync(GetPipelineDefinitionRequest getPipelineDefinitionRequest) throws AmazonServiceException, AmazonClientException
Gets the definition of the specified pipeline. You can call
GetPipelineDefinition
to retrieve the pipeline definition
that you provided using PutPipelineDefinition.
getPipelineDefinitionAsync
in interface DataPipelineAsync
getPipelineDefinitionRequest
- Container for the necessary
parameters to execute the GetPipelineDefinition operation on
DataPipeline.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.public Future<GetPipelineDefinitionResult> getPipelineDefinitionAsync(GetPipelineDefinitionRequest getPipelineDefinitionRequest, AsyncHandler<GetPipelineDefinitionRequest,GetPipelineDefinitionResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Gets the definition of the specified pipeline. You can call
GetPipelineDefinition
to retrieve the pipeline definition
that you provided using PutPipelineDefinition.
getPipelineDefinitionAsync
in interface DataPipelineAsync
getPipelineDefinitionRequest
- Container for the necessary
parameters to execute the GetPipelineDefinition operation on
DataPipeline.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.public Future<SetTaskStatusResult> setTaskStatusAsync(SetTaskStatusRequest setTaskStatusRequest) throws AmazonServiceException, AmazonClientException
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.
setTaskStatusAsync
in interface DataPipelineAsync
setTaskStatusRequest
- Container for the necessary parameters to
execute the SetTaskStatus operation on DataPipeline.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.public Future<SetTaskStatusResult> setTaskStatusAsync(SetTaskStatusRequest setTaskStatusRequest, AsyncHandler<SetTaskStatusRequest,SetTaskStatusResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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.
setTaskStatusAsync
in interface DataPipelineAsync
setTaskStatusRequest
- Container for the necessary parameters to
execute the SetTaskStatus operation on DataPipeline.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.public Future<DescribePipelinesResult> describePipelinesAsync(DescribePipelinesRequest describePipelinesRequest) throws AmazonServiceException, AmazonClientException
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
in interface DataPipelineAsync
describePipelinesRequest
- Container for the necessary parameters
to execute the DescribePipelines operation on DataPipeline.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.public Future<DescribePipelinesResult> describePipelinesAsync(DescribePipelinesRequest describePipelinesRequest, AsyncHandler<DescribePipelinesRequest,DescribePipelinesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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
in interface DataPipelineAsync
describePipelinesRequest
- Container for the necessary parameters
to execute the DescribePipelines operation on DataPipeline.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.public Future<EvaluateExpressionResult> evaluateExpressionAsync(EvaluateExpressionRequest evaluateExpressionRequest) throws AmazonServiceException, AmazonClientException
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.
evaluateExpressionAsync
in interface DataPipelineAsync
evaluateExpressionRequest
- Container for the necessary
parameters to execute the EvaluateExpression operation on
DataPipeline.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.public Future<EvaluateExpressionResult> evaluateExpressionAsync(EvaluateExpressionRequest evaluateExpressionRequest, AsyncHandler<EvaluateExpressionRequest,EvaluateExpressionResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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.
evaluateExpressionAsync
in interface DataPipelineAsync
evaluateExpressionRequest
- Container for the necessary
parameters to execute the EvaluateExpression operation on
DataPipeline.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.public Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest createPipelineRequest) throws AmazonServiceException, AmazonClientException
Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
createPipelineAsync
in interface DataPipelineAsync
createPipelineRequest
- Container for the necessary parameters to
execute the CreatePipeline operation on DataPipeline.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.public Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest createPipelineRequest, AsyncHandler<CreatePipelineRequest,CreatePipelineResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
createPipelineAsync
in interface DataPipelineAsync
createPipelineRequest
- Container for the necessary parameters to
execute the CreatePipeline operation on DataPipeline.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.public Future<DescribeObjectsResult> describeObjectsAsync(DescribeObjectsRequest describeObjectsRequest) throws AmazonServiceException, AmazonClientException
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
in interface DataPipelineAsync
describeObjectsRequest
- Container for the necessary parameters
to execute the DescribeObjects operation on DataPipeline.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.public Future<DescribeObjectsResult> describeObjectsAsync(DescribeObjectsRequest describeObjectsRequest, AsyncHandler<DescribeObjectsRequest,DescribeObjectsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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
in interface DataPipelineAsync
describeObjectsRequest
- Container for the necessary parameters
to execute the DescribeObjects operation on DataPipeline.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.public Future<RemoveTagsResult> removeTagsAsync(RemoveTagsRequest removeTagsRequest) throws AmazonServiceException, AmazonClientException
Removes existing tags from the specified pipeline.
removeTagsAsync
in interface DataPipelineAsync
removeTagsRequest
- Container for the necessary parameters to
execute the RemoveTags operation on DataPipeline.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.public Future<RemoveTagsResult> removeTagsAsync(RemoveTagsRequest removeTagsRequest, AsyncHandler<RemoveTagsRequest,RemoveTagsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Removes existing tags from the specified pipeline.
removeTagsAsync
in interface DataPipelineAsync
removeTagsRequest
- Container for the necessary parameters to
execute the RemoveTags operation on DataPipeline.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.public Future<ReportTaskRunnerHeartbeatResult> reportTaskRunnerHeartbeatAsync(ReportTaskRunnerHeartbeatRequest reportTaskRunnerHeartbeatRequest) throws AmazonServiceException, AmazonClientException
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.
reportTaskRunnerHeartbeatAsync
in interface DataPipelineAsync
reportTaskRunnerHeartbeatRequest
- Container for the necessary
parameters to execute the ReportTaskRunnerHeartbeat operation on
DataPipeline.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.public Future<ReportTaskRunnerHeartbeatResult> reportTaskRunnerHeartbeatAsync(ReportTaskRunnerHeartbeatRequest reportTaskRunnerHeartbeatRequest, AsyncHandler<ReportTaskRunnerHeartbeatRequest,ReportTaskRunnerHeartbeatResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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.
reportTaskRunnerHeartbeatAsync
in interface DataPipelineAsync
reportTaskRunnerHeartbeatRequest
- Container for the necessary
parameters to execute the ReportTaskRunnerHeartbeat operation on
DataPipeline.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.public Future<PutPipelineDefinitionResult> putPipelineDefinitionAsync(PutPipelineDefinitionRequest putPipelineDefinitionRequest) throws AmazonServiceException, AmazonClientException
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.
Pipeline object definitions are passed to the
PutPipelineDefinition
action and returned by the
GetPipelineDefinition action.
putPipelineDefinitionAsync
in interface DataPipelineAsync
putPipelineDefinitionRequest
- Container for the necessary
parameters to execute the PutPipelineDefinition operation on
DataPipeline.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.public Future<PutPipelineDefinitionResult> putPipelineDefinitionAsync(PutPipelineDefinitionRequest putPipelineDefinitionRequest, AsyncHandler<PutPipelineDefinitionRequest,PutPipelineDefinitionResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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.
Pipeline object definitions are passed to the
PutPipelineDefinition
action and returned by the
GetPipelineDefinition action.
putPipelineDefinitionAsync
in interface DataPipelineAsync
putPipelineDefinitionRequest
- Container for the necessary
parameters to execute the PutPipelineDefinition operation on
DataPipeline.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.public Future<AddTagsResult> addTagsAsync(AddTagsRequest addTagsRequest) throws AmazonServiceException, AmazonClientException
Adds or modifies tags for the specified pipeline.
addTagsAsync
in interface DataPipelineAsync
addTagsRequest
- Container for the necessary parameters to
execute the AddTags operation on DataPipeline.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.public Future<AddTagsResult> addTagsAsync(AddTagsRequest addTagsRequest, AsyncHandler<AddTagsRequest,AddTagsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Adds or modifies tags for the specified pipeline.
addTagsAsync
in interface DataPipelineAsync
addTagsRequest
- Container for the necessary parameters to
execute the AddTags operation on DataPipeline.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.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.Copyright © 2015. All rights reserved.