| 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.DataPipeline.ActivatePipeline
Description
Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails.
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.
Synopsis
- data ActivatePipeline = ActivatePipeline' {}
- newActivatePipeline :: Text -> ActivatePipeline
- activatePipeline_startTimestamp :: Lens' ActivatePipeline (Maybe UTCTime)
- activatePipeline_parameterValues :: Lens' ActivatePipeline (Maybe [ParameterValue])
- activatePipeline_pipelineId :: Lens' ActivatePipeline Text
- data ActivatePipelineResponse = ActivatePipelineResponse' {
- httpStatus :: Int
- newActivatePipelineResponse :: Int -> ActivatePipelineResponse
- activatePipelineResponse_httpStatus :: Lens' ActivatePipelineResponse Int
Creating a Request
data ActivatePipeline Source #
Contains the parameters for ActivatePipeline.
See: newActivatePipeline smart constructor.
Constructors
| ActivatePipeline' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ActivatePipeline |
Create a value of ActivatePipeline 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:startTimestamp:ActivatePipeline', activatePipeline_startTimestamp - The date and time to resume the pipeline. By default, the pipeline
resumes from the last completed execution.
$sel:parameterValues:ActivatePipeline', activatePipeline_parameterValues - A list of parameter values to pass to the pipeline at activation.
$sel:pipelineId:ActivatePipeline', activatePipeline_pipelineId - The ID of the pipeline.
Request Lenses
activatePipeline_startTimestamp :: Lens' ActivatePipeline (Maybe UTCTime) Source #
The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.
activatePipeline_parameterValues :: Lens' ActivatePipeline (Maybe [ParameterValue]) Source #
A list of parameter values to pass to the pipeline at activation.
activatePipeline_pipelineId :: Lens' ActivatePipeline Text Source #
The ID of the pipeline.
Destructuring the Response
data ActivatePipelineResponse Source #
Contains the output of ActivatePipeline.
See: newActivatePipelineResponse smart constructor.
Constructors
| ActivatePipelineResponse' | |
Fields
| |
Instances
newActivatePipelineResponse Source #
Create a value of ActivatePipelineResponse 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:httpStatus:ActivatePipelineResponse', activatePipelineResponse_httpStatus - The response's http status code.
Response Lenses
activatePipelineResponse_httpStatus :: Lens' ActivatePipelineResponse Int Source #
The response's http status code.