NAME
Paws::DataPipeline - Perl Interface to AWS AWS Data Pipeline
SYNOPSIS
use Paws;
my $obj = Paws->service('DataPipeline');
my $res = $obj->Method(
Arg1 => $val1,
Arg2 => [ 'V1', 'V2' ],
# if Arg3 is an object, the HashRef will be used as arguments to the constructor
# of the arguments type
Arg3 => { Att1 => 'Val1' },
# if Arg4 is an array of objects, the HashRefs will be passed as arguments to
# the constructor of the arguments type
Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
);DESCRIPTION
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.
For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29
METHODS
ActivatePipeline
- PipelineId => Str
- [ParameterValues => ArrayRef[Paws::DataPipeline::ParameterValue]]
- [StartTimestamp => Str]
Each argument is described in detail in: Paws::DataPipeline::ActivatePipeline
Returns: a Paws::DataPipeline::ActivatePipelineOutput instance
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.
AddTags
- PipelineId => Str
- Tags => ArrayRef[Paws::DataPipeline::Tag]
Each argument is described in detail in: Paws::DataPipeline::AddTags
Returns: a Paws::DataPipeline::AddTagsOutput instance
Adds or modifies tags for the specified pipeline.
CreatePipeline
- Name => Str
- UniqueId => Str
- [Description => Str]
- [Tags => ArrayRef[Paws::DataPipeline::Tag]]
Each argument is described in detail in: Paws::DataPipeline::CreatePipeline
Returns: a Paws::DataPipeline::CreatePipelineOutput instance
Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
DeactivatePipeline
Each argument is described in detail in: Paws::DataPipeline::DeactivatePipeline
Returns: a Paws::DataPipeline::DeactivatePipelineOutput instance
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.
DeletePipeline
Each argument is described in detail in: Paws::DataPipeline::DeletePipeline
Returns: nothing
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.
DescribeObjects
Each argument is described in detail in: Paws::DataPipeline::DescribeObjects
Returns: a Paws::DataPipeline::DescribeObjectsOutput instance
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.
DescribePipelines
Each argument is described in detail in: Paws::DataPipeline::DescribePipelines
Returns: a Paws::DataPipeline::DescribePipelinesOutput instance
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.
EvaluateExpression
Each argument is described in detail in: Paws::DataPipeline::EvaluateExpression
Returns: a Paws::DataPipeline::EvaluateExpressionOutput instance
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.
GetPipelineDefinition
Each argument is described in detail in: Paws::DataPipeline::GetPipelineDefinition
Returns: a Paws::DataPipeline::GetPipelineDefinitionOutput instance
Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition.
ListPipelines
Each argument is described in detail in: Paws::DataPipeline::ListPipelines
Returns: a Paws::DataPipeline::ListPipelinesOutput instance
Lists the pipeline identifiers for all active pipelines that you have permission to access.
PollForTask
- WorkerGroup => Str
- [Hostname => Str]
- [InstanceIdentity => Paws::DataPipeline::InstanceIdentity]
Each argument is described in detail in: Paws::DataPipeline::PollForTask
Returns: a Paws::DataPipeline::PollForTaskOutput instance
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.
PutPipelineDefinition
- PipelineId => Str
- PipelineObjects => ArrayRef[Paws::DataPipeline::PipelineObject]
- [ParameterObjects => ArrayRef[Paws::DataPipeline::ParameterObject]]
- [ParameterValues => ArrayRef[Paws::DataPipeline::ParameterValue]]
Each argument is described in detail in: Paws::DataPipeline::PutPipelineDefinition
Returns: a Paws::DataPipeline::PutPipelineDefinitionOutput instance
Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline.
PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline.
- 1. An object is missing a name or identifier field.
- 2. A string or reference field is empty.
- 3. The number of objects in the pipeline exceeds the maximum allowed objects.
- 4. The pipeline is in a FINISHED state.
Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.
QueryObjects
- PipelineId => Str
- Sphere => Str
- [Limit => Int]
- [Marker => Str]
- [Query => Paws::DataPipeline::Query]
Each argument is described in detail in: Paws::DataPipeline::QueryObjects
Returns: a Paws::DataPipeline::QueryObjectsOutput instance
Queries the specified pipeline for the names of objects that match the specified set of conditions.
RemoveTags
Each argument is described in detail in: Paws::DataPipeline::RemoveTags
Returns: a Paws::DataPipeline::RemoveTagsOutput instance
Removes existing tags from the specified pipeline.
ReportTaskProgress
- TaskId => Str
- [Fields => ArrayRef[Paws::DataPipeline::Field]]
Each argument is described in detail in: Paws::DataPipeline::ReportTaskProgress
Returns: a Paws::DataPipeline::ReportTaskProgressOutput instance
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.
ReportTaskRunnerHeartbeat
Each argument is described in detail in: Paws::DataPipeline::ReportTaskRunnerHeartbeat
Returns: a Paws::DataPipeline::ReportTaskRunnerHeartbeatOutput instance
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.
SetStatus
Each argument is described in detail in: Paws::DataPipeline::SetStatus
Returns: nothing
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.
SetTaskStatus
Each argument is described in detail in: Paws::DataPipeline::SetTaskStatus
Returns: a Paws::DataPipeline::SetTaskStatusOutput instance
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.
ValidatePipelineDefinition
- PipelineId => Str
- PipelineObjects => ArrayRef[Paws::DataPipeline::PipelineObject]
- [ParameterObjects => ArrayRef[Paws::DataPipeline::ParameterObject]]
- [ParameterValues => ArrayRef[Paws::DataPipeline::ParameterValue]]
Each argument is described in detail in: Paws::DataPipeline::ValidatePipelineDefinition
Returns: a Paws::DataPipeline::ValidatePipelineDefinitionOutput instance
Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
PAGINATORS
Paginator methods are helpers that repetively call methods that return partial results
DescribeAllObjects(sub { },ObjectIds => ArrayRef[Str|Undef], PipelineId => Str, [EvaluateExpressions => Bool, Marker => Str])
DescribeAllObjects(ObjectIds => ArrayRef[Str|Undef], PipelineId => Str, [EvaluateExpressions => Bool, Marker => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- pipelineObjects, passing the object as the first parameter, and the string 'pipelineObjects' as the second parameter If not, it will return a a Paws::DataPipeline::DescribeObjectsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllPipelines(sub { },[Marker => Str])
ListAllPipelines([Marker => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- pipelineIdList, passing the object as the first parameter, and the string 'pipelineIdList' as the second parameter If not, it will return a a Paws::DataPipeline::ListPipelinesOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
QueryAllObjects(sub { },PipelineId => Str, Sphere => Str, [Limit => Int, Marker => Str, Query => Paws::DataPipeline::Query])
QueryAllObjects(PipelineId => Str, Sphere => Str, [Limit => Int, Marker => Str, Query => Paws::DataPipeline::Query])
If passed a sub as first parameter, it will call the sub for each element found in :
- ids, passing the object as the first parameter, and the string 'ids' as the second parameter If not, it will return a a Paws::DataPipeline::QueryObjectsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
SEE ALSO
This service class forms part of Paws
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues