datapipeline

package
v1.8.37 Latest Latest
Warning

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

 Go to latest Published: Jun 7, 2017 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package datapipeline provides the client and types for making API requests to AWS Data Pipeline.

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.

See https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29 for more information on this service.

See datapipeline package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/datapipeline/

Using the Client

To use the client for AWS Data Pipeline you will first need to create a new instance of it.

When creating a client for an AWS service you'll first need to have a Session already created. The Session provides configuration that can be shared between multiple service clients. Additional configuration can be applied to the Session and service's client when they are constructed. The aws package's Config type contains several fields such as Region for the AWS Region the client should make API requests too. The optional Config value can be provided as the variadic argument for Sessions and client creation.

Once the service's client is created you can use it to make API requests the AWS service. These clients are safe to use concurrently. 

// Create a session to share configuration, and load external configuration.
sess := session.Must(session.NewSession())

// Create the service's client with the session.
svc := datapipeline.New(sess)

See the SDK's documentation for more information on how to use service clients. https://docs.aws.amazon.com/sdk-for-go/api/

See aws package's Config type for more information on configuration options. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Data Pipeline client DataPipeline for more information on creating the service's client. https://docs.aws.amazon.com/sdk-for-go/api/service/datapipeline/#New

Once the client is created you can make an API request to the service. Each API method takes a input parameter, and returns the service response and an error.

The API method will document which error codes the service can be returned by the operation if the service models the API operation's errors. These errors will also be available as const strings prefixed with "ErrCode". 

result, err := svc.ActivatePipeline(params)
if err != nil {
    // Cast err to awserr.Error to handle specific error codes.
    aerr, ok := err.(awserr.Error)
    if ok && aerr.Code() == <error code to check for> {
        // Specific error code handling
    }
    return err
}

fmt.Println("ActivatePipeline result:")
fmt.Println(result)

Using the Client with Context

The service's client also provides methods to make API requests with a Context value. This allows you to control the timeout, and cancellation of pending requests. These methods also take request Option as variadic parameter to apply additional configuration to the API request. 

ctx := context.Background()

result, err := svc.ActivatePipelineWithContext(ctx, params)

See the request package documentation for more information on using Context pattern with the SDK. https://docs.aws.amazon.com/sdk-for-go/api/aws/request/

Index

Constants

View Source 
const (
	// OperatorTypeEq is a OperatorType enum value
	OperatorTypeEq = "EQ"

	// OperatorTypeRefEq is a OperatorType enum value
	OperatorTypeRefEq = "REF_EQ"

	// OperatorTypeLe is a OperatorType enum value
	OperatorTypeLe = "LE"

	// OperatorTypeGe is a OperatorType enum value
	OperatorTypeGe = "GE"

	// OperatorTypeBetween is a OperatorType enum value
	OperatorTypeBetween = "BETWEEN"
)
View Source 
const (
	// TaskStatusFinished is a TaskStatus enum value
	TaskStatusFinished = "FINISHED"

	// TaskStatusFailed is a TaskStatus enum value
	TaskStatusFailed = "FAILED"

	// TaskStatusFalse is a TaskStatus enum value
	TaskStatusFalse = "FALSE"
)
View Source 
const (

	// ErrCodeInternalServiceError for service response error code
	// "InternalServiceError".
	//
	// An internal service error occurred.
	ErrCodeInternalServiceError = "InternalServiceError"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// The request was not valid. Verify that your request was properly formatted,
	// that the signature was generated with the correct credentials, and that you
	// haven't exceeded any of the service limits for your account.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodePipelineDeletedException for service response error code
	// "PipelineDeletedException".
	//
	// The specified pipeline has been deleted.
	ErrCodePipelineDeletedException = "PipelineDeletedException"

	// ErrCodePipelineNotFoundException for service response error code
	// "PipelineNotFoundException".
	//
	// The specified pipeline was not found. Verify that you used the correct user
	// and account identifiers.
	ErrCodePipelineNotFoundException = "PipelineNotFoundException"

	// ErrCodeTaskNotFoundException for service response error code
	// "TaskNotFoundException".
	//
	// The specified task was not found.
	ErrCodeTaskNotFoundException = "TaskNotFoundException"
)
View Source 
const (
	ServiceName = "datapipeline" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName    // Service ID for Regions and Endpoints metadata.
)

Service information constants

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 is a required field
	PipelineId *string `locationName:"pipelineId" min:"1" 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ActivatePipelineInput

func (ActivatePipelineInput) GoString added in v0.6.5 

func (s ActivatePipelineInput) GoString() string

GoString returns the string representation

func (*ActivatePipelineInput) SetParameterValues added in v1.5.0 

func (s *ActivatePipelineInput) SetParameterValues(v []*ParameterValue) *ActivatePipelineInput

SetParameterValues sets the ParameterValues field's value.

func (*ActivatePipelineInput) SetPipelineId added in v1.5.0 

func (s *ActivatePipelineInput) SetPipelineId(v string) *ActivatePipelineInput

SetPipelineId sets the PipelineId field's value.

func (*ActivatePipelineInput) SetStartTimestamp added in v1.5.0 

func (s *ActivatePipelineInput) SetStartTimestamp(v time.Time) *ActivatePipelineInput

SetStartTimestamp sets the StartTimestamp field's value.

func (ActivatePipelineInput) String added in v0.6.5 

func (s ActivatePipelineInput) String() string

String returns the string representation

func (*ActivatePipelineInput) Validate added in v1.1.21 

func (s *ActivatePipelineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ActivatePipelineOutput 

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

Contains the output of ActivatePipeline. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ActivatePipelineOutput

func (ActivatePipelineOutput) GoString added in v0.6.5 

func (s ActivatePipelineOutput) GoString() string

GoString returns the string representation

func (ActivatePipelineOutput) String added in v0.6.5 

func (s ActivatePipelineOutput) String() string

String returns the string representation

type AddTagsInput 

type AddTagsInput struct {

	// The ID of the pipeline.
	//
	// PipelineId is a required field
	PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`

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

Contains the parameters for AddTags. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/AddTagsInput

func (AddTagsInput) GoString added in v0.6.5 

func (s AddTagsInput) GoString() string

GoString returns the string representation

func (*AddTagsInput) SetPipelineId added in v1.5.0 

func (s *AddTagsInput) SetPipelineId(v string) *AddTagsInput

SetPipelineId sets the PipelineId field's value.

func (*AddTagsInput) SetTags added in v1.5.0 

func (s *AddTagsInput) SetTags(v []*Tag) *AddTagsInput

SetTags sets the Tags field's value.

func (AddTagsInput) String added in v0.6.5 

func (s AddTagsInput) String() string

String returns the string representation

func (*AddTagsInput) Validate added in v1.1.21 

func (s *AddTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AddTagsOutput 

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

Contains the output of AddTags. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/AddTagsOutput

func (AddTagsOutput) GoString added in v0.6.5 

func (s AddTagsOutput) GoString() string

GoString returns the string representation

func (AddTagsOutput) String added in v0.6.5 

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 is a required field
	Name *string `locationName:"name" min:"1" 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 is a required field
	UniqueId *string `locationName:"uniqueId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for CreatePipeline. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/CreatePipelineInput

func (CreatePipelineInput) GoString added in v0.6.5 

func (s CreatePipelineInput) GoString() string

GoString returns the string representation

func (*CreatePipelineInput) SetDescription added in v1.5.0 

func (s *CreatePipelineInput) SetDescription(v string) *CreatePipelineInput

SetDescription sets the Description field's value.

func (*CreatePipelineInput) SetName added in v1.5.0 

func (s *CreatePipelineInput) SetName(v string) *CreatePipelineInput

SetName sets the Name field's value.

func (*CreatePipelineInput) SetTags added in v1.5.0 

func (s *CreatePipelineInput) SetTags(v []*Tag) *CreatePipelineInput

SetTags sets the Tags field's value.

func (*CreatePipelineInput) SetUniqueId added in v1.5.0 

func (s *CreatePipelineInput) SetUniqueId(v string) *CreatePipelineInput

SetUniqueId sets the UniqueId field's value.

func (CreatePipelineInput) String added in v0.6.5 

func (s CreatePipelineInput) String() string

String returns the string representation

func (*CreatePipelineInput) Validate added in v1.1.21 

func (s *CreatePipelineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreatePipelineOutput 

type CreatePipelineOutput struct {

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

Contains the output of CreatePipeline. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/CreatePipelineOutput

func (CreatePipelineOutput) GoString added in v0.6.5 

func (s CreatePipelineOutput) GoString() string

GoString returns the string representation

func (*CreatePipelineOutput) SetPipelineId added in v1.5.0 

func (s *CreatePipelineOutput) SetPipelineId(v string) *CreatePipelineOutput

SetPipelineId sets the PipelineId field's value.

func (CreatePipelineOutput) String added in v0.6.5 

func (s CreatePipelineOutput) String() string

String returns the string representation

type DataPipeline 

type DataPipeline struct {
	*client.Client
}

DataPipeline provides the API operation methods for making requests to AWS Data Pipeline. See this package's package overview docs for details on the service.

DataPipeline methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *DataPipeline

New creates a new instance of the DataPipeline client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a DataPipeline client from just a session.
svc := datapipeline.New(mySession)

// Create a DataPipeline client with additional configuration
svc := datapipeline.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*DataPipeline) ActivatePipeline 

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

ActivatePipeline API operation for AWS Data Pipeline.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Data Pipeline's API operation ActivatePipeline for usage and error information.

Returned Error Codes:

  • ErrCodePipelineNotFoundException "PipelineNotFoundException" The specified pipeline was not found. Verify that you used the correct user and account identifiers.

  • ErrCodePipelineDeletedException "PipelineDeletedException" The specified pipeline has been deleted.

  • ErrCodeInternalServiceError "InternalServiceError" An internal service error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ActivatePipeline

func (*DataPipeline) ActivatePipelineRequest 

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

ActivatePipelineRequest generates a "aws/request.Request" representing the client's request for the ActivatePipeline operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ActivatePipeline for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ActivatePipeline method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the ActivatePipelineRequest method.
req, resp := client.ActivatePipelineRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ActivatePipeline

func (*DataPipeline) ActivatePipelineWithContext added in v1.8.0 

func (c *DataPipeline) ActivatePipelineWithContext(ctx aws.Context, input *ActivatePipelineInput, opts ...request.Option) (*ActivatePipelineOutput, error)

ActivatePipelineWithContext is the same as ActivatePipeline with the addition of the ability to pass a context and additional request options.

See ActivatePipeline for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) AddTags 

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

AddTags API operation for AWS Data Pipeline.

Adds or modifies tags for the specified pipeline.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Data Pipeline's API operation AddTags for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceError "InternalServiceError" An internal service error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

  • ErrCodePipelineNotFoundException "PipelineNotFoundException" The specified pipeline was not found. Verify that you used the correct user and account identifiers.

  • ErrCodePipelineDeletedException "PipelineDeletedException" The specified pipeline has been deleted.

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/AddTags

func (*DataPipeline) AddTagsRequest 

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

AddTagsRequest generates a "aws/request.Request" representing the client's request for the AddTags operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See AddTags for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AddTags method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the AddTagsRequest method.
req, resp := client.AddTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/AddTags

func (*DataPipeline) AddTagsWithContext added in v1.8.0 

func (c *DataPipeline) AddTagsWithContext(ctx aws.Context, input *AddTagsInput, opts ...request.Option) (*AddTagsOutput, error)

AddTagsWithContext is the same as AddTags with the addition of the ability to pass a context and additional request options.

See AddTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) CreatePipeline 

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

CreatePipeline API operation for AWS Data Pipeline.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Data Pipeline's API operation CreatePipeline for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceError "InternalServiceError" An internal service error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/CreatePipeline

func (*DataPipeline) CreatePipelineRequest 

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

CreatePipelineRequest generates a "aws/request.Request" representing the client's request for the CreatePipeline operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreatePipeline for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreatePipeline method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the CreatePipelineRequest method.
req, resp := client.CreatePipelineRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/CreatePipeline

func (*DataPipeline) CreatePipelineWithContext added in v1.8.0 

func (c *DataPipeline) CreatePipelineWithContext(ctx aws.Context, input *CreatePipelineInput, opts ...request.Option) (*CreatePipelineOutput, error)

CreatePipelineWithContext is the same as CreatePipeline with the addition of the ability to pass a context and additional request options.

See CreatePipeline for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) DeactivatePipeline 

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

DeactivatePipeline API operation for AWS Data Pipeline.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Data Pipeline's API operation DeactivatePipeline for usage and error information.

Returned Error Codes:

  • ErrCodePipelineNotFoundException "PipelineNotFoundException" The specified pipeline was not found. Verify that you used the correct user and account identifiers.

  • ErrCodePipelineDeletedException "PipelineDeletedException" The specified pipeline has been deleted.

  • ErrCodeInternalServiceError "InternalServiceError" An internal service error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DeactivatePipeline

func (*DataPipeline) DeactivatePipelineRequest 

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

DeactivatePipelineRequest generates a "aws/request.Request" representing the client's request for the DeactivatePipeline operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeactivatePipeline for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeactivatePipeline method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DeactivatePipelineRequest method.
req, resp := client.DeactivatePipelineRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DeactivatePipeline

func (*DataPipeline) DeactivatePipelineWithContext added in v1.8.0 

func (c *DataPipeline) DeactivatePipelineWithContext(ctx aws.Context, input *DeactivatePipelineInput, opts ...request.Option) (*DeactivatePipelineOutput, error)

DeactivatePipelineWithContext is the same as DeactivatePipeline with the addition of the ability to pass a context and additional request options.

See DeactivatePipeline for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) DeletePipeline 

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

DeletePipeline API operation for AWS Data Pipeline.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Data Pipeline's API operation DeletePipeline for usage and error information.

Returned Error Codes:

  • ErrCodePipelineNotFoundException "PipelineNotFoundException" The specified pipeline was not found. Verify that you used the correct user and account identifiers.

  • ErrCodeInternalServiceError "InternalServiceError" An internal service error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DeletePipeline

func (*DataPipeline) DeletePipelineRequest 

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

DeletePipelineRequest generates a "aws/request.Request" representing the client's request for the DeletePipeline operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeletePipeline for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeletePipeline method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DeletePipelineRequest method.
req, resp := client.DeletePipelineRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DeletePipeline

func (*DataPipeline) DeletePipelineWithContext added in v1.8.0 

func (c *DataPipeline) DeletePipelineWithContext(ctx aws.Context, input *DeletePipelineInput, opts ...request.Option) (*DeletePipelineOutput, error)

DeletePipelineWithContext is the same as DeletePipeline with the addition of the ability to pass a context and additional request options.

See DeletePipeline for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) DescribeObjects 

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

DescribeObjects API operation for AWS Data Pipeline.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Data Pipeline's API operation DescribeObjects for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceError "InternalServiceError" An internal service error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

  • ErrCodePipelineNotFoundException "PipelineNotFoundException" The specified pipeline was not found. Verify that you used the correct user and account identifiers.

  • ErrCodePipelineDeletedException "PipelineDeletedException" The specified pipeline has been deleted.

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DescribeObjects

func (*DataPipeline) DescribeObjectsPages 

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

DescribeObjectsPages iterates over the pages of a DescribeObjects operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeObjects method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeObjects operation.
pageNum := 0
err := client.DescribeObjectsPages(params,
    func(page *DescribeObjectsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DataPipeline) DescribeObjectsPagesWithContext added in v1.8.0 

func (c *DataPipeline) DescribeObjectsPagesWithContext(ctx aws.Context, input *DescribeObjectsInput, fn func(*DescribeObjectsOutput, bool) bool, opts ...request.Option) error

DescribeObjectsPagesWithContext same as DescribeObjectsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) DescribeObjectsRequest 

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

DescribeObjectsRequest generates a "aws/request.Request" representing the client's request for the DescribeObjects operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeObjects for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeObjects method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DescribeObjectsRequest method.
req, resp := client.DescribeObjectsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DescribeObjects

func (*DataPipeline) DescribeObjectsWithContext added in v1.8.0 

func (c *DataPipeline) DescribeObjectsWithContext(ctx aws.Context, input *DescribeObjectsInput, opts ...request.Option) (*DescribeObjectsOutput, error)

DescribeObjectsWithContext is the same as DescribeObjects with the addition of the ability to pass a context and additional request options.

See DescribeObjects for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) DescribePipelines 

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

DescribePipelines API operation for AWS Data Pipeline.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Data Pipeline's API operation DescribePipelines for usage and error information.

Returned Error Codes:

  • ErrCodePipelineNotFoundException "PipelineNotFoundException" The specified pipeline was not found. Verify that you used the correct user and account identifiers.

  • ErrCodePipelineDeletedException "PipelineDeletedException" The specified pipeline has been deleted.

  • ErrCodeInternalServiceError "InternalServiceError" An internal service error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DescribePipelines

func (*DataPipeline) DescribePipelinesRequest 

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

DescribePipelinesRequest generates a "aws/request.Request" representing the client's request for the DescribePipelines operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribePipelines for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribePipelines method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DescribePipelinesRequest method.
req, resp := client.DescribePipelinesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DescribePipelines

func (*DataPipeline) DescribePipelinesWithContext added in v1.8.0 

func (c *DataPipeline) DescribePipelinesWithContext(ctx aws.Context, input *DescribePipelinesInput, opts ...request.Option) (*DescribePipelinesOutput, error)

DescribePipelinesWithContext is the same as DescribePipelines with the addition of the ability to pass a context and additional request options.

See DescribePipelines for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) EvaluateExpression 

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

EvaluateExpression API operation for AWS Data Pipeline.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Data Pipeline's API operation EvaluateExpression for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceError "InternalServiceError" An internal service error occurred.

  • ErrCodeTaskNotFoundException "TaskNotFoundException" The specified task was not found.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

  • ErrCodePipelineNotFoundException "PipelineNotFoundException" The specified pipeline was not found. Verify that you used the correct user and account identifiers.

  • ErrCodePipelineDeletedException "PipelineDeletedException" The specified pipeline has been deleted.

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/EvaluateExpression

func (*DataPipeline) EvaluateExpressionRequest 

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

EvaluateExpressionRequest generates a "aws/request.Request" representing the client's request for the EvaluateExpression operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See EvaluateExpression for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the EvaluateExpression method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the EvaluateExpressionRequest method.
req, resp := client.EvaluateExpressionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/EvaluateExpression

func (*DataPipeline) EvaluateExpressionWithContext added in v1.8.0 

func (c *DataPipeline) EvaluateExpressionWithContext(ctx aws.Context, input *EvaluateExpressionInput, opts ...request.Option) (*EvaluateExpressionOutput, error)

EvaluateExpressionWithContext is the same as EvaluateExpression with the addition of the ability to pass a context and additional request options.

See EvaluateExpression for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) GetPipelineDefinition 

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

GetPipelineDefinition API operation for AWS Data Pipeline.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Data Pipeline's API operation GetPipelineDefinition for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceError "InternalServiceError" An internal service error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

  • ErrCodePipelineNotFoundException "PipelineNotFoundException" The specified pipeline was not found. Verify that you used the correct user and account identifiers.

  • ErrCodePipelineDeletedException "PipelineDeletedException" The specified pipeline has been deleted.

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/GetPipelineDefinition

func (*DataPipeline) GetPipelineDefinitionRequest 

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

GetPipelineDefinitionRequest generates a "aws/request.Request" representing the client's request for the GetPipelineDefinition operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetPipelineDefinition for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetPipelineDefinition method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the GetPipelineDefinitionRequest method.
req, resp := client.GetPipelineDefinitionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/GetPipelineDefinition

func (*DataPipeline) GetPipelineDefinitionWithContext added in v1.8.0 

func (c *DataPipeline) GetPipelineDefinitionWithContext(ctx aws.Context, input *GetPipelineDefinitionInput, opts ...request.Option) (*GetPipelineDefinitionOutput, error)

GetPipelineDefinitionWithContext is the same as GetPipelineDefinition with the addition of the ability to pass a context and additional request options.

See GetPipelineDefinition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) ListPipelines 

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

ListPipelines API operation for AWS Data Pipeline.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Data Pipeline's API operation ListPipelines for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceError "InternalServiceError" An internal service error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ListPipelines

func (*DataPipeline) ListPipelinesPages 

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

ListPipelinesPages iterates over the pages of a ListPipelines operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPipelines method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListPipelines operation.
pageNum := 0
err := client.ListPipelinesPages(params,
    func(page *ListPipelinesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DataPipeline) ListPipelinesPagesWithContext added in v1.8.0 

func (c *DataPipeline) ListPipelinesPagesWithContext(ctx aws.Context, input *ListPipelinesInput, fn func(*ListPipelinesOutput, bool) bool, opts ...request.Option) error

ListPipelinesPagesWithContext same as ListPipelinesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) ListPipelinesRequest 

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

ListPipelinesRequest generates a "aws/request.Request" representing the client's request for the ListPipelines operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListPipelines for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListPipelines method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the ListPipelinesRequest method.
req, resp := client.ListPipelinesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ListPipelines

func (*DataPipeline) ListPipelinesWithContext added in v1.8.0 

func (c *DataPipeline) ListPipelinesWithContext(ctx aws.Context, input *ListPipelinesInput, opts ...request.Option) (*ListPipelinesOutput, error)

ListPipelinesWithContext is the same as ListPipelines with the addition of the ability to pass a context and additional request options.

See ListPipelines for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) PollForTask 

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

PollForTask API operation for AWS Data Pipeline.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Data Pipeline's API operation PollForTask for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceError "InternalServiceError" An internal service error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

  • ErrCodeTaskNotFoundException "TaskNotFoundException" The specified task was not found.

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/PollForTask

func (*DataPipeline) PollForTaskRequest 

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

PollForTaskRequest generates a "aws/request.Request" representing the client's request for the PollForTask operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See PollForTask for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PollForTask method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the PollForTaskRequest method.
req, resp := client.PollForTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/PollForTask

func (*DataPipeline) PollForTaskWithContext added in v1.8.0 

func (c *DataPipeline) PollForTaskWithContext(ctx aws.Context, input *PollForTaskInput, opts ...request.Option) (*PollForTaskOutput, error)

PollForTaskWithContext is the same as PollForTask with the addition of the ability to pass a context and additional request options.

See PollForTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) PutPipelineDefinition 

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

PutPipelineDefinition API operation for AWS Data Pipeline.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Data Pipeline's API operation PutPipelineDefinition for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceError "InternalServiceError" An internal service error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

  • ErrCodePipelineNotFoundException "PipelineNotFoundException" The specified pipeline was not found. Verify that you used the correct user and account identifiers.

  • ErrCodePipelineDeletedException "PipelineDeletedException" The specified pipeline has been deleted.

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/PutPipelineDefinition

func (*DataPipeline) PutPipelineDefinitionRequest 

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

PutPipelineDefinitionRequest generates a "aws/request.Request" representing the client's request for the PutPipelineDefinition operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See PutPipelineDefinition for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutPipelineDefinition method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the PutPipelineDefinitionRequest method.
req, resp := client.PutPipelineDefinitionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/PutPipelineDefinition

func (*DataPipeline) PutPipelineDefinitionWithContext added in v1.8.0 

func (c *DataPipeline) PutPipelineDefinitionWithContext(ctx aws.Context, input *PutPipelineDefinitionInput, opts ...request.Option) (*PutPipelineDefinitionOutput, error)

PutPipelineDefinitionWithContext is the same as PutPipelineDefinition with the addition of the ability to pass a context and additional request options.

See PutPipelineDefinition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) QueryObjects 

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

QueryObjects API operation for AWS Data Pipeline.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Data Pipeline's API operation QueryObjects for usage and error information.

Returned Error Codes:

  • ErrCodePipelineNotFoundException "PipelineNotFoundException" The specified pipeline was not found. Verify that you used the correct user and account identifiers.

  • ErrCodePipelineDeletedException "PipelineDeletedException" The specified pipeline has been deleted.

  • ErrCodeInternalServiceError "InternalServiceError" An internal service error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/QueryObjects

func (*DataPipeline) QueryObjectsPages 

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

QueryObjectsPages iterates over the pages of a QueryObjects operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See QueryObjects method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a QueryObjects operation.
pageNum := 0
err := client.QueryObjectsPages(params,
    func(page *QueryObjectsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DataPipeline) QueryObjectsPagesWithContext added in v1.8.0 

func (c *DataPipeline) QueryObjectsPagesWithContext(ctx aws.Context, input *QueryObjectsInput, fn func(*QueryObjectsOutput, bool) bool, opts ...request.Option) error

QueryObjectsPagesWithContext same as QueryObjectsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) QueryObjectsRequest 

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

QueryObjectsRequest generates a "aws/request.Request" representing the client's request for the QueryObjects operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See QueryObjects for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the QueryObjects method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the QueryObjectsRequest method.
req, resp := client.QueryObjectsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/QueryObjects

func (*DataPipeline) QueryObjectsWithContext added in v1.8.0 

func (c *DataPipeline) QueryObjectsWithContext(ctx aws.Context, input *QueryObjectsInput, opts ...request.Option) (*QueryObjectsOutput, error)

QueryObjectsWithContext is the same as QueryObjects with the addition of the ability to pass a context and additional request options.

See QueryObjects for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) RemoveTags 

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

RemoveTags API operation for AWS Data Pipeline.

Removes existing tags from the specified pipeline.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Data Pipeline's API operation RemoveTags for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceError "InternalServiceError" An internal service error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

  • ErrCodePipelineNotFoundException "PipelineNotFoundException" The specified pipeline was not found. Verify that you used the correct user and account identifiers.

  • ErrCodePipelineDeletedException "PipelineDeletedException" The specified pipeline has been deleted.

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/RemoveTags

func (*DataPipeline) RemoveTagsRequest 

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

RemoveTagsRequest generates a "aws/request.Request" representing the client's request for the RemoveTags operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See RemoveTags for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RemoveTags method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the RemoveTagsRequest method.
req, resp := client.RemoveTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/RemoveTags

func (*DataPipeline) RemoveTagsWithContext added in v1.8.0 

func (c *DataPipeline) RemoveTagsWithContext(ctx aws.Context, input *RemoveTagsInput, opts ...request.Option) (*RemoveTagsOutput, error)

RemoveTagsWithContext is the same as RemoveTags with the addition of the ability to pass a context and additional request options.

See RemoveTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) ReportTaskProgress 

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

ReportTaskProgress API operation for AWS Data Pipeline.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Data Pipeline's API operation ReportTaskProgress for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceError "InternalServiceError" An internal service error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

  • ErrCodeTaskNotFoundException "TaskNotFoundException" The specified task was not found.

  • ErrCodePipelineNotFoundException "PipelineNotFoundException" The specified pipeline was not found. Verify that you used the correct user and account identifiers.

  • ErrCodePipelineDeletedException "PipelineDeletedException" The specified pipeline has been deleted.

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ReportTaskProgress

func (*DataPipeline) ReportTaskProgressRequest 

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

ReportTaskProgressRequest generates a "aws/request.Request" representing the client's request for the ReportTaskProgress operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ReportTaskProgress for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ReportTaskProgress method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the ReportTaskProgressRequest method.
req, resp := client.ReportTaskProgressRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ReportTaskProgress

func (*DataPipeline) ReportTaskProgressWithContext added in v1.8.0 

func (c *DataPipeline) ReportTaskProgressWithContext(ctx aws.Context, input *ReportTaskProgressInput, opts ...request.Option) (*ReportTaskProgressOutput, error)

ReportTaskProgressWithContext is the same as ReportTaskProgress with the addition of the ability to pass a context and additional request options.

See ReportTaskProgress for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) ReportTaskRunnerHeartbeat 

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

ReportTaskRunnerHeartbeat API operation for AWS Data Pipeline.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Data Pipeline's API operation ReportTaskRunnerHeartbeat for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceError "InternalServiceError" An internal service error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ReportTaskRunnerHeartbeat

func (*DataPipeline) ReportTaskRunnerHeartbeatRequest 

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

ReportTaskRunnerHeartbeatRequest generates a "aws/request.Request" representing the client's request for the ReportTaskRunnerHeartbeat operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ReportTaskRunnerHeartbeat for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ReportTaskRunnerHeartbeat method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the ReportTaskRunnerHeartbeatRequest method.
req, resp := client.ReportTaskRunnerHeartbeatRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ReportTaskRunnerHeartbeat

func (*DataPipeline) ReportTaskRunnerHeartbeatWithContext added in v1.8.0 

func (c *DataPipeline) ReportTaskRunnerHeartbeatWithContext(ctx aws.Context, input *ReportTaskRunnerHeartbeatInput, opts ...request.Option) (*ReportTaskRunnerHeartbeatOutput, error)

ReportTaskRunnerHeartbeatWithContext is the same as ReportTaskRunnerHeartbeat with the addition of the ability to pass a context and additional request options.

See ReportTaskRunnerHeartbeat for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) SetStatus 

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

SetStatus API operation for AWS Data Pipeline.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Data Pipeline's API operation SetStatus for usage and error information.

Returned Error Codes:

  • ErrCodePipelineNotFoundException "PipelineNotFoundException" The specified pipeline was not found. Verify that you used the correct user and account identifiers.

  • ErrCodePipelineDeletedException "PipelineDeletedException" The specified pipeline has been deleted.

  • ErrCodeInternalServiceError "InternalServiceError" An internal service error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/SetStatus

func (*DataPipeline) SetStatusRequest 

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

SetStatusRequest generates a "aws/request.Request" representing the client's request for the SetStatus operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See SetStatus for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SetStatus method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the SetStatusRequest method.
req, resp := client.SetStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/SetStatus

func (*DataPipeline) SetStatusWithContext added in v1.8.0 

func (c *DataPipeline) SetStatusWithContext(ctx aws.Context, input *SetStatusInput, opts ...request.Option) (*SetStatusOutput, error)

SetStatusWithContext is the same as SetStatus with the addition of the ability to pass a context and additional request options.

See SetStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) SetTaskStatus 

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

SetTaskStatus API operation for AWS Data Pipeline.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Data Pipeline's API operation SetTaskStatus for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceError "InternalServiceError" An internal service error occurred.

  • ErrCodeTaskNotFoundException "TaskNotFoundException" The specified task was not found.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

  • ErrCodePipelineNotFoundException "PipelineNotFoundException" The specified pipeline was not found. Verify that you used the correct user and account identifiers.

  • ErrCodePipelineDeletedException "PipelineDeletedException" The specified pipeline has been deleted.

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/SetTaskStatus

func (*DataPipeline) SetTaskStatusRequest 

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

SetTaskStatusRequest generates a "aws/request.Request" representing the client's request for the SetTaskStatus operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See SetTaskStatus for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SetTaskStatus method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the SetTaskStatusRequest method.
req, resp := client.SetTaskStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/SetTaskStatus

func (*DataPipeline) SetTaskStatusWithContext added in v1.8.0 

func (c *DataPipeline) SetTaskStatusWithContext(ctx aws.Context, input *SetTaskStatusInput, opts ...request.Option) (*SetTaskStatusOutput, error)

SetTaskStatusWithContext is the same as SetTaskStatus with the addition of the ability to pass a context and additional request options.

See SetTaskStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DataPipeline) ValidatePipelineDefinition 

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

ValidatePipelineDefinition API operation for AWS Data Pipeline.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Data Pipeline's API operation ValidatePipelineDefinition for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceError "InternalServiceError" An internal service error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

  • ErrCodePipelineNotFoundException "PipelineNotFoundException" The specified pipeline was not found. Verify that you used the correct user and account identifiers.

  • ErrCodePipelineDeletedException "PipelineDeletedException" The specified pipeline has been deleted.

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ValidatePipelineDefinition

func (*DataPipeline) ValidatePipelineDefinitionRequest 

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

ValidatePipelineDefinitionRequest generates a "aws/request.Request" representing the client's request for the ValidatePipelineDefinition operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ValidatePipelineDefinition for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ValidatePipelineDefinition method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the ValidatePipelineDefinitionRequest method.
req, resp := client.ValidatePipelineDefinitionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ValidatePipelineDefinition

func (*DataPipeline) ValidatePipelineDefinitionWithContext added in v1.8.0 

func (c *DataPipeline) ValidatePipelineDefinitionWithContext(ctx aws.Context, input *ValidatePipelineDefinitionInput, opts ...request.Option) (*ValidatePipelineDefinitionOutput, error)

ValidatePipelineDefinitionWithContext is the same as ValidatePipelineDefinition with the addition of the ability to pass a context and additional request options.

See ValidatePipelineDefinition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 is a required field
	PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for DeactivatePipeline. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DeactivatePipelineInput

func (DeactivatePipelineInput) GoString added in v0.6.5 

func (s DeactivatePipelineInput) GoString() string

GoString returns the string representation

func (*DeactivatePipelineInput) SetCancelActive added in v1.5.0 

func (s *DeactivatePipelineInput) SetCancelActive(v bool) *DeactivatePipelineInput

SetCancelActive sets the CancelActive field's value.

func (*DeactivatePipelineInput) SetPipelineId added in v1.5.0 

func (s *DeactivatePipelineInput) SetPipelineId(v string) *DeactivatePipelineInput

SetPipelineId sets the PipelineId field's value.

func (DeactivatePipelineInput) String added in v0.6.5 

func (s DeactivatePipelineInput) String() string

String returns the string representation

func (*DeactivatePipelineInput) Validate added in v1.1.21 

func (s *DeactivatePipelineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeactivatePipelineOutput 

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

Contains the output of DeactivatePipeline. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DeactivatePipelineOutput

func (DeactivatePipelineOutput) GoString added in v0.6.5 

func (s DeactivatePipelineOutput) GoString() string

GoString returns the string representation

func (DeactivatePipelineOutput) String added in v0.6.5 

func (s DeactivatePipelineOutput) String() string

String returns the string representation

type DeletePipelineInput 

type DeletePipelineInput struct {

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

Contains the parameters for DeletePipeline. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DeletePipelineInput

func (DeletePipelineInput) GoString added in v0.6.5 

func (s DeletePipelineInput) GoString() string

GoString returns the string representation

func (*DeletePipelineInput) SetPipelineId added in v1.5.0 

func (s *DeletePipelineInput) SetPipelineId(v string) *DeletePipelineInput

SetPipelineId sets the PipelineId field's value.

func (DeletePipelineInput) String added in v0.6.5 

func (s DeletePipelineInput) String() string

String returns the string representation

func (*DeletePipelineInput) Validate added in v1.1.21 

func (s *DeletePipelineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeletePipelineOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DeletePipelineOutput

func (DeletePipelineOutput) GoString added in v0.6.5 

func (s DeletePipelineOutput) GoString() string

GoString returns the string representation

func (DeletePipelineOutput) String added in v0.6.5 

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 is a required field
	ObjectIds []*string `locationName:"objectIds" type:"list" required:"true"`

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

Contains the parameters for DescribeObjects. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DescribeObjectsInput

func (DescribeObjectsInput) GoString added in v0.6.5 

func (s DescribeObjectsInput) GoString() string

GoString returns the string representation

func (*DescribeObjectsInput) SetEvaluateExpressions added in v1.5.0 

func (s *DescribeObjectsInput) SetEvaluateExpressions(v bool) *DescribeObjectsInput

SetEvaluateExpressions sets the EvaluateExpressions field's value.

func (*DescribeObjectsInput) SetMarker added in v1.5.0 

func (s *DescribeObjectsInput) SetMarker(v string) *DescribeObjectsInput

SetMarker sets the Marker field's value.

func (*DescribeObjectsInput) SetObjectIds added in v1.5.0 

func (s *DescribeObjectsInput) SetObjectIds(v []*string) *DescribeObjectsInput

SetObjectIds sets the ObjectIds field's value.

func (*DescribeObjectsInput) SetPipelineId added in v1.5.0 

func (s *DescribeObjectsInput) SetPipelineId(v string) *DescribeObjectsInput

SetPipelineId sets the PipelineId field's value.

func (DescribeObjectsInput) String added in v0.6.5 

func (s DescribeObjectsInput) String() string

String returns the string representation

func (*DescribeObjectsInput) Validate added in v1.1.21 

func (s *DescribeObjectsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 is a required field
	PipelineObjects []*PipelineObject `locationName:"pipelineObjects" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains the output of DescribeObjects. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DescribeObjectsOutput

func (DescribeObjectsOutput) GoString added in v0.6.5 

func (s DescribeObjectsOutput) GoString() string

GoString returns the string representation

func (*DescribeObjectsOutput) SetHasMoreResults added in v1.5.0 

func (s *DescribeObjectsOutput) SetHasMoreResults(v bool) *DescribeObjectsOutput

SetHasMoreResults sets the HasMoreResults field's value.

func (*DescribeObjectsOutput) SetMarker added in v1.5.0 

func (s *DescribeObjectsOutput) SetMarker(v string) *DescribeObjectsOutput

SetMarker sets the Marker field's value.

func (*DescribeObjectsOutput) SetPipelineObjects added in v1.5.0 

func (s *DescribeObjectsOutput) SetPipelineObjects(v []*PipelineObject) *DescribeObjectsOutput

SetPipelineObjects sets the PipelineObjects field's value.

func (DescribeObjectsOutput) String added in v0.6.5 

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 is a required field
	PipelineIds []*string `locationName:"pipelineIds" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for DescribePipelines. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DescribePipelinesInput

func (DescribePipelinesInput) GoString added in v0.6.5 

func (s DescribePipelinesInput) GoString() string

GoString returns the string representation

func (*DescribePipelinesInput) SetPipelineIds added in v1.5.0 

func (s *DescribePipelinesInput) SetPipelineIds(v []*string) *DescribePipelinesInput

SetPipelineIds sets the PipelineIds field's value.

func (DescribePipelinesInput) String added in v0.6.5 

func (s DescribePipelinesInput) String() string

String returns the string representation

func (*DescribePipelinesInput) Validate added in v1.1.21 

func (s *DescribePipelinesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribePipelinesOutput 

type DescribePipelinesOutput struct {

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

Contains the output of DescribePipelines. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DescribePipelinesOutput

func (DescribePipelinesOutput) GoString added in v0.6.5 

func (s DescribePipelinesOutput) GoString() string

GoString returns the string representation

func (*DescribePipelinesOutput) SetPipelineDescriptionList added in v1.5.0 

func (s *DescribePipelinesOutput) SetPipelineDescriptionList(v []*PipelineDescription) *DescribePipelinesOutput

SetPipelineDescriptionList sets the PipelineDescriptionList field's value.

func (DescribePipelinesOutput) String added in v0.6.5 

func (s DescribePipelinesOutput) String() string

String returns the string representation

type EvaluateExpressionInput 

type EvaluateExpressionInput struct {

	// The expression to evaluate.
	//
	// Expression is a required field
	Expression *string `locationName:"expression" type:"string" required:"true"`

	// The ID of the object.
	//
	// ObjectId is a required field
	ObjectId *string `locationName:"objectId" min:"1" type:"string" required:"true"`

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

Contains the parameters for EvaluateExpression. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/EvaluateExpressionInput

func (EvaluateExpressionInput) GoString added in v0.6.5 

func (s EvaluateExpressionInput) GoString() string

GoString returns the string representation

func (*EvaluateExpressionInput) SetExpression added in v1.5.0 

func (s *EvaluateExpressionInput) SetExpression(v string) *EvaluateExpressionInput

SetExpression sets the Expression field's value.

func (*EvaluateExpressionInput) SetObjectId added in v1.5.0 

func (s *EvaluateExpressionInput) SetObjectId(v string) *EvaluateExpressionInput

SetObjectId sets the ObjectId field's value.

func (*EvaluateExpressionInput) SetPipelineId added in v1.5.0 

func (s *EvaluateExpressionInput) SetPipelineId(v string) *EvaluateExpressionInput

SetPipelineId sets the PipelineId field's value.

func (EvaluateExpressionInput) String added in v0.6.5 

func (s EvaluateExpressionInput) String() string

String returns the string representation

func (*EvaluateExpressionInput) Validate added in v1.1.21 

func (s *EvaluateExpressionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EvaluateExpressionOutput 

type EvaluateExpressionOutput struct {

	// The evaluated expression.
	//
	// EvaluatedExpression is a required field
	EvaluatedExpression *string `locationName:"evaluatedExpression" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the output of EvaluateExpression. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/EvaluateExpressionOutput

func (EvaluateExpressionOutput) GoString added in v0.6.5 

func (s EvaluateExpressionOutput) GoString() string

GoString returns the string representation

func (*EvaluateExpressionOutput) SetEvaluatedExpression added in v1.5.0 

func (s *EvaluateExpressionOutput) SetEvaluatedExpression(v string) *EvaluateExpressionOutput

SetEvaluatedExpression sets the EvaluatedExpression field's value.

func (EvaluateExpressionOutput) String added in v0.6.5 

func (s EvaluateExpressionOutput) String() string

String returns the string representation

type Field 

type Field struct {

	// The field identifier.
	//
	// Key is a required field
	Key *string `locationName:"key" min:"1" type:"string" required:"true"`

	// The field value, expressed as the identifier of another object.
	RefValue *string `locationName:"refValue" min:"1" 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/Field

func (Field) GoString added in v0.6.5 

func (s Field) GoString() string

GoString returns the string representation

func (*Field) SetKey added in v1.5.0 

func (s *Field) SetKey(v string) *Field

SetKey sets the Key field's value.

func (*Field) SetRefValue added in v1.5.0 

func (s *Field) SetRefValue(v string) *Field

SetRefValue sets the RefValue field's value.

func (*Field) SetStringValue added in v1.5.0 

func (s *Field) SetStringValue(v string) *Field

SetStringValue sets the StringValue field's value.

func (Field) String added in v0.6.5 

func (s Field) String() string

String returns the string representation

func (*Field) Validate added in v1.1.21 

func (s *Field) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetPipelineDefinitionInput 

type GetPipelineDefinitionInput struct {

	// The ID of the pipeline.
	//
	// PipelineId is a required field
	PipelineId *string `locationName:"pipelineId" min:"1" 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/GetPipelineDefinitionInput

func (GetPipelineDefinitionInput) GoString added in v0.6.5 

func (s GetPipelineDefinitionInput) GoString() string

GoString returns the string representation

func (*GetPipelineDefinitionInput) SetPipelineId added in v1.5.0 

func (s *GetPipelineDefinitionInput) SetPipelineId(v string) *GetPipelineDefinitionInput

SetPipelineId sets the PipelineId field's value.

func (*GetPipelineDefinitionInput) SetVersion added in v1.5.0 

func (s *GetPipelineDefinitionInput) SetVersion(v string) *GetPipelineDefinitionInput

SetVersion sets the Version field's value.

func (GetPipelineDefinitionInput) String added in v0.6.5 

func (s GetPipelineDefinitionInput) String() string

String returns the string representation

func (*GetPipelineDefinitionInput) Validate added in v1.1.21 

func (s *GetPipelineDefinitionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/GetPipelineDefinitionOutput

func (GetPipelineDefinitionOutput) GoString added in v0.6.5 

func (s GetPipelineDefinitionOutput) GoString() string

GoString returns the string representation

func (*GetPipelineDefinitionOutput) SetParameterObjects added in v1.5.0 

func (s *GetPipelineDefinitionOutput) SetParameterObjects(v []*ParameterObject) *GetPipelineDefinitionOutput

SetParameterObjects sets the ParameterObjects field's value.

func (*GetPipelineDefinitionOutput) SetParameterValues added in v1.5.0 

func (s *GetPipelineDefinitionOutput) SetParameterValues(v []*ParameterValue) *GetPipelineDefinitionOutput

SetParameterValues sets the ParameterValues field's value.

func (*GetPipelineDefinitionOutput) SetPipelineObjects added in v1.5.0 

func (s *GetPipelineDefinitionOutput) SetPipelineObjects(v []*PipelineObject) *GetPipelineDefinitionOutput

SetPipelineObjects sets the PipelineObjects field's value.

func (GetPipelineDefinitionOutput) String added in v0.6.5 

func (s GetPipelineDefinitionOutput) String() 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/InstanceIdentity

func (InstanceIdentity) GoString added in v0.6.5 

func (s InstanceIdentity) GoString() string

GoString returns the string representation

func (*InstanceIdentity) SetDocument added in v1.5.0 

func (s *InstanceIdentity) SetDocument(v string) *InstanceIdentity

SetDocument sets the Document field's value.

func (*InstanceIdentity) SetSignature added in v1.5.0 

func (s *InstanceIdentity) SetSignature(v string) *InstanceIdentity

SetSignature sets the Signature field's value.

func (InstanceIdentity) String added in v0.6.5 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ListPipelinesInput

func (ListPipelinesInput) GoString added in v0.6.5 

func (s ListPipelinesInput) GoString() string

GoString returns the string representation

func (*ListPipelinesInput) SetMarker added in v1.5.0 

func (s *ListPipelinesInput) SetMarker(v string) *ListPipelinesInput

SetMarker sets the Marker field's value.

func (ListPipelinesInput) String added in v0.6.5 

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 is a required field
	PipelineIdList []*PipelineIdName `locationName:"pipelineIdList" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains the output of ListPipelines. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ListPipelinesOutput

func (ListPipelinesOutput) GoString added in v0.6.5 

func (s ListPipelinesOutput) GoString() string

GoString returns the string representation

func (*ListPipelinesOutput) SetHasMoreResults added in v1.5.0 

func (s *ListPipelinesOutput) SetHasMoreResults(v bool) *ListPipelinesOutput

SetHasMoreResults sets the HasMoreResults field's value.

func (*ListPipelinesOutput) SetMarker added in v1.5.0 

func (s *ListPipelinesOutput) SetMarker(v string) *ListPipelinesOutput

SetMarker sets the Marker field's value.

func (*ListPipelinesOutput) SetPipelineIdList added in v1.5.0 

func (s *ListPipelinesOutput) SetPipelineIdList(v []*PipelineIdName) *ListPipelinesOutput

SetPipelineIdList sets the PipelineIdList field's value.

func (ListPipelinesOutput) String added in v0.6.5 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/Operator

func (Operator) GoString added in v0.6.5 

func (s Operator) GoString() string

GoString returns the string representation

func (*Operator) SetType added in v1.5.0 

func (s *Operator) SetType(v string) *Operator

SetType sets the Type field's value.

func (*Operator) SetValues added in v1.5.0 

func (s *Operator) SetValues(v []*string) *Operator

SetValues sets the Values field's value.

func (Operator) String added in v0.6.5 

func (s Operator) String() string

String returns the string representation

type ParameterAttribute 

type ParameterAttribute struct {

	// The field identifier.
	//
	// Key is a required field
	Key *string `locationName:"key" min:"1" type:"string" required:"true"`

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

The attributes allowed or specified with a parameter object. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ParameterAttribute

func (ParameterAttribute) GoString added in v0.6.5 

func (s ParameterAttribute) GoString() string

GoString returns the string representation

func (*ParameterAttribute) SetKey added in v1.5.0 

func (s *ParameterAttribute) SetKey(v string) *ParameterAttribute

SetKey sets the Key field's value.

func (*ParameterAttribute) SetStringValue added in v1.5.0 

func (s *ParameterAttribute) SetStringValue(v string) *ParameterAttribute

SetStringValue sets the StringValue field's value.

func (ParameterAttribute) String added in v0.6.5 

func (s ParameterAttribute) String() string

String returns the string representation

func (*ParameterAttribute) Validate added in v1.1.21 

func (s *ParameterAttribute) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ParameterObject 

type ParameterObject struct {

	// The attributes of the parameter object.
	//
	// Attributes is a required field
	Attributes []*ParameterAttribute `locationName:"attributes" type:"list" required:"true"`

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

Contains information about a parameter object. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ParameterObject

func (ParameterObject) GoString added in v0.6.5 

func (s ParameterObject) GoString() string

GoString returns the string representation

func (*ParameterObject) SetAttributes added in v1.5.0 

func (s *ParameterObject) SetAttributes(v []*ParameterAttribute) *ParameterObject

SetAttributes sets the Attributes field's value.

func (*ParameterObject) SetId added in v1.5.0 

func (s *ParameterObject) SetId(v string) *ParameterObject

SetId sets the Id field's value.

func (ParameterObject) String added in v0.6.5 

func (s ParameterObject) String() string

String returns the string representation

func (*ParameterObject) Validate added in v1.1.21 

func (s *ParameterObject) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ParameterValue 

type ParameterValue struct {

	// The ID of the parameter value.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"1" type:"string" required:"true"`

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

A value or list of parameter values. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ParameterValue

func (ParameterValue) GoString added in v0.6.5 

func (s ParameterValue) GoString() string

GoString returns the string representation

func (*ParameterValue) SetId added in v1.5.0 

func (s *ParameterValue) SetId(v string) *ParameterValue

SetId sets the Id field's value.

func (*ParameterValue) SetStringValue added in v1.5.0 

func (s *ParameterValue) SetStringValue(v string) *ParameterValue

SetStringValue sets the StringValue field's value.

func (ParameterValue) String added in v0.6.5 

func (s ParameterValue) String() string

String returns the string representation

func (*ParameterValue) Validate added in v1.1.21 

func (s *ParameterValue) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 is a required field
	Fields []*Field `locationName:"fields" type:"list" required:"true"`

	// The name of the pipeline.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The pipeline identifier that was assigned by AWS Data Pipeline. This is a
	// string of the form df-297EG78HU43EEXAMPLE.
	//
	// PipelineId is a required field
	PipelineId *string `locationName:"pipelineId" min:"1" 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/PipelineDescription

func (PipelineDescription) GoString added in v0.6.5 

func (s PipelineDescription) GoString() string

GoString returns the string representation

func (*PipelineDescription) SetDescription added in v1.5.0 

func (s *PipelineDescription) SetDescription(v string) *PipelineDescription

SetDescription sets the Description field's value.

func (*PipelineDescription) SetFields added in v1.5.0 

func (s *PipelineDescription) SetFields(v []*Field) *PipelineDescription

SetFields sets the Fields field's value.

func (*PipelineDescription) SetName added in v1.5.0 

func (s *PipelineDescription) SetName(v string) *PipelineDescription

SetName sets the Name field's value.

func (*PipelineDescription) SetPipelineId added in v1.5.0 

func (s *PipelineDescription) SetPipelineId(v string) *PipelineDescription

SetPipelineId sets the PipelineId field's value.

func (*PipelineDescription) SetTags added in v1.5.0 

func (s *PipelineDescription) SetTags(v []*Tag) *PipelineDescription

SetTags sets the Tags field's value.

func (PipelineDescription) String added in v0.6.5 

func (s PipelineDescription) String() string

String returns the string representation

type PipelineIdName added in v0.9.5 

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" min:"1" type:"string"`

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

Contains the name and identifier of a pipeline. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/PipelineIdName

func (PipelineIdName) GoString added in v0.9.5 

func (s PipelineIdName) GoString() string

GoString returns the string representation

func (*PipelineIdName) SetId added in v1.5.0 

func (s *PipelineIdName) SetId(v string) *PipelineIdName

SetId sets the Id field's value.

func (*PipelineIdName) SetName added in v1.5.0 

func (s *PipelineIdName) SetName(v string) *PipelineIdName

SetName sets the Name field's value.

func (PipelineIdName) String added in v0.9.5 

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 is a required field
	Fields []*Field `locationName:"fields" type:"list" required:"true"`

	// The ID of the object.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"1" type:"string" required:"true"`

	// The name of the object.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/PipelineObject

func (PipelineObject) GoString added in v0.6.5 

func (s PipelineObject) GoString() string

GoString returns the string representation

func (*PipelineObject) SetFields added in v1.5.0 

func (s *PipelineObject) SetFields(v []*Field) *PipelineObject

SetFields sets the Fields field's value.

func (*PipelineObject) SetId added in v1.5.0 

func (s *PipelineObject) SetId(v string) *PipelineObject

SetId sets the Id field's value.

func (*PipelineObject) SetName added in v1.5.0 

func (s *PipelineObject) SetName(v string) *PipelineObject

SetName sets the Name field's value.

func (PipelineObject) String added in v0.6.5 

func (s PipelineObject) String() string

String returns the string representation

func (*PipelineObject) Validate added in v1.1.21 

func (s *PipelineObject) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PollForTaskInput 

type PollForTaskInput struct {

	// The public DNS name of the calling task runner.
	Hostname *string `locationName:"hostname" min:"1" 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 is a required field
	WorkerGroup *string `locationName:"workerGroup" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for PollForTask. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/PollForTaskInput

func (PollForTaskInput) GoString added in v0.6.5 

func (s PollForTaskInput) GoString() string

GoString returns the string representation

func (*PollForTaskInput) SetHostname added in v1.5.0 

func (s *PollForTaskInput) SetHostname(v string) *PollForTaskInput

SetHostname sets the Hostname field's value.

func (*PollForTaskInput) SetInstanceIdentity added in v1.5.0 

func (s *PollForTaskInput) SetInstanceIdentity(v *InstanceIdentity) *PollForTaskInput

SetInstanceIdentity sets the InstanceIdentity field's value.

func (*PollForTaskInput) SetWorkerGroup added in v1.5.0 

func (s *PollForTaskInput) SetWorkerGroup(v string) *PollForTaskInput

SetWorkerGroup sets the WorkerGroup field's value.

func (PollForTaskInput) String added in v0.6.5 

func (s PollForTaskInput) String() string

String returns the string representation

func (*PollForTaskInput) Validate added in v1.1.21 

func (s *PollForTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/PollForTaskOutput

func (PollForTaskOutput) GoString added in v0.6.5 

func (s PollForTaskOutput) GoString() string

GoString returns the string representation

func (*PollForTaskOutput) SetTaskObject added in v1.5.0 

func (s *PollForTaskOutput) SetTaskObject(v *TaskObject) *PollForTaskOutput

SetTaskObject sets the TaskObject field's value.

func (PollForTaskOutput) String added in v0.6.5 

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 is a required field
	PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`

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

Contains the parameters for PutPipelineDefinition. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/PutPipelineDefinitionInput

func (PutPipelineDefinitionInput) GoString added in v0.6.5 

func (s PutPipelineDefinitionInput) GoString() string

GoString returns the string representation

func (*PutPipelineDefinitionInput) SetParameterObjects added in v1.5.0 

func (s *PutPipelineDefinitionInput) SetParameterObjects(v []*ParameterObject) *PutPipelineDefinitionInput

SetParameterObjects sets the ParameterObjects field's value.

func (*PutPipelineDefinitionInput) SetParameterValues added in v1.5.0 

func (s *PutPipelineDefinitionInput) SetParameterValues(v []*ParameterValue) *PutPipelineDefinitionInput

SetParameterValues sets the ParameterValues field's value.

func (*PutPipelineDefinitionInput) SetPipelineId added in v1.5.0 

func (s *PutPipelineDefinitionInput) SetPipelineId(v string) *PutPipelineDefinitionInput

SetPipelineId sets the PipelineId field's value.

func (*PutPipelineDefinitionInput) SetPipelineObjects added in v1.5.0 

func (s *PutPipelineDefinitionInput) SetPipelineObjects(v []*PipelineObject) *PutPipelineDefinitionInput

SetPipelineObjects sets the PipelineObjects field's value.

func (PutPipelineDefinitionInput) String added in v0.6.5 

func (s PutPipelineDefinitionInput) String() string

String returns the string representation

func (*PutPipelineDefinitionInput) Validate added in v1.1.21 

func (s *PutPipelineDefinitionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 is a required field
	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. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/PutPipelineDefinitionOutput

func (PutPipelineDefinitionOutput) GoString added in v0.6.5 

func (s PutPipelineDefinitionOutput) GoString() string

GoString returns the string representation

func (*PutPipelineDefinitionOutput) SetErrored added in v1.5.0 

func (s *PutPipelineDefinitionOutput) SetErrored(v bool) *PutPipelineDefinitionOutput

SetErrored sets the Errored field's value.

func (*PutPipelineDefinitionOutput) SetValidationErrors added in v1.5.0 

func (s *PutPipelineDefinitionOutput) SetValidationErrors(v []*ValidationError) *PutPipelineDefinitionOutput

SetValidationErrors sets the ValidationErrors field's value.

func (*PutPipelineDefinitionOutput) SetValidationWarnings added in v1.5.0 

func (s *PutPipelineDefinitionOutput) SetValidationWarnings(v []*ValidationWarning) *PutPipelineDefinitionOutput

SetValidationWarnings sets the ValidationWarnings field's value.

func (PutPipelineDefinitionOutput) String added in v0.6.5 

func (s PutPipelineDefinitionOutput) String() 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/Query

func (Query) GoString added in v0.6.5 

func (s Query) GoString() string

GoString returns the string representation

func (*Query) SetSelectors added in v1.5.0 

func (s *Query) SetSelectors(v []*Selector) *Query

SetSelectors sets the Selectors field's value.

func (Query) String added in v0.6.5 

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 is a required field
	PipelineId *string `locationName:"pipelineId" min:"1" 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 is a required field
	Sphere *string `locationName:"sphere" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for QueryObjects. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/QueryObjectsInput

func (QueryObjectsInput) GoString added in v0.6.5 

func (s QueryObjectsInput) GoString() string

GoString returns the string representation

func (*QueryObjectsInput) SetLimit added in v1.5.0 

func (s *QueryObjectsInput) SetLimit(v int64) *QueryObjectsInput

SetLimit sets the Limit field's value.

func (*QueryObjectsInput) SetMarker added in v1.5.0 

func (s *QueryObjectsInput) SetMarker(v string) *QueryObjectsInput

SetMarker sets the Marker field's value.

func (*QueryObjectsInput) SetPipelineId added in v1.5.0 

func (s *QueryObjectsInput) SetPipelineId(v string) *QueryObjectsInput

SetPipelineId sets the PipelineId field's value.

func (*QueryObjectsInput) SetQuery added in v1.5.0 

func (s *QueryObjectsInput) SetQuery(v *Query) *QueryObjectsInput

SetQuery sets the Query field's value.

func (*QueryObjectsInput) SetSphere added in v1.5.0 

func (s *QueryObjectsInput) SetSphere(v string) *QueryObjectsInput

SetSphere sets the Sphere field's value.

func (QueryObjectsInput) String added in v0.6.5 

func (s QueryObjectsInput) String() string

String returns the string representation

func (*QueryObjectsInput) Validate added in v1.1.21 

func (s *QueryObjectsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/QueryObjectsOutput

func (QueryObjectsOutput) GoString added in v0.6.5 

func (s QueryObjectsOutput) GoString() string

GoString returns the string representation

func (*QueryObjectsOutput) SetHasMoreResults added in v1.5.0 

func (s *QueryObjectsOutput) SetHasMoreResults(v bool) *QueryObjectsOutput

SetHasMoreResults sets the HasMoreResults field's value.

func (*QueryObjectsOutput) SetIds added in v1.5.0 

func (s *QueryObjectsOutput) SetIds(v []*string) *QueryObjectsOutput

SetIds sets the Ids field's value.

func (*QueryObjectsOutput) SetMarker added in v1.5.0 

func (s *QueryObjectsOutput) SetMarker(v string) *QueryObjectsOutput

SetMarker sets the Marker field's value.

func (QueryObjectsOutput) String added in v0.6.5 

func (s QueryObjectsOutput) String() string

String returns the string representation

type RemoveTagsInput 

type RemoveTagsInput struct {

	// The ID of the pipeline.
	//
	// PipelineId is a required field
	PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`

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

Contains the parameters for RemoveTags. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/RemoveTagsInput

func (RemoveTagsInput) GoString added in v0.6.5 

func (s RemoveTagsInput) GoString() string

GoString returns the string representation

func (*RemoveTagsInput) SetPipelineId added in v1.5.0 

func (s *RemoveTagsInput) SetPipelineId(v string) *RemoveTagsInput

SetPipelineId sets the PipelineId field's value.

func (*RemoveTagsInput) SetTagKeys added in v1.5.0 

func (s *RemoveTagsInput) SetTagKeys(v []*string) *RemoveTagsInput

SetTagKeys sets the TagKeys field's value.

func (RemoveTagsInput) String added in v0.6.5 

func (s RemoveTagsInput) String() string

String returns the string representation

func (*RemoveTagsInput) Validate added in v1.1.21 

func (s *RemoveTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemoveTagsOutput 

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

Contains the output of RemoveTags. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/RemoveTagsOutput

func (RemoveTagsOutput) GoString added in v0.6.5 

func (s RemoveTagsOutput) GoString() string

GoString returns the string representation

func (RemoveTagsOutput) String added in v0.6.5 

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 is a required field
	TaskId *string `locationName:"taskId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for ReportTaskProgress. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ReportTaskProgressInput

func (ReportTaskProgressInput) GoString added in v0.6.5 

func (s ReportTaskProgressInput) GoString() string

GoString returns the string representation

func (*ReportTaskProgressInput) SetFields added in v1.5.0 

func (s *ReportTaskProgressInput) SetFields(v []*Field) *ReportTaskProgressInput

SetFields sets the Fields field's value.

func (*ReportTaskProgressInput) SetTaskId added in v1.5.0 

func (s *ReportTaskProgressInput) SetTaskId(v string) *ReportTaskProgressInput

SetTaskId sets the TaskId field's value.

func (ReportTaskProgressInput) String added in v0.6.5 

func (s ReportTaskProgressInput) String() string

String returns the string representation

func (*ReportTaskProgressInput) Validate added in v1.1.21 

func (s *ReportTaskProgressInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 is a required field
	Canceled *bool `locationName:"canceled" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Contains the output of ReportTaskProgress. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ReportTaskProgressOutput

func (ReportTaskProgressOutput) GoString added in v0.6.5 

func (s ReportTaskProgressOutput) GoString() string

GoString returns the string representation

func (*ReportTaskProgressOutput) SetCanceled added in v1.5.0 

func (s *ReportTaskProgressOutput) SetCanceled(v bool) *ReportTaskProgressOutput

SetCanceled sets the Canceled field's value.

func (ReportTaskProgressOutput) String added in v0.6.5 

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" min:"1" 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 is a required field
	TaskrunnerId *string `locationName:"taskrunnerId" min:"1" 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ReportTaskRunnerHeartbeatInput

func (ReportTaskRunnerHeartbeatInput) GoString added in v0.6.5 

func (s ReportTaskRunnerHeartbeatInput) GoString() string

GoString returns the string representation

func (*ReportTaskRunnerHeartbeatInput) SetHostname added in v1.5.0 

func (s *ReportTaskRunnerHeartbeatInput) SetHostname(v string) *ReportTaskRunnerHeartbeatInput

SetHostname sets the Hostname field's value.

func (*ReportTaskRunnerHeartbeatInput) SetTaskrunnerId added in v1.5.0 

func (s *ReportTaskRunnerHeartbeatInput) SetTaskrunnerId(v string) *ReportTaskRunnerHeartbeatInput

SetTaskrunnerId sets the TaskrunnerId field's value.

func (*ReportTaskRunnerHeartbeatInput) SetWorkerGroup added in v1.5.0 

func (s *ReportTaskRunnerHeartbeatInput) SetWorkerGroup(v string) *ReportTaskRunnerHeartbeatInput

SetWorkerGroup sets the WorkerGroup field's value.

func (ReportTaskRunnerHeartbeatInput) String added in v0.6.5 

func (s ReportTaskRunnerHeartbeatInput) String() string

String returns the string representation

func (*ReportTaskRunnerHeartbeatInput) Validate added in v1.1.21 

func (s *ReportTaskRunnerHeartbeatInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ReportTaskRunnerHeartbeatOutput 

type ReportTaskRunnerHeartbeatOutput struct {

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

Contains the output of ReportTaskRunnerHeartbeat. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ReportTaskRunnerHeartbeatOutput

func (ReportTaskRunnerHeartbeatOutput) GoString added in v0.6.5 

func (s ReportTaskRunnerHeartbeatOutput) GoString() string

GoString returns the string representation

func (*ReportTaskRunnerHeartbeatOutput) SetTerminate added in v1.5.0 

func (s *ReportTaskRunnerHeartbeatOutput) SetTerminate(v bool) *ReportTaskRunnerHeartbeatOutput

SetTerminate sets the Terminate field's value.

func (ReportTaskRunnerHeartbeatOutput) String added in v0.6.5 

func (s ReportTaskRunnerHeartbeatOutput) String() 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/Selector

func (Selector) GoString added in v0.6.5 

func (s Selector) GoString() string

GoString returns the string representation

func (*Selector) SetFieldName added in v1.5.0 

func (s *Selector) SetFieldName(v string) *Selector

SetFieldName sets the FieldName field's value.

func (*Selector) SetOperator added in v1.5.0 

func (s *Selector) SetOperator(v *Operator) *Selector

SetOperator sets the Operator field's value.

func (Selector) String added in v0.6.5 

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 is a required field
	ObjectIds []*string `locationName:"objectIds" type:"list" required:"true"`

	// The ID of the pipeline that contains the objects.
	//
	// PipelineId is a required field
	PipelineId *string `locationName:"pipelineId" min:"1" 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 is a required field
	Status *string `locationName:"status" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for SetStatus. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/SetStatusInput

func (SetStatusInput) GoString added in v0.6.5 

func (s SetStatusInput) GoString() string

GoString returns the string representation

func (*SetStatusInput) SetObjectIds added in v1.5.0 

func (s *SetStatusInput) SetObjectIds(v []*string) *SetStatusInput

SetObjectIds sets the ObjectIds field's value.

func (*SetStatusInput) SetPipelineId added in v1.5.0 

func (s *SetStatusInput) SetPipelineId(v string) *SetStatusInput

SetPipelineId sets the PipelineId field's value.

func (*SetStatusInput) SetStatus added in v1.5.0 

func (s *SetStatusInput) SetStatus(v string) *SetStatusInput

SetStatus sets the Status field's value.

func (SetStatusInput) String added in v0.6.5 

func (s SetStatusInput) String() string

String returns the string representation

func (*SetStatusInput) Validate added in v1.1.21 

func (s *SetStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SetStatusOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/SetStatusOutput

func (SetStatusOutput) GoString added in v0.6.5 

func (s SetStatusOutput) GoString() string

GoString returns the string representation

func (SetStatusOutput) String added in v0.6.5 

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 is a required field
	TaskId *string `locationName:"taskId" min:"1" type:"string" required:"true"`

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

Contains the parameters for SetTaskStatus. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/SetTaskStatusInput

func (SetTaskStatusInput) GoString added in v0.6.5 

func (s SetTaskStatusInput) GoString() string

GoString returns the string representation

func (*SetTaskStatusInput) SetErrorId added in v1.5.0 

func (s *SetTaskStatusInput) SetErrorId(v string) *SetTaskStatusInput

SetErrorId sets the ErrorId field's value.

func (*SetTaskStatusInput) SetErrorMessage added in v1.5.0 

func (s *SetTaskStatusInput) SetErrorMessage(v string) *SetTaskStatusInput

SetErrorMessage sets the ErrorMessage field's value.

func (*SetTaskStatusInput) SetErrorStackTrace added in v1.5.0 

func (s *SetTaskStatusInput) SetErrorStackTrace(v string) *SetTaskStatusInput

SetErrorStackTrace sets the ErrorStackTrace field's value.

func (*SetTaskStatusInput) SetTaskId added in v1.5.0 

func (s *SetTaskStatusInput) SetTaskId(v string) *SetTaskStatusInput

SetTaskId sets the TaskId field's value.

func (*SetTaskStatusInput) SetTaskStatus added in v1.5.0 

func (s *SetTaskStatusInput) SetTaskStatus(v string) *SetTaskStatusInput

SetTaskStatus sets the TaskStatus field's value.

func (SetTaskStatusInput) String added in v0.6.5 

func (s SetTaskStatusInput) String() string

String returns the string representation

func (*SetTaskStatusInput) Validate added in v1.1.21 

func (s *SetTaskStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SetTaskStatusOutput 

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

Contains the output of SetTaskStatus. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/SetTaskStatusOutput

func (SetTaskStatusOutput) GoString added in v0.6.5 

func (s SetTaskStatusOutput) GoString() string

GoString returns the string representation

func (SetTaskStatusOutput) String added in v0.6.5 

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 is a required field
	Key *string `locationName:"key" min:"1" 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 is a required field
	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. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/Tag

func (Tag) GoString added in v0.6.5 

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey added in v1.5.0 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.5.0 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v0.6.5 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v1.1.21 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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" min:"1" 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" min:"1" type:"string"`

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

Contains information about a pipeline task that is assigned to a task runner. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/TaskObject

func (TaskObject) GoString added in v0.6.5 

func (s TaskObject) GoString() string

GoString returns the string representation

func (*TaskObject) SetAttemptId added in v1.5.0 

func (s *TaskObject) SetAttemptId(v string) *TaskObject

SetAttemptId sets the AttemptId field's value.

func (*TaskObject) SetObjects added in v1.5.0 

func (s *TaskObject) SetObjects(v map[string]*PipelineObject) *TaskObject

SetObjects sets the Objects field's value.

func (*TaskObject) SetPipelineId added in v1.5.0 

func (s *TaskObject) SetPipelineId(v string) *TaskObject

SetPipelineId sets the PipelineId field's value.

func (*TaskObject) SetTaskId added in v1.5.0 

func (s *TaskObject) SetTaskId(v string) *TaskObject

SetTaskId sets the TaskId field's value.

func (TaskObject) String added in v0.6.5 

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 is a required field
	PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`

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

Contains the parameters for ValidatePipelineDefinition. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ValidatePipelineDefinitionInput

func (ValidatePipelineDefinitionInput) GoString added in v0.6.5 

func (s ValidatePipelineDefinitionInput) GoString() string

GoString returns the string representation

func (*ValidatePipelineDefinitionInput) SetParameterObjects added in v1.5.0 

func (s *ValidatePipelineDefinitionInput) SetParameterObjects(v []*ParameterObject) *ValidatePipelineDefinitionInput

SetParameterObjects sets the ParameterObjects field's value.

func (*ValidatePipelineDefinitionInput) SetParameterValues added in v1.5.0 

func (s *ValidatePipelineDefinitionInput) SetParameterValues(v []*ParameterValue) *ValidatePipelineDefinitionInput

SetParameterValues sets the ParameterValues field's value.

func (*ValidatePipelineDefinitionInput) SetPipelineId added in v1.5.0 

func (s *ValidatePipelineDefinitionInput) SetPipelineId(v string) *ValidatePipelineDefinitionInput

SetPipelineId sets the PipelineId field's value.

func (*ValidatePipelineDefinitionInput) SetPipelineObjects added in v1.5.0 

func (s *ValidatePipelineDefinitionInput) SetPipelineObjects(v []*PipelineObject) *ValidatePipelineDefinitionInput

SetPipelineObjects sets the PipelineObjects field's value.

func (ValidatePipelineDefinitionInput) String added in v0.6.5 

func (s ValidatePipelineDefinitionInput) String() string

String returns the string representation

func (*ValidatePipelineDefinitionInput) Validate added in v1.1.21 

func (s *ValidatePipelineDefinitionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ValidatePipelineDefinitionOutput 

type ValidatePipelineDefinitionOutput struct {

	// Indicates whether there were validation errors.
	//
	// Errored is a required field
	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. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ValidatePipelineDefinitionOutput

func (ValidatePipelineDefinitionOutput) GoString added in v0.6.5 

func (s ValidatePipelineDefinitionOutput) GoString() string

GoString returns the string representation

func (*ValidatePipelineDefinitionOutput) SetErrored added in v1.5.0 

func (s *ValidatePipelineDefinitionOutput) SetErrored(v bool) *ValidatePipelineDefinitionOutput

SetErrored sets the Errored field's value.

func (*ValidatePipelineDefinitionOutput) SetValidationErrors added in v1.5.0 

func (s *ValidatePipelineDefinitionOutput) SetValidationErrors(v []*ValidationError) *ValidatePipelineDefinitionOutput

SetValidationErrors sets the ValidationErrors field's value.

func (*ValidatePipelineDefinitionOutput) SetValidationWarnings added in v1.5.0 

func (s *ValidatePipelineDefinitionOutput) SetValidationWarnings(v []*ValidationWarning) *ValidatePipelineDefinitionOutput

SetValidationWarnings sets the ValidationWarnings field's value.

func (ValidatePipelineDefinitionOutput) String added in v0.6.5 

func (s ValidatePipelineDefinitionOutput) String() 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" min:"1" 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ValidationError

func (ValidationError) GoString added in v0.6.5 

func (s ValidationError) GoString() string

GoString returns the string representation

func (*ValidationError) SetErrors added in v1.5.0 

func (s *ValidationError) SetErrors(v []*string) *ValidationError

SetErrors sets the Errors field's value.

func (*ValidationError) SetId added in v1.5.0 

func (s *ValidationError) SetId(v string) *ValidationError

SetId sets the Id field's value.

func (ValidationError) String added in v0.6.5 

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" min:"1" 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ValidationWarning

func (ValidationWarning) GoString added in v0.6.5 

func (s ValidationWarning) GoString() string

GoString returns the string representation

func (*ValidationWarning) SetId added in v1.5.0 

func (s *ValidationWarning) SetId(v string) *ValidationWarning

SetId sets the Id field's value.

func (*ValidationWarning) SetWarnings added in v1.5.0 

func (s *ValidationWarning) SetWarnings(v []*string) *ValidationWarning

SetWarnings sets the Warnings field's value.

func (ValidationWarning) String added in v0.6.5 

func (s ValidationWarning) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package datapipelineiface provides an interface to enable mocking the AWS Data Pipeline service client for testing your code.
 Package datapipelineiface provides an interface to enable mocking the AWS Data Pipeline service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.