package datapipeline
import "github.com/aws/aws-sdk-go-v2/service/datapipeline"
Index ¶
- Constants
- func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
- type ActivatePipelineInput
- type ActivatePipelineOutput
- type AddTagsInput
- type AddTagsOutput
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) ActivatePipeline(ctx context.Context, params *ActivatePipelineInput, optFns ...func(*Options)) (*ActivatePipelineOutput, error)
- func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...func(*Options)) (*AddTagsOutput, error)
- func (c *Client) CreatePipeline(ctx context.Context, params *CreatePipelineInput, optFns ...func(*Options)) (*CreatePipelineOutput, error)
- func (c *Client) DeactivatePipeline(ctx context.Context, params *DeactivatePipelineInput, optFns ...func(*Options)) (*DeactivatePipelineOutput, error)
- func (c *Client) DeletePipeline(ctx context.Context, params *DeletePipelineInput, optFns ...func(*Options)) (*DeletePipelineOutput, error)
- func (c *Client) DescribeObjects(ctx context.Context, params *DescribeObjectsInput, optFns ...func(*Options)) (*DescribeObjectsOutput, error)
- func (c *Client) DescribePipelines(ctx context.Context, params *DescribePipelinesInput, optFns ...func(*Options)) (*DescribePipelinesOutput, error)
- func (c *Client) EvaluateExpression(ctx context.Context, params *EvaluateExpressionInput, optFns ...func(*Options)) (*EvaluateExpressionOutput, error)
- func (c *Client) GetPipelineDefinition(ctx context.Context, params *GetPipelineDefinitionInput, optFns ...func(*Options)) (*GetPipelineDefinitionOutput, error)
- func (c *Client) ListPipelines(ctx context.Context, params *ListPipelinesInput, optFns ...func(*Options)) (*ListPipelinesOutput, error)
- func (c *Client) PollForTask(ctx context.Context, params *PollForTaskInput, optFns ...func(*Options)) (*PollForTaskOutput, error)
- func (c *Client) PutPipelineDefinition(ctx context.Context, params *PutPipelineDefinitionInput, optFns ...func(*Options)) (*PutPipelineDefinitionOutput, error)
- func (c *Client) QueryObjects(ctx context.Context, params *QueryObjectsInput, optFns ...func(*Options)) (*QueryObjectsOutput, error)
- func (c *Client) RemoveTags(ctx context.Context, params *RemoveTagsInput, optFns ...func(*Options)) (*RemoveTagsOutput, error)
- func (c *Client) ReportTaskProgress(ctx context.Context, params *ReportTaskProgressInput, optFns ...func(*Options)) (*ReportTaskProgressOutput, error)
- func (c *Client) ReportTaskRunnerHeartbeat(ctx context.Context, params *ReportTaskRunnerHeartbeatInput, optFns ...func(*Options)) (*ReportTaskRunnerHeartbeatOutput, error)
- func (c *Client) SetStatus(ctx context.Context, params *SetStatusInput, optFns ...func(*Options)) (*SetStatusOutput, error)
- func (c *Client) SetTaskStatus(ctx context.Context, params *SetTaskStatusInput, optFns ...func(*Options)) (*SetTaskStatusOutput, error)
- func (c *Client) ValidatePipelineDefinition(ctx context.Context, params *ValidatePipelineDefinitionInput, optFns ...func(*Options)) (*ValidatePipelineDefinitionOutput, error)
- type CreatePipelineInput
- type CreatePipelineOutput
- type DeactivatePipelineInput
- type DeactivatePipelineOutput
- type DeletePipelineInput
- type DeletePipelineOutput
- type DescribeObjectsInput
- type DescribeObjectsOutput
- type DescribePipelinesInput
- type DescribePipelinesOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EvaluateExpressionInput
- type EvaluateExpressionOutput
- type GetPipelineDefinitionInput
- type GetPipelineDefinitionOutput
- type HTTPClient
- type HTTPSignerV4
- type ListPipelinesInput
- type ListPipelinesOutput
- type Options
- func (o Options) Copy() Options
- func (o Options) GetCredentials() aws.CredentialsProvider
- func (o Options) GetEndpointOptions() ResolverOptions
- func (o Options) GetEndpointResolver() EndpointResolver
- func (o Options) GetHTTPSignerV4() HTTPSignerV4
- func (o Options) GetRegion() string
- func (o Options) GetRetryer() retry.Retryer
- type PollForTaskInput
- type PollForTaskOutput
- type PutPipelineDefinitionInput
- type PutPipelineDefinitionOutput
- type QueryObjectsInput
- type QueryObjectsOutput
- type RemoveTagsInput
- type RemoveTagsOutput
- type ReportTaskProgressInput
- type ReportTaskProgressOutput
- type ReportTaskRunnerHeartbeatInput
- type ReportTaskRunnerHeartbeatOutput
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type ResolveEndpointMiddlewareOptions
- type ResolverOptions
- type SetStatusInput
- type SetStatusOutput
- type SetTaskStatusInput
- type SetTaskStatusOutput
- type ValidatePipelineDefinitionInput
- type ValidatePipelineDefinitionOutput
Constants ¶
const ServiceAPIVersion = "2012-10-29"
const ServiceID = "Data Pipeline"
Functions ¶
func AddResolveEndpointMiddleware ¶
func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func RemoveResolveEndpointMiddleware ¶
func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
Types ¶
type ActivatePipelineInput ¶
type ActivatePipelineInput struct { // A list of parameter values to pass to the pipeline at activation. ParameterValues []*types.ParameterValue // The ID of the pipeline. PipelineId *string // The date and time to resume the pipeline. By default, the pipeline resumes from // the last completed execution. StartTimestamp *time.Time }
Contains the parameters for ActivatePipeline.
type ActivatePipelineOutput ¶
type ActivatePipelineOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Contains the output of ActivatePipeline.
type AddTagsInput ¶
type AddTagsInput struct { // The ID of the pipeline. PipelineId *string // The tags to add, as key/value pairs. Tags []*types.Tag }
Contains the parameters for AddTags.
type AddTagsOutput ¶
type AddTagsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Contains the output of AddTags.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
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. <p>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.</p> <p>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.</p>
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) ActivatePipeline ¶
func (c *Client) ActivatePipeline(ctx context.Context, params *ActivatePipelineInput, optFns ...func(*Options)) (*ActivatePipelineOutput, error)
Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails. If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call DeactivatePipeline (). To activate a finished pipeline, modify the end date for the pipeline and then activate it. If you activate an on-demand pipeline that is already running, it will cancel all running objects and re-run the pipeline. StartTimestamp does not apply to on-demand pipelines.
func (*Client) AddTags ¶
func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...func(*Options)) (*AddTagsOutput, error)
Adds or modifies tags for the specified pipeline.
func (*Client) CreatePipeline ¶
func (c *Client) CreatePipeline(ctx context.Context, params *CreatePipelineInput, optFns ...func(*Options)) (*CreatePipelineOutput, error)
Creates a new, empty pipeline. Use PutPipelineDefinition () to populate the pipeline.
func (*Client) DeactivatePipeline ¶
func (c *Client) DeactivatePipeline(ctx context.Context, params *DeactivatePipelineInput, optFns ...func(*Options)) (*DeactivatePipelineOutput, error)
Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes. To resume a deactivated pipeline, use ActivatePipeline (). By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.
func (*Client) DeletePipeline ¶
func (c *Client) DeletePipeline(ctx context.Context, params *DeletePipelineInput, optFns ...func(*Options)) (*DeletePipelineOutput, error)
Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners. Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call SetStatus () with the status set to PAUSE on individual components. Components that are paused by SetStatus () can be resumed.
func (*Client) DescribeObjects ¶
func (c *Client) DescribeObjects(ctx context.Context, params *DescribeObjectsInput, optFns ...func(*Options)) (*DescribeObjectsOutput, error)
Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.
func (*Client) DescribePipelines ¶
func (c *Client) DescribePipelines(ctx context.Context, params *DescribePipelinesInput, optFns ...func(*Options)) (*DescribePipelinesOutput, error)
Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions. To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition ().
func (*Client) EvaluateExpression ¶
func (c *Client) EvaluateExpression(ctx context.Context, params *EvaluateExpressionInput, optFns ...func(*Options)) (*EvaluateExpressionOutput, error)
Task runners call EvaluateExpression to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3.
func (*Client) GetPipelineDefinition ¶
func (c *Client) GetPipelineDefinition(ctx context.Context, params *GetPipelineDefinitionInput, optFns ...func(*Options)) (*GetPipelineDefinitionOutput, error)
Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition ().
func (*Client) ListPipelines ¶
func (c *Client) ListPipelines(ctx context.Context, params *ListPipelinesInput, optFns ...func(*Options)) (*ListPipelinesOutput, error)
Lists the pipeline identifiers for all active pipelines that you have permission to access.
func (*Client) PollForTask ¶
func (c *Client) PollForTask(ctx context.Context, params *PollForTaskInput, optFns ...func(*Options)) (*PollForTaskOutput, error)
Task runners call PollForTask to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the workerGroup parameter. The task returned can come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner. If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call PollForTask again on the same workerGroup until it receives a response, and this can take up to 90 seconds.
func (*Client) PutPipelineDefinition ¶
func (c *Client) PutPipelineDefinition(ctx context.Context, params *PutPipelineDefinitionInput, optFns ...func(*Options)) (*PutPipelineDefinitionOutput, error)
Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline. PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following validation errors exist 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 allowed maximum number of objects.
- The pipeline is in a
FINISHED state.
Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition () action.
func (*Client) QueryObjects ¶
func (c *Client) QueryObjects(ctx context.Context, params *QueryObjectsInput, optFns ...func(*Options)) (*QueryObjectsOutput, error)
Queries the specified pipeline for the names of objects that match the specified set of conditions.
func (*Client) RemoveTags ¶
func (c *Client) RemoveTags(ctx context.Context, params *RemoveTagsInput, optFns ...func(*Options)) (*RemoveTagsOutput, error)
Removes existing tags from the specified pipeline.
func (*Client) ReportTaskProgress ¶
func (c *Client) ReportTaskProgress(ctx context.Context, params *ReportTaskProgressInput, optFns ...func(*Options)) (*ReportTaskProgressOutput, error)
Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent PollForTask () call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a reportProgressTimeout field in your pipeline.
func (*Client) ReportTaskRunnerHeartbeat ¶
func (c *Client) ReportTaskRunnerHeartbeat(ctx context.Context, params *ReportTaskRunnerHeartbeatInput, optFns ...func(*Options)) (*ReportTaskRunnerHeartbeatOutput, error)
Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance.
func (*Client) SetStatus ¶
func (c *Client) SetStatus(ctx context.Context, params *SetStatusInput, optFns ...func(*Options)) (*SetStatusOutput, error)
Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on FINISHED pipelines and attempting to do so returns InvalidRequestException.
func (*Client) SetTaskStatus ¶
func (c *Client) SetTaskStatus(ctx context.Context, params *SetTaskStatusInput, optFns ...func(*Options)) (*SetTaskStatusOutput, error)
Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress ().
func (*Client) ValidatePipelineDefinition ¶
func (c *Client) ValidatePipelineDefinition(ctx context.Context, params *ValidatePipelineDefinitionInput, optFns ...func(*Options)) (*ValidatePipelineDefinitionOutput, error)
Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
type CreatePipelineInput ¶
type CreatePipelineInput struct { // 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 // (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) // in the AWS Data Pipeline Developer Guide. Tags []*types.Tag // The name for the pipeline. You can use the same name for multiple pipelines // associated with your AWS account, because AWS Data Pipeline assigns each // pipeline a unique pipeline identifier. Name *string // A unique identifier. This identifier is not the same as the pipeline identifier // assigned by AWS Data Pipeline. You are responsible for defining the format and // ensuring the uniqueness of this identifier. You use this parameter to ensure // idempotency during repeated calls to CreatePipeline. For example, if the first // call to CreatePipeline does not succeed, you can pass in the same unique // identifier and pipeline name combination on a subsequent call to CreatePipeline. // CreatePipeline ensures that if a pipeline already exists with the same name and // unique identifier, a new pipeline is not created. Instead, you'll receive the // pipeline identifier from the previous attempt. The uniqueness of the name and // unique identifier combination is scoped to the AWS account or IAM user // credentials. UniqueId *string // The description for the pipeline. Description *string }
Contains the parameters for CreatePipeline.
type CreatePipelineOutput ¶
type CreatePipelineOutput struct { // The ID that AWS Data Pipeline assigns the newly created pipeline. For example, // df-06372391ZG65EXAMPLE. PipelineId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Contains the output of CreatePipeline.
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 // The ID of the pipeline. PipelineId *string }
Contains the parameters for DeactivatePipeline.
type DeactivatePipelineOutput ¶
type DeactivatePipelineOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Contains the output of DeactivatePipeline.
type DeletePipelineInput ¶
type DeletePipelineInput struct { // The ID of the pipeline. PipelineId *string }
Contains the parameters for DeletePipeline.
type DeletePipelineOutput ¶
type DeletePipelineOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeObjectsInput ¶
type DescribeObjectsInput struct { // The ID of the pipeline that contains the object definitions. PipelineId *string // The IDs of the pipeline objects that contain the definitions to be described. // You can pass as many as 25 identifiers in a single call to DescribeObjects. ObjectIds []*string // Indicates whether any expressions in the object should be evaluated when the // object descriptions are returned. EvaluateExpressions *bool // 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 }
Contains the parameters for DescribeObjects.
type DescribeObjectsOutput ¶
type DescribeObjectsOutput struct { // 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 // An array of object definitions. PipelineObjects []*types.PipelineObject // Indicates whether there are more results to return. HasMoreResults *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Contains the output of DescribeObjects.
type DescribePipelinesInput ¶
type DescribePipelinesInput struct { // The IDs of the pipelines to describe. You can pass as many as 25 identifiers in // a single call. To obtain pipeline IDs, call ListPipelines (). PipelineIds []*string }
Contains the parameters for DescribePipelines.
type DescribePipelinesOutput ¶
type DescribePipelinesOutput struct { // An array of descriptions for the specified pipelines. PipelineDescriptionList []*types.PipelineDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Contains the output of DescribePipelines.
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)
type EvaluateExpressionInput ¶
type EvaluateExpressionInput struct { // The ID of the pipeline. PipelineId *string // The expression to evaluate. Expression *string // The ID of the object. ObjectId *string }
Contains the parameters for EvaluateExpression.
type EvaluateExpressionOutput ¶
type EvaluateExpressionOutput struct { // The evaluated expression. EvaluatedExpression *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Contains the output of EvaluateExpression.
type GetPipelineDefinitionInput ¶
type GetPipelineDefinitionInput struct { // 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 // The ID of the pipeline. PipelineId *string }
Contains the parameters for GetPipelineDefinition.
type GetPipelineDefinitionOutput ¶
type GetPipelineDefinitionOutput struct { // The objects defined in the pipeline. PipelineObjects []*types.PipelineObject // The parameter values used in the pipeline definition. ParameterValues []*types.ParameterValue // The parameter objects used in the pipeline definition. ParameterObjects []*types.ParameterObject // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Contains the output of GetPipelineDefinition.
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error }
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 }
Contains the parameters for ListPipelines.
type ListPipelinesOutput ¶
type ListPipelinesOutput struct { // Indicates whether there are more results that can be obtained by a subsequent // call. HasMoreResults *bool // The pipeline identifiers. If you require additional information about the // pipelines, you can use these identifiers to call DescribePipelines () and // GetPipelineDefinition (). PipelineIdList []*types.PipelineIdName // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Contains the output of ListPipelines.
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions ResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer retry.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
func (Options) GetCredentials ¶
func (o Options) GetCredentials() aws.CredentialsProvider
func (Options) GetEndpointOptions ¶
func (o Options) GetEndpointOptions() ResolverOptions
func (Options) GetEndpointResolver ¶
func (o Options) GetEndpointResolver() EndpointResolver
func (Options) GetHTTPSignerV4 ¶
func (o Options) GetHTTPSignerV4() HTTPSignerV4
func (Options) GetRegion ¶
func (Options) GetRetryer ¶
type PollForTaskInput ¶
type PollForTaskInput struct { // The type of task the task runner is configured to accept and process. The worker // group is set as a field on objects in the pipeline when they are created. You // can only specify a single value for workerGroup in the call to PollForTask. // There are no wildcard values permitted in workerGroup; the string must be an // exact, case-sensitive, match. WorkerGroup *string // 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 // (https://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 *types.InstanceIdentity // The public DNS name of the calling task runner. Hostname *string }
Contains the parameters for PollForTask.
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 *types.TaskObject // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Contains the output of PollForTask.
type PutPipelineDefinitionInput ¶
type PutPipelineDefinitionInput struct { // The objects that define the pipeline. These objects overwrite the existing // pipeline definition. PipelineObjects []*types.PipelineObject // The ID of the pipeline. PipelineId *string // The parameter objects used with the pipeline. ParameterObjects []*types.ParameterObject // The parameter values used with the pipeline. ParameterValues []*types.ParameterValue }
Contains the parameters for PutPipelineDefinition.
type PutPipelineDefinitionOutput ¶
type PutPipelineDefinitionOutput struct { // Indicates whether there were validation errors, and the pipeline definition is // stored but cannot be activated until you correct the pipeline and call // PutPipelineDefinition to commit the corrected pipeline. Errored *bool // The validation errors that are associated with the objects defined in // pipelineObjects. ValidationErrors []*types.ValidationError // The validation warnings that are associated with the objects defined in // pipelineObjects. ValidationWarnings []*types.ValidationWarning // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Contains the output of PutPipelineDefinition.
type QueryObjectsInput ¶
type QueryObjectsInput struct { // Indicates whether the query applies to components or instances. The possible // values are: COMPONENT, INSTANCE, and ATTEMPT. Sphere *string // The maximum number of object names that QueryObjects will return in a single // call. The default value is 100. Limit *int32 // 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 *types.Query // 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 // The ID of the pipeline. PipelineId *string }
Contains the parameters for QueryObjects.
type QueryObjectsOutput ¶
type QueryObjectsOutput struct { // 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 // The identifiers that match the query selectors. Ids []*string // Indicates whether there are more results that can be obtained by a subsequent // call. HasMoreResults *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Contains the output of QueryObjects.
type RemoveTagsInput ¶
type RemoveTagsInput struct { // The keys of the tags to remove. TagKeys []*string // The ID of the pipeline. PipelineId *string }
Contains the parameters for RemoveTags.
type RemoveTagsOutput ¶
type RemoveTagsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Contains the output of RemoveTags.
type ReportTaskProgressInput ¶
type ReportTaskProgressInput struct { // Key-value pairs that define the properties of the ReportTaskProgressInput // object. Fields []*types.Field // The ID of the task assigned to the task runner. This value is provided in the // response for PollForTask (). TaskId *string }
Contains the parameters for ReportTaskProgress.
type ReportTaskProgressOutput ¶
type ReportTaskProgressOutput struct { // If true, the calling task runner should cancel processing of the task. The task // runner does not need to call SetTaskStatus () for canceled tasks. Canceled *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Contains the output of ReportTaskProgress.
type ReportTaskRunnerHeartbeatInput ¶
type ReportTaskRunnerHeartbeatInput struct { // The public DNS name of the task runner. Hostname *string // The ID of the task runner. This value should be unique across your AWS account. // In the case of AWS Data Pipeline Task Runner launched on a resource managed by // AWS Data Pipeline, the web service provides a unique identifier when it launches // the application. If you have written a custom task runner, you should assign a // unique identifier for the task runner. TaskrunnerId *string // 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 }
Contains the parameters for ReportTaskRunnerHeartbeat.
type ReportTaskRunnerHeartbeatOutput ¶
type ReportTaskRunnerHeartbeatOutput struct { // Indicates whether the calling task runner should terminate. Terminate *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Contains the output of ReportTaskRunnerHeartbeat.
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options ResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type ResolveEndpointMiddlewareOptions ¶
type ResolveEndpointMiddlewareOptions interface { GetEndpointResolver() EndpointResolver GetEndpointOptions() ResolverOptions }
type ResolverOptions ¶
type ResolverOptions = internalendpoints.Options
ResolverOptions is the service endpoint resolver options
type SetStatusInput ¶
type SetStatusInput struct { // The status to be set on all the objects specified in objectIds. For components, // use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED. Status *string // The ID of the pipeline that contains the objects. PipelineId *string // The IDs of the objects. The corresponding objects can be either physical or // components, but not a mix of both types. ObjectIds []*string }
Contains the parameters for SetStatus.
type SetStatusOutput ¶
type SetStatusOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type SetTaskStatusInput ¶
type SetTaskStatusInput struct { // 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 // If FINISHED, the task successfully completed. If FAILED, the task ended // unsuccessfully. Preconditions use false. TaskStatus types.TaskStatus // 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 // The ID of the task assigned to the task runner. This value is provided in the // response for PollForTask (). TaskId *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 }
Contains the parameters for SetTaskStatus.
type SetTaskStatusOutput ¶
type SetTaskStatusOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Contains the output of SetTaskStatus.
type ValidatePipelineDefinitionInput ¶
type ValidatePipelineDefinitionInput struct { // The objects that define the pipeline changes to validate against the pipeline. PipelineObjects []*types.PipelineObject // The parameter objects used with the pipeline. ParameterObjects []*types.ParameterObject // The ID of the pipeline. PipelineId *string // The parameter values used with the pipeline. ParameterValues []*types.ParameterValue }
Contains the parameters for ValidatePipelineDefinition.
type ValidatePipelineDefinitionOutput ¶
type ValidatePipelineDefinitionOutput struct { // Any validation errors that were found. ValidationErrors []*types.ValidationError // Indicates whether there were validation errors. Errored *bool // Any validation warnings that were found. ValidationWarnings []*types.ValidationWarning // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Contains the output of ValidatePipelineDefinition.
Source Files ¶
api_client.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 deserializers.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v0.1.0
- Published
- Sep 29, 2020
- Platform
- darwin/amd64
- Imports
- 25 packages
- Last checked
- now –
Tools for package owners.