| 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.ElasticTranscoder.UpdatePipelineStatus
Description
The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs.
Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob request.
See: AWS API Reference for UpdatePipelineStatus.
- updatePipelineStatus :: Text -> Text -> UpdatePipelineStatus
- data UpdatePipelineStatus
- upsId :: Lens' UpdatePipelineStatus Text
- upsStatus :: Lens' UpdatePipelineStatus Text
- updatePipelineStatusResponse :: Int -> UpdatePipelineStatusResponse
- data UpdatePipelineStatusResponse
- upsrsPipeline :: Lens' UpdatePipelineStatusResponse (Maybe Pipeline)
- upsrsStatus :: Lens' UpdatePipelineStatusResponse Int
Creating a Request
Arguments
| :: Text | |
| -> Text | |
| -> UpdatePipelineStatus |
Creates a value of UpdatePipelineStatus with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data UpdatePipelineStatus Source
The UpdatePipelineStatusRequest structure.
See: updatePipelineStatus smart constructor.
Instances
Request Lenses
upsId :: Lens' UpdatePipelineStatus Text Source
The identifier of the pipeline to update.
upsStatus :: Lens' UpdatePipelineStatus Text Source
The desired status of the pipeline:
Active: The pipeline is processing jobs.Paused: The pipeline is not currently processing jobs.
Destructuring the Response
updatePipelineStatusResponse Source
Arguments
| :: Int | |
| -> UpdatePipelineStatusResponse |
Creates a value of UpdatePipelineStatusResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data UpdatePipelineStatusResponse Source
When you update status for a pipeline, Elastic Transcoder returns the values that you specified in the request.
See: updatePipelineStatusResponse smart constructor.
Response Lenses
upsrsPipeline :: Lens' UpdatePipelineStatusResponse (Maybe Pipeline) Source
A section of the response body that provides information about the pipeline.
upsrsStatus :: Lens' UpdatePipelineStatusResponse Int Source
The response status code.