amazonka-datapipeline 0.3.3 → 0.3.4
raw patch · 22 files changed
+355/−223 lines, 22 filesdep ~amazonka-corePVP ok
version bump matches the API change (PVP)
Dependency ranges changed: amazonka-core
API changes (from Hackage documentation)
+ Network.AWS.DataPipeline.ActivatePipeline: apStartTimestamp :: Lens' ActivatePipeline (Maybe UTCTime)
+ Network.AWS.DataPipeline.DeactivatePipeline: data DeactivatePipeline
+ Network.AWS.DataPipeline.DeactivatePipeline: data DeactivatePipelineResponse
+ Network.AWS.DataPipeline.DeactivatePipeline: deactivatePipeline :: Text -> DeactivatePipeline
+ Network.AWS.DataPipeline.DeactivatePipeline: deactivatePipelineResponse :: DeactivatePipelineResponse
+ Network.AWS.DataPipeline.DeactivatePipeline: dp1CancelActive :: Lens' DeactivatePipeline (Maybe Bool)
+ Network.AWS.DataPipeline.DeactivatePipeline: dp1PipelineId :: Lens' DeactivatePipeline Text
+ Network.AWS.DataPipeline.DeactivatePipeline: instance AWSRequest DeactivatePipeline
+ Network.AWS.DataPipeline.DeactivatePipeline: instance Constructor C1_0DeactivatePipelineResponse
+ Network.AWS.DataPipeline.DeactivatePipeline: instance Datatype D1DeactivatePipelineResponse
+ Network.AWS.DataPipeline.DeactivatePipeline: instance Eq DeactivatePipeline
+ Network.AWS.DataPipeline.DeactivatePipeline: instance Eq DeactivatePipelineResponse
+ Network.AWS.DataPipeline.DeactivatePipeline: instance Generic DeactivatePipelineResponse
+ Network.AWS.DataPipeline.DeactivatePipeline: instance Ord DeactivatePipeline
+ Network.AWS.DataPipeline.DeactivatePipeline: instance Ord DeactivatePipelineResponse
+ Network.AWS.DataPipeline.DeactivatePipeline: instance Read DeactivatePipeline
+ Network.AWS.DataPipeline.DeactivatePipeline: instance Read DeactivatePipelineResponse
+ Network.AWS.DataPipeline.DeactivatePipeline: instance Show DeactivatePipeline
+ Network.AWS.DataPipeline.DeactivatePipeline: instance Show DeactivatePipelineResponse
+ Network.AWS.DataPipeline.DeactivatePipeline: instance ToHeaders DeactivatePipeline
+ Network.AWS.DataPipeline.DeactivatePipeline: instance ToJSON DeactivatePipeline
+ Network.AWS.DataPipeline.DeactivatePipeline: instance ToPath DeactivatePipeline
+ Network.AWS.DataPipeline.DeactivatePipeline: instance ToQuery DeactivatePipeline
Files
- amazonka-datapipeline.cabal +3/−2
- gen/Network/AWS/DataPipeline.hs +2/−0
- gen/Network/AWS/DataPipeline/ActivatePipeline.hs +21/−8
- gen/Network/AWS/DataPipeline/AddTags.hs +4/−3
- gen/Network/AWS/DataPipeline/CreatePipeline.hs +21/−19
- gen/Network/AWS/DataPipeline/DeactivatePipeline.hs +110/−0
- gen/Network/AWS/DataPipeline/DeletePipeline.hs +8/−8
- gen/Network/AWS/DataPipeline/DescribeObjects.hs +12/−10
- gen/Network/AWS/DataPipeline/DescribePipelines.hs +7/−7
- gen/Network/AWS/DataPipeline/EvaluateExpression.hs +6/−4
- gen/Network/AWS/DataPipeline/GetPipelineDefinition.hs +8/−9
- gen/Network/AWS/DataPipeline/ListPipelines.hs +13/−11
- gen/Network/AWS/DataPipeline/PollForTask.hs +20/−21
- gen/Network/AWS/DataPipeline/PutPipelineDefinition.hs +17/−19
- gen/Network/AWS/DataPipeline/QueryObjects.hs +20/−23
- gen/Network/AWS/DataPipeline/RemoveTags.hs +4/−3
- gen/Network/AWS/DataPipeline/ReportTaskProgress.hs +15/−15
- gen/Network/AWS/DataPipeline/ReportTaskRunnerHeartbeat.hs +16/−16
- gen/Network/AWS/DataPipeline/SetStatus.hs +11/−12
- gen/Network/AWS/DataPipeline/SetTaskStatus.hs +14/−10
- gen/Network/AWS/DataPipeline/Types.hs +13/−13
- gen/Network/AWS/DataPipeline/ValidatePipelineDefinition.hs +10/−10
amazonka-datapipeline.cabal view
@@ -1,5 +1,5 @@ name: amazonka-datapipeline-version: 0.3.3+version: 0.3.4 synopsis: Amazon Data Pipeline SDK. homepage: https://github.com/brendanhay/amazonka license: OtherLicense@@ -39,6 +39,7 @@ , Network.AWS.DataPipeline.ActivatePipeline , Network.AWS.DataPipeline.AddTags , Network.AWS.DataPipeline.CreatePipeline+ , Network.AWS.DataPipeline.DeactivatePipeline , Network.AWS.DataPipeline.DeletePipeline , Network.AWS.DataPipeline.DescribeObjects , Network.AWS.DataPipeline.DescribePipelines@@ -59,5 +60,5 @@ other-modules: build-depends:- amazonka-core == 0.3.3.*+ amazonka-core == 0.3.4.* , base >= 4.7 && < 5
gen/Network/AWS/DataPipeline.hs view
@@ -18,6 +18,7 @@ ( module Network.AWS.DataPipeline.ActivatePipeline , module Network.AWS.DataPipeline.AddTags , module Network.AWS.DataPipeline.CreatePipeline+ , module Network.AWS.DataPipeline.DeactivatePipeline , module Network.AWS.DataPipeline.DeletePipeline , module Network.AWS.DataPipeline.DescribeObjects , module Network.AWS.DataPipeline.DescribePipelines@@ -39,6 +40,7 @@ import Network.AWS.DataPipeline.ActivatePipeline import Network.AWS.DataPipeline.AddTags import Network.AWS.DataPipeline.CreatePipeline+import Network.AWS.DataPipeline.DeactivatePipeline import Network.AWS.DataPipeline.DeletePipeline import Network.AWS.DataPipeline.DescribeObjects import Network.AWS.DataPipeline.DescribePipelines
gen/Network/AWS/DataPipeline/ActivatePipeline.hs view
@@ -22,14 +22,15 @@ -- -- Derived from AWS service descriptions, licensed under Apache 2.0. --- | Validates a pipeline and initiates processing. If the pipeline does not pass--- validation, activation fails. You cannot perform this operation on FINISHED--- pipelines and attempting to do so will return an InvalidRequestException.+-- | Validates the specified pipeline and starts processing pipeline tasks. If the+-- pipeline does not pass validation, activation fails. ----- Call this action to start processing pipeline tasks of a pipeline you've--- created using the 'CreatePipeline' and 'PutPipelineDefinition' actions. A--- pipeline cannot be modified after it has been successfully activated.+-- 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.+-- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_ActivatePipeline.html> module Network.AWS.DataPipeline.ActivatePipeline (@@ -40,6 +41,7 @@ -- ** Request lenses , apParameterValues , apPipelineId+ , apStartTimestamp -- * Response , ActivatePipelineResponse@@ -47,6 +49,7 @@ , activatePipelineResponse ) where +import Network.AWS.Data (Object) import Network.AWS.Prelude import Network.AWS.Request.JSON import Network.AWS.DataPipeline.Types@@ -55,6 +58,7 @@ data ActivatePipeline = ActivatePipeline { _apParameterValues :: List "parameterValues" ParameterValue , _apPipelineId :: Text+ , _apStartTimestamp :: Maybe POSIX } deriving (Eq, Read, Show) -- | 'ActivatePipeline' constructor.@@ -65,23 +69,31 @@ -- -- * 'apPipelineId' @::@ 'Text' --+-- * 'apStartTimestamp' @::@ 'Maybe' 'UTCTime'+-- activatePipeline :: Text -- ^ 'apPipelineId' -> ActivatePipeline activatePipeline p1 = ActivatePipeline { _apPipelineId = p1 , _apParameterValues = mempty+ , _apStartTimestamp = Nothing } --- | Returns a list of parameter values to pass to the pipeline at activation.+-- | A list of parameter values to pass to the pipeline at activation. apParameterValues :: Lens' ActivatePipeline [ParameterValue] apParameterValues = lens _apParameterValues (\s a -> s { _apParameterValues = a }) . _List --- | The identifier of the pipeline to activate.+-- | The ID of the pipeline. apPipelineId :: Lens' ActivatePipeline Text apPipelineId = lens _apPipelineId (\s a -> s { _apPipelineId = a }) +-- | The date and time to resume the pipeline. By default, the pipeline resumes+-- from the last completed execution.+apStartTimestamp :: Lens' ActivatePipeline (Maybe UTCTime)+apStartTimestamp = lens _apStartTimestamp (\s a -> s { _apStartTimestamp = a }) . mapping _Time+ data ActivatePipelineResponse = ActivatePipelineResponse deriving (Eq, Ord, Read, Show, Generic) @@ -101,6 +113,7 @@ toJSON ActivatePipeline{..} = object [ "pipelineId" .= _apPipelineId , "parameterValues" .= _apParameterValues+ , "startTimestamp" .= _apStartTimestamp ] instance AWSRequest ActivatePipeline where
gen/Network/AWS/DataPipeline/AddTags.hs view
@@ -22,7 +22,7 @@ -- -- Derived from AWS service descriptions, licensed under Apache 2.0. --- | Add or modify tags in an existing pipeline.+-- | Adds or modifies tags for the specified pipeline. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_AddTags.html> module Network.AWS.DataPipeline.AddTags@@ -41,6 +41,7 @@ , addTagsResponse ) where +import Network.AWS.Data (Object) import Network.AWS.Prelude import Network.AWS.Request.JSON import Network.AWS.DataPipeline.Types@@ -66,11 +67,11 @@ , _atTags = mempty } --- | The identifier of the pipeline to which you want to add the tags.+-- | The ID of the pipeline. atPipelineId :: Lens' AddTags Text atPipelineId = lens _atPipelineId (\s a -> s { _atPipelineId = a }) --- | The tags as key/value pairs to add to the pipeline.+-- | The tags to add, as key/value pairs. atTags :: Lens' AddTags [Tag] atTags = lens _atTags (\s a -> s { _atTags = a }) . _List
gen/Network/AWS/DataPipeline/CreatePipeline.hs view
@@ -22,7 +22,8 @@ -- -- Derived from AWS service descriptions, licensed under Apache 2.0. --- | Creates a new empty pipeline. When this action succeeds, you can then use the 'PutPipelineDefinition' action to populate the pipeline.+-- | Creates a new, empty pipeline. Use 'PutPipelineDefinition' to populate the+-- pipeline. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_CreatePipeline.html> module Network.AWS.DataPipeline.CreatePipeline@@ -45,6 +46,7 @@ , cprPipelineId ) where +import Network.AWS.Data (Object) import Network.AWS.Prelude import Network.AWS.Request.JSON import Network.AWS.DataPipeline.Types@@ -79,32 +81,32 @@ , _cpTags = mempty } --- | The description of the new pipeline.+-- | The description for the pipeline. cpDescription :: Lens' CreatePipeline (Maybe Text) cpDescription = lens _cpDescription (\s a -> s { _cpDescription = a }) --- | 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.+-- | 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. cpName :: Lens' CreatePipeline Text cpName = lens _cpName (\s a -> s { _cpName = a }) --- | A list of tags to associate with a pipeline at creation time. Tags let you+-- | A list of tags to associate with the pipeline at creation. Tags let you -- control access to pipelines. For more information, see <http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html Controlling UserAccess to Pipelines> in the /AWS Data Pipeline Developer Guide/. cpTags :: Lens' CreatePipeline [Tag] cpTags = lens _cpTags (\s a -> s { _cpTags = a }) . _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.+-- | 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. cpUniqueId :: Lens' CreatePipeline Text cpUniqueId = lens _cpUniqueId (\s a -> s { _cpUniqueId = a }) @@ -124,8 +126,8 @@ { _cprPipelineId = p1 } --- | The ID that AWS Data Pipeline assigns the newly created pipeline. The ID is a--- string of the form: df-06372391ZG65EXAMPLE.+-- | The ID that AWS Data Pipeline assigns the newly created pipeline. For+-- example, 'df-06372391ZG65EXAMPLE'. cprPipelineId :: Lens' CreatePipelineResponse Text cprPipelineId = lens _cprPipelineId (\s a -> s { _cprPipelineId = a })
+ gen/Network/AWS/DataPipeline/DeactivatePipeline.hs view
@@ -0,0 +1,110 @@+{-# LANGUAGE DataKinds #-}+{-# LANGUAGE DeriveGeneric #-}+{-# LANGUAGE FlexibleInstances #-}+{-# LANGUAGE GeneralizedNewtypeDeriving #-}+{-# LANGUAGE LambdaCase #-}+{-# LANGUAGE NoImplicitPrelude #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE RecordWildCards #-}+{-# LANGUAGE TypeFamilies #-}++{-# OPTIONS_GHC -fno-warn-unused-imports #-}++-- Module : Network.AWS.DataPipeline.DeactivatePipeline+-- Copyright : (c) 2013-2014 Brendan Hay <brendan.g.hay@gmail.com>+-- License : This Source Code Form is subject to the terms of+-- the Mozilla Public License, v. 2.0.+-- A copy of the MPL can be found in the LICENSE file or+-- you can obtain it at http://mozilla.org/MPL/2.0/.+-- Maintainer : Brendan Hay <brendan.g.hay@gmail.com>+-- Stability : experimental+-- Portability : non-portable (GHC extensions)+--+-- Derived from AWS service descriptions, licensed under Apache 2.0.++-- | 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.+--+-- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_DeactivatePipeline.html>+module Network.AWS.DataPipeline.DeactivatePipeline+ (+ -- * Request+ DeactivatePipeline+ -- ** Request constructor+ , deactivatePipeline+ -- ** Request lenses+ , dp1CancelActive+ , dp1PipelineId++ -- * Response+ , DeactivatePipelineResponse+ -- ** Response constructor+ , deactivatePipelineResponse+ ) where++import Network.AWS.Data (Object)+import Network.AWS.Prelude+import Network.AWS.Request.JSON+import Network.AWS.DataPipeline.Types+import qualified GHC.Exts++data DeactivatePipeline = DeactivatePipeline+ { _dp1CancelActive :: Maybe Bool+ , _dp1PipelineId :: Text+ } deriving (Eq, Ord, Read, Show)++-- | 'DeactivatePipeline' constructor.+--+-- The fields accessible through corresponding lenses are:+--+-- * 'dp1CancelActive' @::@ 'Maybe' 'Bool'+--+-- * 'dp1PipelineId' @::@ 'Text'+--+deactivatePipeline :: Text -- ^ 'dp1PipelineId'+ -> DeactivatePipeline+deactivatePipeline p1 = DeactivatePipeline+ { _dp1PipelineId = p1+ , _dp1CancelActive = Nothing+ }++-- | 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.+dp1CancelActive :: Lens' DeactivatePipeline (Maybe Bool)+dp1CancelActive = lens _dp1CancelActive (\s a -> s { _dp1CancelActive = a })++-- | The ID of the pipeline.+dp1PipelineId :: Lens' DeactivatePipeline Text+dp1PipelineId = lens _dp1PipelineId (\s a -> s { _dp1PipelineId = a })++data DeactivatePipelineResponse = DeactivatePipelineResponse+ deriving (Eq, Ord, Read, Show, Generic)++-- | 'DeactivatePipelineResponse' constructor.+deactivatePipelineResponse :: DeactivatePipelineResponse+deactivatePipelineResponse = DeactivatePipelineResponse++instance ToPath DeactivatePipeline where+ toPath = const "/"++instance ToQuery DeactivatePipeline where+ toQuery = const mempty++instance ToHeaders DeactivatePipeline++instance ToJSON DeactivatePipeline where+ toJSON DeactivatePipeline{..} = object+ [ "pipelineId" .= _dp1PipelineId+ , "cancelActive" .= _dp1CancelActive+ ]++instance AWSRequest DeactivatePipeline where+ type Sv DeactivatePipeline = DataPipeline+ type Rs DeactivatePipeline = DeactivatePipelineResponse++ request = post "DeactivatePipeline"+ response = nullResponse DeactivatePipelineResponse
gen/Network/AWS/DataPipeline/DeletePipeline.hs view
@@ -22,14 +22,13 @@ -- -- Derived from AWS service descriptions, licensed under Apache 2.0. --- | Permanently deletes a pipeline, its pipeline definition and its run history.--- You cannot query or restore a deleted pipeline. AWS Data Pipeline will--- attempt to cancel instances associated with the pipeline that are currently--- being processed by task runners. Deleting a pipeline cannot be undone.+-- | 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. ----- 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.+-- 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. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_DeletePipeline.html> module Network.AWS.DataPipeline.DeletePipeline@@ -47,6 +46,7 @@ , deletePipelineResponse ) where +import Network.AWS.Data (Object) import Network.AWS.Prelude import Network.AWS.Request.JSON import Network.AWS.DataPipeline.Types@@ -68,7 +68,7 @@ { _dpPipelineId = p1 } --- | The identifier of the pipeline to be deleted.+-- | The ID of the pipeline. dpPipelineId :: Lens' DeletePipeline Text dpPipelineId = lens _dpPipelineId (\s a -> s { _dpPipelineId = a })
gen/Network/AWS/DataPipeline/DescribeObjects.hs view
@@ -22,7 +22,7 @@ -- -- Derived from AWS service descriptions, licensed under Apache 2.0. --- | Returns the object definitions for a set of objects associated with the+-- | 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. --@@ -49,6 +49,7 @@ , dorPipelineObjects ) where +import Network.AWS.Data (Object) import Network.AWS.Prelude import Network.AWS.Request.JSON import Network.AWS.DataPipeline.Types@@ -88,18 +89,18 @@ doEvaluateExpressions = lens _doEvaluateExpressions (\s a -> s { _doEvaluateExpressions = a }) --- | 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.+-- | 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. doMarker :: Lens' DescribeObjects (Maybe Text) doMarker = lens _doMarker (\s a -> s { _doMarker = a }) --- | 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.+-- | 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'. doObjectIds :: Lens' DescribeObjects [Text] doObjectIds = lens _doObjectIds (\s a -> s { _doObjectIds = a }) . _List --- | Identifier of the pipeline that contains the object definitions.+-- | The ID of the pipeline that contains the object definitions. doPipelineId :: Lens' DescribeObjects Text doPipelineId = lens _doPipelineId (\s a -> s { _doPipelineId = a }) @@ -126,17 +127,18 @@ , _dorHasMoreResults = Nothing } --- | If 'True', there are more pages of results to return.+-- | Indicates whether there are more results to return. dorHasMoreResults :: Lens' DescribeObjectsResponse (Maybe Bool) dorHasMoreResults = lens _dorHasMoreResults (\s a -> s { _dorHasMoreResults = a }) -- | The starting point for the next page of results. To view the next page of--- results, call 'DescribeObjects' again with this marker value.+-- results, call 'DescribeObjects' again with this marker value. If the value is+-- null, there are no more results. dorMarker :: Lens' DescribeObjectsResponse (Maybe Text) dorMarker = lens _dorMarker (\s a -> s { _dorMarker = a }) --- | An array of object definitions that are returned by the call to 'DescribeObjects'.+-- | An array of object definitions. dorPipelineObjects :: Lens' DescribeObjectsResponse [PipelineObject] dorPipelineObjects = lens _dorPipelineObjects (\s a -> s { _dorPipelineObjects = a })
gen/Network/AWS/DataPipeline/DescribePipelines.hs view
@@ -22,15 +22,15 @@ -- -- Derived from AWS service descriptions, licensed under Apache 2.0. --- | Retrieve metadata about one or more pipelines. The information retrieved+-- | 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 you have read permission for.+-- metadata about only those pipelines for which you have read permissions. -- -- To retrieve the full pipeline definition instead of metadata about the--- pipeline, call the 'GetPipelineDefinition' action.+-- pipeline, call 'GetPipelineDefinition'. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_DescribePipelines.html> module Network.AWS.DataPipeline.DescribePipelines@@ -50,6 +50,7 @@ , dprPipelineDescriptionList ) where +import Network.AWS.Data (Object) import Network.AWS.Prelude import Network.AWS.Request.JSON import Network.AWS.DataPipeline.Types@@ -76,9 +77,8 @@ { _dpPipelineIds = mempty } --- | 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'.+-- | 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'. dpPipelineIds :: Lens' DescribePipelines [Text] dpPipelineIds = lens _dpPipelineIds (\s a -> s { _dpPipelineIds = a }) . _List @@ -103,7 +103,7 @@ { _dprPipelineDescriptionList = mempty } --- | An array of descriptions returned for the specified pipelines.+-- | An array of descriptions for the specified pipelines. dprPipelineDescriptionList :: Lens' DescribePipelinesResponse [PipelineDescription] dprPipelineDescriptionList = lens _dprPipelineDescriptionList
gen/Network/AWS/DataPipeline/EvaluateExpression.hs view
@@ -22,8 +22,9 @@ -- -- Derived from AWS service descriptions, licensed under Apache 2.0. --- | Evaluates a string in the context of a specified object. A task runner can--- use this action to evaluate SQL queries stored in Amazon S3.+-- | 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. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_EvaluateExpression.html> module Network.AWS.DataPipeline.EvaluateExpression@@ -45,6 +46,7 @@ , eerEvaluatedExpression ) where +import Network.AWS.Data (Object) import Network.AWS.Prelude import Network.AWS.Request.JSON import Network.AWS.DataPipeline.Types@@ -80,11 +82,11 @@ eeExpression :: Lens' EvaluateExpression Text eeExpression = lens _eeExpression (\s a -> s { _eeExpression = a }) --- | The identifier of the object.+-- | The ID of the object. eeObjectId :: Lens' EvaluateExpression Text eeObjectId = lens _eeObjectId (\s a -> s { _eeObjectId = a }) --- | The identifier of the pipeline.+-- | The ID of the pipeline. eePipelineId :: Lens' EvaluateExpression Text eePipelineId = lens _eePipelineId (\s a -> s { _eePipelineId = a })
gen/Network/AWS/DataPipeline/GetPipelineDefinition.hs view
@@ -22,7 +22,7 @@ -- -- Derived from AWS service descriptions, licensed under Apache 2.0. --- | Returns the definition of the specified pipeline. You can call 'GetPipelineDefinition' to retrieve the pipeline definition you provided using 'PutPipelineDefinition'.+-- | Gets the definition of the specified pipeline. You can call 'GetPipelineDefinition' to retrieve the pipeline definition that you provided using 'PutPipelineDefinition'. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_GetPipelineDefinition.html> module Network.AWS.DataPipeline.GetPipelineDefinition@@ -45,6 +45,7 @@ , gpdrPipelineObjects ) where +import Network.AWS.Data (Object) import Network.AWS.Prelude import Network.AWS.Request.JSON import Network.AWS.DataPipeline.Types@@ -70,14 +71,12 @@ , _gpdVersion = Nothing } --- | The identifier of the pipeline.+-- | The ID of the pipeline. gpdPipelineId :: Lens' GetPipelineDefinition Text gpdPipelineId = lens _gpdPipelineId (\s a -> s { _gpdPipelineId = a }) --- | 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.+-- | 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. gpdVersion :: Lens' GetPipelineDefinition (Maybe Text) gpdVersion = lens _gpdVersion (\s a -> s { _gpdVersion = a }) @@ -104,19 +103,19 @@ , _gpdrParameterValues = mempty } --- | Returns a list of parameter objects used in the pipeline definition.+-- | The parameter objects used in the pipeline definition. gpdrParameterObjects :: Lens' GetPipelineDefinitionResponse [ParameterObject] gpdrParameterObjects = lens _gpdrParameterObjects (\s a -> s { _gpdrParameterObjects = a }) . _List --- | Returns a list of parameter values used in the pipeline definition.+-- | The parameter values used in the pipeline definition. gpdrParameterValues :: Lens' GetPipelineDefinitionResponse [ParameterValue] gpdrParameterValues = lens _gpdrParameterValues (\s a -> s { _gpdrParameterValues = a }) . _List --- | An array of objects defined in the pipeline.+-- | The objects defined in the pipeline. gpdrPipelineObjects :: Lens' GetPipelineDefinitionResponse [PipelineObject] gpdrPipelineObjects = lens _gpdrPipelineObjects (\s a -> s { _gpdrPipelineObjects = a })
gen/Network/AWS/DataPipeline/ListPipelines.hs view
@@ -22,8 +22,8 @@ -- -- Derived from AWS service descriptions, licensed under Apache 2.0. --- | Returns a list of pipeline identifiers for all active pipelines. Identifiers--- are returned only for pipelines you have permission to access.+-- | Lists the pipeline identifiers for all active pipelines that you have+-- permission to access. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_ListPipelines.html> module Network.AWS.DataPipeline.ListPipelines@@ -45,6 +45,7 @@ , lprPipelineIdList ) where +import Network.AWS.Data (Object) import Network.AWS.Prelude import Network.AWS.Request.JSON import Network.AWS.DataPipeline.Types@@ -65,8 +66,9 @@ { _lpMarker = Nothing } --- | 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.+-- | 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. lpMarker :: Lens' ListPipelines (Maybe Text) lpMarker = lens _lpMarker (\s a -> s { _lpMarker = a }) @@ -93,20 +95,20 @@ , _lprHasMoreResults = Nothing } --- | If 'True', there are more results that can be obtained by a subsequent call to 'ListPipelines'.+-- | Indicates whether there are more results that can be obtained by a subsequent+-- call. lprHasMoreResults :: Lens' ListPipelinesResponse (Maybe Bool) lprHasMoreResults = lens _lprHasMoreResults (\s a -> s { _lprHasMoreResults = a }) --- | 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.+-- | 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. lprMarker :: Lens' ListPipelinesResponse (Maybe Text) lprMarker = lens _lprMarker (\s a -> s { _lprMarker = a }) --- | 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'.+-- | The pipeline identifiers. If you require additional information about the+-- pipelines, you can use these identifiers to call 'DescribePipelines' and 'GetPipelineDefinition'. lprPipelineIdList :: Lens' ListPipelinesResponse [PipelineIdName] lprPipelineIdList = lens _lprPipelineIdList (\s a -> s { _lprPipelineIdList = a })
gen/Network/AWS/DataPipeline/PollForTask.hs view
@@ -22,20 +22,20 @@ -- -- Derived from AWS service descriptions, licensed under Apache 2.0. --- | Task runners call this action to receive a task to perform from AWS Data+-- | 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 of the 'PollForTask' call. The task--- returned by 'PollForTask' may 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.+-- 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+-- 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 may take up to 90 seconds.+-- until it receives a response, and this can take up to 90 seconds. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_PollForTask.html> module Network.AWS.DataPipeline.PollForTask@@ -57,6 +57,7 @@ , pftrTaskObject ) where +import Network.AWS.Data (Object) import Network.AWS.Prelude import Network.AWS.Request.JSON import Network.AWS.DataPipeline.Types@@ -90,19 +91,18 @@ pftHostname :: Lens' PollForTask (Maybe Text) pftHostname = lens _pftHostname (\s a -> s { _pftHostname = a }) --- | 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 <http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html 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.+-- | 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 <http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html Instance Metadata> in the /Amazon Elastic ComputeCloud 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. pftInstanceIdentity :: Lens' PollForTask (Maybe InstanceIdentity) pftInstanceIdentity = lens _pftInstanceIdentity (\s a -> s { _pftInstanceIdentity = a }) --- | 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.+-- | 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. pftWorkerGroup :: Lens' PollForTask Text pftWorkerGroup = lens _pftWorkerGroup (\s a -> s { _pftWorkerGroup = a }) @@ -121,11 +121,10 @@ { _pftrTaskObject = Nothing } --- | 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'.+-- | 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'. pftrTaskObject :: Lens' PollForTaskResponse (Maybe TaskObject) pftrTaskObject = lens _pftrTaskObject (\s a -> s { _pftrTaskObject = a })
gen/Network/AWS/DataPipeline/PutPipelineDefinition.hs view
@@ -22,18 +22,18 @@ -- -- Derived from AWS service descriptions, licensed under Apache 2.0. --- | Adds tasks, schedules, and preconditions that control the behavior of the--- pipeline. You can use PutPipelineDefinition to populate a new pipeline.+-- | 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 three--- validation errors exists 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 maximum allowed objects. The pipeline is in a--- FINISHED state.+-- validation errors exists in the pipeline. ----- Pipeline object definitions are passed to the 'PutPipelineDefinition' action--- and returned by the 'GetPipelineDefinition' action.+-- 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 maximum+-- allowed objects. The pipeline is in a FINISHED state. Pipeline object+-- definitions are passed to the 'PutPipelineDefinition' action and returned by+-- the 'GetPipelineDefinition' action. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_PutPipelineDefinition.html> module Network.AWS.DataPipeline.PutPipelineDefinition@@ -58,6 +58,7 @@ , ppdrValidationWarnings ) where +import Network.AWS.Data (Object) import Network.AWS.Prelude import Network.AWS.Request.JSON import Network.AWS.DataPipeline.Types@@ -91,23 +92,23 @@ , _ppdParameterValues = mempty } --- | A list of parameter objects used with the pipeline.+-- | The parameter objects used with the pipeline. ppdParameterObjects :: Lens' PutPipelineDefinition [ParameterObject] ppdParameterObjects = lens _ppdParameterObjects (\s a -> s { _ppdParameterObjects = a }) . _List --- | A list of parameter values used with the pipeline.+-- | The parameter values used with the pipeline. ppdParameterValues :: Lens' PutPipelineDefinition [ParameterValue] ppdParameterValues = lens _ppdParameterValues (\s a -> s { _ppdParameterValues = a }) . _List --- | The identifier of the pipeline to be configured.+-- | The ID of the pipeline. ppdPipelineId :: Lens' PutPipelineDefinition Text ppdPipelineId = lens _ppdPipelineId (\s a -> s { _ppdPipelineId = a }) --- | The objects that define the pipeline. These will overwrite the existing+-- | The objects that define the pipeline. These objects overwrite the existing -- pipeline definition. ppdPipelineObjects :: Lens' PutPipelineDefinition [PipelineObject] ppdPipelineObjects =@@ -138,21 +139,18 @@ , _ppdrValidationWarnings = mempty } --- | 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.+-- | 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. ppdrErrored :: Lens' PutPipelineDefinitionResponse Bool ppdrErrored = lens _ppdrErrored (\s a -> s { _ppdrErrored = a }) --- | A list of the validation errors that are associated with the objects defined--- in 'pipelineObjects'.+-- | The validation errors that are associated with the objects defined in 'pipelineObjects'. ppdrValidationErrors :: Lens' PutPipelineDefinitionResponse [ValidationError] ppdrValidationErrors = lens _ppdrValidationErrors (\s a -> s { _ppdrValidationErrors = a }) . _List --- | A list of the validation warnings that are associated with the objects--- defined in 'pipelineObjects'.+-- | The validation warnings that are associated with the objects defined in 'pipelineObjects'. ppdrValidationWarnings :: Lens' PutPipelineDefinitionResponse [ValidationWarning] ppdrValidationWarnings = lens _ppdrValidationWarnings (\s a -> s { _ppdrValidationWarnings = a })
gen/Network/AWS/DataPipeline/QueryObjects.hs view
@@ -22,14 +22,8 @@ -- -- Derived from AWS service descriptions, licensed under Apache 2.0. --- | Queries a pipeline for the names of objects that match a specified set of--- conditions.------ The objects returned by 'QueryObjects' are paginated and then filtered by the--- value you set for query. This means the action may return an empty result set--- with a value set for marker. If 'HasMoreResults' is set to 'True', you should--- continue to call 'QueryObjects', passing in the returned value for marker,--- until 'HasMoreResults' returns 'False'.+-- | Queries the specified pipeline for the names of objects that match the+-- specified set of conditions. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_QueryObjects.html> module Network.AWS.DataPipeline.QueryObjects@@ -55,6 +49,7 @@ , qorMarker ) where +import Network.AWS.Data (Object) import Network.AWS.Prelude import Network.AWS.Request.JSON import Network.AWS.DataPipeline.Types@@ -93,29 +88,30 @@ , _qoLimit = Nothing } --- | Specifies the maximum number of object names that 'QueryObjects' will return in--- a single call. The default value is 100.+-- | The maximum number of object names that 'QueryObjects' will return in a single+-- call. The default value is 100. qoLimit :: Lens' QueryObjects (Maybe Int) qoLimit = lens _qoLimit (\s a -> s { _qoLimit = a }) --- | 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.+-- | 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. qoMarker :: Lens' QueryObjects (Maybe Text) qoMarker = lens _qoMarker (\s a -> s { _qoMarker = a }) --- | Identifier of the pipeline to be queried for object names.+-- | The ID of the pipeline. qoPipelineId :: Lens' QueryObjects Text qoPipelineId = lens _qoPipelineId (\s a -> s { _qoPipelineId = a }) --- | 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+-- | 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. qoQuery :: Lens' QueryObjects (Maybe Query) qoQuery = lens _qoQuery (\s a -> s { _qoQuery = a }) --- | Specifies whether the query applies to components or instances. Allowable--- values: 'COMPONENT', 'INSTANCE', 'ATTEMPT'.+-- | Indicates whether the query applies to components or instances. The possible+-- values are: 'COMPONENT', 'INSTANCE', and 'ATTEMPT'. qoSphere :: Lens' QueryObjects Text qoSphere = lens _qoSphere (\s a -> s { _qoSphere = a }) @@ -142,18 +138,19 @@ , _qorHasMoreResults = Nothing } --- | If 'True', there are more results that can be obtained by a subsequent call to 'QueryObjects'.+-- | Indicates whether there are more results that can be obtained by a subsequent+-- call. qorHasMoreResults :: Lens' QueryObjectsResponse (Maybe Bool) qorHasMoreResults = lens _qorHasMoreResults (\s a -> s { _qorHasMoreResults = a }) --- | A list of identifiers that match the query selectors.+-- | The identifiers that match the query selectors. qorIds :: Lens' QueryObjectsResponse [Text] qorIds = lens _qorIds (\s a -> s { _qorIds = a }) . _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.+-- | 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. qorMarker :: Lens' QueryObjectsResponse (Maybe Text) qorMarker = lens _qorMarker (\s a -> s { _qorMarker = a })
gen/Network/AWS/DataPipeline/RemoveTags.hs view
@@ -22,7 +22,7 @@ -- -- Derived from AWS service descriptions, licensed under Apache 2.0. --- | Remove existing tags from a pipeline.+-- | Removes existing tags from the specified pipeline. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_RemoveTags.html> module Network.AWS.DataPipeline.RemoveTags@@ -41,6 +41,7 @@ , removeTagsResponse ) where +import Network.AWS.Data (Object) import Network.AWS.Prelude import Network.AWS.Request.JSON import Network.AWS.DataPipeline.Types@@ -66,11 +67,11 @@ , _rtTagKeys = mempty } --- | The pipeline from which you want to remove tags.+-- | The ID of the pipeline. rtPipelineId :: Lens' RemoveTags Text rtPipelineId = lens _rtPipelineId (\s a -> s { _rtPipelineId = a }) --- | The keys of the tags you wish to remove.+-- | The keys of the tags to remove. rtTagKeys :: Lens' RemoveTags [Text] rtTagKeys = lens _rtTagKeys (\s a -> s { _rtTagKeys = a }) . _List
gen/Network/AWS/DataPipeline/ReportTaskProgress.hs view
@@ -22,19 +22,19 @@ -- -- Derived from AWS service descriptions, licensed under Apache 2.0. --- | Updates the AWS Data Pipeline service on the progress of the calling task--- runner. When the task runner is assigned a task, it should call--- ReportTaskProgress to acknowledge that it has the task within 2 minutes. If--- the web service does not recieve this acknowledgement within the 2 minute--- window, it will assign 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+-- | 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. If a task runner does not report its status after 5 minutes,--- AWS Data Pipeline will assume that the task runner is unable to process the--- task and will reassign the task in a subsequent response to 'PollForTask'. task--- runners should call 'ReportTaskProgress' every 60 seconds.+-- your pipeline. --+-- If a task runner does not report its status after 5 minutes, AWS Data+-- Pipeline assumes that the task runner is unable to process the task and+-- reassigns the task in a subsequent response to 'PollForTask'. Task runners+-- should call 'ReportTaskProgress' every 60 seconds.+-- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_ReportTaskProgress.html> module Network.AWS.DataPipeline.ReportTaskProgress (@@ -54,6 +54,7 @@ , rtprCanceled ) where +import Network.AWS.Data (Object) import Network.AWS.Prelude import Network.AWS.Request.JSON import Network.AWS.DataPipeline.Types@@ -84,9 +85,8 @@ rtpFields :: Lens' ReportTaskProgress [Field] rtpFields = lens _rtpFields (\s a -> s { _rtpFields = a }) . _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.+-- | The ID of the task assigned to the task runner. This value is provided in the+-- response for 'PollForTask'. rtpTaskId :: Lens' ReportTaskProgress Text rtpTaskId = lens _rtpTaskId (\s a -> s { _rtpTaskId = a }) @@ -106,7 +106,7 @@ { _rtprCanceled = p1 } --- | If 'True', the calling task runner should cancel processing of the task. The+-- | If true, the calling task runner should cancel processing of the task. The -- task runner does not need to call 'SetTaskStatus' for canceled tasks. rtprCanceled :: Lens' ReportTaskProgressResponse Bool rtprCanceled = lens _rtprCanceled (\s a -> s { _rtprCanceled = a })
gen/Network/AWS/DataPipeline/ReportTaskRunnerHeartbeat.hs view
@@ -23,10 +23,9 @@ -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | Task runners call 'ReportTaskRunnerHeartbeat' every 15 minutes to indicate that--- they are operational. In the case of AWS Data Pipeline Task Runner 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.+-- 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. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_ReportTaskRunnerHeartbeat.html> module Network.AWS.DataPipeline.ReportTaskRunnerHeartbeat@@ -48,6 +47,7 @@ , rtrhrTerminate ) where +import Network.AWS.Data (Object) import Network.AWS.Prelude import Network.AWS.Request.JSON import Network.AWS.DataPipeline.Types@@ -77,22 +77,23 @@ , _rtrhHostname = Nothing } --- | The public DNS name of the calling task runner.+-- | The public DNS name of the task runner. rtrhHostname :: Lens' ReportTaskRunnerHeartbeat (Maybe Text) rtrhHostname = lens _rtrhHostname (\s a -> s { _rtrhHostname = a }) --- | 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.+-- | 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. rtrhTaskrunnerId :: Lens' ReportTaskRunnerHeartbeat Text rtrhTaskrunnerId = lens _rtrhTaskrunnerId (\s a -> s { _rtrhTaskrunnerId = a }) --- | 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.+-- | 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. rtrhWorkerGroup :: Lens' ReportTaskRunnerHeartbeat (Maybe Text) rtrhWorkerGroup = lens _rtrhWorkerGroup (\s a -> s { _rtrhWorkerGroup = a }) @@ -112,8 +113,7 @@ { _rtrhrTerminate = p1 } --- | Indicates whether the calling task runner should terminate. If 'True', the task--- runner that called 'ReportTaskRunnerHeartbeat' should terminate.+-- | Indicates whether the calling task runner should terminate. rtrhrTerminate :: Lens' ReportTaskRunnerHeartbeatResponse Bool rtrhrTerminate = lens _rtrhrTerminate (\s a -> s { _rtrhrTerminate = a })
gen/Network/AWS/DataPipeline/SetStatus.hs view
@@ -22,12 +22,11 @@ -- -- Derived from AWS service descriptions, licensed under Apache 2.0. --- | Requests that the status of an array of physical or logical pipeline objects--- be updated in the pipeline. This update may not occur immediately, but is--- eventually consistent. The status that can be set depends on the type of--- object, e.g. DataNode or Activity. You cannot perform this operation on--- FINISHED pipelines and attempting to do so will return an--- InvalidRequestException.+-- | 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'. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_SetStatus.html> module Network.AWS.DataPipeline.SetStatus@@ -47,6 +46,7 @@ , setStatusResponse ) where +import Network.AWS.Data (Object) import Network.AWS.Prelude import Network.AWS.Request.JSON import Network.AWS.DataPipeline.Types@@ -77,18 +77,17 @@ , _ssObjectIds = mempty } --- | Identifies an array of objects. The corresponding objects can be either--- physical or components, but not a mix of both types.+-- | The IDs of the objects. The corresponding objects can be either physical or+-- components, but not a mix of both types. ssObjectIds :: Lens' SetStatus [Text] ssObjectIds = lens _ssObjectIds (\s a -> s { _ssObjectIds = a }) . _List --- | Identifies the pipeline that contains the objects.+-- | The ID of the pipeline that contains the objects. ssPipelineId :: Lens' SetStatus Text ssPipelineId = lens _ssPipelineId (\s a -> s { _ssPipelineId = a }) --- | 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'.+-- | 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'. ssStatus :: Lens' SetStatus Text ssStatus = lens _ssStatus (\s a -> s { _ssStatus = a })
gen/Network/AWS/DataPipeline/SetTaskStatus.hs view
@@ -22,9 +22,11 @@ -- -- Derived from AWS service descriptions, licensed under Apache 2.0. --- | Notifies AWS Data Pipeline that a task is completed and provides information--- about the final status. The task runner calls this action regardless of--- whether the task was sucessful. The task runner does not need to call 'SetTaskStatus' for tasks that are canceled by the web service during a call to 'ReportTaskProgress'.+-- | 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'. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_SetTaskStatus.html> module Network.AWS.DataPipeline.SetTaskStatus@@ -46,6 +48,7 @@ , setTaskStatusResponse ) where +import Network.AWS.Data (Object) import Network.AWS.Prelude import Network.AWS.Request.JSON import Network.AWS.DataPipeline.Types@@ -84,10 +87,10 @@ , _stsErrorStackTrace = Nothing } --- | 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.+-- | 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. stsErrorId :: Lens' SetTaskStatus (Maybe Text) stsErrorId = lens _stsErrorId (\s a -> s { _stsErrorId = a }) @@ -106,12 +109,13 @@ stsErrorStackTrace = lens _stsErrorStackTrace (\s a -> s { _stsErrorStackTrace = a }) --- | Identifies the task assigned to the task runner. This value is set in the 'TaskObject' that is returned by the 'PollForTask' action.+-- | The ID of the task assigned to the task runner. This value is provided in the+-- response for 'PollForTask'. stsTaskId :: Lens' SetTaskStatus Text stsTaskId = lens _stsTaskId (\s a -> s { _stsTaskId = a }) --- | If 'FINISHED', the task successfully completed. If 'FAILED' the task ended--- unsuccessfully. The 'FALSE' value is used by preconditions.+-- | If 'FINISHED', the task successfully completed. If 'FAILED', the task ended+-- unsuccessfully. Preconditions use false. stsTaskStatus :: Lens' SetTaskStatus TaskStatus stsTaskStatus = lens _stsTaskStatus (\s a -> s { _stsTaskStatus = a })
gen/Network/AWS/DataPipeline/Types.hs view
@@ -203,7 +203,7 @@ poAttributes :: Lens' ParameterObject [ParameterAttribute] poAttributes = lens _poAttributes (\s a -> s { _poAttributes = a }) . _List --- | Identifier of the parameter object.+-- | The ID of the parameter object. poId :: Lens' ParameterObject Text poId = lens _poId (\s a -> s { _poId = a }) @@ -247,11 +247,11 @@ po1Fields :: Lens' PipelineObject [Field] po1Fields = lens _po1Fields (\s a -> s { _po1Fields = a }) . _List --- | Identifier of the object.+-- | The ID of the object. po1Id :: Lens' PipelineObject Text po1Id = lens _po1Id (\s a -> s { _po1Id = a }) --- | Name of the object.+-- | The name of the object. po1Name :: Lens' PipelineObject Text po1Name = lens _po1Name (\s a -> s { _po1Name = a }) @@ -379,7 +379,7 @@ , _pvStringValue = p2 } --- | Identifier of the parameter value.+-- | The ID of the parameter value. pvId :: Lens' ParameterValue Text pvId = lens _pvId (\s a -> s { _pvId = a }) @@ -559,8 +559,8 @@ , _toObjects = mempty } --- | Identifier of the pipeline task attempt object. AWS Data Pipeline uses this--- value to track how many times a task is attempted.+-- | The ID of the pipeline task attempt object. AWS Data Pipeline uses this value+-- to track how many times a task is attempted. toAttemptId :: Lens' TaskObject (Maybe Text) toAttemptId = lens _toAttemptId (\s a -> s { _toAttemptId = a }) @@ -569,7 +569,7 @@ toObjects :: Lens' TaskObject (HashMap Text PipelineObject) toObjects = lens _toObjects (\s a -> s { _toObjects = a }) . _Map --- | Identifier of the pipeline that provided the task.+-- | The ID of the pipeline that provided the task. toPipelineId :: Lens' TaskObject (Maybe Text) toPipelineId = lens _toPipelineId (\s a -> s { _toPipelineId = a }) @@ -673,7 +673,7 @@ pdFields :: Lens' PipelineDescription [Field] pdFields = lens _pdFields (\s a -> s { _pdFields = a }) . _List --- | Name of the pipeline.+-- | The name of the pipeline. pdName :: Lens' PipelineDescription Text pdName = lens _pdName (\s a -> s { _pdName = a }) @@ -724,9 +724,9 @@ , _iiSignature = Nothing } --- | 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.+-- | 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. iiDocument :: Lens' InstanceIdentity (Maybe Text) iiDocument = lens _iiDocument (\s a -> s { _iiDocument = a }) @@ -838,12 +838,12 @@ , _pinName = Nothing } --- | Identifier of the pipeline that was assigned by AWS Data Pipeline. This is a+-- | The ID of the pipeline that was assigned by AWS Data Pipeline. This is a -- string of the form 'df-297EG78HU43EEXAMPLE'. pinId :: Lens' PipelineIdName (Maybe Text) pinId = lens _pinId (\s a -> s { _pinId = a }) --- | Name of the pipeline.+-- | The name of the pipeline. pinName :: Lens' PipelineIdName (Maybe Text) pinName = lens _pinName (\s a -> s { _pinName = a })
gen/Network/AWS/DataPipeline/ValidatePipelineDefinition.hs view
@@ -22,8 +22,8 @@ -- -- Derived from AWS service descriptions, licensed under Apache 2.0. --- | Tests the pipeline definition with a set of validation checks to ensure that--- it is well formed and can run without error.+-- | Validates the specified pipeline definition to ensure that it is well formed+-- and can be run without error. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_ValidatePipelineDefinition.html> module Network.AWS.DataPipeline.ValidatePipelineDefinition@@ -48,6 +48,7 @@ , vpdrValidationWarnings ) where +import Network.AWS.Data (Object) import Network.AWS.Prelude import Network.AWS.Request.JSON import Network.AWS.DataPipeline.Types@@ -81,24 +82,23 @@ , _vpdParameterValues = mempty } --- | A list of parameter objects used with the pipeline.+-- | The parameter objects used with the pipeline. vpdParameterObjects :: Lens' ValidatePipelineDefinition [ParameterObject] vpdParameterObjects = lens _vpdParameterObjects (\s a -> s { _vpdParameterObjects = a }) . _List --- | A list of parameter values used with the pipeline.+-- | The parameter values used with the pipeline. vpdParameterValues :: Lens' ValidatePipelineDefinition [ParameterValue] vpdParameterValues = lens _vpdParameterValues (\s a -> s { _vpdParameterValues = a }) . _List --- | Identifies the pipeline whose definition is to be validated.+-- | The ID of the pipeline. vpdPipelineId :: Lens' ValidatePipelineDefinition Text vpdPipelineId = lens _vpdPipelineId (\s a -> s { _vpdPipelineId = a }) --- | A list of objects that define the pipeline changes to validate against the--- pipeline.+-- | The objects that define the pipeline changes to validate against the pipeline. vpdPipelineObjects :: Lens' ValidatePipelineDefinition [PipelineObject] vpdPipelineObjects = lens _vpdPipelineObjects (\s a -> s { _vpdPipelineObjects = a })@@ -128,17 +128,17 @@ , _vpdrValidationWarnings = mempty } --- | If 'True', there were validation errors.+-- | Indicates whether there were validation errors. vpdrErrored :: Lens' ValidatePipelineDefinitionResponse Bool vpdrErrored = lens _vpdrErrored (\s a -> s { _vpdrErrored = a }) --- | Lists the validation errors that were found by 'ValidatePipelineDefinition'.+-- | Any validation errors that were found. vpdrValidationErrors :: Lens' ValidatePipelineDefinitionResponse [ValidationError] vpdrValidationErrors = lens _vpdrValidationErrors (\s a -> s { _vpdrValidationErrors = a }) . _List --- | Lists the validation warnings that were found by 'ValidatePipelineDefinition'.+-- | Any validation warnings that were found. vpdrValidationWarnings :: Lens' ValidatePipelineDefinitionResponse [ValidationWarning] vpdrValidationWarnings = lens _vpdrValidationWarnings (\s a -> s { _vpdrValidationWarnings = a })