Documentation ¶
Overview ¶
Package datapipeline provides a client for AWS Data Pipeline.
Index ¶
- Constants
- type ActivatePipelineInput
- type ActivatePipelineOutput
- type CreatePipelineInput
- type CreatePipelineOutput
- type DataPipeline
- func (c *DataPipeline) ActivatePipeline(req *ActivatePipelineInput) (resp *ActivatePipelineOutput, err error)
- func (c *DataPipeline) CreatePipeline(req *CreatePipelineInput) (resp *CreatePipelineOutput, err error)
- func (c *DataPipeline) DeletePipeline(req *DeletePipelineInput) (err error)
- func (c *DataPipeline) DescribeObjects(req *DescribeObjectsInput) (resp *DescribeObjectsOutput, err error)
- func (c *DataPipeline) DescribePipelines(req *DescribePipelinesInput) (resp *DescribePipelinesOutput, err error)
- func (c *DataPipeline) EvaluateExpression(req *EvaluateExpressionInput) (resp *EvaluateExpressionOutput, err error)
- func (c *DataPipeline) GetPipelineDefinition(req *GetPipelineDefinitionInput) (resp *GetPipelineDefinitionOutput, err error)
- func (c *DataPipeline) ListPipelines(req *ListPipelinesInput) (resp *ListPipelinesOutput, err error)
- func (c *DataPipeline) PollForTask(req *PollForTaskInput) (resp *PollForTaskOutput, err error)
- func (c *DataPipeline) PutPipelineDefinition(req *PutPipelineDefinitionInput) (resp *PutPipelineDefinitionOutput, err error)
- func (c *DataPipeline) QueryObjects(req *QueryObjectsInput) (resp *QueryObjectsOutput, err error)
- func (c *DataPipeline) ReportTaskProgress(req *ReportTaskProgressInput) (resp *ReportTaskProgressOutput, err error)
- func (c *DataPipeline) ReportTaskRunnerHeartbeat(req *ReportTaskRunnerHeartbeatInput) (resp *ReportTaskRunnerHeartbeatOutput, err error)
- func (c *DataPipeline) SetStatus(req *SetStatusInput) (err error)
- func (c *DataPipeline) SetTaskStatus(req *SetTaskStatusInput) (resp *SetTaskStatusOutput, err error)
- func (c *DataPipeline) ValidatePipelineDefinition(req *ValidatePipelineDefinitionInput) (resp *ValidatePipelineDefinitionOutput, err error)
- type DeletePipelineInput
- type DescribeObjectsInput
- type DescribeObjectsOutput
- type DescribePipelinesInput
- type DescribePipelinesOutput
- type EvaluateExpressionInput
- type EvaluateExpressionOutput
- type Field
- type GetPipelineDefinitionInput
- type GetPipelineDefinitionOutput
- type InstanceIdentity
- type ListPipelinesInput
- type ListPipelinesOutput
- type Operator
- type ParameterAttribute
- type ParameterObject
- type ParameterValue
- type PipelineDescription
- type PipelineIDName
- type PipelineObject
- type PollForTaskInput
- type PollForTaskOutput
- type PutPipelineDefinitionInput
- type PutPipelineDefinitionOutput
- type Query
- type QueryObjectsInput
- type QueryObjectsOutput
- type ReportTaskProgressInput
- type ReportTaskProgressOutput
- type ReportTaskRunnerHeartbeatInput
- type ReportTaskRunnerHeartbeatOutput
- type Selector
- type SetStatusInput
- type SetTaskStatusInput
- type SetTaskStatusOutput
- type TaskObject
- type ValidatePipelineDefinitionInput
- type ValidatePipelineDefinitionOutput
- type ValidationError
- type ValidationWarning
Constants ¶
const ( OperatorTypeBetween = "BETWEEN" OperatorTypeEq = "EQ" OperatorTypeGe = "GE" OperatorTypeLe = "LE" OperatorTypeRefEq = "REF_EQ" )
Possible values for DataPipeline.
const ( TaskStatusFailed = "FAILED" TaskStatusFalse = "FALSE" TaskStatusFinished = "FINISHED" )
Possible values for DataPipeline.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ActivatePipelineInput ¶
type ActivatePipelineInput struct { ParameterValues []ParameterValue `json:"parameterValues,omitempty"` PipelineID aws.StringValue `json:"pipelineId"` }
ActivatePipelineInput is undocumented.
type ActivatePipelineOutput ¶
type ActivatePipelineOutput struct { }
ActivatePipelineOutput is undocumented.
type CreatePipelineInput ¶
type CreatePipelineInput struct { Description aws.StringValue `json:"description,omitempty"` Name aws.StringValue `json:"name"` UniqueID aws.StringValue `json:"uniqueId"` }
CreatePipelineInput is undocumented.
type CreatePipelineOutput ¶
type CreatePipelineOutput struct {
PipelineID aws.StringValue `json:"pipelineId"`
}
CreatePipelineOutput is undocumented.
type DataPipeline ¶
type DataPipeline struct {
// contains filtered or unexported fields
}
DataPipeline is a client for AWS Data Pipeline.
func New ¶
func New(creds aws.CredentialsProvider, region string, client *http.Client) *DataPipeline
New returns a new DataPipeline client.
func (*DataPipeline) ActivatePipeline ¶
func (c *DataPipeline) ActivatePipeline(req *ActivatePipelineInput) (resp *ActivatePipelineOutput, err error)
ActivatePipeline validates a pipeline and initiates processing. If the pipeline does not pass validation, activation fails. You cannot perform this operation on pipelines and attempting to do so will return an InvalidRequestException. Call this action to start processing pipeline tasks of a pipeline you've created using the CreatePipeline and PutPipelineDefinition actions. A pipeline cannot be modified after it has been successfully activated.
func (*DataPipeline) CreatePipeline ¶
func (c *DataPipeline) CreatePipeline(req *CreatePipelineInput) (resp *CreatePipelineOutput, err error)
CreatePipeline creates a new empty pipeline. When this action succeeds, you can then use the PutPipelineDefinition action to populate the pipeline.
func (*DataPipeline) DeletePipeline ¶
func (c *DataPipeline) DeletePipeline(req *DeletePipelineInput) (err error)
DeletePipeline permanently deletes a pipeline, its pipeline definition and its run history. You cannot query or restore a deleted pipeline. AWS Data Pipeline will attempt to cancel instances associated with the pipeline that are currently being processed by task runners. Deleting a pipeline cannot be undone. 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.
func (*DataPipeline) DescribeObjects ¶
func (c *DataPipeline) DescribeObjects(req *DescribeObjectsInput) (resp *DescribeObjectsOutput, err error)
DescribeObjects returns 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.
func (*DataPipeline) DescribePipelines ¶
func (c *DataPipeline) DescribePipelines(req *DescribePipelinesInput) (resp *DescribePipelinesOutput, err error)
DescribePipelines retrieve 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 you have read permission for. To retrieve the full pipeline definition instead of metadata about the pipeline, call the GetPipelineDefinition action.
func (*DataPipeline) EvaluateExpression ¶
func (c *DataPipeline) EvaluateExpression(req *EvaluateExpressionInput) (resp *EvaluateExpressionOutput, err error)
EvaluateExpression evaluates a string in the context of a specified object. A task runner can use this action to evaluate SQL queries stored in Amazon S3.
func (*DataPipeline) GetPipelineDefinition ¶
func (c *DataPipeline) GetPipelineDefinition(req *GetPipelineDefinitionInput) (resp *GetPipelineDefinitionOutput, err error)
GetPipelineDefinition returns the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition you provided using PutPipelineDefinition
func (*DataPipeline) ListPipelines ¶
func (c *DataPipeline) ListPipelines(req *ListPipelinesInput) (resp *ListPipelinesOutput, err error)
ListPipelines returns a list of pipeline identifiers for all active pipelines. Identifiers are returned only for pipelines you have permission to access.
func (*DataPipeline) PollForTask ¶
func (c *DataPipeline) PollForTask(req *PollForTaskInput) (resp *PollForTaskOutput, err error)
PollForTask task runners call this action 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 of the PollForTask call. The task returned by PollForTask may 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 may take up to 90 seconds.
func (*DataPipeline) PutPipelineDefinition ¶
func (c *DataPipeline) PutPipelineDefinition(req *PutPipelineDefinitionInput) (resp *PutPipelineDefinitionOutput, err error)
PutPipelineDefinition adds tasks, schedules, and preconditions that control the behavior of the 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. An object is missing a name or identifier field. A string or reference field is empty. The number of objects in the pipeline exceeds the maximum allowed objects. The pipeline is in a state. Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.
func (*DataPipeline) QueryObjects ¶
func (c *DataPipeline) QueryObjects(req *QueryObjectsInput) (resp *QueryObjectsOutput, err error)
QueryObjects queries a pipeline for the names of objects that match a specified set of conditions. The objects returned by QueryObjects are paginated and then filtered by the value you set for query. This means the action may return an empty result set with a value set for marker. If HasMoreResults is set to True , you should continue to call QueryObjects , passing in the returned value for marker, until HasMoreResults returns False
func (*DataPipeline) ReportTaskProgress ¶
func (c *DataPipeline) ReportTaskProgress(req *ReportTaskProgressInput) (resp *ReportTaskProgressOutput, err error)
ReportTaskProgress updates the AWS Data Pipeline service on the progress of the calling task runner. When the task runner is assigned a task, it should call ReportTaskProgress to acknowledge that it has the task within 2 minutes. If the web service does not recieve this acknowledgement within the 2 minute window, it will assign 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 will assume that the task runner is unable to process the task and will reassign the task in a subsequent response to PollForTask . task runners should call ReportTaskProgress every 60 seconds.
func (*DataPipeline) ReportTaskRunnerHeartbeat ¶
func (c *DataPipeline) ReportTaskRunnerHeartbeat(req *ReportTaskRunnerHeartbeatInput) (resp *ReportTaskRunnerHeartbeatOutput, err error)
ReportTaskRunnerHeartbeat task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. In the case of AWS Data Pipeline Task Runner 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.
func (*DataPipeline) SetStatus ¶
func (c *DataPipeline) SetStatus(req *SetStatusInput) (err error)
SetStatus requests that the status of an array of physical or logical pipeline objects be updated in the pipeline. This update may not occur immediately, but is eventually consistent. The status that can be set depends on the type of object, e.g. DataNode or Activity. You cannot perform this operation on pipelines and attempting to do so will return an InvalidRequestException.
func (*DataPipeline) SetTaskStatus ¶
func (c *DataPipeline) SetTaskStatus(req *SetTaskStatusInput) (resp *SetTaskStatusOutput, err error)
SetTaskStatus notifies AWS Data Pipeline that a task is completed and provides information about the final status. The task runner calls this action regardless of whether the task was sucessful. The task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress .
func (*DataPipeline) ValidatePipelineDefinition ¶
func (c *DataPipeline) ValidatePipelineDefinition(req *ValidatePipelineDefinitionInput) (resp *ValidatePipelineDefinitionOutput, err error)
ValidatePipelineDefinition tests the pipeline definition with a set of validation checks to ensure that it is well formed and can run without error.
type DeletePipelineInput ¶
type DeletePipelineInput struct {
PipelineID aws.StringValue `json:"pipelineId"`
}
DeletePipelineInput is undocumented.
type DescribeObjectsInput ¶
type DescribeObjectsInput struct { EvaluateExpressions aws.BooleanValue `json:"evaluateExpressions,omitempty"` Marker aws.StringValue `json:"marker,omitempty"` ObjectIDs []string `json:"objectIds"` PipelineID aws.StringValue `json:"pipelineId"` }
DescribeObjectsInput is undocumented.
type DescribeObjectsOutput ¶
type DescribeObjectsOutput struct { HasMoreResults aws.BooleanValue `json:"hasMoreResults,omitempty"` Marker aws.StringValue `json:"marker,omitempty"` PipelineObjects []PipelineObject `json:"pipelineObjects"` }
DescribeObjectsOutput is undocumented.
type DescribePipelinesInput ¶
type DescribePipelinesInput struct {
PipelineIDs []string `json:"pipelineIds"`
}
DescribePipelinesInput is undocumented.
type DescribePipelinesOutput ¶
type DescribePipelinesOutput struct {
PipelineDescriptionList []PipelineDescription `json:"pipelineDescriptionList"`
}
DescribePipelinesOutput is undocumented.
type EvaluateExpressionInput ¶
type EvaluateExpressionInput struct { Expression aws.StringValue `json:"expression"` ObjectID aws.StringValue `json:"objectId"` PipelineID aws.StringValue `json:"pipelineId"` }
EvaluateExpressionInput is undocumented.
type EvaluateExpressionOutput ¶
type EvaluateExpressionOutput struct {
EvaluatedExpression aws.StringValue `json:"evaluatedExpression"`
}
EvaluateExpressionOutput is undocumented.
type Field ¶
type Field struct { Key aws.StringValue `json:"key"` RefValue aws.StringValue `json:"refValue,omitempty"` StringValue aws.StringValue `json:"stringValue,omitempty"` }
Field is undocumented.
type GetPipelineDefinitionInput ¶
type GetPipelineDefinitionInput struct { PipelineID aws.StringValue `json:"pipelineId"` Version aws.StringValue `json:"version,omitempty"` }
GetPipelineDefinitionInput is undocumented.
type GetPipelineDefinitionOutput ¶
type GetPipelineDefinitionOutput struct { ParameterObjects []ParameterObject `json:"parameterObjects,omitempty"` ParameterValues []ParameterValue `json:"parameterValues,omitempty"` PipelineObjects []PipelineObject `json:"pipelineObjects,omitempty"` }
GetPipelineDefinitionOutput is undocumented.
type InstanceIdentity ¶
type InstanceIdentity struct { Document aws.StringValue `json:"document,omitempty"` Signature aws.StringValue `json:"signature,omitempty"` }
InstanceIdentity is undocumented.
type ListPipelinesInput ¶
type ListPipelinesInput struct {
Marker aws.StringValue `json:"marker,omitempty"`
}
ListPipelinesInput is undocumented.
type ListPipelinesOutput ¶
type ListPipelinesOutput struct { HasMoreResults aws.BooleanValue `json:"hasMoreResults,omitempty"` Marker aws.StringValue `json:"marker,omitempty"` PipelineIDList []PipelineIDName `json:"pipelineIdList"` }
ListPipelinesOutput is undocumented.
type Operator ¶
type Operator struct { Type aws.StringValue `json:"type,omitempty"` Values []string `json:"values,omitempty"` }
Operator is undocumented.
type ParameterAttribute ¶
type ParameterAttribute struct { Key aws.StringValue `json:"key"` StringValue aws.StringValue `json:"stringValue"` }
ParameterAttribute is undocumented.
type ParameterObject ¶
type ParameterObject struct { Attributes []ParameterAttribute `json:"attributes"` ID aws.StringValue `json:"id"` }
ParameterObject is undocumented.
type ParameterValue ¶
type ParameterValue struct { ID aws.StringValue `json:"id"` StringValue aws.StringValue `json:"stringValue"` }
ParameterValue is undocumented.
type PipelineDescription ¶
type PipelineDescription struct { Description aws.StringValue `json:"description,omitempty"` Fields []Field `json:"fields"` Name aws.StringValue `json:"name"` PipelineID aws.StringValue `json:"pipelineId"` }
PipelineDescription is undocumented.
type PipelineIDName ¶
type PipelineIDName struct { ID aws.StringValue `json:"id,omitempty"` Name aws.StringValue `json:"name,omitempty"` }
PipelineIDName is undocumented.
type PipelineObject ¶
type PipelineObject struct { Fields []Field `json:"fields"` ID aws.StringValue `json:"id"` Name aws.StringValue `json:"name"` }
PipelineObject is undocumented.
type PollForTaskInput ¶
type PollForTaskInput struct { Hostname aws.StringValue `json:"hostname,omitempty"` InstanceIdentity *InstanceIdentity `json:"instanceIdentity,omitempty"` WorkerGroup aws.StringValue `json:"workerGroup"` }
PollForTaskInput is undocumented.
type PollForTaskOutput ¶
type PollForTaskOutput struct {
TaskObject *TaskObject `json:"taskObject,omitempty"`
}
PollForTaskOutput is undocumented.
type PutPipelineDefinitionInput ¶
type PutPipelineDefinitionInput struct { ParameterObjects []ParameterObject `json:"parameterObjects,omitempty"` ParameterValues []ParameterValue `json:"parameterValues,omitempty"` PipelineID aws.StringValue `json:"pipelineId"` PipelineObjects []PipelineObject `json:"pipelineObjects"` }
PutPipelineDefinitionInput is undocumented.
type PutPipelineDefinitionOutput ¶
type PutPipelineDefinitionOutput struct { Errored aws.BooleanValue `json:"errored"` ValidationErrors []ValidationError `json:"validationErrors,omitempty"` ValidationWarnings []ValidationWarning `json:"validationWarnings,omitempty"` }
PutPipelineDefinitionOutput is undocumented.
type Query ¶
type Query struct {
Selectors []Selector `json:"selectors,omitempty"`
}
Query is undocumented.
type QueryObjectsInput ¶
type QueryObjectsInput struct { Limit aws.IntegerValue `json:"limit,omitempty"` Marker aws.StringValue `json:"marker,omitempty"` PipelineID aws.StringValue `json:"pipelineId"` Query *Query `json:"query,omitempty"` Sphere aws.StringValue `json:"sphere"` }
QueryObjectsInput is undocumented.
type QueryObjectsOutput ¶
type QueryObjectsOutput struct { HasMoreResults aws.BooleanValue `json:"hasMoreResults,omitempty"` IDs []string `json:"ids,omitempty"` Marker aws.StringValue `json:"marker,omitempty"` }
QueryObjectsOutput is undocumented.
type ReportTaskProgressInput ¶
type ReportTaskProgressInput struct { Fields []Field `json:"fields,omitempty"` TaskID aws.StringValue `json:"taskId"` }
ReportTaskProgressInput is undocumented.
type ReportTaskProgressOutput ¶
type ReportTaskProgressOutput struct {
Canceled aws.BooleanValue `json:"canceled"`
}
ReportTaskProgressOutput is undocumented.
type ReportTaskRunnerHeartbeatInput ¶
type ReportTaskRunnerHeartbeatInput struct { Hostname aws.StringValue `json:"hostname,omitempty"` TaskrunnerID aws.StringValue `json:"taskrunnerId"` WorkerGroup aws.StringValue `json:"workerGroup,omitempty"` }
ReportTaskRunnerHeartbeatInput is undocumented.
type ReportTaskRunnerHeartbeatOutput ¶
type ReportTaskRunnerHeartbeatOutput struct {
Terminate aws.BooleanValue `json:"terminate"`
}
ReportTaskRunnerHeartbeatOutput is undocumented.
type Selector ¶
type Selector struct { FieldName aws.StringValue `json:"fieldName,omitempty"` Operator *Operator `json:"operator,omitempty"` }
Selector is undocumented.
type SetStatusInput ¶
type SetStatusInput struct { ObjectIDs []string `json:"objectIds"` PipelineID aws.StringValue `json:"pipelineId"` Status aws.StringValue `json:"status"` }
SetStatusInput is undocumented.
type SetTaskStatusInput ¶
type SetTaskStatusInput struct { ErrorID aws.StringValue `json:"errorId,omitempty"` ErrorMessage aws.StringValue `json:"errorMessage,omitempty"` ErrorStackTrace aws.StringValue `json:"errorStackTrace,omitempty"` TaskID aws.StringValue `json:"taskId"` TaskStatus aws.StringValue `json:"taskStatus"` }
SetTaskStatusInput is undocumented.
type TaskObject ¶
type TaskObject struct { AttemptID aws.StringValue `json:"attemptId,omitempty"` Objects map[string]PipelineObject `json:"objects,omitempty"` PipelineID aws.StringValue `json:"pipelineId,omitempty"` TaskID aws.StringValue `json:"taskId,omitempty"` }
TaskObject is undocumented.
type ValidatePipelineDefinitionInput ¶
type ValidatePipelineDefinitionInput struct { ParameterObjects []ParameterObject `json:"parameterObjects,omitempty"` ParameterValues []ParameterValue `json:"parameterValues,omitempty"` PipelineID aws.StringValue `json:"pipelineId"` PipelineObjects []PipelineObject `json:"pipelineObjects"` }
ValidatePipelineDefinitionInput is undocumented.
type ValidatePipelineDefinitionOutput ¶
type ValidatePipelineDefinitionOutput struct { Errored aws.BooleanValue `json:"errored"` ValidationErrors []ValidationError `json:"validationErrors,omitempty"` ValidationWarnings []ValidationWarning `json:"validationWarnings,omitempty"` }
ValidatePipelineDefinitionOutput is undocumented.
type ValidationError ¶
type ValidationError struct { Errors []string `json:"errors,omitempty"` ID aws.StringValue `json:"id,omitempty"` }
ValidationError is undocumented.
type ValidationWarning ¶
type ValidationWarning struct { ID aws.StringValue `json:"id,omitempty"` Warnings []string `json:"warnings,omitempty"` }
ValidationWarning is undocumented.