datapipeline

package
v0.7.2-0...-3f85735 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 27, 2015 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package datapipeline provides a client for AWS Data Pipeline.

Index

Examples

Constants

View Source
const (
	// @enum OperatorType
	OperatorTypeEq = "EQ"
	// @enum OperatorType
	OperatorTypeRefEq = "REF_EQ"
	// @enum OperatorType
	OperatorTypeLe = "LE"
	// @enum OperatorType
	OperatorTypeGe = "GE"
	// @enum OperatorType
	OperatorTypeBetween = "BETWEEN"
)
View Source
const (
	// @enum TaskStatus
	TaskStatusFinished = "FINISHED"
	// @enum TaskStatus
	TaskStatusFailed = "FAILED"
	// @enum TaskStatus
	TaskStatusFalse = "FALSE"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ActivatePipelineInput

type ActivatePipelineInput struct {
	// A list of parameter values to pass to the pipeline at activation.
	ParameterValues []*ParameterValue `locationName:"parameterValues" type:"list"`

	// The ID of the pipeline.
	PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`

	// The date and time to resume the pipeline. By default, the pipeline resumes
	// from the last completed execution.
	StartTimestamp *time.Time `locationName:"startTimestamp" type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Contains the parameters for ActivatePipeline.

func (ActivatePipelineInput) GoString

func (s ActivatePipelineInput) GoString() string

GoString returns the string representation

func (ActivatePipelineInput) String

func (s ActivatePipelineInput) String() string

String returns the string representation

type ActivatePipelineOutput

type ActivatePipelineOutput struct {
	// contains filtered or unexported fields
}

Contains the output of ActivatePipeline.

func (ActivatePipelineOutput) GoString

func (s ActivatePipelineOutput) GoString() string

GoString returns the string representation

func (ActivatePipelineOutput) String

func (s ActivatePipelineOutput) String() string

String returns the string representation

type AddTagsInput

type AddTagsInput struct {
	// The ID of the pipeline.
	PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`

	// The tags to add, as key/value pairs.
	Tags []*Tag `locationName:"tags" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for AddTags.

func (AddTagsInput) GoString

func (s AddTagsInput) GoString() string

GoString returns the string representation

func (AddTagsInput) String

func (s AddTagsInput) String() string

String returns the string representation

type AddTagsOutput

type AddTagsOutput struct {
	// contains filtered or unexported fields
}

Contains the output of AddTags.

func (AddTagsOutput) GoString

func (s AddTagsOutput) GoString() string

GoString returns the string representation

func (AddTagsOutput) String

func (s AddTagsOutput) String() string

String returns the string representation

type CreatePipelineInput

type CreatePipelineInput struct {
	// The description for the pipeline.
	Description *string `locationName:"description" type:"string"`

	// The name for the pipeline. You can use the same name for multiple pipelines
	// associated with your AWS account, because AWS Data Pipeline assigns each
	// pipeline a unique pipeline identifier.
	Name *string `locationName:"name" type:"string" required:"true"`

	// A list of tags to associate with the pipeline at creation. Tags let you control
	// access to pipelines. For more information, see Controlling User Access to
	// Pipelines (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html)
	// in the AWS Data Pipeline Developer Guide.
	Tags []*Tag `locationName:"tags" type:"list"`

	// A unique identifier. This identifier is not the same as the pipeline identifier
	// assigned by AWS Data Pipeline. You are responsible for defining the format
	// and ensuring the uniqueness of this identifier. You use this parameter to
	// ensure idempotency during repeated calls to CreatePipeline. For example,
	// if the first call to CreatePipeline does not succeed, you can pass in the
	// same unique identifier and pipeline name combination on a subsequent call
	// to CreatePipeline. CreatePipeline ensures that if a pipeline already exists
	// with the same name and unique identifier, a new pipeline is not created.
	// Instead, you'll receive the pipeline identifier from the previous attempt.
	// The uniqueness of the name and unique identifier combination is scoped to
	// the AWS account or IAM user credentials.
	UniqueId *string `locationName:"uniqueId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for CreatePipeline.

func (CreatePipelineInput) GoString

func (s CreatePipelineInput) GoString() string

GoString returns the string representation

func (CreatePipelineInput) String

func (s CreatePipelineInput) String() string

String returns the string representation

type CreatePipelineOutput

type CreatePipelineOutput struct {
	// The ID that AWS Data Pipeline assigns the newly created pipeline. For example,
	// df-06372391ZG65EXAMPLE.
	PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the output of CreatePipeline.

func (CreatePipelineOutput) GoString

func (s CreatePipelineOutput) GoString() string

GoString returns the string representation

func (CreatePipelineOutput) String

func (s CreatePipelineOutput) String() string

String returns the string representation

type DataPipeline

type DataPipeline struct {
	*service.Service
}

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.

func New

func New(config *aws.Config) *DataPipeline

New returns a new DataPipeline client.

func (*DataPipeline) ActivatePipeline

func (c *DataPipeline) ActivatePipeline(input *ActivatePipelineInput) (*ActivatePipelineOutput, error)

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.

Example
package main

import (
	"fmt"
	"time"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/service/datapipeline"
)

func main() {
	svc := datapipeline.New(nil)

	params := &datapipeline.ActivatePipelineInput{
		PipelineId: aws.String("id"), // Required
		ParameterValues: []*datapipeline.ParameterValue{
			{ // Required
				Id:          aws.String("fieldNameString"),  // Required
				StringValue: aws.String("fieldStringValue"), // Required
			},
			// More values...
		},
		StartTimestamp: aws.Time(time.Now()),
	}
	resp, err := svc.ActivatePipeline(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*DataPipeline) ActivatePipelineRequest

func (c *DataPipeline) ActivatePipelineRequest(input *ActivatePipelineInput) (req *request.Request, output *ActivatePipelineOutput)

ActivatePipelineRequest generates a request for the ActivatePipeline operation.

func (*DataPipeline) AddTags

func (c *DataPipeline) AddTags(input *AddTagsInput) (*AddTagsOutput, error)

Adds or modifies tags for the specified pipeline.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/service/datapipeline"
)

func main() {
	svc := datapipeline.New(nil)

	params := &datapipeline.AddTagsInput{
		PipelineId: aws.String("id"), // Required
		Tags: []*datapipeline.Tag{ // Required
			{ // Required
				Key:   aws.String("tagKey"),   // Required
				Value: aws.String("tagValue"), // Required
			},
			// More values...
		},
	}
	resp, err := svc.AddTags(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*DataPipeline) AddTagsRequest

func (c *DataPipeline) AddTagsRequest(input *AddTagsInput) (req *request.Request, output *AddTagsOutput)

AddTagsRequest generates a request for the AddTags operation.

func (*DataPipeline) CreatePipeline

func (c *DataPipeline) CreatePipeline(input *CreatePipelineInput) (*CreatePipelineOutput, error)

Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/service/datapipeline"
)

func main() {
	svc := datapipeline.New(nil)

	params := &datapipeline.CreatePipelineInput{
		Name:        aws.String("id"), // Required
		UniqueId:    aws.String("id"), // Required
		Description: aws.String("string"),
		Tags: []*datapipeline.Tag{
			{ // Required
				Key:   aws.String("tagKey"),   // Required
				Value: aws.String("tagValue"), // Required
			},
			// More values...
		},
	}
	resp, err := svc.CreatePipeline(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*DataPipeline) CreatePipelineRequest

func (c *DataPipeline) CreatePipelineRequest(input *CreatePipelineInput) (req *request.Request, output *CreatePipelineOutput)

CreatePipelineRequest generates a request for the CreatePipeline operation.

func (*DataPipeline) DeactivatePipeline

func (c *DataPipeline) DeactivatePipeline(input *DeactivatePipelineInput) (*DeactivatePipelineOutput, error)

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.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/service/datapipeline"
)

func main() {
	svc := datapipeline.New(nil)

	params := &datapipeline.DeactivatePipelineInput{
		PipelineId:   aws.String("id"), // Required
		CancelActive: aws.Bool(true),
	}
	resp, err := svc.DeactivatePipeline(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*DataPipeline) DeactivatePipelineRequest

func (c *DataPipeline) DeactivatePipelineRequest(input *DeactivatePipelineInput) (req *request.Request, output *DeactivatePipelineOutput)

DeactivatePipelineRequest generates a request for the DeactivatePipeline operation.

func (*DataPipeline) DeletePipeline

func (c *DataPipeline) DeletePipeline(input *DeletePipelineInput) (*DeletePipelineOutput, error)

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.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/service/datapipeline"
)

func main() {
	svc := datapipeline.New(nil)

	params := &datapipeline.DeletePipelineInput{
		PipelineId: aws.String("id"), // Required
	}
	resp, err := svc.DeletePipeline(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*DataPipeline) DeletePipelineRequest

func (c *DataPipeline) DeletePipelineRequest(input *DeletePipelineInput) (req *request.Request, output *DeletePipelineOutput)

DeletePipelineRequest generates a request for the DeletePipeline operation.

func (*DataPipeline) DescribeObjects

func (c *DataPipeline) DescribeObjects(input *DescribeObjectsInput) (*DescribeObjectsOutput, error)

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.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/service/datapipeline"
)

func main() {
	svc := datapipeline.New(nil)

	params := &datapipeline.DescribeObjectsInput{
		ObjectIds: []*string{ // Required
			aws.String("id"), // Required
			// More values...
		},
		PipelineId:          aws.String("id"), // Required
		EvaluateExpressions: aws.Bool(true),
		Marker:              aws.String("string"),
	}
	resp, err := svc.DescribeObjects(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*DataPipeline) DescribeObjectsPages

func (c *DataPipeline) DescribeObjectsPages(input *DescribeObjectsInput, fn func(p *DescribeObjectsOutput, lastPage bool) (shouldContinue bool)) error

func (*DataPipeline) DescribeObjectsRequest

func (c *DataPipeline) DescribeObjectsRequest(input *DescribeObjectsInput) (req *request.Request, output *DescribeObjectsOutput)

DescribeObjectsRequest generates a request for the DescribeObjects operation.

func (*DataPipeline) DescribePipelines

func (c *DataPipeline) DescribePipelines(input *DescribePipelinesInput) (*DescribePipelinesOutput, error)

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.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/service/datapipeline"
)

func main() {
	svc := datapipeline.New(nil)

	params := &datapipeline.DescribePipelinesInput{
		PipelineIds: []*string{ // Required
			aws.String("id"), // Required
			// More values...
		},
	}
	resp, err := svc.DescribePipelines(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*DataPipeline) DescribePipelinesRequest

func (c *DataPipeline) DescribePipelinesRequest(input *DescribePipelinesInput) (req *request.Request, output *DescribePipelinesOutput)

DescribePipelinesRequest generates a request for the DescribePipelines operation.

func (*DataPipeline) EvaluateExpression

func (c *DataPipeline) EvaluateExpression(input *EvaluateExpressionInput) (*EvaluateExpressionOutput, error)

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.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/service/datapipeline"
)

func main() {
	svc := datapipeline.New(nil)

	params := &datapipeline.EvaluateExpressionInput{
		Expression: aws.String("longString"), // Required
		ObjectId:   aws.String("id"),         // Required
		PipelineId: aws.String("id"),         // Required
	}
	resp, err := svc.EvaluateExpression(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*DataPipeline) EvaluateExpressionRequest

func (c *DataPipeline) EvaluateExpressionRequest(input *EvaluateExpressionInput) (req *request.Request, output *EvaluateExpressionOutput)

EvaluateExpressionRequest generates a request for the EvaluateExpression operation.

func (*DataPipeline) GetPipelineDefinition

func (c *DataPipeline) GetPipelineDefinition(input *GetPipelineDefinitionInput) (*GetPipelineDefinitionOutput, error)

Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/service/datapipeline"
)

func main() {
	svc := datapipeline.New(nil)

	params := &datapipeline.GetPipelineDefinitionInput{
		PipelineId: aws.String("id"), // Required
		Version:    aws.String("string"),
	}
	resp, err := svc.GetPipelineDefinition(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*DataPipeline) GetPipelineDefinitionRequest

func (c *DataPipeline) GetPipelineDefinitionRequest(input *GetPipelineDefinitionInput) (req *request.Request, output *GetPipelineDefinitionOutput)

GetPipelineDefinitionRequest generates a request for the GetPipelineDefinition operation.

func (*DataPipeline) ListPipelines

func (c *DataPipeline) ListPipelines(input *ListPipelinesInput) (*ListPipelinesOutput, error)

Lists the pipeline identifiers for all active pipelines that you have permission to access.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/service/datapipeline"
)

func main() {
	svc := datapipeline.New(nil)

	params := &datapipeline.ListPipelinesInput{
		Marker: aws.String("string"),
	}
	resp, err := svc.ListPipelines(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*DataPipeline) ListPipelinesPages

func (c *DataPipeline) ListPipelinesPages(input *ListPipelinesInput, fn func(p *ListPipelinesOutput, lastPage bool) (shouldContinue bool)) error

func (*DataPipeline) ListPipelinesRequest

func (c *DataPipeline) ListPipelinesRequest(input *ListPipelinesInput) (req *request.Request, output *ListPipelinesOutput)

ListPipelinesRequest generates a request for the ListPipelines operation.

func (*DataPipeline) PollForTask

func (c *DataPipeline) PollForTask(input *PollForTaskInput) (*PollForTaskOutput, error)

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.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/service/datapipeline"
)

func main() {
	svc := datapipeline.New(nil)

	params := &datapipeline.PollForTaskInput{
		WorkerGroup: aws.String("string"), // Required
		Hostname:    aws.String("id"),
		InstanceIdentity: &datapipeline.InstanceIdentity{
			Document:  aws.String("string"),
			Signature: aws.String("string"),
		},
	}
	resp, err := svc.PollForTask(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*DataPipeline) PollForTaskRequest

func (c *DataPipeline) PollForTaskRequest(input *PollForTaskInput) (req *request.Request, output *PollForTaskOutput)

PollForTaskRequest generates a request for the PollForTask operation.

func (*DataPipeline) PutPipelineDefinition

func (c *DataPipeline) PutPipelineDefinition(input *PutPipelineDefinitionInput) (*PutPipelineDefinitionOutput, error)

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.

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 FINISHED state. Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/service/datapipeline"
)

func main() {
	svc := datapipeline.New(nil)

	params := &datapipeline.PutPipelineDefinitionInput{
		PipelineId: aws.String("id"), // Required
		PipelineObjects: []*datapipeline.PipelineObject{ // Required
			{ // Required
				Fields: []*datapipeline.Field{ // Required
					{ // Required
						Key:         aws.String("fieldNameString"), // Required
						RefValue:    aws.String("fieldNameString"),
						StringValue: aws.String("fieldStringValue"),
					},
					// More values...
				},
				Id:   aws.String("id"), // Required
				Name: aws.String("id"), // Required
			},
			// More values...
		},
		ParameterObjects: []*datapipeline.ParameterObject{
			{ // Required
				Attributes: []*datapipeline.ParameterAttribute{ // Required
					{ // Required
						Key:         aws.String("attributeNameString"),  // Required
						StringValue: aws.String("attributeValueString"), // Required
					},
					// More values...
				},
				Id: aws.String("fieldNameString"), // Required
			},
			// More values...
		},
		ParameterValues: []*datapipeline.ParameterValue{
			{ // Required
				Id:          aws.String("fieldNameString"),  // Required
				StringValue: aws.String("fieldStringValue"), // Required
			},
			// More values...
		},
	}
	resp, err := svc.PutPipelineDefinition(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*DataPipeline) PutPipelineDefinitionRequest

func (c *DataPipeline) PutPipelineDefinitionRequest(input *PutPipelineDefinitionInput) (req *request.Request, output *PutPipelineDefinitionOutput)

PutPipelineDefinitionRequest generates a request for the PutPipelineDefinition operation.

func (*DataPipeline) QueryObjects

func (c *DataPipeline) QueryObjects(input *QueryObjectsInput) (*QueryObjectsOutput, error)

Queries the specified pipeline for the names of objects that match the specified set of conditions.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/service/datapipeline"
)

func main() {
	svc := datapipeline.New(nil)

	params := &datapipeline.QueryObjectsInput{
		PipelineId: aws.String("id"),     // Required
		Sphere:     aws.String("string"), // Required
		Limit:      aws.Int64(1),
		Marker:     aws.String("string"),
		Query: &datapipeline.Query{
			Selectors: []*datapipeline.Selector{
				{ // Required
					FieldName: aws.String("string"),
					Operator: &datapipeline.Operator{
						Type: aws.String("OperatorType"),
						Values: []*string{
							aws.String("string"), // Required
							// More values...
						},
					},
				},
				// More values...
			},
		},
	}
	resp, err := svc.QueryObjects(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*DataPipeline) QueryObjectsPages

func (c *DataPipeline) QueryObjectsPages(input *QueryObjectsInput, fn func(p *QueryObjectsOutput, lastPage bool) (shouldContinue bool)) error

func (*DataPipeline) QueryObjectsRequest

func (c *DataPipeline) QueryObjectsRequest(input *QueryObjectsInput) (req *request.Request, output *QueryObjectsOutput)

QueryObjectsRequest generates a request for the QueryObjects operation.

func (*DataPipeline) RemoveTags

func (c *DataPipeline) RemoveTags(input *RemoveTagsInput) (*RemoveTagsOutput, error)

Removes existing tags from the specified pipeline.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/service/datapipeline"
)

func main() {
	svc := datapipeline.New(nil)

	params := &datapipeline.RemoveTagsInput{
		PipelineId: aws.String("id"), // Required
		TagKeys: []*string{ // Required
			aws.String("string"), // Required
			// More values...
		},
	}
	resp, err := svc.RemoveTags(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*DataPipeline) RemoveTagsRequest

func (c *DataPipeline) RemoveTagsRequest(input *RemoveTagsInput) (req *request.Request, output *RemoveTagsOutput)

RemoveTagsRequest generates a request for the RemoveTags operation.

func (*DataPipeline) ReportTaskProgress

func (c *DataPipeline) ReportTaskProgress(input *ReportTaskProgressInput) (*ReportTaskProgressOutput, error)

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.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/service/datapipeline"
)

func main() {
	svc := datapipeline.New(nil)

	params := &datapipeline.ReportTaskProgressInput{
		TaskId: aws.String("taskId"), // Required
		Fields: []*datapipeline.Field{
			{ // Required
				Key:         aws.String("fieldNameString"), // Required
				RefValue:    aws.String("fieldNameString"),
				StringValue: aws.String("fieldStringValue"),
			},
			// More values...
		},
	}
	resp, err := svc.ReportTaskProgress(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*DataPipeline) ReportTaskProgressRequest

func (c *DataPipeline) ReportTaskProgressRequest(input *ReportTaskProgressInput) (req *request.Request, output *ReportTaskProgressOutput)

ReportTaskProgressRequest generates a request for the ReportTaskProgress operation.

func (*DataPipeline) ReportTaskRunnerHeartbeat

func (c *DataPipeline) ReportTaskRunnerHeartbeat(input *ReportTaskRunnerHeartbeatInput) (*ReportTaskRunnerHeartbeatOutput, error)

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.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/service/datapipeline"
)

func main() {
	svc := datapipeline.New(nil)

	params := &datapipeline.ReportTaskRunnerHeartbeatInput{
		TaskrunnerId: aws.String("id"), // Required
		Hostname:     aws.String("id"),
		WorkerGroup:  aws.String("string"),
	}
	resp, err := svc.ReportTaskRunnerHeartbeat(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*DataPipeline) ReportTaskRunnerHeartbeatRequest

func (c *DataPipeline) ReportTaskRunnerHeartbeatRequest(input *ReportTaskRunnerHeartbeatInput) (req *request.Request, output *ReportTaskRunnerHeartbeatOutput)

ReportTaskRunnerHeartbeatRequest generates a request for the ReportTaskRunnerHeartbeat operation.

func (*DataPipeline) SetStatus

func (c *DataPipeline) SetStatus(input *SetStatusInput) (*SetStatusOutput, error)

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.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/service/datapipeline"
)

func main() {
	svc := datapipeline.New(nil)

	params := &datapipeline.SetStatusInput{
		ObjectIds: []*string{ // Required
			aws.String("id"), // Required
			// More values...
		},
		PipelineId: aws.String("id"),     // Required
		Status:     aws.String("string"), // Required
	}
	resp, err := svc.SetStatus(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*DataPipeline) SetStatusRequest

func (c *DataPipeline) SetStatusRequest(input *SetStatusInput) (req *request.Request, output *SetStatusOutput)

SetStatusRequest generates a request for the SetStatus operation.

func (*DataPipeline) SetTaskStatus

func (c *DataPipeline) SetTaskStatus(input *SetTaskStatusInput) (*SetTaskStatusOutput, error)

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.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/service/datapipeline"
)

func main() {
	svc := datapipeline.New(nil)

	params := &datapipeline.SetTaskStatusInput{
		TaskId:          aws.String("taskId"),     // Required
		TaskStatus:      aws.String("TaskStatus"), // Required
		ErrorId:         aws.String("string"),
		ErrorMessage:    aws.String("errorMessage"),
		ErrorStackTrace: aws.String("string"),
	}
	resp, err := svc.SetTaskStatus(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*DataPipeline) SetTaskStatusRequest

func (c *DataPipeline) SetTaskStatusRequest(input *SetTaskStatusInput) (req *request.Request, output *SetTaskStatusOutput)

SetTaskStatusRequest generates a request for the SetTaskStatus operation.

func (*DataPipeline) ValidatePipelineDefinition

func (c *DataPipeline) ValidatePipelineDefinition(input *ValidatePipelineDefinitionInput) (*ValidatePipelineDefinitionOutput, error)

Validates the specified pipeline definition to ensure that it is well formed and can be run without error.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/service/datapipeline"
)

func main() {
	svc := datapipeline.New(nil)

	params := &datapipeline.ValidatePipelineDefinitionInput{
		PipelineId: aws.String("id"), // Required
		PipelineObjects: []*datapipeline.PipelineObject{ // Required
			{ // Required
				Fields: []*datapipeline.Field{ // Required
					{ // Required
						Key:         aws.String("fieldNameString"), // Required
						RefValue:    aws.String("fieldNameString"),
						StringValue: aws.String("fieldStringValue"),
					},
					// More values...
				},
				Id:   aws.String("id"), // Required
				Name: aws.String("id"), // Required
			},
			// More values...
		},
		ParameterObjects: []*datapipeline.ParameterObject{
			{ // Required
				Attributes: []*datapipeline.ParameterAttribute{ // Required
					{ // Required
						Key:         aws.String("attributeNameString"),  // Required
						StringValue: aws.String("attributeValueString"), // Required
					},
					// More values...
				},
				Id: aws.String("fieldNameString"), // Required
			},
			// More values...
		},
		ParameterValues: []*datapipeline.ParameterValue{
			{ // Required
				Id:          aws.String("fieldNameString"),  // Required
				StringValue: aws.String("fieldStringValue"), // Required
			},
			// More values...
		},
	}
	resp, err := svc.ValidatePipelineDefinition(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*DataPipeline) ValidatePipelineDefinitionRequest

func (c *DataPipeline) ValidatePipelineDefinitionRequest(input *ValidatePipelineDefinitionInput) (req *request.Request, output *ValidatePipelineDefinitionOutput)

ValidatePipelineDefinitionRequest generates a request for the ValidatePipelineDefinition operation.

type DeactivatePipelineInput

type DeactivatePipelineInput struct {
	// Indicates whether to cancel any running objects. The default is true, which
	// sets the state of any running objects to CANCELED. If this value is false,
	// the pipeline is deactivated after all running objects finish.
	CancelActive *bool `locationName:"cancelActive" type:"boolean"`

	// The ID of the pipeline.
	PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for DeactivatePipeline.

func (DeactivatePipelineInput) GoString

func (s DeactivatePipelineInput) GoString() string

GoString returns the string representation

func (DeactivatePipelineInput) String

func (s DeactivatePipelineInput) String() string

String returns the string representation

type DeactivatePipelineOutput

type DeactivatePipelineOutput struct {
	// contains filtered or unexported fields
}

Contains the output of DeactivatePipeline.

func (DeactivatePipelineOutput) GoString

func (s DeactivatePipelineOutput) GoString() string

GoString returns the string representation

func (DeactivatePipelineOutput) String

func (s DeactivatePipelineOutput) String() string

String returns the string representation

type DeletePipelineInput

type DeletePipelineInput struct {
	// The ID of the pipeline.
	PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for DeletePipeline.

func (DeletePipelineInput) GoString

func (s DeletePipelineInput) GoString() string

GoString returns the string representation

func (DeletePipelineInput) String

func (s DeletePipelineInput) String() string

String returns the string representation

type DeletePipelineOutput

type DeletePipelineOutput struct {
	// contains filtered or unexported fields
}

func (DeletePipelineOutput) GoString

func (s DeletePipelineOutput) GoString() string

GoString returns the string representation

func (DeletePipelineOutput) String

func (s DeletePipelineOutput) String() string

String returns the string representation

type DescribeObjectsInput

type DescribeObjectsInput struct {
	// Indicates whether any expressions in the object should be evaluated when
	// the object descriptions are returned.
	EvaluateExpressions *bool `locationName:"evaluateExpressions" type:"boolean"`

	// The starting point for the results to be returned. For the first call, this
	// value should be empty. As long as there are more results, continue to call
	// DescribeObjects with the marker value from the previous call to retrieve
	// the next set of results.
	Marker *string `locationName:"marker" type:"string"`

	// The IDs of the pipeline objects that contain the definitions to be described.
	// You can pass as many as 25 identifiers in a single call to DescribeObjects.
	ObjectIds []*string `locationName:"objectIds" type:"list" required:"true"`

	// The ID of the pipeline that contains the object definitions.
	PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for DescribeObjects.

func (DescribeObjectsInput) GoString

func (s DescribeObjectsInput) GoString() string

GoString returns the string representation

func (DescribeObjectsInput) String

func (s DescribeObjectsInput) String() string

String returns the string representation

type DescribeObjectsOutput

type DescribeObjectsOutput struct {
	// Indicates whether there are more results to return.
	HasMoreResults *bool `locationName:"hasMoreResults" type:"boolean"`

	// The starting point for the next page of results. To view the next page of
	// results, call DescribeObjects again with this marker value. If the value
	// is null, there are no more results.
	Marker *string `locationName:"marker" type:"string"`

	// An array of object definitions.
	PipelineObjects []*PipelineObject `locationName:"pipelineObjects" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains the output of DescribeObjects.

func (DescribeObjectsOutput) GoString

func (s DescribeObjectsOutput) GoString() string

GoString returns the string representation

func (DescribeObjectsOutput) String

func (s DescribeObjectsOutput) String() string

String returns the string representation

type DescribePipelinesInput

type DescribePipelinesInput struct {
	// The IDs of the pipelines to describe. You can pass as many as 25 identifiers
	// in a single call. To obtain pipeline IDs, call ListPipelines.
	PipelineIds []*string `locationName:"pipelineIds" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for DescribePipelines.

func (DescribePipelinesInput) GoString

func (s DescribePipelinesInput) GoString() string

GoString returns the string representation

func (DescribePipelinesInput) String

func (s DescribePipelinesInput) String() string

String returns the string representation

type DescribePipelinesOutput

type DescribePipelinesOutput struct {
	// An array of descriptions for the specified pipelines.
	PipelineDescriptionList []*PipelineDescription `locationName:"pipelineDescriptionList" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains the output of DescribePipelines.

func (DescribePipelinesOutput) GoString

func (s DescribePipelinesOutput) GoString() string

GoString returns the string representation

func (DescribePipelinesOutput) String

func (s DescribePipelinesOutput) String() string

String returns the string representation

type EvaluateExpressionInput

type EvaluateExpressionInput struct {
	// The expression to evaluate.
	Expression *string `locationName:"expression" type:"string" required:"true"`

	// The ID of the object.
	ObjectId *string `locationName:"objectId" type:"string" required:"true"`

	// The ID of the pipeline.
	PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for EvaluateExpression.

func (EvaluateExpressionInput) GoString

func (s EvaluateExpressionInput) GoString() string

GoString returns the string representation

func (EvaluateExpressionInput) String

func (s EvaluateExpressionInput) String() string

String returns the string representation

type EvaluateExpressionOutput

type EvaluateExpressionOutput struct {
	// The evaluated expression.
	EvaluatedExpression *string `locationName:"evaluatedExpression" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the output of EvaluateExpression.

func (EvaluateExpressionOutput) GoString

func (s EvaluateExpressionOutput) GoString() string

GoString returns the string representation

func (EvaluateExpressionOutput) String

func (s EvaluateExpressionOutput) String() string

String returns the string representation

type Field

type Field struct {
	// The field identifier.
	Key *string `locationName:"key" type:"string" required:"true"`

	// The field value, expressed as the identifier of another object.
	RefValue *string `locationName:"refValue" type:"string"`

	// The field value, expressed as a String.
	StringValue *string `locationName:"stringValue" type:"string"`
	// contains filtered or unexported fields
}

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.

func (Field) GoString

func (s Field) GoString() string

GoString returns the string representation

func (Field) String

func (s Field) String() string

String returns the string representation

type GetPipelineDefinitionInput

type GetPipelineDefinitionInput struct {
	// The ID of the pipeline.
	PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`

	// The version of the pipeline definition to retrieve. Set this parameter to
	// latest (default) to use the last definition saved to the pipeline or active
	// to use the last definition that was activated.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

Contains the parameters for GetPipelineDefinition.

func (GetPipelineDefinitionInput) GoString

func (s GetPipelineDefinitionInput) GoString() string

GoString returns the string representation

func (GetPipelineDefinitionInput) String

String returns the string representation

type GetPipelineDefinitionOutput

type GetPipelineDefinitionOutput struct {
	// The parameter objects used in the pipeline definition.
	ParameterObjects []*ParameterObject `locationName:"parameterObjects" type:"list"`

	// The parameter values used in the pipeline definition.
	ParameterValues []*ParameterValue `locationName:"parameterValues" type:"list"`

	// The objects defined in the pipeline.
	PipelineObjects []*PipelineObject `locationName:"pipelineObjects" type:"list"`
	// contains filtered or unexported fields
}

Contains the output of GetPipelineDefinition.

func (GetPipelineDefinitionOutput) GoString

func (s GetPipelineDefinitionOutput) GoString() string

GoString returns the string representation

func (GetPipelineDefinitionOutput) String

String returns the string representation

type InstanceIdentity

type InstanceIdentity struct {
	// A description of an EC2 instance that is generated when the instance is launched
	// and exposed to the instance via the instance metadata service in the form
	// of a JSON representation of an object.
	Document *string `locationName:"document" type:"string"`

	// A signature which can be used to verify the accuracy and authenticity of
	// the information provided in the instance identity document.
	Signature *string `locationName:"signature" type:"string"`
	// contains filtered or unexported fields
}

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 (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html) 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.

func (InstanceIdentity) GoString

func (s InstanceIdentity) GoString() string

GoString returns the string representation

func (InstanceIdentity) String

func (s InstanceIdentity) String() string

String returns the string representation

type ListPipelinesInput

type ListPipelinesInput struct {
	// The starting point for the results to be returned. For the first call, this
	// value should be empty. As long as there are more results, continue to call
	// ListPipelines with the marker value from the previous call to retrieve the
	// next set of results.
	Marker *string `locationName:"marker" type:"string"`
	// contains filtered or unexported fields
}

Contains the parameters for ListPipelines.

func (ListPipelinesInput) GoString

func (s ListPipelinesInput) GoString() string

GoString returns the string representation

func (ListPipelinesInput) String

func (s ListPipelinesInput) String() string

String returns the string representation

type ListPipelinesOutput

type ListPipelinesOutput struct {
	// Indicates whether there are more results that can be obtained by a subsequent
	// call.
	HasMoreResults *bool `locationName:"hasMoreResults" type:"boolean"`

	// The starting point for the next page of results. To view the next page of
	// results, call ListPipelinesOutput again with this marker value. If the value
	// is null, there are no more results.
	Marker *string `locationName:"marker" type:"string"`

	// The pipeline identifiers. If you require additional information about the
	// pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition.
	PipelineIdList []*PipelineIdName `locationName:"pipelineIdList" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains the output of ListPipelines.

func (ListPipelinesOutput) GoString

func (s ListPipelinesOutput) GoString() string

GoString returns the string representation

func (ListPipelinesOutput) String

func (s ListPipelinesOutput) String() string

String returns the string representation

type Operator

type Operator struct {
	// The logical operation to be performed: equal (EQ), equal reference (REF_EQ),
	// less than or equal (LE), greater than or equal (GE), or between (BETWEEN).
	// Equal reference (REF_EQ) can be used only with reference fields. The other
	// comparison types can be used only with String fields. The comparison types
	// you can use apply only to certain object fields, as detailed below.
	//
	//  The comparison operators EQ and REF_EQ act on the following fields:
	//
	//  name @sphere parent @componentParent @instanceParent @status @scheduledStartTime
	// @scheduledEndTime @actualStartTime @actualEndTime   The comparison operators
	// GE, LE, and BETWEEN act on the following fields:
	//
	//  @scheduledStartTime @scheduledEndTime @actualStartTime @actualEndTime
	// Note that fields beginning with the at sign (@) are read-only and set by
	// the web service. When you name fields, you should choose names containing
	// only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline.
	// User-defined fields that you add to a pipeline should prefix their name with
	// the string "my".
	Type *string `locationName:"type" type:"string" enum:"OperatorType"`

	// The value that the actual field value will be compared with.
	Values []*string `locationName:"values" type:"list"`
	// contains filtered or unexported fields
}

Contains a logical operation for comparing the value of a field with a specified value.

func (Operator) GoString

func (s Operator) GoString() string

GoString returns the string representation

func (Operator) String

func (s Operator) String() string

String returns the string representation

type ParameterAttribute

type ParameterAttribute struct {
	// The field identifier.
	Key *string `locationName:"key" type:"string" required:"true"`

	// The field value, expressed as a String.
	StringValue *string `locationName:"stringValue" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The attributes allowed or specified with a parameter object.

func (ParameterAttribute) GoString

func (s ParameterAttribute) GoString() string

GoString returns the string representation

func (ParameterAttribute) String

func (s ParameterAttribute) String() string

String returns the string representation

type ParameterObject

type ParameterObject struct {
	// The attributes of the parameter object.
	Attributes []*ParameterAttribute `locationName:"attributes" type:"list" required:"true"`

	// The ID of the parameter object.
	Id *string `locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains information about a parameter object.

func (ParameterObject) GoString

func (s ParameterObject) GoString() string

GoString returns the string representation

func (ParameterObject) String

func (s ParameterObject) String() string

String returns the string representation

type ParameterValue

type ParameterValue struct {
	// The ID of the parameter value.
	Id *string `locationName:"id" type:"string" required:"true"`

	// The field value, expressed as a String.
	StringValue *string `locationName:"stringValue" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A value or list of parameter values.

func (ParameterValue) GoString

func (s ParameterValue) GoString() string

GoString returns the string representation

func (ParameterValue) String

func (s ParameterValue) String() string

String returns the string representation

type PipelineDescription

type PipelineDescription struct {
	// Description of the pipeline.
	Description *string `locationName:"description" type:"string"`

	// A list of read-only fields that contain metadata about the pipeline: @userId,
	// @accountId, and @pipelineState.
	Fields []*Field `locationName:"fields" type:"list" required:"true"`

	// The name of the pipeline.
	Name *string `locationName:"name" type:"string" required:"true"`

	// The pipeline identifier that was assigned by AWS Data Pipeline. This is a
	// string of the form df-297EG78HU43EEXAMPLE.
	PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`

	// A list of tags to associated with a pipeline. Tags let you control access
	// to pipelines. For more information, see Controlling User Access to Pipelines
	// (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html)
	// in the AWS Data Pipeline Developer Guide.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

Contains pipeline metadata.

func (PipelineDescription) GoString

func (s PipelineDescription) GoString() string

GoString returns the string representation

func (PipelineDescription) String

func (s PipelineDescription) String() string

String returns the string representation

type PipelineIdName

type PipelineIdName struct {
	// The ID of the pipeline that was assigned by AWS Data Pipeline. This is a
	// string of the form df-297EG78HU43EEXAMPLE.
	Id *string `locationName:"id" type:"string"`

	// The name of the pipeline.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

Contains the name and identifier of a pipeline.

func (PipelineIdName) GoString

func (s PipelineIdName) GoString() string

GoString returns the string representation

func (PipelineIdName) String

func (s PipelineIdName) String() string

String returns the string representation

type PipelineObject

type PipelineObject struct {
	// Key-value pairs that define the properties of the object.
	Fields []*Field `locationName:"fields" type:"list" required:"true"`

	// The ID of the object.
	Id *string `locationName:"id" type:"string" required:"true"`

	// The name of the object.
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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.

func (PipelineObject) GoString

func (s PipelineObject) GoString() string

GoString returns the string representation

func (PipelineObject) String

func (s PipelineObject) String() string

String returns the string representation

type PollForTaskInput

type PollForTaskInput struct {
	// The public DNS name of the calling task runner.
	Hostname *string `locationName:"hostname" type:"string"`

	// Identity information for the EC2 instance that is hosting the task runner.
	// You can get this value from the instance using http://169.254.169.254/latest/meta-data/instance-id.
	// For more information, see Instance Metadata (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html)
	// 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.
	InstanceIdentity *InstanceIdentity `locationName:"instanceIdentity" type:"structure"`

	// The type of task the task runner is configured to accept and process. The
	// worker group is set as a field on objects in the pipeline when they are created.
	// You can only specify a single value for workerGroup in the call to PollForTask.
	// There are no wildcard values permitted in workerGroup; the string must be
	// an exact, case-sensitive, match.
	WorkerGroup *string `locationName:"workerGroup" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for PollForTask.

func (PollForTaskInput) GoString

func (s PollForTaskInput) GoString() string

GoString returns the string representation

func (PollForTaskInput) String

func (s PollForTaskInput) String() string

String returns the string representation

type PollForTaskOutput

type PollForTaskOutput struct {
	// The information needed to complete the task that is being assigned to the
	// task runner. One of the fields returned in this object is taskId, which contains
	// an identifier for the task being assigned. The calling task runner uses taskId
	// in subsequent calls to ReportTaskProgress and SetTaskStatus.
	TaskObject *TaskObject `locationName:"taskObject" type:"structure"`
	// contains filtered or unexported fields
}

Contains the output of PollForTask.

func (PollForTaskOutput) GoString

func (s PollForTaskOutput) GoString() string

GoString returns the string representation

func (PollForTaskOutput) String

func (s PollForTaskOutput) String() string

String returns the string representation

type PutPipelineDefinitionInput

type PutPipelineDefinitionInput struct {
	// The parameter objects used with the pipeline.
	ParameterObjects []*ParameterObject `locationName:"parameterObjects" type:"list"`

	// The parameter values used with the pipeline.
	ParameterValues []*ParameterValue `locationName:"parameterValues" type:"list"`

	// The ID of the pipeline.
	PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`

	// The objects that define the pipeline. These objects overwrite the existing
	// pipeline definition.
	PipelineObjects []*PipelineObject `locationName:"pipelineObjects" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for PutPipelineDefinition.

func (PutPipelineDefinitionInput) GoString

func (s PutPipelineDefinitionInput) GoString() string

GoString returns the string representation

func (PutPipelineDefinitionInput) String

String returns the string representation

type PutPipelineDefinitionOutput

type PutPipelineDefinitionOutput struct {
	// Indicates whether there were validation errors, and the pipeline definition
	// is stored but cannot be activated until you correct the pipeline and call
	// PutPipelineDefinition to commit the corrected pipeline.
	Errored *bool `locationName:"errored" type:"boolean" required:"true"`

	// The validation errors that are associated with the objects defined in pipelineObjects.
	ValidationErrors []*ValidationError `locationName:"validationErrors" type:"list"`

	// The validation warnings that are associated with the objects defined in pipelineObjects.
	ValidationWarnings []*ValidationWarning `locationName:"validationWarnings" type:"list"`
	// contains filtered or unexported fields
}

Contains the output of PutPipelineDefinition.

func (PutPipelineDefinitionOutput) GoString

func (s PutPipelineDefinitionOutput) GoString() string

GoString returns the string representation

func (PutPipelineDefinitionOutput) String

String returns the string representation

type Query

type Query struct {
	// List of selectors that define the query. An object must satisfy all of the
	// selectors to match the query.
	Selectors []*Selector `locationName:"selectors" type:"list"`
	// contains filtered or unexported fields
}

Defines the query to run against an object.

func (Query) GoString

func (s Query) GoString() string

GoString returns the string representation

func (Query) String

func (s Query) String() string

String returns the string representation

type QueryObjectsInput

type QueryObjectsInput struct {
	// The maximum number of object names that QueryObjects will return in a single
	// call. The default value is 100.
	Limit *int64 `locationName:"limit" type:"integer"`

	// The starting point for the results to be returned. For the first call, this
	// value should be empty. As long as there are more results, continue to call
	// QueryObjects with the marker value from the previous call to retrieve the
	// next set of results.
	Marker *string `locationName:"marker" type:"string"`

	// The ID of the pipeline.
	PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`

	// The query that defines the objects to be returned. The Query object can contain
	// a maximum of ten selectors. The conditions in the query are limited to top-level
	// String fields in the object. These filters can be applied to components,
	// instances, and attempts.
	Query *Query `locationName:"query" type:"structure"`

	// Indicates whether the query applies to components or instances. The possible
	// values are: COMPONENT, INSTANCE, and ATTEMPT.
	Sphere *string `locationName:"sphere" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for QueryObjects.

func (QueryObjectsInput) GoString

func (s QueryObjectsInput) GoString() string

GoString returns the string representation

func (QueryObjectsInput) String

func (s QueryObjectsInput) String() string

String returns the string representation

type QueryObjectsOutput

type QueryObjectsOutput struct {
	// Indicates whether there are more results that can be obtained by a subsequent
	// call.
	HasMoreResults *bool `locationName:"hasMoreResults" type:"boolean"`

	// The identifiers that match the query selectors.
	Ids []*string `locationName:"ids" type:"list"`

	// The starting point for the next page of results. To view the next page of
	// results, call QueryObjects again with this marker value. If the value is
	// null, there are no more results.
	Marker *string `locationName:"marker" type:"string"`
	// contains filtered or unexported fields
}

Contains the output of QueryObjects.

func (QueryObjectsOutput) GoString

func (s QueryObjectsOutput) GoString() string

GoString returns the string representation

func (QueryObjectsOutput) String

func (s QueryObjectsOutput) String() string

String returns the string representation

type RemoveTagsInput

type RemoveTagsInput struct {
	// The ID of the pipeline.
	PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`

	// The keys of the tags to remove.
	TagKeys []*string `locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for RemoveTags.

func (RemoveTagsInput) GoString

func (s RemoveTagsInput) GoString() string

GoString returns the string representation

func (RemoveTagsInput) String

func (s RemoveTagsInput) String() string

String returns the string representation

type RemoveTagsOutput

type RemoveTagsOutput struct {
	// contains filtered or unexported fields
}

Contains the output of RemoveTags.

func (RemoveTagsOutput) GoString

func (s RemoveTagsOutput) GoString() string

GoString returns the string representation

func (RemoveTagsOutput) String

func (s RemoveTagsOutput) String() string

String returns the string representation

type ReportTaskProgressInput

type ReportTaskProgressInput struct {
	// Key-value pairs that define the properties of the ReportTaskProgressInput
	// object.
	Fields []*Field `locationName:"fields" type:"list"`

	// The ID of the task assigned to the task runner. This value is provided in
	// the response for PollForTask.
	TaskId *string `locationName:"taskId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for ReportTaskProgress.

func (ReportTaskProgressInput) GoString

func (s ReportTaskProgressInput) GoString() string

GoString returns the string representation

func (ReportTaskProgressInput) String

func (s ReportTaskProgressInput) String() string

String returns the string representation

type ReportTaskProgressOutput

type ReportTaskProgressOutput struct {
	// If true, the calling task runner should cancel processing of the task. The
	// task runner does not need to call SetTaskStatus for canceled tasks.
	Canceled *bool `locationName:"canceled" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Contains the output of ReportTaskProgress.

func (ReportTaskProgressOutput) GoString

func (s ReportTaskProgressOutput) GoString() string

GoString returns the string representation

func (ReportTaskProgressOutput) String

func (s ReportTaskProgressOutput) String() string

String returns the string representation

type ReportTaskRunnerHeartbeatInput

type ReportTaskRunnerHeartbeatInput struct {
	// The public DNS name of the task runner.
	Hostname *string `locationName:"hostname" type:"string"`

	// The ID of the task runner. This value should be unique across your AWS account.
	// In the case of AWS Data Pipeline Task Runner launched on a resource managed
	// by AWS Data Pipeline, the web service provides a unique identifier when it
	// launches the application. If you have written a custom task runner, you should
	// assign a unique identifier for the task runner.
	TaskrunnerId *string `locationName:"taskrunnerId" type:"string" required:"true"`

	// The type of task the task runner is configured to accept and process. The
	// worker group is set as a field on objects in the pipeline when they are created.
	// You can only specify a single value for workerGroup. There are no wildcard
	// values permitted in workerGroup; the string must be an exact, case-sensitive,
	// match.
	WorkerGroup *string `locationName:"workerGroup" type:"string"`
	// contains filtered or unexported fields
}

Contains the parameters for ReportTaskRunnerHeartbeat.

func (ReportTaskRunnerHeartbeatInput) GoString

GoString returns the string representation

func (ReportTaskRunnerHeartbeatInput) String

String returns the string representation

type ReportTaskRunnerHeartbeatOutput

type ReportTaskRunnerHeartbeatOutput struct {
	// Indicates whether the calling task runner should terminate.
	Terminate *bool `locationName:"terminate" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Contains the output of ReportTaskRunnerHeartbeat.

func (ReportTaskRunnerHeartbeatOutput) GoString

GoString returns the string representation

func (ReportTaskRunnerHeartbeatOutput) String

String returns the string representation

type Selector

type Selector struct {
	// The name of the field that the operator will be applied to. The field name
	// is the "key" portion of the field definition in the pipeline definition syntax
	// that is used by the AWS Data Pipeline API. If the field is not set on the
	// object, the condition fails.
	FieldName *string `locationName:"fieldName" type:"string"`

	// Contains a logical operation for comparing the value of a field with a specified
	// value.
	Operator *Operator `locationName:"operator" type:"structure"`
	// contains filtered or unexported fields
}

A comparision that is used to determine whether a query should return this object.

func (Selector) GoString

func (s Selector) GoString() string

GoString returns the string representation

func (Selector) String

func (s Selector) String() string

String returns the string representation

type SetStatusInput

type SetStatusInput struct {
	// The IDs of the objects. The corresponding objects can be either physical
	// or components, but not a mix of both types.
	ObjectIds []*string `locationName:"objectIds" type:"list" required:"true"`

	// The ID of the pipeline that contains the objects.
	PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`

	// The status to be set on all the objects specified in objectIds. For components,
	// use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.
	Status *string `locationName:"status" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for SetStatus.

func (SetStatusInput) GoString

func (s SetStatusInput) GoString() string

GoString returns the string representation

func (SetStatusInput) String

func (s SetStatusInput) String() string

String returns the string representation

type SetStatusOutput

type SetStatusOutput struct {
	// contains filtered or unexported fields
}

func (SetStatusOutput) GoString

func (s SetStatusOutput) GoString() string

GoString returns the string representation

func (SetStatusOutput) String

func (s SetStatusOutput) String() string

String returns the string representation

type SetTaskStatusInput

type SetTaskStatusInput struct {
	// If an error occurred during the task, this value specifies the error code.
	// This value is set on the physical attempt object. It is used to display error
	// information to the user. It should not start with string "Service_" which
	// is reserved by the system.
	ErrorId *string `locationName:"errorId" type:"string"`

	// If an error occurred during the task, this value specifies a text description
	// of the error. This value is set on the physical attempt object. It is used
	// to display error information to the user. The web service does not parse
	// this value.
	ErrorMessage *string `locationName:"errorMessage" type:"string"`

	// If an error occurred during the task, this value specifies the stack trace
	// associated with the error. This value is set on the physical attempt object.
	// It is used to display error information to the user. The web service does
	// not parse this value.
	ErrorStackTrace *string `locationName:"errorStackTrace" type:"string"`

	// The ID of the task assigned to the task runner. This value is provided in
	// the response for PollForTask.
	TaskId *string `locationName:"taskId" type:"string" required:"true"`

	// If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully.
	// Preconditions use false.
	TaskStatus *string `locationName:"taskStatus" type:"string" required:"true" enum:"TaskStatus"`
	// contains filtered or unexported fields
}

Contains the parameters for SetTaskStatus.

func (SetTaskStatusInput) GoString

func (s SetTaskStatusInput) GoString() string

GoString returns the string representation

func (SetTaskStatusInput) String

func (s SetTaskStatusInput) String() string

String returns the string representation

type SetTaskStatusOutput

type SetTaskStatusOutput struct {
	// contains filtered or unexported fields
}

Contains the output of SetTaskStatus.

func (SetTaskStatusOutput) GoString

func (s SetTaskStatusOutput) GoString() string

GoString returns the string representation

func (SetTaskStatusOutput) String

func (s SetTaskStatusOutput) String() string

String returns the string representation

type Tag

type Tag struct {
	// The key name of a tag defined by a user. For more information, see Controlling
	// User Access to Pipelines (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html)
	// in the AWS Data Pipeline Developer Guide.
	Key *string `locationName:"key" type:"string" required:"true"`

	// The optional value portion of a tag defined by a user. For more information,
	// see Controlling User Access to Pipelines (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html)
	// in the AWS Data Pipeline Developer Guide.
	Value *string `locationName:"value" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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 (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) in the AWS Data Pipeline Developer Guide.

func (Tag) GoString

func (s Tag) GoString() string

GoString returns the string representation

func (Tag) String

func (s Tag) String() string

String returns the string representation

type TaskObject

type TaskObject struct {
	// The ID of the pipeline task attempt object. AWS Data Pipeline uses this value
	// to track how many times a task is attempted.
	AttemptId *string `locationName:"attemptId" type:"string"`

	// Connection information for the location where the task runner will publish
	// the output of the task.
	Objects map[string]*PipelineObject `locationName:"objects" type:"map"`

	// The ID of the pipeline that provided the task.
	PipelineId *string `locationName:"pipelineId" type:"string"`

	// An internal identifier for the task. This ID is passed to the SetTaskStatus
	// and ReportTaskProgress actions.
	TaskId *string `locationName:"taskId" type:"string"`
	// contains filtered or unexported fields
}

Contains information about a pipeline task that is assigned to a task runner.

func (TaskObject) GoString

func (s TaskObject) GoString() string

GoString returns the string representation

func (TaskObject) String

func (s TaskObject) String() string

String returns the string representation

type ValidatePipelineDefinitionInput

type ValidatePipelineDefinitionInput struct {
	// The parameter objects used with the pipeline.
	ParameterObjects []*ParameterObject `locationName:"parameterObjects" type:"list"`

	// The parameter values used with the pipeline.
	ParameterValues []*ParameterValue `locationName:"parameterValues" type:"list"`

	// The ID of the pipeline.
	PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`

	// The objects that define the pipeline changes to validate against the pipeline.
	PipelineObjects []*PipelineObject `locationName:"pipelineObjects" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for ValidatePipelineDefinition.

func (ValidatePipelineDefinitionInput) GoString

GoString returns the string representation

func (ValidatePipelineDefinitionInput) String

String returns the string representation

type ValidatePipelineDefinitionOutput

type ValidatePipelineDefinitionOutput struct {
	// Indicates whether there were validation errors.
	Errored *bool `locationName:"errored" type:"boolean" required:"true"`

	// Any validation errors that were found.
	ValidationErrors []*ValidationError `locationName:"validationErrors" type:"list"`

	// Any validation warnings that were found.
	ValidationWarnings []*ValidationWarning `locationName:"validationWarnings" type:"list"`
	// contains filtered or unexported fields
}

Contains the output of ValidatePipelineDefinition.

func (ValidatePipelineDefinitionOutput) GoString

GoString returns the string representation

func (ValidatePipelineDefinitionOutput) String

String returns the string representation

type ValidationError

type ValidationError struct {
	// A description of the validation error.
	Errors []*string `locationName:"errors" type:"list"`

	// The identifier of the object that contains the validation error.
	Id *string `locationName:"id" type:"string"`
	// contains filtered or unexported fields
}

Defines a validation error. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.

func (ValidationError) GoString

func (s ValidationError) GoString() string

GoString returns the string representation

func (ValidationError) String

func (s ValidationError) String() string

String returns the string representation

type ValidationWarning

type ValidationWarning struct {
	// The identifier of the object that contains the validation warning.
	Id *string `locationName:"id" type:"string"`

	// A description of the validation warning.
	Warnings []*string `locationName:"warnings" type:"list"`
	// contains filtered or unexported fields
}

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.

func (ValidationWarning) GoString

func (s ValidationWarning) GoString() string

GoString returns the string representation

func (ValidationWarning) String

func (s ValidationWarning) String() string

String returns the string representation

Directories

Path Synopsis
Package datapipelineiface provides an interface for the AWS Data Pipeline.
Package datapipelineiface provides an interface for the AWS Data Pipeline.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL