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 |
Starts a job run.
Synopsis
- data StartJobRun = StartJobRun' {}
- newStartJobRun :: Text -> Text -> Text -> StartJobRun
- startJobRun_configurationOverrides :: Lens' StartJobRun (Maybe ConfigurationOverrides)
- startJobRun_executionTimeoutMinutes :: Lens' StartJobRun (Maybe Natural)
- startJobRun_jobDriver :: Lens' StartJobRun (Maybe JobDriver)
- startJobRun_name :: Lens' StartJobRun (Maybe Text)
- startJobRun_tags :: Lens' StartJobRun (Maybe (HashMap Text Text))
- startJobRun_applicationId :: Lens' StartJobRun Text
- startJobRun_clientToken :: Lens' StartJobRun Text
- startJobRun_executionRoleArn :: Lens' StartJobRun Text
- data StartJobRunResponse = StartJobRunResponse' {
- httpStatus :: Int
- applicationId :: Text
- jobRunId :: Text
- arn :: Text
- newStartJobRunResponse :: Int -> Text -> Text -> Text -> StartJobRunResponse
- startJobRunResponse_httpStatus :: Lens' StartJobRunResponse Int
- startJobRunResponse_applicationId :: Lens' StartJobRunResponse Text
- startJobRunResponse_jobRunId :: Lens' StartJobRunResponse Text
- startJobRunResponse_arn :: Lens' StartJobRunResponse Text
Creating a Request
data StartJobRun Source #
See: newStartJobRun
smart constructor.
StartJobRun' | |
|
Instances
:: Text | |
-> Text | |
-> Text | |
-> StartJobRun |
Create a value of StartJobRun
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:
StartJobRun
, startJobRun_configurationOverrides
- The configuration overrides for the job run.
$sel:executionTimeoutMinutes:StartJobRun'
, startJobRun_executionTimeoutMinutes
- The maximum duration for the job run to run. If the job run runs beyond
this duration, it will be automatically cancelled.
StartJobRun
, startJobRun_jobDriver
- The job driver for the job run.
StartJobRun
, startJobRun_name
- The optional job run name. This doesn't have to be unique.
StartJobRun
, startJobRun_tags
- The tags assigned to the job run.
StartJobRun
, startJobRun_applicationId
- The ID of the application on which to run the job.
$sel:clientToken:StartJobRun'
, startJobRun_clientToken
- The client idempotency token of the job run to start. Its value must be
unique for each request.
$sel:executionRoleArn:StartJobRun'
, startJobRun_executionRoleArn
- The execution role ARN for the job run.
Request Lenses
startJobRun_configurationOverrides :: Lens' StartJobRun (Maybe ConfigurationOverrides) Source #
The configuration overrides for the job run.
startJobRun_executionTimeoutMinutes :: Lens' StartJobRun (Maybe Natural) Source #
The maximum duration for the job run to run. If the job run runs beyond this duration, it will be automatically cancelled.
startJobRun_jobDriver :: Lens' StartJobRun (Maybe JobDriver) Source #
The job driver for the job run.
startJobRun_name :: Lens' StartJobRun (Maybe Text) Source #
The optional job run name. This doesn't have to be unique.
startJobRun_tags :: Lens' StartJobRun (Maybe (HashMap Text Text)) Source #
The tags assigned to the job run.
startJobRun_applicationId :: Lens' StartJobRun Text Source #
The ID of the application on which to run the job.
startJobRun_clientToken :: Lens' StartJobRun Text Source #
The client idempotency token of the job run to start. Its value must be unique for each request.
startJobRun_executionRoleArn :: Lens' StartJobRun Text Source #
The execution role ARN for the job run.
Destructuring the Response
data StartJobRunResponse Source #
See: newStartJobRunResponse
smart constructor.
StartJobRunResponse' | |
|
Instances
newStartJobRunResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> Text | |
-> StartJobRunResponse |
Create a value of StartJobRunResponse
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:StartJobRunResponse'
, startJobRunResponse_httpStatus
- The response's http status code.
StartJobRun
, startJobRunResponse_applicationId
- This output displays the application ID on which the job run was
submitted.
StartJobRunResponse
, startJobRunResponse_jobRunId
- The output contains the ID of the started job run.
StartJobRunResponse
, startJobRunResponse_arn
- The output lists the execution role ARN of the job run.
Response Lenses
startJobRunResponse_httpStatus :: Lens' StartJobRunResponse Int Source #
The response's http status code.
startJobRunResponse_applicationId :: Lens' StartJobRunResponse Text Source #
This output displays the application ID on which the job run was submitted.
startJobRunResponse_jobRunId :: Lens' StartJobRunResponse Text Source #
The output contains the ID of the started job run.
startJobRunResponse_arn :: Lens' StartJobRunResponse Text Source #
The output lists the execution role ARN of the job run.