packages feed

amazonka-datapipeline 0.0.1 → 0.0.2

raw patch · 19 files changed

+243/−251 lines, 19 filesdep ~amazonka-corePVP ok

version bump matches the API change (PVP)

Dependency ranges changed: amazonka-core

API changes (from Hackage documentation)

Files

README.md view
@@ -8,7 +8,10 @@  ## Description -AWS Data Pipeline is a web service that you can use to automate the movement and transformation of data. With AWS Data Pipeline, you can define data-driven workflows, so that tasks can be dependent on the successful completion of previous tasks.+    AWS Data Pipeline is a web service that you can use to automate the movement+    and transformation of data. With AWS Data Pipeline, you can define+    data-driven workflows, so that tasks can be dependent on the successful+    completion of previous tasks.  Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-datapipeline) and [AWS API Reference](http://docs.aws.amazon.com/datapipeline/latest/APIReference/Welcome.html).
amazonka-datapipeline.cabal view
@@ -1,5 +1,5 @@ name:                  amazonka-datapipeline-version:               0.0.1+version:               0.0.2 synopsis:              Amazon Data Pipeline SDK. homepage:              https://github.com/brendanhay/amazonka license:               OtherLicense@@ -13,10 +13,10 @@ cabal-version:         >= 1.10  description:-    AWS Data Pipeline is a web service that you can use to automate the-    movement and transformation of data. With AWS Data Pipeline, you can-    define data-driven workflows, so that tasks can be dependent on the-    successful completion of previous tasks.+    AWS Data Pipeline is a web service that you can use to automate the movement+    and transformation of data. With AWS Data Pipeline, you can define+    data-driven workflows, so that tasks can be dependent on the successful+    completion of previous tasks.     .     /See:/ <http://docs.aws.amazon.com/datapipeline/latest/APIReference/Welcome.html AWS API Reference>     .@@ -56,5 +56,5 @@     other-modules:      build-depends:-          amazonka-core == 0.0.1.*+          amazonka-core == 0.0.2.*         , base          >= 4.7     && < 5
gen/Network/AWS/DataPipeline.hs view
@@ -8,8 +8,8 @@ -- Stability   : experimental -- Portability : non-portable (GHC extensions) --- | AWS Data Pipeline is a web service that you can use to automate the--- movement and transformation of data. With AWS Data Pipeline, you can define+-- | AWS Data Pipeline is a web service that you can use to automate the movement+-- and transformation of data. With AWS Data Pipeline, you can define -- data-driven workflows, so that tasks can be dependent on the successful -- completion of previous tasks. module Network.AWS.DataPipeline
gen/Network/AWS/DataPipeline/ActivatePipeline.hs view
@@ -20,11 +20,12 @@ -- Stability   : experimental -- Portability : non-portable (GHC extensions) --- | Validates a pipeline and initiates processing. 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.+-- | Validates a pipeline and initiates processing. 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. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_ActivatePipeline.html> module Network.AWS.DataPipeline.ActivatePipeline
gen/Network/AWS/DataPipeline/CreatePipeline.hs view
@@ -20,8 +20,7 @@ -- Stability   : experimental -- Portability : non-portable (GHC extensions) --- | 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. When this action succeeds, you can then use the 'PutPipelineDefinition' action to populate the pipeline. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_CreatePipeline.html> module Network.AWS.DataPipeline.CreatePipeline@@ -78,23 +77,22 @@ 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.+-- pipelines associated with your AWS account, because AWS Data Pipeline assigns+-- each new pipeline a unique pipeline identifier. cpName :: Lens' CreatePipeline Text cpName = lens _cpName (\s a -> s { _cpName = a }) --- | 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 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. cpUniqueId :: Lens' CreatePipeline Text cpUniqueId = lens _cpUniqueId (\s a -> s { _cpUniqueId = a }) @@ -114,8 +112,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. The ID is a+-- string of the form: df-06372391ZG65EXAMPLE. cprPipelineId :: Lens' CreatePipelineResponse Text cprPipelineId = lens _cprPipelineId (\s a -> s { _cprPipelineId = a })
gen/Network/AWS/DataPipeline/DeletePipeline.hs view
@@ -20,13 +20,14 @@ -- Stability   : experimental -- Portability : non-portable (GHC extensions) --- | 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. 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.+-- | 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.+--+-- 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
gen/Network/AWS/DataPipeline/DescribeObjects.hs view
@@ -21,8 +21,8 @@ -- Portability : non-portable (GHC extensions)  -- | Returns 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.+-- pipeline. Object definitions are composed of a set of fields that define the+-- properties of the object. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_DescribeObjects.html> module Network.AWS.DataPipeline.DescribeObjects@@ -80,17 +80,14 @@     , _doMarker              = Nothing     } --- | Indicates whether any expressions in the object should be evaluated when--- the object descriptions are returned.+-- | Indicates whether any expressions in the object should be evaluated when the+-- object descriptions are returned. doEvaluateExpressions :: Lens' DescribeObjects (Maybe Bool) 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. 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. doMarker :: Lens' DescribeObjects (Maybe Text) doMarker = lens _doMarker (\s a -> s { _doMarker = a }) @@ -127,18 +124,17 @@     , _dorHasMoreResults  = Nothing     } --- | If True, there are more pages of results to return.+-- | If 'True', there are more pages of 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. 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 that are returned by the call to 'DescribeObjects'. dorPipelineObjects :: Lens' DescribeObjectsResponse [PipelineObject] dorPipelineObjects =     lens _dorPipelineObjects (\s a -> s { _dorPipelineObjects = a })
gen/Network/AWS/DataPipeline/DescribePipelines.hs view
@@ -25,10 +25,11 @@ -- 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. To--- retrieve the full pipeline definition instead of metadata about the--- pipeline, call the GetPipelineDefinition action.+-- metadata about only those pipelines you have read permission for. --+-- To retrieve the full pipeline definition instead of metadata about the+-- pipeline, call the 'GetPipelineDefinition' action.+-- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_DescribePipelines.html> module Network.AWS.DataPipeline.DescribePipelines     (@@ -74,8 +75,8 @@     }  -- | 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.+-- identifiers in a single call to 'DescribePipelines'. You can obtain pipeline+-- identifiers by calling 'ListPipelines'. dpPipelineIds :: Lens' DescribePipelines [Text] dpPipelineIds = lens _dpPipelineIds (\s a -> s { _dpPipelineIds = a }) . _List
gen/Network/AWS/DataPipeline/GetPipelineDefinition.hs view
@@ -20,9 +20,7 @@ -- Stability   : experimental -- Portability : non-portable (GHC extensions) --- | Returns the definition of the specified pipeline. You can call--- GetPipelineDefinition to retrieve the pipeline definition you provided--- using PutPipelineDefinition.+-- | Returns the definition of the specified pipeline. You can call 'GetPipelineDefinition' to retrieve the pipeline definition you provided using 'PutPipelineDefinition'. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_GetPipelineDefinition.html> module Network.AWS.DataPipeline.GetPipelineDefinition@@ -72,10 +70,10 @@ 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. 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. gpdVersion :: Lens' GetPipelineDefinition (Maybe Text) gpdVersion = lens _gpdVersion (\s a -> s { _gpdVersion = a })
gen/Network/AWS/DataPipeline/ListPipelines.hs view
@@ -20,8 +20,8 @@ -- Stability   : experimental -- Portability : non-portable (GHC extensions) --- | Returns a list of pipeline identifiers for all active pipelines.--- Identifiers are returned only for pipelines you have permission to access.+-- | Returns a list of pipeline identifiers for all active pipelines. Identifiers+-- are returned only for pipelines you have permission to access. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_ListPipelines.html> module Network.AWS.DataPipeline.ListPipelines@@ -63,10 +63,8 @@     { _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. 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. lpMarker :: Lens' ListPipelines (Maybe Text) lpMarker = lens _lpMarker (\s a -> s { _lpMarker = a }) @@ -93,22 +91,20 @@     , _lprHasMoreResults = Nothing     } --- | If True, there are more results that can be obtained by a subsequent call--- to ListPipelines.+-- | If 'True', there are more results that can be obtained by a subsequent call to 'ListPipelines'. 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.+-- | 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. 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.+-- | 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'. lprPipelineIdList :: Lens' ListPipelinesResponse [PipelineIdName] lprPipelineIdList =     lens _lprPipelineIdList (\s a -> s { _lprPipelineIdList = a })
gen/Network/AWS/DataPipeline/PollForTask.hs view
@@ -22,18 +22,19 @@  -- | Task runners call this action 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+-- 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. 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 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.+-- 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+-- 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.+-- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_PollForTask.html> module Network.AWS.DataPipeline.PollForTask     (@@ -88,22 +89,18 @@ 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 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+-- 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. 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.+-- 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 }) @@ -122,12 +119,12 @@     { _pftrTaskObject = Nothing     } --- | An instance of PollForTaskResult, which contains 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.+-- | An instance of 'PollForTaskResult', which contains 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'. pftrTaskObject :: Lens' PollForTaskResponse (Maybe TaskObject) pftrTaskObject = lens _pftrTaskObject (\s a -> s { _pftrTaskObject = a })
gen/Network/AWS/DataPipeline/PutPipelineDefinition.hs view
@@ -22,14 +22,16 @@  -- | Adds tasks, schedules, and preconditions that control the behavior of the -- 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. Pipeline--- object definitions are passed to the PutPipelineDefinition action and--- returned by the GetPipelineDefinition action. --+-- '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.+--+-- 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     (@@ -111,21 +113,21 @@     , _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.+-- | 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. 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.+-- | A list of 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.+-- defined in 'pipelineObjects'. ppdrValidationWarnings :: Lens' PutPipelineDefinitionResponse [ValidationWarning] ppdrValidationWarnings =     lens _ppdrValidationWarnings (\s a -> s { _ppdrValidationWarnings = a })
gen/Network/AWS/DataPipeline/QueryObjects.hs view
@@ -21,12 +21,14 @@ -- Portability : non-portable (GHC extensions)  -- | 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.+-- 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'.+-- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_QueryObjects.html> module Network.AWS.DataPipeline.QueryObjects     (@@ -89,15 +91,13 @@     , _qoLimit      = Nothing     } --- | Specifies the maximum number of object names that QueryObjects will--- return in a single call. The default value is 100.+-- | Specifies 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. 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. qoMarker :: Lens' QueryObjects (Maybe Text) qoMarker = lens _qoMarker (\s a -> s { _qoMarker = a }) @@ -105,15 +105,15 @@ 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 components, instances, and attempts.+-- | 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.+-- values: 'COMPONENT', 'INSTANCE', 'ATTEMPT'. qoSphere :: Lens' QueryObjects Text qoSphere = lens _qoSphere (\s a -> s { _qoSphere = a }) @@ -140,8 +140,7 @@     , _qorHasMoreResults = Nothing     } --- | If True, there are more results that can be obtained by a subsequent call--- to QueryObjects.+-- | If 'True', there are more results that can be obtained by a subsequent call to 'QueryObjects'. qorHasMoreResults :: Lens' QueryObjectsResponse (Maybe Bool) qorHasMoreResults =     lens _qorHasMoreResults (\s a -> s { _qorHasMoreResults = a })@@ -151,8 +150,8 @@ 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.+-- returns 'HasMoreResults' as 'True', you can call 'QueryObjects' again and pass the+-- marker value from the response to retrieve the next set of results. qorMarker :: Lens' QueryObjectsResponse (Maybe Text) qorMarker = lens _qorMarker (\s a -> s { _qorMarker = a })
gen/Network/AWS/DataPipeline/ReportTaskProgress.hs view
@@ -24,14 +24,14 @@ -- 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--- 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.+-- 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+-- 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. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_ReportTaskProgress.html> module Network.AWS.DataPipeline.ReportTaskProgress@@ -72,9 +72,9 @@     { _rtpTaskId = p1     } --- | 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.+-- | 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. rtpTaskId :: Lens' ReportTaskProgress Text rtpTaskId = lens _rtpTaskId (\s a -> s { _rtpTaskId = a }) @@ -94,8 +94,8 @@     { _rtprCanceled = p1     } --- | If True, the calling task runner should cancel processing of the task.--- The task runner does not need to call SetTaskStatus for canceled tasks.+-- | 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
@@ -20,11 +20,11 @@ -- Stability   : experimental -- Portability : non-portable (GHC extensions) --- | 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.+-- | 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. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_ReportTaskRunnerHeartbeat.html> module Network.AWS.DataPipeline.ReportTaskRunnerHeartbeat@@ -79,21 +79,18 @@ 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 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. 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.+-- 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. rtrhWorkerGroup :: Lens' ReportTaskRunnerHeartbeat (Maybe Text) rtrhWorkerGroup = lens _rtrhWorkerGroup (\s a -> s { _rtrhWorkerGroup = a }) @@ -113,8 +110,8 @@     { _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. If 'True', the task+-- runner that called 'ReportTaskRunnerHeartbeat' should terminate. rtrhrTerminate :: Lens' ReportTaskRunnerHeartbeatResponse Bool rtrhrTerminate = lens _rtrhrTerminate (\s a -> s { _rtrhrTerminate = a })
gen/Network/AWS/DataPipeline/SetStatus.hs view
@@ -20,10 +20,10 @@ -- Stability   : experimental -- Portability : non-portable (GHC extensions) --- | 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.+-- | 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. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_SetStatus.html> module Network.AWS.DataPipeline.SetStatus@@ -82,9 +82,9 @@ 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 CANCEL, RERUN, or MARK_FINISHED.+-- | 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 'CANCEL', 'RERUN', or 'MARK_FINISHED'. ssStatus :: Lens' SetStatus Text ssStatus = lens _ssStatus (\s a -> s { _ssStatus = a })
gen/Network/AWS/DataPipeline/SetTaskStatus.hs view
@@ -20,11 +20,9 @@ -- Stability   : experimental -- Portability : non-portable (GHC extensions) --- | 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.+-- | 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'. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_SetTaskStatus.html> module Network.AWS.DataPipeline.SetTaskStatus@@ -84,35 +82,34 @@     , _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 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. stsErrorId :: Lens' SetTaskStatus (Maybe Text) stsErrorId = lens _stsErrorId (\s a -> s { _stsErrorId = a }) --- | 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.+-- | 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. stsErrorMessage :: Lens' SetTaskStatus (Maybe Text) stsErrorMessage = lens _stsErrorMessage (\s a -> s { _stsErrorMessage = a }) --- | 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.+-- | 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. stsErrorStackTrace :: Lens' SetTaskStatus (Maybe Text) 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.+-- | Identifies the task assigned to the task runner. This value is set in the 'TaskObject' that is returned by the 'PollForTask' action. 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. The 'FALSE' value is used by preconditions. stsTaskStatus :: Lens' SetTaskStatus TaskStatus stsTaskStatus = lens _stsTaskStatus (\s a -> s { _stsTaskStatus = a })
gen/Network/AWS/DataPipeline/Types.hs view
@@ -247,10 +247,10 @@     , _sOperator  = Nothing     } --- | 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.+-- | 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. sFieldName :: Lens' Selector (Maybe Text) sFieldName = lens _sFieldName (\s a -> s { _sFieldName = a }) @@ -287,21 +287,23 @@     , _oValues = mempty     } --- | 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".+-- | 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". oType :: Lens' Operator (Maybe OperatorType) oType = lens _oType (\s a -> s { _oType = a }) @@ -347,13 +349,13 @@     , _toObjects    = mempty     } --- | Identifier of the pipeline task attempt object. AWS Data Pipeline uses--- this value to track how many times a task is attempted.+-- | Identifier 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 }) --- | Connection information for the location where the task runner will--- publish the output of the task.+-- | Connection information for the location where the task runner will publish+-- the output of the task. toObjects :: Lens' TaskObject (HashMap Text PipelineObject) toObjects = lens _toObjects (\s a -> s { _toObjects = a }) . _Map @@ -361,8 +363,8 @@ toPipelineId :: Lens' TaskObject (Maybe Text) toPipelineId = lens _toPipelineId (\s a -> s { _toPipelineId = a }) --- | An internal identifier for the task. This ID is passed to the--- SetTaskStatus and ReportTaskProgress actions.+-- | An internal identifier for the task. This ID is passed to the 'SetTaskStatus'+-- and 'ReportTaskProgress' actions. toTaskId :: Lens' TaskObject (Maybe Text) toTaskId = lens _toTaskId (\s a -> s { _toTaskId = a }) @@ -452,8 +454,8 @@ pdDescription :: Lens' PipelineDescription (Maybe Text) pdDescription = lens _pdDescription (\s a -> s { _pdDescription = a }) --- | A list of read-only fields that contain metadata about the pipeline:--- @userId, @accountId, and @pipelineState.+-- | A list of read-only fields that contain metadata about the pipeline: @userId,+-- @accountId, and @pipelineState. pdFields :: Lens' PipelineDescription [Field] pdFields = lens _pdFields (\s a -> s { _pdFields = a }) . _List @@ -462,7 +464,7 @@ pdName = lens _pdName (\s a -> s { _pdName = a })  -- | The pipeline identifier that was assigned by AWS Data Pipeline. This is a--- string of the form df-297EG78HU43EEXAMPLE.+-- string of the form 'df-297EG78HU43EEXAMPLE'. pdPipelineId :: Lens' PipelineDescription Text pdPipelineId = lens _pdPipelineId (\s a -> s { _pdPipelineId = a }) @@ -500,14 +502,14 @@     , _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 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. iiDocument :: Lens' InstanceIdentity (Maybe Text) iiDocument = lens _iiDocument (\s a -> s { _iiDocument = a }) --- | A signature which can be used to verify the accuracy and authenticity of--- the information provided in the instance identity document.+-- | A signature which can be used to verify the accuracy and authenticity of the+-- information provided in the instance identity document. iiSignature :: Lens' InstanceIdentity (Maybe Text) iiSignature = lens _iiSignature (\s a -> s { _iiSignature = a }) @@ -543,8 +545,8 @@     { _qSelectors = mempty     } --- | List of selectors that define the query. An object must satisfy all of--- the selectors to match the query.+-- | List of selectors that define the query. An object must satisfy all of the+-- selectors to match the query. qSelectors :: Lens' Query [Selector] qSelectors = lens _qSelectors (\s a -> s { _qSelectors = a }) . _List @@ -568,11 +570,14 @@ instance Hashable OperatorType  instance FromText OperatorType where-    parser = match "BETWEEN" OperatorBetween-         <|> match "EQ"      OperatorEq-         <|> match "GE"      OperatorGe-         <|> match "LE"      OperatorLe-         <|> match "REF_EQ"  OperatorRefEq+    parser = takeText >>= \case+        "BETWEEN" -> pure OperatorBetween+        "EQ"      -> pure OperatorEq+        "GE"      -> pure OperatorGe+        "LE"      -> pure OperatorLe+        "REF_EQ"  -> pure OperatorRefEq+        e         -> fail $+            "Failure parsing OperatorType from " ++ show e  instance ToText OperatorType where     toText = \case@@ -611,8 +616,8 @@     , _pinName = Nothing     } --- | Identifier of the pipeline that was assigned by AWS Data Pipeline. This--- is a string of the form df-297EG78HU43EEXAMPLE.+-- | Identifier 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 }) @@ -640,9 +645,12 @@ instance Hashable TaskStatus  instance FromText TaskStatus where-    parser = match "FAILED"   Failed-         <|> match "FALSE"    False'-         <|> match "FINISHED" Finished+    parser = takeText >>= \case+        "FAILED"   -> pure Failed+        "FALSE"    -> pure False'+        "FINISHED" -> pure Finished+        e          -> fail $+            "Failure parsing TaskStatus from " ++ show e  instance ToText TaskStatus where     toText = \case
gen/Network/AWS/DataPipeline/ValidatePipelineDefinition.hs view
@@ -20,8 +20,8 @@ -- Stability   : experimental -- Portability : non-portable (GHC extensions) --- | Tests the pipeline definition with a set of validation checks to ensure--- that it is well formed and can run without error.+-- | Tests the pipeline definition with a set of validation checks to ensure that+-- it is well formed and can run without error. -- -- <http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_ValidatePipelineDefinition.html> module Network.AWS.DataPipeline.ValidatePipelineDefinition@@ -73,8 +73,8 @@ 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.+-- | A list of objects that define the pipeline changes to validate against the+-- pipeline. vpdPipelineObjects :: Lens' ValidatePipelineDefinition [PipelineObject] vpdPipelineObjects =     lens _vpdPipelineObjects (\s a -> s { _vpdPipelineObjects = a })@@ -104,19 +104,17 @@     , _vpdrValidationWarnings = mempty     } --- | If True, there were validation errors.+-- | If 'True', 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.+-- | Lists the validation errors that were found by 'ValidatePipelineDefinition'. vpdrValidationErrors :: Lens' ValidatePipelineDefinitionResponse [ValidationError] vpdrValidationErrors =     lens _vpdrValidationErrors (\s a -> s { _vpdrValidationErrors = a })         . _List --- | Lists the validation warnings that were found by--- ValidatePipelineDefinition.+-- | Lists the validation warnings that were found by 'ValidatePipelineDefinition'. vpdrValidationWarnings :: Lens' ValidatePipelineDefinitionResponse [ValidationWarning] vpdrValidationWarnings =     lens _vpdrValidationWarnings (\s a -> s { _vpdrValidationWarnings = a })