@datafire/amazonaws_datapipeline

Client library for AWS Data Pipeline

Installation and Usage

npm install --save @datafire/amazonaws_datapipeline

let amazonaws_datapipeline = require('@datafire/amazonaws_datapipeline').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_datapipeline.ActivatePipeline({
  "pipelineId": ""
}).then(data => {
  console.log(data);
});

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.

Actions

ActivatePipeline

amazonaws_datapipeline.ActivatePipeline({
  "pipelineId": ""
}, context)

Input

• input object
  • parameterValues ParameterValueList
  • pipelineId required id
  • startTimestamp timestamp

Output

• output ActivatePipelineOutput

AddTags

amazonaws_datapipeline.AddTags({
  "pipelineId": "",
  "tags": []
}, context)

Input

• input object
  • pipelineId required id
  • tags required tagList

Output

• output AddTagsOutput

CreatePipeline

amazonaws_datapipeline.CreatePipeline({
  "name": "",
  "uniqueId": ""
}, context)

Input

• input object
  • description string
  • name required id
  • tags tagList
  • uniqueId required id

Output

• output CreatePipelineOutput

DeactivatePipeline

amazonaws_datapipeline.DeactivatePipeline({
  "pipelineId": ""
}, context)

Input

• input object
  • cancelActive cancelActive
  • pipelineId required id

Output

• output DeactivatePipelineOutput

DeletePipeline

amazonaws_datapipeline.DeletePipeline({
  "pipelineId": ""
}, context)

Input

• input object
  • pipelineId required id

Output

Output schema unknown

DescribeObjects

amazonaws_datapipeline.DescribeObjects({
  "pipelineId": "",
  "objectIds": []
}, context)

Input

• input object
  • marker string
  • evaluateExpressions boolean
  • marker string
  • objectIds required idList
  • pipelineId required id

Output

• output DescribeObjectsOutput

DescribePipelines

amazonaws_datapipeline.DescribePipelines({
  "pipelineIds": []
}, context)

Input

• input object
  • pipelineIds required idList

Output

• output DescribePipelinesOutput

EvaluateExpression

amazonaws_datapipeline.EvaluateExpression({
  "pipelineId": "",
  "objectId": "",
  "expression": ""
}, context)

Input

• input object
  • expression required longString
  • objectId required id
  • pipelineId required id

Output

• output EvaluateExpressionOutput

GetPipelineDefinition

amazonaws_datapipeline.GetPipelineDefinition({
  "pipelineId": ""
}, context)

Input

• input object
  • pipelineId required id
  • version string

Output

• output GetPipelineDefinitionOutput

ListPipelines

amazonaws_datapipeline.ListPipelines({}, context)

Input

• input object
  • marker string
  • marker string

Output

• output ListPipelinesOutput

PollForTask

amazonaws_datapipeline.PollForTask({
  "workerGroup": ""
}, context)

Input

• input object
  • hostname id
  • instanceIdentity InstanceIdentity
  • workerGroup required string

Output

• output PollForTaskOutput

PutPipelineDefinition

amazonaws_datapipeline.PutPipelineDefinition({
  "pipelineId": "",
  "pipelineObjects": []
}, context)

Input

• input object
  • parameterObjects ParameterObjectList
  • parameterValues ParameterValueList
  • pipelineId required id
  • pipelineObjects required PipelineObjectList

Output

• output PutPipelineDefinitionOutput

QueryObjects

amazonaws_datapipeline.QueryObjects({
  "pipelineId": "",
  "sphere": ""
}, context)

Input

• input object
  • limit string
  • marker string
  • limit int
  • marker string
  • pipelineId required id
  • query Query
  • sphere required string

Output

• output QueryObjectsOutput

RemoveTags

amazonaws_datapipeline.RemoveTags({
  "pipelineId": "",
  "tagKeys": []
}, context)

Input

• input object
  • pipelineId required id
  • tagKeys required stringList

Output

• output RemoveTagsOutput

ReportTaskProgress

amazonaws_datapipeline.ReportTaskProgress({
  "taskId": ""
}, context)

Input

• input object
  • fields fieldList
  • taskId required taskId

Output

• output ReportTaskProgressOutput

ReportTaskRunnerHeartbeat

amazonaws_datapipeline.ReportTaskRunnerHeartbeat({
  "taskrunnerId": ""
}, context)

Input

• input object
  • hostname id
  • taskrunnerId required id
  • workerGroup string

Output

• output ReportTaskRunnerHeartbeatOutput

SetStatus

amazonaws_datapipeline.SetStatus({
  "pipelineId": "",
  "objectIds": [],
  "status": ""
}, context)

Input

• input object
  • objectIds required idList
  • pipelineId required id
  • status required string

Output

Output schema unknown

SetTaskStatus

amazonaws_datapipeline.SetTaskStatus({
  "taskId": "",
  "taskStatus": ""
}, context)

Input

• input object
  • errorId string
  • errorMessage errorMessage
  • errorStackTrace string
  • taskId required taskId
  • taskStatus required TaskStatus

Output

• output SetTaskStatusOutput

ValidatePipelineDefinition

amazonaws_datapipeline.ValidatePipelineDefinition({
  "pipelineId": "",
  "pipelineObjects": []
}, context)

Input

• input object
  • parameterObjects ParameterObjectList
  • parameterValues ParameterValueList
  • pipelineId required id
  • pipelineObjects required PipelineObjectList

Output

• output ValidatePipelineDefinitionOutput

Definitions

ActivatePipelineInput

• ActivatePipelineInput object: Contains the parameters for ActivatePipeline.
  • parameterValues ParameterValueList
  • pipelineId required id
  • startTimestamp timestamp

ActivatePipelineOutput

• ActivatePipelineOutput object: Contains the output of ActivatePipeline.

AddTagsInput

• AddTagsInput object: Contains the parameters for AddTags.
  • pipelineId required id
  • tags required tagList

AddTagsOutput

• AddTagsOutput object: Contains the output of AddTags.

CreatePipelineInput

• CreatePipelineInput object: Contains the parameters for CreatePipeline.
  • description string
  • name required id
  • tags tagList
  • uniqueId required id

CreatePipelineOutput

• CreatePipelineOutput object: Contains the output of CreatePipeline.
  • pipelineId required id

DeactivatePipelineInput

• DeactivatePipelineInput object: Contains the parameters for DeactivatePipeline.
  • cancelActive cancelActive
  • pipelineId required id

DeactivatePipelineOutput

• DeactivatePipelineOutput object: Contains the output of DeactivatePipeline.

DeletePipelineInput

• DeletePipelineInput object: Contains the parameters for DeletePipeline.
  • pipelineId required id

DescribeObjectsInput

• DescribeObjectsInput object: Contains the parameters for DescribeObjects.
  • evaluateExpressions boolean
  • marker string
  • objectIds required idList
  • pipelineId required id

DescribeObjectsOutput

• DescribeObjectsOutput object: Contains the output of DescribeObjects.
  • hasMoreResults boolean
  • marker string
  • pipelineObjects required PipelineObjectList

DescribePipelinesInput

• DescribePipelinesInput object: Contains the parameters for DescribePipelines.
  • pipelineIds required idList

DescribePipelinesOutput

• DescribePipelinesOutput object: Contains the output of DescribePipelines.
  • pipelineDescriptionList required PipelineDescriptionList

EvaluateExpressionInput

• EvaluateExpressionInput object: Contains the parameters for EvaluateExpression.
  • expression required longString
  • objectId required id
  • pipelineId required id

EvaluateExpressionOutput

• EvaluateExpressionOutput object: Contains the output of EvaluateExpression.
  • evaluatedExpression required longString

Field

• Field object: A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (StringValue) or a reference to another object (RefValue) but not as both.
  • key required fieldNameString
  • refValue fieldNameString
  • stringValue fieldStringValue

GetPipelineDefinitionInput

• GetPipelineDefinitionInput object: Contains the parameters for GetPipelineDefinition.
  • pipelineId required id
  • version string

GetPipelineDefinitionOutput

• GetPipelineDefinitionOutput object: Contains the output of GetPipelineDefinition.
  • parameterObjects ParameterObjectList
  • parameterValues ParameterValueList
  • pipelineObjects PipelineObjectList

InstanceIdentity

• InstanceIdentity object:

  Identity information for the EC2 instance that is hosting the task runner. You can get this value by calling a metadata URI from the EC2 instance. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.

  • document string
  • signature string

InternalServiceError

• InternalServiceError object: An internal service error occurred.
  • message errorMessage

InvalidRequestException

• InvalidRequestException object: 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.
  • message errorMessage

ListPipelinesInput

• ListPipelinesInput object: Contains the parameters for ListPipelines.
  • marker string

ListPipelinesOutput

• ListPipelinesOutput object: Contains the output of ListPipelines.
  • hasMoreResults boolean
  • marker string
  • pipelineIdList required pipelineList

Operator

• Operator object: Contains a logical operation for comparing the value of a field with a specified value.
  • type OperatorType
  • values stringList

OperatorType

• OperatorType string (values: EQ, REF_EQ, LE, GE, BETWEEN)

ParameterAttribute

• ParameterAttribute object: The attributes allowed or specified with a parameter object.
  • key required attributeNameString
  • stringValue required attributeValueString

ParameterAttributeList

• ParameterAttributeList array
  • items ParameterAttribute

ParameterObject

• ParameterObject object: Contains information about a parameter object.
  • attributes required ParameterAttributeList
  • id required fieldNameString

ParameterObjectList

• ParameterObjectList array
  • items ParameterObject

ParameterValue

• ParameterValue object: A value or list of parameter values.
  • id required fieldNameString
  • stringValue required fieldStringValue

ParameterValueList

• ParameterValueList array
  • items ParameterValue

PipelineDeletedException

• PipelineDeletedException object: The specified pipeline has been deleted.
  • message errorMessage

PipelineDescription

• PipelineDescription object: Contains pipeline metadata.
  • description string
  • fields required fieldList
  • name required id
  • pipelineId required id
  • tags tagList

PipelineDescriptionList

• PipelineDescriptionList array
  • items PipelineDescription

PipelineIdName

• PipelineIdName object: Contains the name and identifier of a pipeline.
  • id id
  • name id

PipelineNotFoundException

• PipelineNotFoundException object: The specified pipeline was not found. Verify that you used the correct user and account identifiers.
  • message errorMessage

PipelineObject

• PipelineObject object: Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.
  • fields required fieldList
  • id required id
  • name required id

PipelineObjectList

• PipelineObjectList array
  • items PipelineObject

PipelineObjectMap

• PipelineObjectMap array
  • items object
    • key id
    • value PipelineObject

PollForTaskInput

• PollForTaskInput object: Contains the parameters for PollForTask.
  • hostname id
  • instanceIdentity InstanceIdentity
  • workerGroup required string

PollForTaskOutput

• PollForTaskOutput object: Contains the output of PollForTask.
  • taskObject TaskObject

PutPipelineDefinitionInput

• PutPipelineDefinitionInput object: Contains the parameters for PutPipelineDefinition.
  • parameterObjects ParameterObjectList
  • parameterValues ParameterValueList
  • pipelineId required id
  • pipelineObjects required PipelineObjectList

PutPipelineDefinitionOutput

• PutPipelineDefinitionOutput object: Contains the output of PutPipelineDefinition.
  • errored required boolean
  • validationErrors ValidationErrors
  • validationWarnings ValidationWarnings

Query

• Query object: Defines the query to run against an object.
  • selectors SelectorList

QueryObjectsInput

• QueryObjectsInput object: Contains the parameters for QueryObjects.
  • limit int
  • marker string
  • pipelineId required id
  • query Query
  • sphere required string

QueryObjectsOutput

• QueryObjectsOutput object: Contains the output of QueryObjects.
  • hasMoreResults boolean
  • ids idList
  • marker string

RemoveTagsInput

• RemoveTagsInput object: Contains the parameters for RemoveTags.
  • pipelineId required id
  • tagKeys required stringList

RemoveTagsOutput

• RemoveTagsOutput object: Contains the output of RemoveTags.

ReportTaskProgressInput

• ReportTaskProgressInput object: Contains the parameters for ReportTaskProgress.
  • fields fieldList
  • taskId required taskId

ReportTaskProgressOutput

• ReportTaskProgressOutput object: Contains the output of ReportTaskProgress.
  • canceled required boolean

ReportTaskRunnerHeartbeatInput

• ReportTaskRunnerHeartbeatInput object: Contains the parameters for ReportTaskRunnerHeartbeat.
  • hostname id
  • taskrunnerId required id
  • workerGroup string

ReportTaskRunnerHeartbeatOutput

• ReportTaskRunnerHeartbeatOutput object: Contains the output of ReportTaskRunnerHeartbeat.
  • terminate required boolean

Selector

• Selector object: A comparision that is used to determine whether a query should return this object.
  • fieldName string
  • operator Operator

SelectorList

• SelectorList array: The list of Selectors that define queries on individual fields.
  • items Selector

SetStatusInput

• SetStatusInput object: Contains the parameters for SetStatus.
  • objectIds required idList
  • pipelineId required id
  • status required string

SetTaskStatusInput

• SetTaskStatusInput object: Contains the parameters for SetTaskStatus.
  • errorId string
  • errorMessage errorMessage
  • errorStackTrace string
  • taskId required taskId
  • taskStatus required TaskStatus

SetTaskStatusOutput

• SetTaskStatusOutput object: Contains the output of SetTaskStatus.

Tag

• Tag object: Tags are key/value pairs defined by a user and associated with a pipeline to control access. AWS Data Pipeline allows you to associate ten tags per pipeline. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.
  • key required tagKey
  • value required tagValue

TaskNotFoundException

• TaskNotFoundException object: The specified task was not found.
  • message errorMessage

TaskObject

• TaskObject object: Contains information about a pipeline task that is assigned to a task runner.
  • attemptId id
  • objects PipelineObjectMap
  • pipelineId id
  • taskId taskId

TaskStatus

• TaskStatus string (values: FINISHED, FAILED, FALSE)

ValidatePipelineDefinitionInput

• ValidatePipelineDefinitionInput object: Contains the parameters for ValidatePipelineDefinition.
  • parameterObjects ParameterObjectList
  • parameterValues ParameterValueList
  • pipelineId required id
  • pipelineObjects required PipelineObjectList

ValidatePipelineDefinitionOutput

• ValidatePipelineDefinitionOutput object: Contains the output of ValidatePipelineDefinition.
  • errored required boolean
  • validationErrors ValidationErrors
  • validationWarnings ValidationWarnings

ValidationError

• ValidationError object: Defines a validation error. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.
  • errors validationMessages
  • id id

ValidationErrors

• ValidationErrors array
  • items ValidationError

ValidationWarning

• ValidationWarning object: Defines a validation warning. Validation warnings do not prevent pipeline activation. The set of validation warnings that can be returned are defined by AWS Data Pipeline.
  • id id
  • warnings validationMessages

ValidationWarnings

• ValidationWarnings array
  • items ValidationWarning

attributeNameString

• attributeNameString string

attributeValueString

• attributeValueString string

boolean

• boolean boolean

cancelActive

• cancelActive boolean

errorMessage

• errorMessage string

fieldList

• fieldList array
  • items Field

fieldNameString

• fieldNameString string

fieldStringValue

• fieldStringValue string

id

• id string

idList

• idList array
  • items id

int

• int integer

longString

• longString string

pipelineList

• pipelineList array
  • items PipelineIdName

string

• string string

stringList

• stringList array
  • items string

tagKey

• tagKey string

tagList

• tagList array
  • items Tag

tagValue

• tagValue string

taskId

• taskId string

timestamp

• timestamp string

validationMessage

• validationMessage string

validationMessages

• validationMessages array
  • items validationMessage