| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.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.
Synopsis
- data UpdatePipelineStatus = UpdatePipelineStatus' {}
- newUpdatePipelineStatus :: Text -> Text -> UpdatePipelineStatus
- updatePipelineStatus_id :: Lens' UpdatePipelineStatus Text
- updatePipelineStatus_status :: Lens' UpdatePipelineStatus Text
- data UpdatePipelineStatusResponse = UpdatePipelineStatusResponse' {
- pipeline :: Maybe Pipeline
- httpStatus :: Int
- newUpdatePipelineStatusResponse :: Int -> UpdatePipelineStatusResponse
- updatePipelineStatusResponse_pipeline :: Lens' UpdatePipelineStatusResponse (Maybe Pipeline)
- updatePipelineStatusResponse_httpStatus :: Lens' UpdatePipelineStatusResponse Int
Creating a Request
data UpdatePipelineStatus Source #
The UpdatePipelineStatusRequest structure.
See: newUpdatePipelineStatus smart constructor.
Constructors
| UpdatePipelineStatus' | |
Instances
newUpdatePipelineStatus Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdatePipelineStatus |
Create a value of UpdatePipelineStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:UpdatePipelineStatus', updatePipelineStatus_id - The identifier of the pipeline to update.
$sel:status:UpdatePipelineStatus', updatePipelineStatus_status - The desired status of the pipeline:
Active: The pipeline is processing jobs.Paused: The pipeline is not currently processing jobs.
Request Lenses
updatePipelineStatus_id :: Lens' UpdatePipelineStatus Text Source #
The identifier of the pipeline to update.
updatePipelineStatus_status :: 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
data UpdatePipelineStatusResponse Source #
When you update status for a pipeline, Elastic Transcoder returns the values that you specified in the request.
See: newUpdatePipelineStatusResponse smart constructor.
Constructors
| UpdatePipelineStatusResponse' | |
Fields
| |
Instances
newUpdatePipelineStatusResponse Source #
Create a value of UpdatePipelineStatusResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pipeline:UpdatePipelineStatusResponse', updatePipelineStatusResponse_pipeline - A section of the response body that provides information about the
pipeline.
$sel:httpStatus:UpdatePipelineStatusResponse', updatePipelineStatusResponse_httpStatus - The response's http status code.
Response Lenses
updatePipelineStatusResponse_pipeline :: Lens' UpdatePipelineStatusResponse (Maybe Pipeline) Source #
A section of the response body that provides information about the pipeline.
updatePipelineStatusResponse_httpStatus :: Lens' UpdatePipelineStatusResponse Int Source #
The response's http status code.