| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.M2.StartBatchJob
Description
Starts a batch job and returns the unique identifier of this execution of the batch job. The associated application must be running in order to start the batch job.
Synopsis
- data StartBatchJob = StartBatchJob' {}
- newStartBatchJob :: Text -> BatchJobIdentifier -> StartBatchJob
- startBatchJob_jobParams :: Lens' StartBatchJob (Maybe (HashMap Text Text))
- startBatchJob_applicationId :: Lens' StartBatchJob Text
- startBatchJob_batchJobIdentifier :: Lens' StartBatchJob BatchJobIdentifier
- data StartBatchJobResponse = StartBatchJobResponse' {
- httpStatus :: Int
- executionId :: Text
- newStartBatchJobResponse :: Int -> Text -> StartBatchJobResponse
- startBatchJobResponse_httpStatus :: Lens' StartBatchJobResponse Int
- startBatchJobResponse_executionId :: Lens' StartBatchJobResponse Text
Creating a Request
data StartBatchJob Source #
See: newStartBatchJob smart constructor.
Constructors
| StartBatchJob' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> BatchJobIdentifier | |
| -> StartBatchJob |
Create a value of StartBatchJob 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:jobParams:StartBatchJob', startBatchJob_jobParams - The collection of batch job parameters. For details about limits for
keys and values, see
Coding variables in JCL.
StartBatchJob, startBatchJob_applicationId - The unique identifier of the application associated with this batch job.
$sel:batchJobIdentifier:StartBatchJob', startBatchJob_batchJobIdentifier - The unique identifier of the batch job.
Request Lenses
startBatchJob_jobParams :: Lens' StartBatchJob (Maybe (HashMap Text Text)) Source #
The collection of batch job parameters. For details about limits for keys and values, see Coding variables in JCL.
startBatchJob_applicationId :: Lens' StartBatchJob Text Source #
The unique identifier of the application associated with this batch job.
startBatchJob_batchJobIdentifier :: Lens' StartBatchJob BatchJobIdentifier Source #
The unique identifier of the batch job.
Destructuring the Response
data StartBatchJobResponse Source #
See: newStartBatchJobResponse smart constructor.
Constructors
| StartBatchJobResponse' | |
Fields
| |
Instances
newStartBatchJobResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> StartBatchJobResponse |
Create a value of StartBatchJobResponse 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:StartBatchJobResponse', startBatchJobResponse_httpStatus - The response's http status code.
StartBatchJobResponse, startBatchJobResponse_executionId - The unique identifier of this execution of the batch job.
Response Lenses
startBatchJobResponse_httpStatus :: Lens' StartBatchJobResponse Int Source #
The response's http status code.
startBatchJobResponse_executionId :: Lens' StartBatchJobResponse Text Source #
The unique identifier of this execution of the batch job.