@Generated(value="software.amazon.awssdk:codegen") public interface DataPipelineClient extends SdkClient, SdkAutoCloseable
builder()
method.
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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default ActivatePipelineResponse |
activatePipeline(ActivatePipelineRequest activatePipelineRequest)
Validates the specified pipeline and starts processing pipeline tasks.
|
default ActivatePipelineResponse |
activatePipeline(Consumer<ActivatePipelineRequest.Builder> activatePipelineRequest)
Validates the specified pipeline and starts processing pipeline tasks.
|
default AddTagsResponse |
addTags(AddTagsRequest addTagsRequest)
Adds or modifies tags for the specified pipeline.
|
default AddTagsResponse |
addTags(Consumer<AddTagsRequest.Builder> addTagsRequest)
Adds or modifies tags for the specified pipeline.
|
static DataPipelineClientBuilder |
builder()
Create a builder that can be used to configure and create a
DataPipelineClient . |
static DataPipelineClient |
create()
Create a
DataPipelineClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from
the DefaultCredentialsProvider . |
default CreatePipelineResponse |
createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest)
Creates a new, empty pipeline.
|
default CreatePipelineResponse |
createPipeline(CreatePipelineRequest createPipelineRequest)
Creates a new, empty pipeline.
|
default DeactivatePipelineResponse |
deactivatePipeline(Consumer<DeactivatePipelineRequest.Builder> deactivatePipelineRequest)
Deactivates the specified running pipeline.
|
default DeactivatePipelineResponse |
deactivatePipeline(DeactivatePipelineRequest deactivatePipelineRequest)
Deactivates the specified running pipeline.
|
default DeletePipelineResponse |
deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest)
Deletes a pipeline, its pipeline definition, and its run history.
|
default DeletePipelineResponse |
deletePipeline(DeletePipelineRequest deletePipelineRequest)
Deletes a pipeline, its pipeline definition, and its run history.
|
default DescribeObjectsResponse |
describeObjects(Consumer<DescribeObjectsRequest.Builder> describeObjectsRequest)
Gets the object definitions for a set of objects associated with the pipeline.
|
default DescribeObjectsResponse |
describeObjects(DescribeObjectsRequest describeObjectsRequest)
Gets the object definitions for a set of objects associated with the pipeline.
|
default DescribeObjectsIterable |
describeObjectsPaginator(DescribeObjectsRequest describeObjectsRequest)
Gets the object definitions for a set of objects associated with the pipeline.
|
default DescribePipelinesResponse |
describePipelines(Consumer<DescribePipelinesRequest.Builder> describePipelinesRequest)
Retrieves metadata about one or more pipelines.
|
default DescribePipelinesResponse |
describePipelines(DescribePipelinesRequest describePipelinesRequest)
Retrieves metadata about one or more pipelines.
|
default EvaluateExpressionResponse |
evaluateExpression(Consumer<EvaluateExpressionRequest.Builder> evaluateExpressionRequest)
Task runners call
EvaluateExpression to evaluate a string in the context of the specified object. |
default EvaluateExpressionResponse |
evaluateExpression(EvaluateExpressionRequest evaluateExpressionRequest)
Task runners call
EvaluateExpression to evaluate a string in the context of the specified object. |
default GetPipelineDefinitionResponse |
getPipelineDefinition(Consumer<GetPipelineDefinitionRequest.Builder> getPipelineDefinitionRequest)
Gets the definition of the specified pipeline.
|
default GetPipelineDefinitionResponse |
getPipelineDefinition(GetPipelineDefinitionRequest getPipelineDefinitionRequest)
Gets the definition of the specified pipeline.
|
default ListPipelinesResponse |
listPipelines()
Lists the pipeline identifiers for all active pipelines that you have permission to access.
|
default ListPipelinesResponse |
listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
Lists the pipeline identifiers for all active pipelines that you have permission to access.
|
default ListPipelinesResponse |
listPipelines(ListPipelinesRequest listPipelinesRequest)
Lists the pipeline identifiers for all active pipelines that you have permission to access.
|
default ListPipelinesIterable |
listPipelinesPaginator()
Lists the pipeline identifiers for all active pipelines that you have permission to access.
|
default ListPipelinesIterable |
listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest)
Lists the pipeline identifiers for all active pipelines that you have permission to access.
|
default PollForTaskResponse |
pollForTask(Consumer<PollForTaskRequest.Builder> pollForTaskRequest)
Task runners call
PollForTask to receive a task to perform from AWS Data Pipeline. |
default PollForTaskResponse |
pollForTask(PollForTaskRequest pollForTaskRequest)
Task runners call
PollForTask to receive a task to perform from AWS Data Pipeline. |
default PutPipelineDefinitionResponse |
putPipelineDefinition(Consumer<PutPipelineDefinitionRequest.Builder> putPipelineDefinitionRequest)
Adds tasks, schedules, and preconditions to the specified pipeline.
|
default PutPipelineDefinitionResponse |
putPipelineDefinition(PutPipelineDefinitionRequest putPipelineDefinitionRequest)
Adds tasks, schedules, and preconditions to the specified pipeline.
|
default QueryObjectsResponse |
queryObjects(Consumer<QueryObjectsRequest.Builder> queryObjectsRequest)
Queries the specified pipeline for the names of objects that match the specified set of conditions.
|
default QueryObjectsResponse |
queryObjects(QueryObjectsRequest queryObjectsRequest)
Queries the specified pipeline for the names of objects that match the specified set of conditions.
|
default QueryObjectsIterable |
queryObjectsPaginator(QueryObjectsRequest queryObjectsRequest)
Queries the specified pipeline for the names of objects that match the specified set of conditions.
|
default RemoveTagsResponse |
removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest)
Removes existing tags from the specified pipeline.
|
default RemoveTagsResponse |
removeTags(RemoveTagsRequest removeTagsRequest)
Removes existing tags from the specified pipeline.
|
default ReportTaskProgressResponse |
reportTaskProgress(Consumer<ReportTaskProgressRequest.Builder> reportTaskProgressRequest)
Task runners call
ReportTaskProgress when assigned a task to acknowledge that it has the task. |
default ReportTaskProgressResponse |
reportTaskProgress(ReportTaskProgressRequest reportTaskProgressRequest)
Task runners call
ReportTaskProgress when assigned a task to acknowledge that it has the task. |
default ReportTaskRunnerHeartbeatResponse |
reportTaskRunnerHeartbeat(Consumer<ReportTaskRunnerHeartbeatRequest.Builder> reportTaskRunnerHeartbeatRequest)
Task runners call
ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. |
default ReportTaskRunnerHeartbeatResponse |
reportTaskRunnerHeartbeat(ReportTaskRunnerHeartbeatRequest reportTaskRunnerHeartbeatRequest)
Task runners call
ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. |
static ServiceMetadata |
serviceMetadata() |
default SetStatusResponse |
setStatus(Consumer<SetStatusRequest.Builder> setStatusRequest)
Requests that the status of the specified physical or logical pipeline objects be updated in the specified
pipeline.
|
default SetStatusResponse |
setStatus(SetStatusRequest setStatusRequest)
Requests that the status of the specified physical or logical pipeline objects be updated in the specified
pipeline.
|
default SetTaskStatusResponse |
setTaskStatus(Consumer<SetTaskStatusRequest.Builder> setTaskStatusRequest)
Task runners call
SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide
information about the final status. |
default SetTaskStatusResponse |
setTaskStatus(SetTaskStatusRequest setTaskStatusRequest)
Task runners call
SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide
information about the final status. |
default ValidatePipelineDefinitionResponse |
validatePipelineDefinition(Consumer<ValidatePipelineDefinitionRequest.Builder> validatePipelineDefinitionRequest)
Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
|
default ValidatePipelineDefinitionResponse |
validatePipelineDefinition(ValidatePipelineDefinitionRequest validatePipelineDefinitionRequest)
Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
|
serviceName
close
static final String SERVICE_NAME
static DataPipelineClient create()
DataPipelineClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static DataPipelineClientBuilder builder()
DataPipelineClient
.default ActivatePipelineResponse activatePipeline(ActivatePipelineRequest activatePipelineRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
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.
activatePipelineRequest
- Contains the parameters for ActivatePipeline.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ActivatePipelineResponse activatePipeline(Consumer<ActivatePipelineRequest.Builder> activatePipelineRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
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.
activatePipelineRequest
- Contains the parameters for ActivatePipeline.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default AddTagsResponse addTags(AddTagsRequest addTagsRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, SdkServiceException, SdkClientException, DataPipelineException
Adds or modifies tags for the specified pipeline.
addTagsRequest
- Contains the parameters for AddTags.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default AddTagsResponse addTags(Consumer<AddTagsRequest.Builder> addTagsRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, SdkServiceException, SdkClientException, DataPipelineException
Adds or modifies tags for the specified pipeline.
addTagsRequest
- Contains the parameters for AddTags.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreatePipelineResponse createPipeline(CreatePipelineRequest createPipelineRequest) throws InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
createPipelineRequest
- Contains the parameters for CreatePipeline.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreatePipelineResponse createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest) throws InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
createPipelineRequest
- Contains the parameters for CreatePipeline.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeactivatePipelineResponse deactivatePipeline(DeactivatePipelineRequest deactivatePipelineRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
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.
deactivatePipelineRequest
- Contains the parameters for DeactivatePipeline.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeactivatePipelineResponse deactivatePipeline(Consumer<DeactivatePipelineRequest.Builder> deactivatePipelineRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
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.
deactivatePipelineRequest
- Contains the parameters for DeactivatePipeline.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeletePipelineResponse deletePipeline(DeletePipelineRequest deletePipelineRequest) throws PipelineNotFoundException, InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
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.
deletePipelineRequest
- Contains the parameters for DeletePipeline.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeletePipelineResponse deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest) throws PipelineNotFoundException, InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
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.
deletePipelineRequest
- Contains the parameters for DeletePipeline.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeObjectsResponse describeObjects(DescribeObjectsRequest describeObjectsRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, SdkServiceException, SdkClientException, DataPipelineException
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.
describeObjectsRequest
- Contains the parameters for DescribeObjects.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeObjectsResponse describeObjects(Consumer<DescribeObjectsRequest.Builder> describeObjectsRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, SdkServiceException, SdkClientException, DataPipelineException
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.
describeObjectsRequest
- Contains the parameters for DescribeObjects.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeObjectsIterable describeObjectsPaginator(DescribeObjectsRequest describeObjectsRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, SdkServiceException, SdkClientException, DataPipelineException
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.
This is a variant of
describeObjects(software.amazon.awssdk.services.datapipeline.model.DescribeObjectsRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.datapipeline.paginators.DescribeObjectsIterable responses = client.describeObjectsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.datapipeline.paginators.DescribeObjectsIterable responses = client .describeObjectsPaginator(request); for (software.amazon.awssdk.services.datapipeline.model.DescribeObjectsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.datapipeline.paginators.DescribeObjectsIterable responses = client.describeObjectsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeObjects(software.amazon.awssdk.services.datapipeline.model.DescribeObjectsRequest)
operation.
describeObjectsRequest
- Contains the parameters for DescribeObjects.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribePipelinesResponse describePipelines(DescribePipelinesRequest describePipelinesRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
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.
describePipelinesRequest
- Contains the parameters for DescribePipelines.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribePipelinesResponse describePipelines(Consumer<DescribePipelinesRequest.Builder> describePipelinesRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
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.
describePipelinesRequest
- Contains the parameters for DescribePipelines.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default EvaluateExpressionResponse evaluateExpression(EvaluateExpressionRequest evaluateExpressionRequest) throws InternalServiceErrorException, TaskNotFoundException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, SdkServiceException, SdkClientException, DataPipelineException
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.
evaluateExpressionRequest
- Contains the parameters for EvaluateExpression.InternalServiceErrorException
- An internal service error occurred.TaskNotFoundException
- The specified task was not found.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default EvaluateExpressionResponse evaluateExpression(Consumer<EvaluateExpressionRequest.Builder> evaluateExpressionRequest) throws InternalServiceErrorException, TaskNotFoundException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, SdkServiceException, SdkClientException, DataPipelineException
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.
evaluateExpressionRequest
- Contains the parameters for EvaluateExpression.InternalServiceErrorException
- An internal service error occurred.TaskNotFoundException
- The specified task was not found.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GetPipelineDefinitionResponse getPipelineDefinition(GetPipelineDefinitionRequest getPipelineDefinitionRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, SdkServiceException, SdkClientException, DataPipelineException
Gets the definition of the specified pipeline. You can call GetPipelineDefinition
to retrieve the
pipeline definition that you provided using PutPipelineDefinition.
getPipelineDefinitionRequest
- Contains the parameters for GetPipelineDefinition.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GetPipelineDefinitionResponse getPipelineDefinition(Consumer<GetPipelineDefinitionRequest.Builder> getPipelineDefinitionRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, SdkServiceException, SdkClientException, DataPipelineException
Gets the definition of the specified pipeline. You can call GetPipelineDefinition
to retrieve the
pipeline definition that you provided using PutPipelineDefinition.
getPipelineDefinitionRequest
- Contains the parameters for GetPipelineDefinition.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListPipelinesResponse listPipelines() throws InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
Lists the pipeline identifiers for all active pipelines that you have permission to access.
InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
listPipelines(ListPipelinesRequest)
,
AWS API
Documentationdefault ListPipelinesResponse listPipelines(ListPipelinesRequest listPipelinesRequest) throws InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
Lists the pipeline identifiers for all active pipelines that you have permission to access.
listPipelinesRequest
- Contains the parameters for ListPipelines.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListPipelinesResponse listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) throws InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
Lists the pipeline identifiers for all active pipelines that you have permission to access.
listPipelinesRequest
- Contains the parameters for ListPipelines.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ListPipelinesIterable listPipelinesPaginator() throws InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
Lists the pipeline identifiers for all active pipelines that you have permission to access.
This is a variant of
listPipelines(software.amazon.awssdk.services.datapipeline.model.ListPipelinesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.datapipeline.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.datapipeline.paginators.ListPipelinesIterable responses = client .listPipelinesPaginator(request); for (software.amazon.awssdk.services.datapipeline.model.ListPipelinesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.datapipeline.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listPipelines(software.amazon.awssdk.services.datapipeline.model.ListPipelinesRequest)
operation.
InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
listPipelinesPaginator(ListPipelinesRequest)
,
AWS API
Documentationdefault ListPipelinesIterable listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest) throws InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
Lists the pipeline identifiers for all active pipelines that you have permission to access.
This is a variant of
listPipelines(software.amazon.awssdk.services.datapipeline.model.ListPipelinesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.datapipeline.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.datapipeline.paginators.ListPipelinesIterable responses = client .listPipelinesPaginator(request); for (software.amazon.awssdk.services.datapipeline.model.ListPipelinesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.datapipeline.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listPipelines(software.amazon.awssdk.services.datapipeline.model.ListPipelinesRequest)
operation.
listPipelinesRequest
- Contains the parameters for ListPipelines.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default PollForTaskResponse pollForTask(PollForTaskRequest pollForTaskRequest) throws InternalServiceErrorException, InvalidRequestException, TaskNotFoundException, SdkServiceException, SdkClientException, DataPipelineException
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.
pollForTaskRequest
- Contains the parameters for PollForTask.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.TaskNotFoundException
- The specified task was not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default PollForTaskResponse pollForTask(Consumer<PollForTaskRequest.Builder> pollForTaskRequest) throws InternalServiceErrorException, InvalidRequestException, TaskNotFoundException, SdkServiceException, SdkClientException, DataPipelineException
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.
pollForTaskRequest
- Contains the parameters for PollForTask.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.TaskNotFoundException
- The specified task was not found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default PutPipelineDefinitionResponse putPipelineDefinition(PutPipelineDefinitionRequest putPipelineDefinitionRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, SdkServiceException, SdkClientException, DataPipelineException
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.
putPipelineDefinitionRequest
- Contains the parameters for PutPipelineDefinition.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default PutPipelineDefinitionResponse putPipelineDefinition(Consumer<PutPipelineDefinitionRequest.Builder> putPipelineDefinitionRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, SdkServiceException, SdkClientException, DataPipelineException
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.
putPipelineDefinitionRequest
- Contains the parameters for PutPipelineDefinition.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default QueryObjectsResponse queryObjects(QueryObjectsRequest queryObjectsRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
Queries the specified pipeline for the names of objects that match the specified set of conditions.
queryObjectsRequest
- Contains the parameters for QueryObjects.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default QueryObjectsResponse queryObjects(Consumer<QueryObjectsRequest.Builder> queryObjectsRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
Queries the specified pipeline for the names of objects that match the specified set of conditions.
queryObjectsRequest
- Contains the parameters for QueryObjects.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default QueryObjectsIterable queryObjectsPaginator(QueryObjectsRequest queryObjectsRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
Queries the specified pipeline for the names of objects that match the specified set of conditions.
This is a variant of
queryObjects(software.amazon.awssdk.services.datapipeline.model.QueryObjectsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.datapipeline.paginators.QueryObjectsIterable responses = client.queryObjectsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.datapipeline.paginators.QueryObjectsIterable responses = client .queryObjectsPaginator(request); for (software.amazon.awssdk.services.datapipeline.model.QueryObjectsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.datapipeline.paginators.QueryObjectsIterable responses = client.queryObjectsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
queryObjects(software.amazon.awssdk.services.datapipeline.model.QueryObjectsRequest)
operation.
queryObjectsRequest
- Contains the parameters for QueryObjects.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default RemoveTagsResponse removeTags(RemoveTagsRequest removeTagsRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, SdkServiceException, SdkClientException, DataPipelineException
Removes existing tags from the specified pipeline.
removeTagsRequest
- Contains the parameters for RemoveTags.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default RemoveTagsResponse removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, SdkServiceException, SdkClientException, DataPipelineException
Removes existing tags from the specified pipeline.
removeTagsRequest
- Contains the parameters for RemoveTags.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ReportTaskProgressResponse reportTaskProgress(ReportTaskProgressRequest reportTaskProgressRequest) throws InternalServiceErrorException, InvalidRequestException, TaskNotFoundException, PipelineNotFoundException, PipelineDeletedException, SdkServiceException, SdkClientException, DataPipelineException
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.
reportTaskProgressRequest
- Contains the parameters for ReportTaskProgress.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.TaskNotFoundException
- The specified task was not found.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ReportTaskProgressResponse reportTaskProgress(Consumer<ReportTaskProgressRequest.Builder> reportTaskProgressRequest) throws InternalServiceErrorException, InvalidRequestException, TaskNotFoundException, PipelineNotFoundException, PipelineDeletedException, SdkServiceException, SdkClientException, DataPipelineException
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.
reportTaskProgressRequest
- Contains the parameters for ReportTaskProgress.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.TaskNotFoundException
- The specified task was not found.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ReportTaskRunnerHeartbeatResponse reportTaskRunnerHeartbeat(ReportTaskRunnerHeartbeatRequest reportTaskRunnerHeartbeatRequest) throws InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
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.
reportTaskRunnerHeartbeatRequest
- Contains the parameters for ReportTaskRunnerHeartbeat.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ReportTaskRunnerHeartbeatResponse reportTaskRunnerHeartbeat(Consumer<ReportTaskRunnerHeartbeatRequest.Builder> reportTaskRunnerHeartbeatRequest) throws InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
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.
reportTaskRunnerHeartbeatRequest
- Contains the parameters for ReportTaskRunnerHeartbeat.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default SetStatusResponse setStatus(SetStatusRequest setStatusRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
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
.
setStatusRequest
- Contains the parameters for SetStatus.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default SetStatusResponse setStatus(Consumer<SetStatusRequest.Builder> setStatusRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, SdkServiceException, SdkClientException, DataPipelineException
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
.
setStatusRequest
- Contains the parameters for SetStatus.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default SetTaskStatusResponse setTaskStatus(SetTaskStatusRequest setTaskStatusRequest) throws InternalServiceErrorException, TaskNotFoundException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, SdkServiceException, SdkClientException, DataPipelineException
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.
setTaskStatusRequest
- Contains the parameters for SetTaskStatus.InternalServiceErrorException
- An internal service error occurred.TaskNotFoundException
- The specified task was not found.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default SetTaskStatusResponse setTaskStatus(Consumer<SetTaskStatusRequest.Builder> setTaskStatusRequest) throws InternalServiceErrorException, TaskNotFoundException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, SdkServiceException, SdkClientException, DataPipelineException
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.
setTaskStatusRequest
- Contains the parameters for SetTaskStatus.InternalServiceErrorException
- An internal service error occurred.TaskNotFoundException
- The specified task was not found.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ValidatePipelineDefinitionResponse validatePipelineDefinition(ValidatePipelineDefinitionRequest validatePipelineDefinitionRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, SdkServiceException, SdkClientException, DataPipelineException
Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
validatePipelineDefinitionRequest
- Contains the parameters for ValidatePipelineDefinition.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ValidatePipelineDefinitionResponse validatePipelineDefinition(Consumer<ValidatePipelineDefinitionRequest.Builder> validatePipelineDefinitionRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, SdkServiceException, SdkClientException, DataPipelineException
Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
validatePipelineDefinitionRequest
- Contains the parameters for ValidatePipelineDefinition.InternalServiceErrorException
- An internal service error occurred.InvalidRequestException
- The request was not valid. Verify that your request was properly formatted, that the signature was
generated with the correct credentials, and that you haven't exceeded any of the service limits for your
account.PipelineNotFoundException
- The specified pipeline was not found. Verify that you used the correct user and account identifiers.PipelineDeletedException
- The specified pipeline has been deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DataPipelineException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.