Safe Haskell	None
Language	Haskell2010

Network.AWS.DataPipeline.Types

Contents

Service
- Error
ParameterObject
PipelineObject
Tag
Field
ParameterValue
Selector
ParameterAttribute
Operator
TaskObject
ValidationError
PipelineDescription
InstanceIdentity
Query
OperatorType
PipelineIdName
TaskStatus
ValidationWarning

Synopsis

Service

data DataPipeline Source

Version 2012-10-29 of the Amazon Data Pipeline service.

Instances

AWSService DataPipeline
type Er DataPipeline = JSONError
type Sg DataPipeline = V4

Error

data JSONError :: *

Instances

Eq JSONError
Show JSONError
Generic JSONError
FromJSON JSONError
AWSErrorCode JSONError
type Rep JSONError = D1 D1JSONError (C1 C1_0JSONError ((::) (S1 S1_0_0JSONError (Rec0 (Maybe Text))) ((::) (S1 S1_0_1JSONError (Rec0 ErrorCode)) (S1 S1_0_2JSONError (Rec0 Text)))))

ParameterObject

data ParameterObject Source

Instances

Eq ParameterObject
Read ParameterObject
Show ParameterObject
ToJSON ParameterObject
FromJSON ParameterObject

parameterObject Source

Arguments

:: Text	`poId`
-> ParameterObject

ParameterObject constructor.

The fields accessible through corresponding lenses are:

poAttributes :: [ParameterAttribute]
poId :: Text

poAttributes :: Lens' ParameterObject [ParameterAttribute] Source

The attributes of the parameter object.

poId :: Lens' ParameterObject Text Source

Identifier of the parameter object.

PipelineObject

data PipelineObject Source

Instances

Eq PipelineObject
Read PipelineObject
Show PipelineObject
ToJSON PipelineObject
FromJSON PipelineObject

pipelineObject Source

Arguments

:: Text	`po1Id`
-> Text	`po1Name`
-> PipelineObject

PipelineObject constructor.

The fields accessible through corresponding lenses are:

po1Fields :: [Field]
po1Id :: Text
po1Name :: Text

po1Fields :: Lens' PipelineObject [Field] Source

Key-value pairs that define the properties of the object.

po1Id :: Lens' PipelineObject Text Source

Identifier of the object.

po1Name :: Lens' PipelineObject Text Source

Name of the object.

Tag

data Tag Source

Instances

Eq Tag
Ord Tag
Read Tag
Show Tag
ToJSON Tag
FromJSON Tag

tag Source

Arguments

:: Text	`tagKey`
-> Text	`tagValue`
-> Tag

Tag constructor.

The fields accessible through corresponding lenses are:

tagKey :: Text
tagValue :: Text

tagKey :: Lens' Tag Text Source

The key name of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

tagValue :: Lens' Tag Text Source

The optional value portion of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline DeveloperGuide.

Field

data Field Source

Instances

Eq Field
Ord Field
Read Field
Show Field
ToJSON Field
FromJSON Field

field Source

Arguments

:: Text	`fKey`
-> Field

Field constructor.

The fields accessible through corresponding lenses are:

fKey :: Text
fRefValue :: Maybe Text
fStringValue :: Maybe Text

fKey :: Lens' Field Text Source

The field identifier.

fRefValue :: Lens' Field (Maybe Text) Source

The field value, expressed as the identifier of another object.

fStringValue :: Lens' Field (Maybe Text) Source

The field value, expressed as a String.

ParameterValue

data ParameterValue Source

Instances

Eq ParameterValue
Ord ParameterValue
Read ParameterValue
Show ParameterValue
ToJSON ParameterValue
FromJSON ParameterValue

parameterValue Source

Arguments

:: Text	`pvId`
-> Text	`pvStringValue`
-> ParameterValue

ParameterValue constructor.

The fields accessible through corresponding lenses are:

pvId :: Text
pvStringValue :: Text

pvId :: Lens' ParameterValue Text Source

Identifier of the parameter value.

pvStringValue :: Lens' ParameterValue Text Source

The field value, expressed as a String.

Selector

data Selector Source

Instances

Eq Selector
Read Selector
Show Selector
ToJSON Selector
FromJSON Selector

selector :: Selector Source

Selector constructor.

The fields accessible through corresponding lenses are:

sFieldName :: Maybe Text
sOperator :: Maybe Operator

sFieldName :: Lens' Selector (Maybe Text) Source

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.

sOperator :: Lens' Selector (Maybe Operator) Source

ParameterAttribute

data ParameterAttribute Source

Instances

Eq ParameterAttribute
Ord ParameterAttribute
Read ParameterAttribute
Show ParameterAttribute
ToJSON ParameterAttribute
FromJSON ParameterAttribute

parameterAttribute Source

Arguments

:: Text	`paKey`
-> Text	`paStringValue`
-> ParameterAttribute

ParameterAttribute constructor.

The fields accessible through corresponding lenses are:

paKey :: Text
paStringValue :: Text

paKey :: Lens' ParameterAttribute Text Source

The field identifier.

paStringValue :: Lens' ParameterAttribute Text Source

The field value, expressed as a String.

Operator

data Operator Source

Instances

Eq Operator
Read Operator
Show Operator
ToJSON Operator
FromJSON Operator

operator :: Operator Source

Operator constructor.

The fields accessible through corresponding lenses are:

oType :: Maybe OperatorType
oValues :: [Text]

oType :: Lens' Operator (Maybe OperatorType) Source

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 scheduledStartTimescheduledEndTime 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".

oValues :: Lens' Operator [Text] Source

The value that the actual field value will be compared with.

TaskObject

data TaskObject Source

Instances

Eq TaskObject
Read TaskObject
Show TaskObject
ToJSON TaskObject
FromJSON TaskObject

taskObject :: TaskObject Source

TaskObject constructor.

The fields accessible through corresponding lenses are:

toAttemptId :: Maybe Text
toObjects :: HashMap Text PipelineObject
toPipelineId :: Maybe Text
toTaskId :: Maybe Text

toAttemptId :: Lens' TaskObject (Maybe Text) Source

Identifier of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.

toObjects :: Lens' TaskObject (HashMap Text PipelineObject) Source

Connection information for the location where the task runner will publish the output of the task.

toPipelineId :: Lens' TaskObject (Maybe Text) Source

Identifier of the pipeline that provided the task.

toTaskId :: Lens' TaskObject (Maybe Text) Source

An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.

ValidationError

data ValidationError Source

Instances

Eq ValidationError
Ord ValidationError
Read ValidationError
Show ValidationError
ToJSON ValidationError
FromJSON ValidationError

validationError :: ValidationError Source

ValidationError constructor.

The fields accessible through corresponding lenses are:

veErrors :: [Text]
veId :: Maybe Text

veErrors :: Lens' ValidationError [Text] Source

A description of the validation error.

veId :: Lens' ValidationError (Maybe Text) Source

The identifier of the object that contains the validation error.

PipelineDescription

data PipelineDescription Source

Instances

Eq PipelineDescription
Read PipelineDescription
Show PipelineDescription
ToJSON PipelineDescription
FromJSON PipelineDescription

pipelineDescription Source

Arguments

:: Text	`pdPipelineId`
-> Text	`pdName`
-> PipelineDescription

PipelineDescription constructor.

The fields accessible through corresponding lenses are:

pdDescription :: Maybe Text
pdFields :: [Field]
pdName :: Text
pdPipelineId :: Text
pdTags :: [Tag]

pdDescription :: Lens' PipelineDescription (Maybe Text) Source

Description of the pipeline.

pdFields :: Lens' PipelineDescription [Field] Source

A list of read-only fields that contain metadata about the pipeline: userId,accountId, and @pipelineState.

pdName :: Lens' PipelineDescription Text Source

Name of the pipeline.

pdPipelineId :: Lens' PipelineDescription Text Source

The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form 'df-297EG78HU43EEXAMPLE'.

pdTags :: Lens' PipelineDescription [Tag] Source

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 in the AWS Data Pipeline Developer Guide.

InstanceIdentity

data InstanceIdentity Source

Instances

Eq InstanceIdentity
Ord InstanceIdentity
Read InstanceIdentity
Show InstanceIdentity
ToJSON InstanceIdentity
FromJSON InstanceIdentity

instanceIdentity :: InstanceIdentity Source

InstanceIdentity constructor.

The fields accessible through corresponding lenses are:

iiDocument :: Maybe Text
iiSignature :: Maybe Text

iiDocument :: Lens' InstanceIdentity (Maybe Text) Source

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.

iiSignature :: Lens' InstanceIdentity (Maybe Text) Source

A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.

Query

data Query Source

Instances

IsList Query
Eq Query
Read Query
Show Query
ToJSON Query
FromJSON Query
Monoid Query
Semigroup Query
type Item Query = Selector

query :: Query Source

Query constructor.

The fields accessible through corresponding lenses are:

qSelectors :: [Selector]

qSelectors :: Lens' Query [Selector] Source

List of selectors that define the query. An object must satisfy all of the selectors to match the query.

OperatorType

data OperatorType Source

Constructors

OperatorBetween	BETWEEN
OperatorEq	EQ
OperatorGe	GE
OperatorLe	LE
OperatorRefEq	REF_EQ

PipelineIdName

data PipelineIdName Source

Instances

Eq PipelineIdName
Ord PipelineIdName
Read PipelineIdName
Show PipelineIdName
ToJSON PipelineIdName
FromJSON PipelineIdName

pipelineIdName :: PipelineIdName Source

PipelineIdName constructor.

The fields accessible through corresponding lenses are:

pinId :: Maybe Text
pinName :: Maybe Text

pinId :: Lens' PipelineIdName (Maybe Text) Source

Identifier of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form 'df-297EG78HU43EEXAMPLE'.

pinName :: Lens' PipelineIdName (Maybe Text) Source

Name of the pipeline.

TaskStatus

data TaskStatus Source

Constructors

Failed	FAILED
False'	FALSE
Finished	FINISHED

ValidationWarning

data ValidationWarning Source

Instances

Eq ValidationWarning
Ord ValidationWarning
Read ValidationWarning
Show ValidationWarning
ToJSON ValidationWarning
FromJSON ValidationWarning

validationWarning :: ValidationWarning Source

ValidationWarning constructor.

The fields accessible through corresponding lenses are:

vwId :: Maybe Text
vwWarnings :: [Text]

vwId :: Lens' ValidationWarning (Maybe Text) Source

The identifier of the object that contains the validation warning.

vwWarnings :: Lens' ValidationWarning [Text] Source

A description of the validation warning.

Enum OperatorType
Eq OperatorType
Ord OperatorType
Read OperatorType
Show OperatorType
Generic OperatorType
ToJSON OperatorType
FromJSON OperatorType
Hashable OperatorType
ToQuery OperatorType
ToHeader OperatorType
ToByteString OperatorType
FromText OperatorType
ToText OperatorType
type Rep OperatorType

Enum TaskStatus
Eq TaskStatus
Ord TaskStatus
Read TaskStatus
Show TaskStatus
Generic TaskStatus
ToJSON TaskStatus
FromJSON TaskStatus
Hashable TaskStatus
ToQuery TaskStatus
ToHeader TaskStatus
ToByteString TaskStatus
FromText TaskStatus
ToText TaskStatus
type Rep TaskStatus