Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Field

type Field struct {

	// The field identifier.
	//
	// This member is required.
	Key *string

	// The field value, expressed as the identifier of another object.
	RefValue *string

	// The field value, expressed as a String.
	StringValue *string
}

    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 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
    
    	// A signature which can be used to verify the accuracy and authenticity of the
    	// information provided in the instance identity document.
    	Signature *string
    }

      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 (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.

      type InternalServiceError

      type InternalServiceError struct {
      	Message *string
      }

        An internal service error occurred.

        func (*InternalServiceError) Error

        func (e *InternalServiceError) Error() string

        func (*InternalServiceError) ErrorCode

        func (e *InternalServiceError) ErrorCode() string

        func (*InternalServiceError) ErrorFault

        func (e *InternalServiceError) ErrorFault() smithy.ErrorFault

        func (*InternalServiceError) ErrorMessage

        func (e *InternalServiceError) ErrorMessage() string

        type InvalidRequestException

        type InvalidRequestException struct {
        	Message *string
        }

          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.

          func (*InvalidRequestException) Error

          func (e *InvalidRequestException) Error() string

          func (*InvalidRequestException) ErrorCode

          func (e *InvalidRequestException) ErrorCode() string

          func (*InvalidRequestException) ErrorFault

          func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault

          func (*InvalidRequestException) ErrorMessage

          func (e *InvalidRequestException) ErrorMessage() string

          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
          
          	// The value that the actual field value will be compared with.
          	Values []string
          }

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

            type OperatorType

            type OperatorType string
            const (
            	OperatorTypeEqual              OperatorType = "EQ"
            	OperatorTypeReferenceEqual     OperatorType = "REF_EQ"
            	OperatorTypeLessThanOrEqual    OperatorType = "LE"
            	OperatorTypeGreaterThanOrEqual OperatorType = "GE"
            	OperatorTypeBetween            OperatorType = "BETWEEN"
            )

              Enum values for OperatorType

              func (OperatorType) Values

              func (OperatorType) Values() []OperatorType

                Values returns all known values for OperatorType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                type ParameterAttribute

                type ParameterAttribute struct {
                
                	// The field identifier.
                	//
                	// This member is required.
                	Key *string
                
                	// The field value, expressed as a String.
                	//
                	// This member is required.
                	StringValue *string
                }

                  The attributes allowed or specified with a parameter object.

                  type ParameterObject

                  type ParameterObject struct {
                  
                  	// The attributes of the parameter object.
                  	//
                  	// This member is required.
                  	Attributes []ParameterAttribute
                  
                  	// The ID of the parameter object.
                  	//
                  	// This member is required.
                  	Id *string
                  }

                    Contains information about a parameter object.

                    type ParameterValue

                    type ParameterValue struct {
                    
                    	// The ID of the parameter value.
                    	//
                    	// This member is required.
                    	Id *string
                    
                    	// The field value, expressed as a String.
                    	//
                    	// This member is required.
                    	StringValue *string
                    }

                      A value or list of parameter values.

                      type PipelineDeletedException

                      type PipelineDeletedException struct {
                      	Message *string
                      }

                        The specified pipeline has been deleted.

                        func (*PipelineDeletedException) Error

                        func (e *PipelineDeletedException) Error() string

                        func (*PipelineDeletedException) ErrorCode

                        func (e *PipelineDeletedException) ErrorCode() string

                        func (*PipelineDeletedException) ErrorFault

                        func (e *PipelineDeletedException) ErrorFault() smithy.ErrorFault

                        func (*PipelineDeletedException) ErrorMessage

                        func (e *PipelineDeletedException) ErrorMessage() string

                        type PipelineDescription

                        type PipelineDescription struct {
                        
                        	// A list of read-only fields that contain metadata about the pipeline: @userId,
                        	// @accountId, and @pipelineState.
                        	//
                        	// This member is required.
                        	Fields []Field
                        
                        	// The name of the pipeline.
                        	//
                        	// This member is required.
                        	Name *string
                        
                        	// The pipeline identifier that was assigned by AWS Data Pipeline. This is a string
                        	// of the form df-297EG78HU43EEXAMPLE.
                        	//
                        	// This member is required.
                        	PipelineId *string
                        
                        	// Description of the pipeline.
                        	Description *string
                        
                        	// 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
                        	// (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html)
                        	// in the AWS Data Pipeline Developer Guide.
                        	Tags []Tag
                        }

                          Contains pipeline metadata.

                          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
                          
                          	// The name of the pipeline.
                          	Name *string
                          }

                            Contains the name and identifier of a pipeline.

                            type PipelineNotFoundException

                            type PipelineNotFoundException struct {
                            	Message *string
                            }

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

                              func (*PipelineNotFoundException) Error

                              func (e *PipelineNotFoundException) Error() string

                              func (*PipelineNotFoundException) ErrorCode

                              func (e *PipelineNotFoundException) ErrorCode() string

                              func (*PipelineNotFoundException) ErrorFault

                              func (*PipelineNotFoundException) ErrorMessage

                              func (e *PipelineNotFoundException) ErrorMessage() string

                              type PipelineObject

                              type PipelineObject struct {
                              
                              	// Key-value pairs that define the properties of the object.
                              	//
                              	// This member is required.
                              	Fields []Field
                              
                              	// The ID of the object.
                              	//
                              	// This member is required.
                              	Id *string
                              
                              	// The name of the object.
                              	//
                              	// This member is required.
                              	Name *string
                              }

                                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.

                                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
                                }

                                  Defines the query to run against an object.

                                  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
                                  
                                  	// Contains a logical operation for comparing the value of a field with a specified
                                  	// value.
                                  	Operator *Operator
                                  }

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

                                    type Tag

                                    type Tag struct {
                                    
                                    	// The key name of a tag defined by a user. 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.
                                    	//
                                    	// This member is required.
                                    	Key *string
                                    
                                    	// The optional value portion of a tag defined by a user. 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.
                                    	//
                                    	// This member is required.
                                    	Value *string
                                    }

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

                                      type TaskNotFoundException

                                      type TaskNotFoundException struct {
                                      	Message *string
                                      }

                                        The specified task was not found.

                                        func (*TaskNotFoundException) Error

                                        func (e *TaskNotFoundException) Error() string

                                        func (*TaskNotFoundException) ErrorCode

                                        func (e *TaskNotFoundException) ErrorCode() string

                                        func (*TaskNotFoundException) ErrorFault

                                        func (e *TaskNotFoundException) ErrorFault() smithy.ErrorFault

                                        func (*TaskNotFoundException) ErrorMessage

                                        func (e *TaskNotFoundException) ErrorMessage() string

                                        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
                                        
                                        	// Connection information for the location where the task runner will publish the
                                        	// output of the task.
                                        	Objects map[string]PipelineObject
                                        
                                        	// The ID of the pipeline that provided the task.
                                        	PipelineId *string
                                        
                                        	// An internal identifier for the task. This ID is passed to the SetTaskStatus and
                                        	// ReportTaskProgress actions.
                                        	TaskId *string
                                        }

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

                                          type TaskStatus

                                          type TaskStatus string
                                          const (
                                          	TaskStatusFinished TaskStatus = "FINISHED"
                                          	TaskStatusFailed   TaskStatus = "FAILED"
                                          	TaskStatusFalse    TaskStatus = "FALSE"
                                          )

                                            Enum values for TaskStatus

                                            func (TaskStatus) Values

                                            func (TaskStatus) Values() []TaskStatus

                                              Values returns all known values for TaskStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                              type ValidationError

                                              type ValidationError struct {
                                              
                                              	// A description of the validation error.
                                              	Errors []string
                                              
                                              	// The identifier of the object that contains the validation error.
                                              	Id *string
                                              }

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

                                                type ValidationWarning

                                                type ValidationWarning struct {
                                                
                                                	// The identifier of the object that contains the validation warning.
                                                	Id *string
                                                
                                                	// A description of the validation warning.
                                                	Warnings []string
                                                }

                                                  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.