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 AWS Data Pipeline with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the AWS Data Pipeline client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/datapipeline/#New
Index ¶
- Constants
- type ActivatePipelineInput
- type ActivatePipelineOutput
- type ActivatePipelineRequest
- type ActivatePipelineResponse
- type AddTagsInput
- type AddTagsOutput
- type AddTagsRequest
- type AddTagsResponse
- type Client
- func (c *Client) ActivatePipelineRequest(input *ActivatePipelineInput) ActivatePipelineRequest
- func (c *Client) AddTagsRequest(input *AddTagsInput) AddTagsRequest
- func (c *Client) CreatePipelineRequest(input *CreatePipelineInput) CreatePipelineRequest
- func (c *Client) DeactivatePipelineRequest(input *DeactivatePipelineInput) DeactivatePipelineRequest
- func (c *Client) DeletePipelineRequest(input *DeletePipelineInput) DeletePipelineRequest
- func (c *Client) DescribeObjectsRequest(input *DescribeObjectsInput) DescribeObjectsRequest
- func (c *Client) DescribePipelinesRequest(input *DescribePipelinesInput) DescribePipelinesRequest
- func (c *Client) EvaluateExpressionRequest(input *EvaluateExpressionInput) EvaluateExpressionRequest
- func (c *Client) GetPipelineDefinitionRequest(input *GetPipelineDefinitionInput) GetPipelineDefinitionRequest
- func (c *Client) ListPipelinesRequest(input *ListPipelinesInput) ListPipelinesRequest
- func (c *Client) PollForTaskRequest(input *PollForTaskInput) PollForTaskRequest
- func (c *Client) PutPipelineDefinitionRequest(input *PutPipelineDefinitionInput) PutPipelineDefinitionRequest
- func (c *Client) QueryObjectsRequest(input *QueryObjectsInput) QueryObjectsRequest
- func (c *Client) RemoveTagsRequest(input *RemoveTagsInput) RemoveTagsRequest
- func (c *Client) ReportTaskProgressRequest(input *ReportTaskProgressInput) ReportTaskProgressRequest
- func (c *Client) ReportTaskRunnerHeartbeatRequest(input *ReportTaskRunnerHeartbeatInput) ReportTaskRunnerHeartbeatRequest
- func (c *Client) SetStatusRequest(input *SetStatusInput) SetStatusRequest
- func (c *Client) SetTaskStatusRequest(input *SetTaskStatusInput) SetTaskStatusRequest
- func (c *Client) ValidatePipelineDefinitionRequest(input *ValidatePipelineDefinitionInput) ValidatePipelineDefinitionRequest
- type CreatePipelineInput
- type CreatePipelineOutput
- type CreatePipelineRequest
- type CreatePipelineResponse
- type DeactivatePipelineInput
- type DeactivatePipelineOutput
- type DeactivatePipelineRequest
- type DeactivatePipelineResponse
- type DeletePipelineInput
- type DeletePipelineOutput
- type DeletePipelineRequest
- type DeletePipelineResponse
- type DescribeObjectsInput
- type DescribeObjectsOutput
- type DescribeObjectsPaginator
- type DescribeObjectsRequest
- type DescribeObjectsResponse
- type DescribePipelinesInput
- type DescribePipelinesOutput
- type DescribePipelinesRequest
- type DescribePipelinesResponse
- type EvaluateExpressionInput
- type EvaluateExpressionOutput
- type EvaluateExpressionRequest
- type EvaluateExpressionResponse
- type Field
- type GetPipelineDefinitionInput
- type GetPipelineDefinitionOutput
- type GetPipelineDefinitionRequest
- type GetPipelineDefinitionResponse
- type InstanceIdentity
- type ListPipelinesInput
- type ListPipelinesOutput
- type ListPipelinesPaginator
- type ListPipelinesRequest
- type ListPipelinesResponse
- type Operator
- type OperatorType
- type ParameterAttribute
- type ParameterObject
- type ParameterValue
- type PipelineDescription
- type PipelineIdName
- type PipelineObject
- type PollForTaskInput
- type PollForTaskOutput
- type PollForTaskRequest
- type PollForTaskResponse
- type PutPipelineDefinitionInput
- type PutPipelineDefinitionOutput
- type PutPipelineDefinitionRequest
- type PutPipelineDefinitionResponse
- type Query
- type QueryObjectsInput
- type QueryObjectsOutput
- type QueryObjectsPaginator
- type QueryObjectsRequest
- type QueryObjectsResponse
- type RemoveTagsInput
- type RemoveTagsOutput
- type RemoveTagsRequest
- type RemoveTagsResponse
- type ReportTaskProgressInput
- type ReportTaskProgressOutput
- type ReportTaskProgressRequest
- type ReportTaskProgressResponse
- type ReportTaskRunnerHeartbeatInput
- type ReportTaskRunnerHeartbeatOutput
- type ReportTaskRunnerHeartbeatRequest
- type ReportTaskRunnerHeartbeatResponse
- type Selector
- type SetStatusInput
- type SetStatusOutput
- type SetStatusRequest
- type SetStatusResponse
- type SetTaskStatusInput
- type SetTaskStatusOutput
- type SetTaskStatusRequest
- type SetTaskStatusResponse
- type Tag
- type TaskObject
- type TaskStatus
- type ValidatePipelineDefinitionInput
- type ValidatePipelineDefinitionOutput
- type ValidatePipelineDefinitionRequest
- type ValidatePipelineDefinitionResponse
- type ValidationError
- type ValidationWarning
Constants ¶
const ( ServiceName = "AWS Data Pipeline" // Service's name ServiceID = "DataPipeline" // Service's identifier EndpointsID = "datapipeline" // Service's Endpoint identifier )
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" )
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"` // contains filtered or unexported fields }
Contains the parameters for ActivatePipeline.
func (ActivatePipelineInput) String ¶
func (s ActivatePipelineInput) String() string
String returns the string representation
func (*ActivatePipelineInput) Validate ¶
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.
func (ActivatePipelineOutput) String ¶
func (s ActivatePipelineOutput) String() string
String returns the string representation
type ActivatePipelineRequest ¶
type ActivatePipelineRequest struct { *aws.Request Input *ActivatePipelineInput Copy func(*ActivatePipelineInput) ActivatePipelineRequest }
ActivatePipelineRequest is the request type for the ActivatePipeline API operation.
func (ActivatePipelineRequest) Send ¶
func (r ActivatePipelineRequest) Send(ctx context.Context) (*ActivatePipelineResponse, error)
Send marshals and sends the ActivatePipeline API request.
type ActivatePipelineResponse ¶ added in v0.9.0
type ActivatePipelineResponse struct { *ActivatePipelineOutput // contains filtered or unexported fields }
ActivatePipelineResponse is the response type for the ActivatePipeline API operation.
func (*ActivatePipelineResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ActivatePipelineResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ActivatePipeline request.
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.
func (AddTagsInput) String ¶
func (s AddTagsInput) String() string
String returns the string representation
func (*AddTagsInput) Validate ¶
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.
func (AddTagsOutput) String ¶
func (s AddTagsOutput) String() string
String returns the string representation
type AddTagsRequest ¶
type AddTagsRequest struct { *aws.Request Input *AddTagsInput Copy func(*AddTagsInput) AddTagsRequest }
AddTagsRequest is the request type for the AddTags API operation.
func (AddTagsRequest) Send ¶
func (r AddTagsRequest) Send(ctx context.Context) (*AddTagsResponse, error)
Send marshals and sends the AddTags API request.
type AddTagsResponse ¶ added in v0.9.0
type AddTagsResponse struct { *AddTagsOutput // contains filtered or unexported fields }
AddTagsResponse is the response type for the AddTags API operation.
func (*AddTagsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *AddTagsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the AddTags request.
type Client ¶ added in v0.9.0
Client provides the API operation methods for making requests to AWS Data Pipeline. See this package's package overview docs for details on the service.
The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
New creates a new instance of the client from the provided Config.
Example:
// Create a client from just a config. svc := datapipeline.New(myConfig)
func (*Client) ActivatePipelineRequest ¶ added in v0.9.0
func (c *Client) ActivatePipelineRequest(input *ActivatePipelineInput) ActivatePipelineRequest
ActivatePipelineRequest returns a request value for making 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.
// Example sending a request using ActivatePipelineRequest. req := client.ActivatePipelineRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ActivatePipeline
func (*Client) AddTagsRequest ¶ added in v0.9.0
func (c *Client) AddTagsRequest(input *AddTagsInput) AddTagsRequest
AddTagsRequest returns a request value for making API operation for AWS Data Pipeline.
Adds or modifies tags for the specified pipeline.
// Example sending a request using AddTagsRequest. req := client.AddTagsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/AddTags
func (*Client) CreatePipelineRequest ¶ added in v0.9.0
func (c *Client) CreatePipelineRequest(input *CreatePipelineInput) CreatePipelineRequest
CreatePipelineRequest returns a request value for making API operation for AWS Data Pipeline.
Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
// Example sending a request using CreatePipelineRequest. req := client.CreatePipelineRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/CreatePipeline
func (*Client) DeactivatePipelineRequest ¶ added in v0.9.0
func (c *Client) DeactivatePipelineRequest(input *DeactivatePipelineInput) DeactivatePipelineRequest
DeactivatePipelineRequest returns a request value for making 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.
// Example sending a request using DeactivatePipelineRequest. req := client.DeactivatePipelineRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DeactivatePipeline
func (*Client) DeletePipelineRequest ¶ added in v0.9.0
func (c *Client) DeletePipelineRequest(input *DeletePipelineInput) DeletePipelineRequest
DeletePipelineRequest returns a request value for making 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.
// Example sending a request using DeletePipelineRequest. req := client.DeletePipelineRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DeletePipeline
func (*Client) DescribeObjectsRequest ¶ added in v0.9.0
func (c *Client) DescribeObjectsRequest(input *DescribeObjectsInput) DescribeObjectsRequest
DescribeObjectsRequest returns a request value for making 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.
// Example sending a request using DescribeObjectsRequest. req := client.DescribeObjectsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DescribeObjects
func (*Client) DescribePipelinesRequest ¶ added in v0.9.0
func (c *Client) DescribePipelinesRequest(input *DescribePipelinesInput) DescribePipelinesRequest
DescribePipelinesRequest returns a request value for making 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.
// Example sending a request using DescribePipelinesRequest. req := client.DescribePipelinesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/DescribePipelines
func (*Client) EvaluateExpressionRequest ¶ added in v0.9.0
func (c *Client) EvaluateExpressionRequest(input *EvaluateExpressionInput) EvaluateExpressionRequest
EvaluateExpressionRequest returns a request value for making 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.
// Example sending a request using EvaluateExpressionRequest. req := client.EvaluateExpressionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/EvaluateExpression
func (*Client) GetPipelineDefinitionRequest ¶ added in v0.9.0
func (c *Client) GetPipelineDefinitionRequest(input *GetPipelineDefinitionInput) GetPipelineDefinitionRequest
GetPipelineDefinitionRequest returns a request value for making 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.
// Example sending a request using GetPipelineDefinitionRequest. req := client.GetPipelineDefinitionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/GetPipelineDefinition
func (*Client) ListPipelinesRequest ¶ added in v0.9.0
func (c *Client) ListPipelinesRequest(input *ListPipelinesInput) ListPipelinesRequest
ListPipelinesRequest returns a request value for making API operation for AWS Data Pipeline.
Lists the pipeline identifiers for all active pipelines that you have permission to access.
// Example sending a request using ListPipelinesRequest. req := client.ListPipelinesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ListPipelines
func (*Client) PollForTaskRequest ¶ added in v0.9.0
func (c *Client) PollForTaskRequest(input *PollForTaskInput) PollForTaskRequest
PollForTaskRequest returns a request value for making 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.
// Example sending a request using PollForTaskRequest. req := client.PollForTaskRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/PollForTask
func (*Client) PutPipelineDefinitionRequest ¶ added in v0.9.0
func (c *Client) PutPipelineDefinitionRequest(input *PutPipelineDefinitionInput) PutPipelineDefinitionRequest
PutPipelineDefinitionRequest returns a request value for making 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.
// Example sending a request using PutPipelineDefinitionRequest. req := client.PutPipelineDefinitionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/PutPipelineDefinition
func (*Client) QueryObjectsRequest ¶ added in v0.9.0
func (c *Client) QueryObjectsRequest(input *QueryObjectsInput) QueryObjectsRequest
QueryObjectsRequest returns a request value for making API operation for AWS Data Pipeline.
Queries the specified pipeline for the names of objects that match the specified set of conditions.
// Example sending a request using QueryObjectsRequest. req := client.QueryObjectsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/QueryObjects
func (*Client) RemoveTagsRequest ¶ added in v0.9.0
func (c *Client) RemoveTagsRequest(input *RemoveTagsInput) RemoveTagsRequest
RemoveTagsRequest returns a request value for making API operation for AWS Data Pipeline.
Removes existing tags from the specified pipeline.
// Example sending a request using RemoveTagsRequest. req := client.RemoveTagsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/RemoveTags
func (*Client) ReportTaskProgressRequest ¶ added in v0.9.0
func (c *Client) ReportTaskProgressRequest(input *ReportTaskProgressInput) ReportTaskProgressRequest
ReportTaskProgressRequest returns a request value for making 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.
// Example sending a request using ReportTaskProgressRequest. req := client.ReportTaskProgressRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ReportTaskProgress
func (*Client) ReportTaskRunnerHeartbeatRequest ¶ added in v0.9.0
func (c *Client) ReportTaskRunnerHeartbeatRequest(input *ReportTaskRunnerHeartbeatInput) ReportTaskRunnerHeartbeatRequest
ReportTaskRunnerHeartbeatRequest returns a request value for making 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.
// Example sending a request using ReportTaskRunnerHeartbeatRequest. req := client.ReportTaskRunnerHeartbeatRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ReportTaskRunnerHeartbeat
func (*Client) SetStatusRequest ¶ added in v0.9.0
func (c *Client) SetStatusRequest(input *SetStatusInput) SetStatusRequest
SetStatusRequest returns a request value for making 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.
// Example sending a request using SetStatusRequest. req := client.SetStatusRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/SetStatus
func (*Client) SetTaskStatusRequest ¶ added in v0.9.0
func (c *Client) SetTaskStatusRequest(input *SetTaskStatusInput) SetTaskStatusRequest
SetTaskStatusRequest returns a request value for making 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.
// Example sending a request using SetTaskStatusRequest. req := client.SetTaskStatusRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/SetTaskStatus
func (*Client) ValidatePipelineDefinitionRequest ¶ added in v0.9.0
func (c *Client) ValidatePipelineDefinitionRequest(input *ValidatePipelineDefinitionInput) ValidatePipelineDefinitionRequest
ValidatePipelineDefinitionRequest returns a request value for making API operation for AWS Data Pipeline.
Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
// Example sending a request using ValidatePipelineDefinitionRequest. req := client.ValidatePipelineDefinitionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/ValidatePipelineDefinition
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.
func (CreatePipelineInput) String ¶
func (s CreatePipelineInput) String() string
String returns the string representation
func (*CreatePipelineInput) Validate ¶
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.
func (CreatePipelineOutput) String ¶
func (s CreatePipelineOutput) String() string
String returns the string representation
type CreatePipelineRequest ¶
type CreatePipelineRequest struct { *aws.Request Input *CreatePipelineInput Copy func(*CreatePipelineInput) CreatePipelineRequest }
CreatePipelineRequest is the request type for the CreatePipeline API operation.
func (CreatePipelineRequest) Send ¶
func (r CreatePipelineRequest) Send(ctx context.Context) (*CreatePipelineResponse, error)
Send marshals and sends the CreatePipeline API request.
type CreatePipelineResponse ¶ added in v0.9.0
type CreatePipelineResponse struct { *CreatePipelineOutput // contains filtered or unexported fields }
CreatePipelineResponse is the response type for the CreatePipeline API operation.
func (*CreatePipelineResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreatePipelineResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreatePipeline request.
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.
func (DeactivatePipelineInput) String ¶
func (s DeactivatePipelineInput) String() string
String returns the string representation
func (*DeactivatePipelineInput) Validate ¶
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.
func (DeactivatePipelineOutput) String ¶
func (s DeactivatePipelineOutput) String() string
String returns the string representation
type DeactivatePipelineRequest ¶
type DeactivatePipelineRequest struct { *aws.Request Input *DeactivatePipelineInput Copy func(*DeactivatePipelineInput) DeactivatePipelineRequest }
DeactivatePipelineRequest is the request type for the DeactivatePipeline API operation.
func (DeactivatePipelineRequest) Send ¶
func (r DeactivatePipelineRequest) Send(ctx context.Context) (*DeactivatePipelineResponse, error)
Send marshals and sends the DeactivatePipeline API request.
type DeactivatePipelineResponse ¶ added in v0.9.0
type DeactivatePipelineResponse struct { *DeactivatePipelineOutput // contains filtered or unexported fields }
DeactivatePipelineResponse is the response type for the DeactivatePipeline API operation.
func (*DeactivatePipelineResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeactivatePipelineResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeactivatePipeline request.
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.
func (DeletePipelineInput) String ¶
func (s DeletePipelineInput) String() string
String returns the string representation
func (*DeletePipelineInput) Validate ¶
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
}
func (DeletePipelineOutput) String ¶
func (s DeletePipelineOutput) String() string
String returns the string representation
type DeletePipelineRequest ¶
type DeletePipelineRequest struct { *aws.Request Input *DeletePipelineInput Copy func(*DeletePipelineInput) DeletePipelineRequest }
DeletePipelineRequest is the request type for the DeletePipeline API operation.
func (DeletePipelineRequest) Send ¶
func (r DeletePipelineRequest) Send(ctx context.Context) (*DeletePipelineResponse, error)
Send marshals and sends the DeletePipeline API request.
type DeletePipelineResponse ¶ added in v0.9.0
type DeletePipelineResponse struct { *DeletePipelineOutput // contains filtered or unexported fields }
DeletePipelineResponse is the response type for the DeletePipeline API operation.
func (*DeletePipelineResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeletePipelineResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeletePipeline request.
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.
func (DescribeObjectsInput) String ¶
func (s DescribeObjectsInput) String() string
String returns the string representation
func (*DescribeObjectsInput) Validate ¶
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.
func (DescribeObjectsOutput) String ¶
func (s DescribeObjectsOutput) String() string
String returns the string representation
type DescribeObjectsPaginator ¶ added in v0.9.0
DescribeObjectsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewDescribeObjectsPaginator ¶ added in v0.9.0
func NewDescribeObjectsPaginator(req DescribeObjectsRequest) DescribeObjectsPaginator
NewDescribeObjectsRequestPaginator returns a paginator for DescribeObjects. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.DescribeObjectsRequest(input) p := datapipeline.NewDescribeObjectsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*DescribeObjectsPaginator) CurrentPage ¶ added in v0.9.0
func (p *DescribeObjectsPaginator) CurrentPage() *DescribeObjectsOutput
type DescribeObjectsRequest ¶
type DescribeObjectsRequest struct { *aws.Request Input *DescribeObjectsInput Copy func(*DescribeObjectsInput) DescribeObjectsRequest }
DescribeObjectsRequest is the request type for the DescribeObjects API operation.
func (DescribeObjectsRequest) Send ¶
func (r DescribeObjectsRequest) Send(ctx context.Context) (*DescribeObjectsResponse, error)
Send marshals and sends the DescribeObjects API request.
type DescribeObjectsResponse ¶ added in v0.9.0
type DescribeObjectsResponse struct { *DescribeObjectsOutput // contains filtered or unexported fields }
DescribeObjectsResponse is the response type for the DescribeObjects API operation.
func (*DescribeObjectsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeObjectsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeObjects request.
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.
func (DescribePipelinesInput) String ¶
func (s DescribePipelinesInput) String() string
String returns the string representation
func (*DescribePipelinesInput) Validate ¶
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.
func (DescribePipelinesOutput) String ¶
func (s DescribePipelinesOutput) String() string
String returns the string representation
type DescribePipelinesRequest ¶
type DescribePipelinesRequest struct { *aws.Request Input *DescribePipelinesInput Copy func(*DescribePipelinesInput) DescribePipelinesRequest }
DescribePipelinesRequest is the request type for the DescribePipelines API operation.
func (DescribePipelinesRequest) Send ¶
func (r DescribePipelinesRequest) Send(ctx context.Context) (*DescribePipelinesResponse, error)
Send marshals and sends the DescribePipelines API request.
type DescribePipelinesResponse ¶ added in v0.9.0
type DescribePipelinesResponse struct { *DescribePipelinesOutput // contains filtered or unexported fields }
DescribePipelinesResponse is the response type for the DescribePipelines API operation.
func (*DescribePipelinesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribePipelinesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribePipelines request.
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.
func (EvaluateExpressionInput) String ¶
func (s EvaluateExpressionInput) String() string
String returns the string representation
func (*EvaluateExpressionInput) Validate ¶
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.
func (EvaluateExpressionOutput) String ¶
func (s EvaluateExpressionOutput) String() string
String returns the string representation
type EvaluateExpressionRequest ¶
type EvaluateExpressionRequest struct { *aws.Request Input *EvaluateExpressionInput Copy func(*EvaluateExpressionInput) EvaluateExpressionRequest }
EvaluateExpressionRequest is the request type for the EvaluateExpression API operation.
func (EvaluateExpressionRequest) Send ¶
func (r EvaluateExpressionRequest) Send(ctx context.Context) (*EvaluateExpressionResponse, error)
Send marshals and sends the EvaluateExpression API request.
type EvaluateExpressionResponse ¶ added in v0.9.0
type EvaluateExpressionResponse struct { *EvaluateExpressionOutput // contains filtered or unexported fields }
EvaluateExpressionResponse is the response type for the EvaluateExpression API operation.
func (*EvaluateExpressionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *EvaluateExpressionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the EvaluateExpression request.
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.
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.
func (GetPipelineDefinitionInput) String ¶
func (s GetPipelineDefinitionInput) String() string
String returns the string representation
func (*GetPipelineDefinitionInput) Validate ¶
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.
func (GetPipelineDefinitionOutput) String ¶
func (s GetPipelineDefinitionOutput) String() string
String returns the string representation
type GetPipelineDefinitionRequest ¶
type GetPipelineDefinitionRequest struct { *aws.Request Input *GetPipelineDefinitionInput Copy func(*GetPipelineDefinitionInput) GetPipelineDefinitionRequest }
GetPipelineDefinitionRequest is the request type for the GetPipelineDefinition API operation.
func (GetPipelineDefinitionRequest) Send ¶
func (r GetPipelineDefinitionRequest) Send(ctx context.Context) (*GetPipelineDefinitionResponse, error)
Send marshals and sends the GetPipelineDefinition API request.
type GetPipelineDefinitionResponse ¶ added in v0.9.0
type GetPipelineDefinitionResponse struct { *GetPipelineDefinitionOutput // contains filtered or unexported fields }
GetPipelineDefinitionResponse is the response type for the GetPipelineDefinition API operation.
func (*GetPipelineDefinitionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetPipelineDefinitionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetPipelineDefinition request.
type InstanceIdentity ¶
type InstanceIdentity struct { // A description of an EC2 instance that is generated when the instance is launched // and exposed to the instance via the instance metadata service in the form // of a JSON representation of an object. Document *string `locationName:"document" type:"string"` // A signature which can be used to verify the accuracy and authenticity of // the information provided in the instance identity document. Signature *string `locationName:"signature" type:"string"` // contains filtered or unexported fields }
Identity information for the EC2 instance that is hosting the task runner. You can get this value by calling a metadata URI from the EC2 instance. For more information, see Instance Metadata (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html) in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.
func (InstanceIdentity) String ¶
func (s InstanceIdentity) String() string
String returns the string representation
type ListPipelinesInput ¶
type ListPipelinesInput struct { // The starting point for the results to be returned. For the first call, this // value should be empty. As long as there are more results, continue to call // ListPipelines with the marker value from the previous call to retrieve the // next set of results. Marker *string `locationName:"marker" type:"string"` // contains filtered or unexported fields }
Contains the parameters for ListPipelines.
func (ListPipelinesInput) String ¶
func (s ListPipelinesInput) String() string
String returns the string representation
type ListPipelinesOutput ¶
type ListPipelinesOutput struct { // Indicates whether there are more results that can be obtained by a subsequent // call. HasMoreResults *bool `locationName:"hasMoreResults" type:"boolean"` // The starting point for the next page of results. To view the next page of // results, call ListPipelinesOutput again with this marker value. If the value // is null, there are no more results. Marker *string `locationName:"marker" type:"string"` // The pipeline identifiers. If you require additional information about the // pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition. // // PipelineIdList is a required field PipelineIdList []PipelineIdName `locationName:"pipelineIdList" type:"list" required:"true"` // contains filtered or unexported fields }
Contains the output of ListPipelines.
func (ListPipelinesOutput) String ¶
func (s ListPipelinesOutput) String() string
String returns the string representation
type ListPipelinesPaginator ¶ added in v0.9.0
ListPipelinesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListPipelinesPaginator ¶ added in v0.9.0
func NewListPipelinesPaginator(req ListPipelinesRequest) ListPipelinesPaginator
NewListPipelinesRequestPaginator returns a paginator for ListPipelines. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListPipelinesRequest(input) p := datapipeline.NewListPipelinesRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListPipelinesPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListPipelinesPaginator) CurrentPage() *ListPipelinesOutput
type ListPipelinesRequest ¶
type ListPipelinesRequest struct { *aws.Request Input *ListPipelinesInput Copy func(*ListPipelinesInput) ListPipelinesRequest }
ListPipelinesRequest is the request type for the ListPipelines API operation.
func (ListPipelinesRequest) Send ¶
func (r ListPipelinesRequest) Send(ctx context.Context) (*ListPipelinesResponse, error)
Send marshals and sends the ListPipelines API request.
type ListPipelinesResponse ¶ added in v0.9.0
type ListPipelinesResponse struct { *ListPipelinesOutput // contains filtered or unexported fields }
ListPipelinesResponse is the response type for the ListPipelines API operation.
func (*ListPipelinesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListPipelinesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListPipelines request.
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 OperatorType `locationName:"type" type:"string" enum:"true"` // 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.
type OperatorType ¶
type OperatorType string
const ( OperatorTypeEq OperatorType = "EQ" OperatorTypeRefEq OperatorType = "REF_EQ" OperatorTypeLe OperatorType = "LE" OperatorTypeGe OperatorType = "GE" OperatorTypeBetween OperatorType = "BETWEEN" )
Enum values for OperatorType
func (OperatorType) MarshalValue ¶ added in v0.3.0
func (enum OperatorType) MarshalValue() (string, error)
func (OperatorType) MarshalValueBuf ¶ added in v0.3.0
func (enum OperatorType) MarshalValueBuf(b []byte) ([]byte, error)
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.
func (ParameterAttribute) String ¶
func (s ParameterAttribute) String() string
String returns the string representation
func (*ParameterAttribute) Validate ¶
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.
func (ParameterObject) String ¶
func (s ParameterObject) String() string
String returns the string representation
func (*ParameterObject) Validate ¶
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.
func (ParameterValue) String ¶
func (s ParameterValue) String() string
String returns the string representation
func (*ParameterValue) Validate ¶
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.
func (PipelineDescription) String ¶
func (s PipelineDescription) String() string
String returns the string representation
type PipelineIdName ¶
type PipelineIdName struct { // The ID of the pipeline that was assigned by AWS Data Pipeline. This is a // string of the form df-297EG78HU43EEXAMPLE. Id *string `locationName:"id" 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.
func (PipelineIdName) String ¶
func (s PipelineIdName) String() string
String returns the string representation
type PipelineObject ¶
type PipelineObject struct { // Key-value pairs that define the properties of the object. // // Fields 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.
func (PipelineObject) String ¶
func (s PipelineObject) String() string
String returns the string representation
func (*PipelineObject) Validate ¶
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.
func (PollForTaskInput) String ¶
func (s PollForTaskInput) String() string
String returns the string representation
func (*PollForTaskInput) Validate ¶
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.
func (PollForTaskOutput) String ¶
func (s PollForTaskOutput) String() string
String returns the string representation
type PollForTaskRequest ¶
type PollForTaskRequest struct { *aws.Request Input *PollForTaskInput Copy func(*PollForTaskInput) PollForTaskRequest }
PollForTaskRequest is the request type for the PollForTask API operation.
func (PollForTaskRequest) Send ¶
func (r PollForTaskRequest) Send(ctx context.Context) (*PollForTaskResponse, error)
Send marshals and sends the PollForTask API request.
type PollForTaskResponse ¶ added in v0.9.0
type PollForTaskResponse struct { *PollForTaskOutput // contains filtered or unexported fields }
PollForTaskResponse is the response type for the PollForTask API operation.
func (*PollForTaskResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PollForTaskResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PollForTask request.
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.
func (PutPipelineDefinitionInput) String ¶
func (s PutPipelineDefinitionInput) String() string
String returns the string representation
func (*PutPipelineDefinitionInput) Validate ¶
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.
func (PutPipelineDefinitionOutput) String ¶
func (s PutPipelineDefinitionOutput) String() string
String returns the string representation
type PutPipelineDefinitionRequest ¶
type PutPipelineDefinitionRequest struct { *aws.Request Input *PutPipelineDefinitionInput Copy func(*PutPipelineDefinitionInput) PutPipelineDefinitionRequest }
PutPipelineDefinitionRequest is the request type for the PutPipelineDefinition API operation.
func (PutPipelineDefinitionRequest) Send ¶
func (r PutPipelineDefinitionRequest) Send(ctx context.Context) (*PutPipelineDefinitionResponse, error)
Send marshals and sends the PutPipelineDefinition API request.
type PutPipelineDefinitionResponse ¶ added in v0.9.0
type PutPipelineDefinitionResponse struct { *PutPipelineDefinitionOutput // contains filtered or unexported fields }
PutPipelineDefinitionResponse is the response type for the PutPipelineDefinition API operation.
func (*PutPipelineDefinitionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PutPipelineDefinitionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PutPipelineDefinition request.
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.
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.
func (QueryObjectsInput) String ¶
func (s QueryObjectsInput) String() string
String returns the string representation
func (*QueryObjectsInput) Validate ¶
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.
func (QueryObjectsOutput) String ¶
func (s QueryObjectsOutput) String() string
String returns the string representation
type QueryObjectsPaginator ¶ added in v0.9.0
QueryObjectsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewQueryObjectsPaginator ¶ added in v0.9.0
func NewQueryObjectsPaginator(req QueryObjectsRequest) QueryObjectsPaginator
NewQueryObjectsRequestPaginator returns a paginator for QueryObjects. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.QueryObjectsRequest(input) p := datapipeline.NewQueryObjectsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*QueryObjectsPaginator) CurrentPage ¶ added in v0.9.0
func (p *QueryObjectsPaginator) CurrentPage() *QueryObjectsOutput
type QueryObjectsRequest ¶
type QueryObjectsRequest struct { *aws.Request Input *QueryObjectsInput Copy func(*QueryObjectsInput) QueryObjectsRequest }
QueryObjectsRequest is the request type for the QueryObjects API operation.
func (QueryObjectsRequest) Send ¶
func (r QueryObjectsRequest) Send(ctx context.Context) (*QueryObjectsResponse, error)
Send marshals and sends the QueryObjects API request.
type QueryObjectsResponse ¶ added in v0.9.0
type QueryObjectsResponse struct { *QueryObjectsOutput // contains filtered or unexported fields }
QueryObjectsResponse is the response type for the QueryObjects API operation.
func (*QueryObjectsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *QueryObjectsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the QueryObjects request.
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.
func (RemoveTagsInput) String ¶
func (s RemoveTagsInput) String() string
String returns the string representation
func (*RemoveTagsInput) Validate ¶
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.
func (RemoveTagsOutput) String ¶
func (s RemoveTagsOutput) String() string
String returns the string representation
type RemoveTagsRequest ¶
type RemoveTagsRequest struct { *aws.Request Input *RemoveTagsInput Copy func(*RemoveTagsInput) RemoveTagsRequest }
RemoveTagsRequest is the request type for the RemoveTags API operation.
func (RemoveTagsRequest) Send ¶
func (r RemoveTagsRequest) Send(ctx context.Context) (*RemoveTagsResponse, error)
Send marshals and sends the RemoveTags API request.
type RemoveTagsResponse ¶ added in v0.9.0
type RemoveTagsResponse struct { *RemoveTagsOutput // contains filtered or unexported fields }
RemoveTagsResponse is the response type for the RemoveTags API operation.
func (*RemoveTagsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *RemoveTagsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the RemoveTags request.
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.
func (ReportTaskProgressInput) String ¶
func (s ReportTaskProgressInput) String() string
String returns the string representation
func (*ReportTaskProgressInput) Validate ¶
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.
func (ReportTaskProgressOutput) String ¶
func (s ReportTaskProgressOutput) String() string
String returns the string representation
type ReportTaskProgressRequest ¶
type ReportTaskProgressRequest struct { *aws.Request Input *ReportTaskProgressInput Copy func(*ReportTaskProgressInput) ReportTaskProgressRequest }
ReportTaskProgressRequest is the request type for the ReportTaskProgress API operation.
func (ReportTaskProgressRequest) Send ¶
func (r ReportTaskProgressRequest) Send(ctx context.Context) (*ReportTaskProgressResponse, error)
Send marshals and sends the ReportTaskProgress API request.
type ReportTaskProgressResponse ¶ added in v0.9.0
type ReportTaskProgressResponse struct { *ReportTaskProgressOutput // contains filtered or unexported fields }
ReportTaskProgressResponse is the response type for the ReportTaskProgress API operation.
func (*ReportTaskProgressResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ReportTaskProgressResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ReportTaskProgress request.
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.
func (ReportTaskRunnerHeartbeatInput) String ¶
func (s ReportTaskRunnerHeartbeatInput) String() string
String returns the string representation
func (*ReportTaskRunnerHeartbeatInput) Validate ¶
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.
func (ReportTaskRunnerHeartbeatOutput) String ¶
func (s ReportTaskRunnerHeartbeatOutput) String() string
String returns the string representation
type ReportTaskRunnerHeartbeatRequest ¶
type ReportTaskRunnerHeartbeatRequest struct { *aws.Request Input *ReportTaskRunnerHeartbeatInput Copy func(*ReportTaskRunnerHeartbeatInput) ReportTaskRunnerHeartbeatRequest }
ReportTaskRunnerHeartbeatRequest is the request type for the ReportTaskRunnerHeartbeat API operation.
func (ReportTaskRunnerHeartbeatRequest) Send ¶
func (r ReportTaskRunnerHeartbeatRequest) Send(ctx context.Context) (*ReportTaskRunnerHeartbeatResponse, error)
Send marshals and sends the ReportTaskRunnerHeartbeat API request.
type ReportTaskRunnerHeartbeatResponse ¶ added in v0.9.0
type ReportTaskRunnerHeartbeatResponse struct { *ReportTaskRunnerHeartbeatOutput // contains filtered or unexported fields }
ReportTaskRunnerHeartbeatResponse is the response type for the ReportTaskRunnerHeartbeat API operation.
func (*ReportTaskRunnerHeartbeatResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ReportTaskRunnerHeartbeatResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ReportTaskRunnerHeartbeat request.
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.
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.
func (SetStatusInput) String ¶
func (s SetStatusInput) String() string
String returns the string representation
func (*SetStatusInput) Validate ¶
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
}
func (SetStatusOutput) String ¶
func (s SetStatusOutput) String() string
String returns the string representation
type SetStatusRequest ¶
type SetStatusRequest struct { *aws.Request Input *SetStatusInput Copy func(*SetStatusInput) SetStatusRequest }
SetStatusRequest is the request type for the SetStatus API operation.
func (SetStatusRequest) Send ¶
func (r SetStatusRequest) Send(ctx context.Context) (*SetStatusResponse, error)
Send marshals and sends the SetStatus API request.
type SetStatusResponse ¶ added in v0.9.0
type SetStatusResponse struct { *SetStatusOutput // contains filtered or unexported fields }
SetStatusResponse is the response type for the SetStatus API operation.
func (*SetStatusResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *SetStatusResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the SetStatus request.
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 TaskStatus `locationName:"taskStatus" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Contains the parameters for SetTaskStatus.
func (SetTaskStatusInput) String ¶
func (s SetTaskStatusInput) String() string
String returns the string representation
func (*SetTaskStatusInput) Validate ¶
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.
func (SetTaskStatusOutput) String ¶
func (s SetTaskStatusOutput) String() string
String returns the string representation
type SetTaskStatusRequest ¶
type SetTaskStatusRequest struct { *aws.Request Input *SetTaskStatusInput Copy func(*SetTaskStatusInput) SetTaskStatusRequest }
SetTaskStatusRequest is the request type for the SetTaskStatus API operation.
func (SetTaskStatusRequest) Send ¶
func (r SetTaskStatusRequest) Send(ctx context.Context) (*SetTaskStatusResponse, error)
Send marshals and sends the SetTaskStatus API request.
type SetTaskStatusResponse ¶ added in v0.9.0
type SetTaskStatusResponse struct { *SetTaskStatusOutput // contains filtered or unexported fields }
SetTaskStatusResponse is the response type for the SetTaskStatus API operation.
func (*SetTaskStatusResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *SetTaskStatusResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the SetTaskStatus request.
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.
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.
func (TaskObject) String ¶
func (s TaskObject) String() string
String returns the string representation
type TaskStatus ¶
type TaskStatus string
const ( TaskStatusFinished TaskStatus = "FINISHED" TaskStatusFailed TaskStatus = "FAILED" TaskStatusFalse TaskStatus = "FALSE" )
Enum values for TaskStatus
func (TaskStatus) MarshalValue ¶ added in v0.3.0
func (enum TaskStatus) MarshalValue() (string, error)
func (TaskStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum TaskStatus) MarshalValueBuf(b []byte) ([]byte, error)
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.
func (ValidatePipelineDefinitionInput) String ¶
func (s ValidatePipelineDefinitionInput) String() string
String returns the string representation
func (*ValidatePipelineDefinitionInput) Validate ¶
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.
func (ValidatePipelineDefinitionOutput) String ¶
func (s ValidatePipelineDefinitionOutput) String() string
String returns the string representation
type ValidatePipelineDefinitionRequest ¶
type ValidatePipelineDefinitionRequest struct { *aws.Request Input *ValidatePipelineDefinitionInput Copy func(*ValidatePipelineDefinitionInput) ValidatePipelineDefinitionRequest }
ValidatePipelineDefinitionRequest is the request type for the ValidatePipelineDefinition API operation.
func (ValidatePipelineDefinitionRequest) Send ¶
func (r ValidatePipelineDefinitionRequest) Send(ctx context.Context) (*ValidatePipelineDefinitionResponse, error)
Send marshals and sends the ValidatePipelineDefinition API request.
type ValidatePipelineDefinitionResponse ¶ added in v0.9.0
type ValidatePipelineDefinitionResponse struct { *ValidatePipelineDefinitionOutput // contains filtered or unexported fields }
ValidatePipelineDefinitionResponse is the response type for the ValidatePipelineDefinition API operation.
func (*ValidatePipelineDefinitionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ValidatePipelineDefinitionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ValidatePipelineDefinition request.
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.
func (ValidationError) String ¶
func (s ValidationError) String() string
String returns the string representation
type ValidationWarning ¶
type ValidationWarning struct { // The identifier of the object that contains the validation warning. Id *string `locationName:"id" 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.
func (ValidationWarning) String ¶
func (s ValidationWarning) String() string
String returns the string representation
Source Files ¶
- api_client.go
- api_doc.go
- api_enums.go
- api_errors.go
- api_op_ActivatePipeline.go
- api_op_AddTags.go
- api_op_CreatePipeline.go
- api_op_DeactivatePipeline.go
- api_op_DeletePipeline.go
- api_op_DescribeObjects.go
- api_op_DescribePipelines.go
- api_op_EvaluateExpression.go
- api_op_GetPipelineDefinition.go
- api_op_ListPipelines.go
- api_op_PollForTask.go
- api_op_PutPipelineDefinition.go
- api_op_QueryObjects.go
- api_op_RemoveTags.go
- api_op_ReportTaskProgress.go
- api_op_ReportTaskRunnerHeartbeat.go
- api_op_SetStatus.go
- api_op_SetTaskStatus.go
- api_op_ValidatePipelineDefinition.go
- api_types.go
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. |