AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

DataPipeline

import "github.com/aws/aws-sdk-go/service/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.

Client

Type: *client.Client

Method

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.

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ActivatePipeline for more information on using the ActivatePipeline API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) }

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

ActivatePipelineWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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.

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddTags for more information on using the AddTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) }

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

AddTagsWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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.

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreatePipeline for more information on using the CreatePipeline API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) }

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

CreatePipelineWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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.

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeactivatePipeline for more information on using the DeactivatePipeline API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) }

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

DeactivatePipelineWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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.

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeletePipeline for more information on using the DeletePipeline API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) }

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

DeletePipelineWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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.

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

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 })

See Also

For more information about using this API, see AWS API Documentation.

DescribeObjectsPagesWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeObjects for more information on using the DescribeObjects API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) }

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

DescribeObjectsWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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.

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePipelines for more information on using the DescribePipelines API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) }

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

DescribePipelinesWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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.

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See EvaluateExpression for more information on using the EvaluateExpression API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) }

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

EvaluateExpressionWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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.

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetPipelineDefinition for more information on using the GetPipelineDefinition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) }

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

GetPipelineDefinitionWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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.

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

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 })

See Also

For more information about using this API, see AWS API Documentation.

ListPipelinesPagesWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPipelines for more information on using the ListPipelines API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) }

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

ListPipelinesWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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.

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PollForTask for more information on using the PollForTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) }

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

PollForTaskWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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.

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutPipelineDefinition for more information on using the PutPipelineDefinition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) }

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

PutPipelineDefinitionWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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.

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

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 })

See Also

For more information about using this API, see AWS API Documentation.

QueryObjectsPagesWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See QueryObjects for more information on using the QueryObjects API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) }

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

QueryObjectsWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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.

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveTags for more information on using the RemoveTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) }

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

RemoveTagsWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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.

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ReportTaskProgress for more information on using the ReportTaskProgress API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) }

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

ReportTaskProgressWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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.

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ReportTaskRunnerHeartbeat for more information on using the ReportTaskRunnerHeartbeat API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) }

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

ReportTaskRunnerHeartbeatWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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.

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetStatus for more information on using the SetStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) }

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

SetStatusWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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.

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetTaskStatus for more information on using the SetTaskStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) }

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

SetTaskStatusWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

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.

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

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 will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ValidatePipelineDefinition for more information on using the ValidatePipelineDefinition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// 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) }

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

ValidatePipelineDefinitionWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

On this page: