| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.DataPipeline.DeactivatePipeline
Description
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.
See: AWS API Reference for DeactivatePipeline.
- deactivatePipeline :: Text -> DeactivatePipeline
- data DeactivatePipeline
- dCancelActive :: Lens' DeactivatePipeline (Maybe Bool)
- dPipelineId :: Lens' DeactivatePipeline Text
- deactivatePipelineResponse :: Int -> DeactivatePipelineResponse
- data DeactivatePipelineResponse
- drsResponseStatus :: Lens' DeactivatePipelineResponse Int
Creating a Request
Arguments
| :: Text | |
| -> DeactivatePipeline |
Creates a value of DeactivatePipeline with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DeactivatePipeline Source
Contains the parameters for DeactivatePipeline.
See: deactivatePipeline smart constructor.
Instances
Request Lenses
dCancelActive :: Lens' DeactivatePipeline (Maybe Bool) Source
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.
dPipelineId :: Lens' DeactivatePipeline Text Source
The ID of the pipeline.
Destructuring the Response
deactivatePipelineResponse Source
Arguments
| :: Int | |
| -> DeactivatePipelineResponse |
Creates a value of DeactivatePipelineResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DeactivatePipelineResponse Source
Contains the output of DeactivatePipeline.
See: deactivatePipelineResponse smart constructor.
Response Lenses
drsResponseStatus :: Lens' DeactivatePipelineResponse Int Source
The response status code.