datapipeline

type ActivatePipelineInput struct {
	// Returns a list of parameter values to pass to the pipeline at activation.
	ParameterValues []*ParameterValue `locationName:"parameterValues" type:"list"`

	// The identifier of the pipeline to activate.
	PipelineID *string `locationName:"pipelineId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

type AddTagsInput struct {
	// The identifier of the pipeline to which you want to add the tags.
	PipelineID *string `locationName:"pipelineId" type:"string" required:"true"`

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

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

type CreatePipelineInput struct {
	// The description of the new pipeline.
	Description *string `locationName:"description" type:"string"`

	// The name of the new pipeline. You can use the same name for multiple pipelines
	// associated with your AWS account, because AWS Data Pipeline assigns each
	// new pipeline a unique pipeline identifier.
	Name *string `locationName:"name" type:"string" required:"true"`

	// A list of tags to associate with a pipeline at creation time. 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 that you specify. 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 return a clear
	// success, 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
	// will not be 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 `locationName:"uniqueId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

type CreatePipelineOutput struct {
	// The ID that AWS Data Pipeline assigns the newly created pipeline. The ID
	// is a string of the form: df-06372391ZG65EXAMPLE.
	PipelineID *string `locationName:"pipelineId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

type DataPipeline struct {
	*aws.Service
}

type DeletePipelineInput struct {
	// The identifier of the pipeline to be deleted.
	PipelineID *string `locationName:"pipelineId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

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. The first time you call
	// DescribeObjects, this value should be empty. As long as the action returns
	// HasMoreResults as True, you can call DescribeObjects again and pass the marker
	// value from the response to retrieve the next set of results.
	Marker *string `locationName:"marker" type:"string"`

	// Identifiers 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 `locationName:"objectIds" type:"list" required:"true"`

	// Identifier of the pipeline that contains the object definitions.
	PipelineID *string `locationName:"pipelineId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

type DescribeObjectsOutput struct {
	// If True, there are more pages of 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.
	Marker *string `locationName:"marker" type:"string"`

	// An array of object definitions that are returned by the call to DescribeObjects.
	PipelineObjects []*PipelineObject `locationName:"pipelineObjects" type:"list" required:"true"`
	// contains filtered or unexported fields
}

type DescribePipelinesInput struct {
	// Identifiers of the pipelines to describe. You can pass as many as 25 identifiers
	// in a single call to DescribePipelines. You can obtain pipeline identifiers
	// by calling ListPipelines.
	PipelineIDs []*string `locationName:"pipelineIds" type:"list" required:"true"`
	// contains filtered or unexported fields
}

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

type EvaluateExpressionInput struct {
	// The expression to evaluate.
	Expression *string `locationName:"expression" type:"string" required:"true"`

	// The identifier of the object.
	ObjectID *string `locationName:"objectId" type:"string" required:"true"`

	// The identifier of the pipeline.
	PipelineID *string `locationName:"pipelineId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

type EvaluateExpressionOutput struct {
	// The evaluated expression.
	EvaluatedExpression *string `locationName:"evaluatedExpression" type:"string" required:"true"`
	// contains filtered or unexported fields
}

type Field struct {
	// The field identifier.
	Key *string `locationName:"key" type:"string" required:"true"`

	// The field value, expressed as the identifier of another object.
	RefValue *string `locationName:"refValue" type:"string"`

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

type GetPipelineDefinitionInput struct {
	// The identifier of the pipeline.
	PipelineID *string `locationName:"pipelineId" type:"string" required:"true"`

	// The version of the pipeline definition to retrieve. This parameter accepts
	// the values latest (default) and active. Where latest indicates the last definition
	// saved to the pipeline and active indicates the last definition of the pipeline
	// that was activated.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

type GetPipelineDefinitionOutput struct {
	// Returns a list of parameter objects used in the pipeline definition.
	ParameterObjects []*ParameterObject `locationName:"parameterObjects" type:"list"`

	// Returns a list of parameter values used in the pipeline definition.
	ParameterValues []*ParameterValue `locationName:"parameterValues" type:"list"`

	// An array of objects defined in the pipeline.
	PipelineObjects []*PipelineObject `locationName:"pipelineObjects" type:"list"`
	// contains filtered or unexported fields
}

type InstanceIdentity struct {
	// A description of an Amazon 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
}

type ListPipelinesInput struct {
	// The starting point for the results to be returned. The first time you call
	// ListPipelines, this value should be empty. As long as the action returns
	// HasMoreResults as True, you can call ListPipelines again and pass the marker
	// value from the response to retrieve the next set of results.
	Marker *string `locationName:"marker" type:"string"`
	// contains filtered or unexported fields
}

type ListPipelinesOutput struct {
	// If True, there are more results that can be obtained by a subsequent call
	// to ListPipelines.
	HasMoreResults *bool `locationName:"hasMoreResults" type:"boolean"`

	// If not null, indicates the starting point for the set of pipeline identifiers
	// that the next call to ListPipelines will retrieve. If null, there are no
	// more pipeline identifiers.
	Marker *string `locationName:"marker" type:"string"`

	// A list of all the pipeline identifiers that your account has permission to
	// access. If you require additional information about the pipelines, you can
	// use these identifiers to call DescribePipelines and GetPipelineDefinition.
	PipelineIDList []*PipelineIDName `locationName:"pipelineIdList" type:"list" required:"true"`
	// contains filtered or unexported fields
}

type Operator struct {
	// The logical operation to be performed: equal (EQ), equal reference (REF_EQ),
	// less than or equal (LE), greater than or equal (GE), or between (BETWEEN).
	// Equal reference (REF_EQ) can be used only with reference fields. The other
	// comparison types can be used only with String fields. The comparison types
	// you can use apply only to certain object fields, as detailed below.
	//
	//  The comparison operators EQ and REF_EQ act on the following fields:
	//
	//  name @sphere parent @componentParent @instanceParent @status @scheduledStartTime
	// @scheduledEndTime @actualStartTime @actualEndTime   The comparison operators
	// GE, LE, and BETWEEN act on the following fields:
	//
	//  @scheduledStartTime @scheduledEndTime @actualStartTime @actualEndTime
	// Note that fields beginning with the at sign (@) are read-only and set by
	// the web service. When you name fields, you should choose names containing
	// only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline.
	// User-defined fields that you add to a pipeline should prefix their name with
	// the string "my".
	Type *string `locationName:"type" type:"string"`

	// The value that the actual field value will be compared with.
	Values []*string `locationName:"values" type:"list"`
	// contains filtered or unexported fields
}

type ParameterAttribute struct {
	// The field identifier.
	Key *string `locationName:"key" type:"string" required:"true"`

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

type ParameterObject struct {
	// The attributes of the parameter object.
	Attributes []*ParameterAttribute `locationName:"attributes" type:"list" required:"true"`

	// Identifier of the parameter object.
	ID *string `locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

type ParameterValue struct {
	// Identifier of the parameter value.
	ID *string `locationName:"id" type:"string" required:"true"`

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

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

	// Name of the pipeline.
	Name *string `locationName:"name" type:"string" required:"true"`

	// The pipeline identifier that was assigned by AWS Data Pipeline. This is a
	// string of the form df-297EG78HU43EEXAMPLE.
	PipelineID *string `locationName:"pipelineId" 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
}

type PipelineIDName struct {
	// Identifier of the pipeline that was assigned by AWS Data Pipeline. This is
	// a string of the form df-297EG78HU43EEXAMPLE.
	ID *string `locationName:"id" type:"string"`

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

type PipelineObject struct {
	// Key-value pairs that define the properties of the object.
	Fields []*Field `locationName:"fields" type:"list" required:"true"`

	// Identifier of the object.
	ID *string `locationName:"id" type:"string" required:"true"`

	// Name of the object.
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

type PollForTaskInput struct {
	// The public DNS name of the calling task runner.
	Hostname *string `locationName:"hostname" type:"string"`

	// Identity information for the Amazon EC2 instance that is hosting the task
	// runner. You can get this value by calling the URI, http://169.254.169.254/latest/meta-data/instance-id,
	// from the EC2 instance. For more information, go to 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"`

	// Indicates 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 `locationName:"workerGroup" type:"string" required:"true"`
	// contains filtered or unexported fields
}

type PollForTaskOutput struct {
	// An instance of TaskObject. The returned object contains all 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
}

type PutPipelineDefinitionInput struct {
	// A list of parameter objects used with the pipeline.
	ParameterObjects []*ParameterObject `locationName:"parameterObjects" type:"list"`

	// A list of parameter values used with the pipeline.
	ParameterValues []*ParameterValue `locationName:"parameterValues" type:"list"`

	// The identifier of the pipeline to be configured.
	PipelineID *string `locationName:"pipelineId" type:"string" required:"true"`

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

type PutPipelineDefinitionOutput struct {
	// If True, there were validation errors. If errored is True, the pipeline definition
	// is stored but cannot be activated until you correct the pipeline and call
	// PutPipelineDefinition to commit the corrected pipeline.
	Errored *bool `locationName:"errored" type:"boolean" required:"true"`

	// A list of the validation errors that are associated with the objects defined
	// in pipelineObjects.
	ValidationErrors []*ValidationError `locationName:"validationErrors" type:"list"`

	// A list of the validation warnings that are associated with the objects defined
	// in pipelineObjects.
	ValidationWarnings []*ValidationWarning `locationName:"validationWarnings" type:"list"`
	// contains filtered or unexported fields
}

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
}

type QueryObjectsInput struct {
	// Specifies 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. The first time you call
	// QueryObjects, this value should be empty. As long as the action returns HasMoreResults
	// as True, you can call QueryObjects again and pass the marker value from the
	// response to retrieve the next set of results.
	Marker *string `locationName:"marker" type:"string"`

	// Identifier of the pipeline to be queried for object names.
	PipelineID *string `locationName:"pipelineId" type:"string" required:"true"`

	// 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"`

	// Specifies whether the query applies to components or instances. Allowable
	// values: COMPONENT, INSTANCE, ATTEMPT.
	Sphere *string `locationName:"sphere" type:"string" required:"true"`
	// contains filtered or unexported fields
}

type QueryObjectsOutput struct {
	// If True, there are more results that can be obtained by a subsequent call
	// to QueryObjects.
	HasMoreResults *bool `locationName:"hasMoreResults" type:"boolean"`

	// A list of identifiers that match the query selectors.
	IDs []*string `locationName:"ids" type:"list"`

	// The starting point for the results to be returned. As long as the action
	// returns HasMoreResults as True, you can call QueryObjects again and pass
	// the marker value from the response to retrieve the next set of results.
	Marker *string `locationName:"marker" type:"string"`
	// contains filtered or unexported fields
}

type RemoveTagsInput struct {
	// The pipeline from which you want to remove tags.
	PipelineID *string `locationName:"pipelineId" type:"string" required:"true"`

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

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

type ReportTaskProgressInput struct {
	// Key-value pairs that define the properties of the ReportTaskProgressInput
	// object.
	Fields []*Field `locationName:"fields" type:"list"`

	// Identifier of the task assigned to the task runner. This value is provided
	// in the TaskObject that the service returns with the response for the PollForTask
	// action.
	TaskID *string `locationName:"taskId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

type ReportTaskRunnerHeartbeatInput struct {
	// The public DNS name of the calling task runner.
	Hostname *string `locationName:"hostname" type:"string"`

	// The identifier 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 `locationName:"taskrunnerId" type:"string" required:"true"`

	// Indicates 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 ReportTaskRunnerHeartbeat. 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
}

type ReportTaskRunnerHeartbeatOutput struct {
	// Indicates whether the calling task runner should terminate. If True, the
	// task runner that called ReportTaskRunnerHeartbeat should terminate.
	Terminate *bool `locationName:"terminate" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

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
}

type SetStatusInput struct {
	// Identifies an array of objects. The corresponding objects can be either physical
	// or components, but not a mix of both types.
	ObjectIDs []*string `locationName:"objectIds" type:"list" required:"true"`

	// Identifies the pipeline that contains the objects.
	PipelineID *string `locationName:"pipelineId" type:"string" required:"true"`

	// Specifies the status to be set on all the objects in objectIds. For components,
	// this can be either PAUSE or RESUME. For instances, this can be either TRY_CANCEL,
	// RERUN, or MARK_FINISHED.
	Status *string `locationName:"status" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

type SetTaskStatusInput struct {
	// If an error occurred during the task, this value specifies an id value that
	// represents the error. 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"`

	// Identifies the task assigned to the task runner. This value is set in the
	// TaskObject that is returned by the PollForTask action.
	TaskID *string `locationName:"taskId" type:"string" required:"true"`

	// If FINISHED, the task successfully completed. If FAILED the task ended unsuccessfully.
	// The FALSE value is used by preconditions.
	TaskStatus *string `locationName:"taskStatus" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

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 *string `locationName:"key" 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 *string `locationName:"value" type:"string" required:"true"`
	// contains filtered or unexported fields
}

type TaskObject struct {
	// Identifier 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" 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"`

	// Identifier of the pipeline that provided the task.
	PipelineID *string `locationName:"pipelineId" type:"string"`

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

type ValidatePipelineDefinitionInput struct {
	// A list of parameter objects used with the pipeline.
	ParameterObjects []*ParameterObject `locationName:"parameterObjects" type:"list"`

	// A list of parameter values used with the pipeline.
	ParameterValues []*ParameterValue `locationName:"parameterValues" type:"list"`

	// Identifies the pipeline whose definition is to be validated.
	PipelineID *string `locationName:"pipelineId" type:"string" required:"true"`

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

type ValidatePipelineDefinitionOutput struct {
	// If True, there were validation errors.
	Errored *bool `locationName:"errored" type:"boolean" required:"true"`

	// Lists the validation errors that were found by ValidatePipelineDefinition.
	ValidationErrors []*ValidationError `locationName:"validationErrors" type:"list"`

	// Lists the validation warnings that were found by ValidatePipelineDefinition.
	ValidationWarnings []*ValidationWarning `locationName:"validationWarnings" type:"list"`
	// contains filtered or unexported fields
}

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" type:"string"`
	// contains filtered or unexported fields
}

type ValidationWarning struct {
	// The identifier of the object that contains the validation warning.
	ID *string `locationName:"id" type:"string"`

	// A description of the validation warning.
	Warnings []*string `locationName:"warnings" type:"list"`
	// contains filtered or unexported fields
}