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.EMRServerless.StartJobRun

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts a job run.

Synopsis

data StartJobRun = StartJobRun' {
- configurationOverrides :: Maybe ConfigurationOverrides
- executionTimeoutMinutes :: Maybe Natural
- jobDriver :: Maybe JobDriver
- name :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- applicationId :: Text
- clientToken :: Text
- executionRoleArn :: Text
}
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.

Constructors

StartJobRun'

Fields

configurationOverrides :: Maybe ConfigurationOverrides
The configuration overrides for the job run.
executionTimeoutMinutes :: Maybe Natural
The maximum duration for the job run to run. If the job run runs beyond this duration, it will be automatically cancelled.
jobDriver :: Maybe JobDriver
The job driver for the job run.
name :: Maybe Text
The optional job run name. This doesn't have to be unique.
tags :: Maybe (HashMap Text Text)
The tags assigned to the job run.
applicationId :: Text
The ID of the application on which to run the job.
clientToken :: Text
The client idempotency token of the job run to start. Its value must be unique for each request.
executionRoleArn :: Text
The execution role ARN for the job run.

Instances

Instances details

ToJSON StartJobRun Source #
Instance details Defined in Amazonka.EMRServerless.StartJobRun Methods toJSON :: StartJobRun -> Value # toEncoding :: StartJobRun -> Encoding # toJSONList :: [StartJobRun] -> Value # toEncodingList :: [StartJobRun] -> Encoding #
ToHeaders StartJobRun Source #
Instance details Defined in Amazonka.EMRServerless.StartJobRun Methods toHeaders :: StartJobRun -> [Header] #
ToPath StartJobRun Source #
Instance details Defined in Amazonka.EMRServerless.StartJobRun Methods toPath :: StartJobRun -> ByteString #
ToQuery StartJobRun Source #
Instance details Defined in Amazonka.EMRServerless.StartJobRun Methods toQuery :: StartJobRun -> QueryString #
AWSRequest StartJobRun Source #
Instance details Defined in Amazonka.EMRServerless.StartJobRun Associated Types type AWSResponse StartJobRun # Methods request :: (Service -> Service) -> StartJobRun -> Request StartJobRun # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartJobRun -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartJobRun))) #
Generic StartJobRun Source #
Instance details Defined in Amazonka.EMRServerless.StartJobRun Associated Types type Rep StartJobRun :: Type -> Type # Methods from :: StartJobRun -> Rep StartJobRun x # to :: Rep StartJobRun x -> StartJobRun #
Show StartJobRun Source #
Instance details Defined in Amazonka.EMRServerless.StartJobRun Methods showsPrec :: Int -> StartJobRun -> ShowS # show :: StartJobRun -> String # showList :: [StartJobRun] -> ShowS #
NFData StartJobRun Source #
Instance details Defined in Amazonka.EMRServerless.StartJobRun Methods rnf :: StartJobRun -> () #
Eq StartJobRun Source #
Instance details Defined in Amazonka.EMRServerless.StartJobRun Methods (==) :: StartJobRun -> StartJobRun -> Bool # (/=) :: StartJobRun -> StartJobRun -> Bool #
Hashable StartJobRun Source #
Instance details Defined in Amazonka.EMRServerless.StartJobRun Methods hashWithSalt :: Int -> StartJobRun -> Int # hash :: StartJobRun -> Int #
type AWSResponse StartJobRun Source #
Instance details Defined in Amazonka.EMRServerless.StartJobRun type AWSResponse StartJobRun = StartJobRunResponse
type Rep StartJobRun Source #
Instance details Defined in Amazonka.EMRServerless.StartJobRun type Rep StartJobRun = D1 ('MetaData "StartJobRun" "Amazonka.EMRServerless.StartJobRun" "amazonka-emr-serverless-2.0-Zw6ehwruaDFJFsqn31iYt" 'False) (C1 ('MetaCons "StartJobRun'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "configurationOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfigurationOverrides)) :: S1 ('MetaSel ('Just "executionTimeoutMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "jobDriver") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobDriver)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "executionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newStartJobRun Source #

Arguments

:: Text	`StartJobRun`
-> Text	`$sel:clientToken:StartJobRun'`
-> Text	`$sel:executionRoleArn:StartJobRun'`
-> 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.

Constructors

StartJobRunResponse'
Fields httpStatus :: Int The response's http status code. applicationId :: Text This output displays the application ID on which the job run was submitted. jobRunId :: Text The output contains the ID of the started job run. arn :: Text The output lists the execution role ARN of the job run.

Instances

Instances details

Generic StartJobRunResponse Source #
Instance details Defined in Amazonka.EMRServerless.StartJobRun Associated Types type Rep StartJobRunResponse :: Type -> Type # Methods from :: StartJobRunResponse -> Rep StartJobRunResponse x # to :: Rep StartJobRunResponse x -> StartJobRunResponse #
Read StartJobRunResponse Source #
Instance details Defined in Amazonka.EMRServerless.StartJobRun Methods readsPrec :: Int -> ReadS StartJobRunResponse # readList :: ReadS [StartJobRunResponse] # readPrec :: ReadPrec StartJobRunResponse # readListPrec :: ReadPrec [StartJobRunResponse] #
Show StartJobRunResponse Source #
Instance details Defined in Amazonka.EMRServerless.StartJobRun Methods showsPrec :: Int -> StartJobRunResponse -> ShowS # show :: StartJobRunResponse -> String # showList :: [StartJobRunResponse] -> ShowS #
NFData StartJobRunResponse Source #
Instance details Defined in Amazonka.EMRServerless.StartJobRun Methods rnf :: StartJobRunResponse -> () #
Eq StartJobRunResponse Source #
Instance details Defined in Amazonka.EMRServerless.StartJobRun Methods (==) :: StartJobRunResponse -> StartJobRunResponse -> Bool # (/=) :: StartJobRunResponse -> StartJobRunResponse -> Bool #
type Rep StartJobRunResponse Source #
Instance details Defined in Amazonka.EMRServerless.StartJobRun type Rep StartJobRunResponse = D1 ('MetaData "StartJobRunResponse" "Amazonka.EMRServerless.StartJobRun" "amazonka-emr-serverless-2.0-Zw6ehwruaDFJFsqn31iYt" 'False) (C1 ('MetaCons "StartJobRunResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "jobRunId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newStartJobRunResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartJobRunResponse'`
-> Text	`StartJobRun`
-> Text	`StartJobRunResponse`
-> Text	`StartJobRunResponse`
-> 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.