| Copyright | (c) 2013-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.DataPipeline.Types
Contents
Description
- dataPipeline :: Service
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServiceError :: AsError a => Getting (First ServiceError) a ServiceError
- _PipelineDeletedException :: AsError a => Getting (First ServiceError) a ServiceError
- _PipelineNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _TaskNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- data OperatorType
- data TaskStatus
- data Field
- field :: Text -> Field
- fRefValue :: Lens' Field (Maybe Text)
- fStringValue :: Lens' Field (Maybe Text)
- fKey :: Lens' Field Text
- data InstanceIdentity
- instanceIdentity :: InstanceIdentity
- iiSignature :: Lens' InstanceIdentity (Maybe Text)
- iiDocument :: Lens' InstanceIdentity (Maybe Text)
- data Operator
- operator :: Operator
- oValues :: Lens' Operator [Text]
- oType :: Lens' Operator (Maybe OperatorType)
- data ParameterAttribute
- parameterAttribute :: Text -> Text -> ParameterAttribute
- paKey :: Lens' ParameterAttribute Text
- paStringValue :: Lens' ParameterAttribute Text
- data ParameterObject
- parameterObject :: Text -> ParameterObject
- poId :: Lens' ParameterObject Text
- poAttributes :: Lens' ParameterObject [ParameterAttribute]
- data ParameterValue
- parameterValue :: Text -> Text -> ParameterValue
- pvId :: Lens' ParameterValue Text
- pvStringValue :: Lens' ParameterValue Text
- data PipelineDescription
- pipelineDescription :: Text -> Text -> PipelineDescription
- pdDescription :: Lens' PipelineDescription (Maybe Text)
- pdTags :: Lens' PipelineDescription [Tag]
- pdPipelineId :: Lens' PipelineDescription Text
- pdName :: Lens' PipelineDescription Text
- pdFields :: Lens' PipelineDescription [Field]
- data PipelineIdName
- pipelineIdName :: PipelineIdName
- pinName :: Lens' PipelineIdName (Maybe Text)
- pinId :: Lens' PipelineIdName (Maybe Text)
- data PipelineObject
- pipelineObject :: Text -> Text -> PipelineObject
- pId :: Lens' PipelineObject Text
- pName :: Lens' PipelineObject Text
- pFields :: Lens' PipelineObject [Field]
- data Query
- query :: Query
- qSelectors :: Lens' Query [Selector]
- data Selector
- selector :: Selector
- sOperator :: Lens' Selector (Maybe Operator)
- sFieldName :: Lens' Selector (Maybe Text)
- data Tag
- tag :: Text -> Text -> Tag
- tagKey :: Lens' Tag Text
- tagValue :: Lens' Tag Text
- data TaskObject
- taskObject :: TaskObject
- toPipelineId :: Lens' TaskObject (Maybe Text)
- toAttemptId :: Lens' TaskObject (Maybe Text)
- toTaskId :: Lens' TaskObject (Maybe Text)
- toObjects :: Lens' TaskObject (HashMap Text PipelineObject)
- data ValidationError
- validationError :: ValidationError
- veId :: Lens' ValidationError (Maybe Text)
- veErrors :: Lens' ValidationError [Text]
- data ValidationWarning
- validationWarning :: ValidationWarning
- vwWarnings :: Lens' ValidationWarning [Text]
- vwId :: Lens' ValidationWarning (Maybe Text)
Service Configuration
dataPipeline :: Service Source #
API version '2012-10-29' of the Amazon Data Pipeline SDK configuration.
Errors
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
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.
_InternalServiceError :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal service error occurred.
_PipelineDeletedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified pipeline has been deleted.
_PipelineNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified pipeline was not found. Verify that you used the correct user and account identifiers.
_TaskNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified task was not found.
OperatorType
data OperatorType Source #
Constructors
| OperatorBetween | |
| OperatorEQ' | |
| OperatorGE | |
| OperatorLE | |
| OperatorRefEQ |
Instances
TaskStatus
data TaskStatus Source #
Instances
Field
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.
See: field smart constructor.
Creates a value of Field with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fRefValue :: Lens' Field (Maybe Text) Source #
The field value, expressed as the identifier of another object.
InstanceIdentity
data InstanceIdentity Source #
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 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.
See: instanceIdentity smart constructor.
Instances
instanceIdentity :: InstanceIdentity Source #
Creates a value of InstanceIdentity with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
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.
iiDocument :: Lens' InstanceIdentity (Maybe Text) Source #
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.
Operator
Contains a logical operation for comparing the value of a field with a specified value.
See: operator smart constructor.
oValues :: Lens' Operator [Text] Source #
The value that the actual field value will be compared with.
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
- '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".
ParameterAttribute
data ParameterAttribute Source #
The attributes allowed or specified with a parameter object.
See: parameterAttribute smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ParameterAttribute |
Creates a value of ParameterAttribute with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
paStringValue :: Lens' ParameterAttribute Text Source #
The field value, expressed as a String.
ParameterObject
data ParameterObject Source #
Contains information about a parameter object.
See: parameterObject smart constructor.
Instances
Arguments
| :: Text | |
| -> ParameterObject |
Creates a value of ParameterObject with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
poAttributes :: Lens' ParameterObject [ParameterAttribute] Source #
The attributes of the parameter object.
ParameterValue
data ParameterValue Source #
A value or list of parameter values.
See: parameterValue smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ParameterValue |
Creates a value of ParameterValue with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pvStringValue :: Lens' ParameterValue Text Source #
The field value, expressed as a String.
PipelineDescription
data PipelineDescription Source #
Contains pipeline metadata.
See: pipelineDescription smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> PipelineDescription |
Creates a value of PipelineDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pdDescription :: Lens' PipelineDescription (Maybe Text) Source #
Description of the pipeline.
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.
pdPipelineId :: Lens' PipelineDescription Text Source #
The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form 'df-297EG78HU43EEXAMPLE'.
pdFields :: Lens' PipelineDescription [Field] Source #
A list of read-only fields that contain metadata about the pipeline: 'userId, 'accountId, and 'pipelineState.
PipelineIdName
data PipelineIdName Source #
Contains the name and identifier of a pipeline.
See: pipelineIdName smart constructor.
pipelineIdName :: PipelineIdName Source #
Creates a value of PipelineIdName with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pinId :: Lens' PipelineIdName (Maybe Text) Source #
The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form 'df-297EG78HU43EEXAMPLE'.
PipelineObject
data PipelineObject Source #
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.
See: pipelineObject smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> PipelineObject |
Creates a value of PipelineObject with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pFields :: Lens' PipelineObject [Field] Source #
Key-value pairs that define the properties of the object.
Query
Defines the query to run against an object.
See: query smart constructor.
Creates a value of Query with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qSelectors :: Lens' Query [Selector] Source #
List of selectors that define the query. An object must satisfy all of the selectors to match the query.
Selector
A comparision that is used to determine whether a query should return this object.
See: selector smart constructor.
Creates a value of Selector with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
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.
Tag
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 in the AWS Data Pipeline Developer Guide.
See: tag smart constructor.
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 Developer Guide.
TaskObject
data TaskObject Source #
Contains information about a pipeline task that is assigned to a task runner.
See: taskObject smart constructor.
Instances
taskObject :: TaskObject Source #
Creates a value of TaskObject with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
toPipelineId :: Lens' TaskObject (Maybe Text) Source #
The ID of the pipeline that provided the task.
toAttemptId :: Lens' TaskObject (Maybe Text) Source #
The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.
toTaskId :: Lens' TaskObject (Maybe Text) Source #
An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.
toObjects :: Lens' TaskObject (HashMap Text PipelineObject) Source #
Connection information for the location where the task runner will publish the output of the task.
ValidationError
data ValidationError Source #
Defines a validation error. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.
See: validationError smart constructor.
validationError :: ValidationError Source #
Creates a value of ValidationError with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
veId :: Lens' ValidationError (Maybe Text) Source #
The identifier of the object that contains the validation error.
ValidationWarning
data ValidationWarning Source #
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.
See: validationWarning smart constructor.
Instances
validationWarning :: ValidationWarning Source #
Creates a value of ValidationWarning with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vwWarnings :: Lens' ValidationWarning [Text] Source #
A description of the validation warning.