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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

Synopsis

data StartJobRun = StartJobRun' {
- configurationOverrides :: Maybe ConfigurationOverrides
- executionRoleArn :: Maybe Text
- jobDriver :: Maybe JobDriver
- jobTemplateId :: Maybe Text
- jobTemplateParameters :: Maybe (HashMap Text Text)
- name :: Maybe Text
- releaseLabel :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- virtualClusterId :: Text
- clientToken :: Text
}
newStartJobRun :: Text -> Text -> StartJobRun
startJobRun_configurationOverrides :: Lens' StartJobRun (Maybe ConfigurationOverrides)
startJobRun_executionRoleArn :: Lens' StartJobRun (Maybe Text)
startJobRun_jobDriver :: Lens' StartJobRun (Maybe JobDriver)
startJobRun_jobTemplateId :: Lens' StartJobRun (Maybe Text)
startJobRun_jobTemplateParameters :: Lens' StartJobRun (Maybe (HashMap Text Text))
startJobRun_name :: Lens' StartJobRun (Maybe Text)
startJobRun_releaseLabel :: Lens' StartJobRun (Maybe Text)
startJobRun_tags :: Lens' StartJobRun (Maybe (HashMap Text Text))
startJobRun_virtualClusterId :: Lens' StartJobRun Text
startJobRun_clientToken :: Lens' StartJobRun Text
data StartJobRunResponse = StartJobRunResponse' {
- arn :: Maybe Text
- id :: Maybe Text
- name :: Maybe Text
- virtualClusterId :: Maybe Text
- httpStatus :: Int
}
newStartJobRunResponse :: Int -> StartJobRunResponse
startJobRunResponse_arn :: Lens' StartJobRunResponse (Maybe Text)
startJobRunResponse_id :: Lens' StartJobRunResponse (Maybe Text)
startJobRunResponse_name :: Lens' StartJobRunResponse (Maybe Text)
startJobRunResponse_virtualClusterId :: Lens' StartJobRunResponse (Maybe Text)
startJobRunResponse_httpStatus :: Lens' StartJobRunResponse Int

Creating a Request

data StartJobRun Source #

See: newStartJobRun smart constructor.

Constructors

StartJobRun'

Fields

configurationOverrides :: Maybe ConfigurationOverrides
The configuration overrides for the job run.
executionRoleArn :: Maybe Text
The execution role ARN for the job run.
jobDriver :: Maybe JobDriver
The job driver for the job run.
jobTemplateId :: Maybe Text
The job template ID to be used to start the job run.
jobTemplateParameters :: Maybe (HashMap Text Text)
The values of job template parameters to start a job run.
name :: Maybe Text
The name of the job run.
releaseLabel :: Maybe Text
The Amazon EMR release version to use for the job run.
tags :: Maybe (HashMap Text Text)
The tags assigned to job runs.
virtualClusterId :: Text
The virtual cluster ID for which the job run request is submitted.
clientToken :: Text
The client idempotency token of the job run request.

Instances

Instances details

ToJSON StartJobRun Source #
Instance details Defined in Amazonka.EMRContainers.StartJobRun Methods toJSON :: StartJobRun -> Value # toEncoding :: StartJobRun -> Encoding # toJSONList :: [StartJobRun] -> Value # toEncodingList :: [StartJobRun] -> Encoding #
ToHeaders StartJobRun Source #
Instance details Defined in Amazonka.EMRContainers.StartJobRun Methods toHeaders :: StartJobRun -> [Header] #
ToPath StartJobRun Source #
Instance details Defined in Amazonka.EMRContainers.StartJobRun Methods toPath :: StartJobRun -> ByteString #
ToQuery StartJobRun Source #
Instance details Defined in Amazonka.EMRContainers.StartJobRun Methods toQuery :: StartJobRun -> QueryString #
AWSRequest StartJobRun Source #
Instance details Defined in Amazonka.EMRContainers.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.EMRContainers.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.EMRContainers.StartJobRun Methods showsPrec :: Int -> StartJobRun -> ShowS # show :: StartJobRun -> String # showList :: [StartJobRun] -> ShowS #
NFData StartJobRun Source #
Instance details Defined in Amazonka.EMRContainers.StartJobRun Methods rnf :: StartJobRun -> () #
Eq StartJobRun Source #
Instance details Defined in Amazonka.EMRContainers.StartJobRun Methods (==) :: StartJobRun -> StartJobRun -> Bool # (/=) :: StartJobRun -> StartJobRun -> Bool #
Hashable StartJobRun Source #
Instance details Defined in Amazonka.EMRContainers.StartJobRun Methods hashWithSalt :: Int -> StartJobRun -> Int # hash :: StartJobRun -> Int #
type AWSResponse StartJobRun Source #
Instance details Defined in Amazonka.EMRContainers.StartJobRun type AWSResponse StartJobRun = StartJobRunResponse
type Rep StartJobRun Source #
Instance details Defined in Amazonka.EMRContainers.StartJobRun type Rep StartJobRun = D1 ('MetaData "StartJobRun" "Amazonka.EMRContainers.StartJobRun" "amazonka-emr-containers-2.0-IoSteTibWXL7DljQZKPB8n" 'False) (C1 ('MetaCons "StartJobRun'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "configurationOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfigurationOverrides)) :: S1 ('MetaSel ('Just "executionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "jobDriver") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobDriver)) :: (S1 ('MetaSel ('Just "jobTemplateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "jobTemplateParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "releaseLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "virtualClusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newStartJobRun Source #

Arguments

:: Text	`StartJobRun`
-> Text	`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.

StartJobRun, startJobRun_executionRoleArn - The execution role ARN for the job run.

StartJobRun, startJobRun_jobDriver - The job driver for the job run.

$sel:jobTemplateId:StartJobRun', startJobRun_jobTemplateId - The job template ID to be used to start the job run.

$sel:jobTemplateParameters:StartJobRun', startJobRun_jobTemplateParameters - The values of job template parameters to start a job run.

StartJobRun, startJobRun_name - The name of the job run.

StartJobRun, startJobRun_releaseLabel - The Amazon EMR release version to use for the job run.

StartJobRun, startJobRun_tags - The tags assigned to job runs.

StartJobRun, startJobRun_virtualClusterId - The virtual cluster ID for which the job run request is submitted.

StartJobRun, startJobRun_clientToken - The client idempotency token of the job run request.

Request Lenses

startJobRun_configurationOverrides :: Lens' StartJobRun (Maybe ConfigurationOverrides) Source #

The configuration overrides for the job run.

startJobRun_executionRoleArn :: Lens' StartJobRun (Maybe Text) Source #

The execution role ARN for the job run.

startJobRun_jobDriver :: Lens' StartJobRun (Maybe JobDriver) Source #

The job driver for the job run.

startJobRun_jobTemplateId :: Lens' StartJobRun (Maybe Text) Source #

The job template ID to be used to start the job run.

startJobRun_jobTemplateParameters :: Lens' StartJobRun (Maybe (HashMap Text Text)) Source #

The values of job template parameters to start a job run.

startJobRun_name :: Lens' StartJobRun (Maybe Text) Source #

The name of the job run.

startJobRun_releaseLabel :: Lens' StartJobRun (Maybe Text) Source #

The Amazon EMR release version to use for the job run.

startJobRun_tags :: Lens' StartJobRun (Maybe (HashMap Text Text)) Source #

The tags assigned to job runs.

startJobRun_virtualClusterId :: Lens' StartJobRun Text Source #

The virtual cluster ID for which the job run request is submitted.

startJobRun_clientToken :: Lens' StartJobRun Text Source #

The client idempotency token of the job run request.

Destructuring the Response

data StartJobRunResponse Source #

See: newStartJobRunResponse smart constructor.

Constructors

StartJobRunResponse'
Fields arn :: Maybe Text This output lists the ARN of job run. id :: Maybe Text This output displays the started job run ID. name :: Maybe Text This output displays the name of the started job run. virtualClusterId :: Maybe Text This output displays the virtual cluster ID for which the job run was submitted. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic StartJobRunResponse Source #
Instance details Defined in Amazonka.EMRContainers.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.EMRContainers.StartJobRun Methods readsPrec :: Int -> ReadS StartJobRunResponse # readList :: ReadS [StartJobRunResponse] # readPrec :: ReadPrec StartJobRunResponse # readListPrec :: ReadPrec [StartJobRunResponse] #
Show StartJobRunResponse Source #
Instance details Defined in Amazonka.EMRContainers.StartJobRun Methods showsPrec :: Int -> StartJobRunResponse -> ShowS # show :: StartJobRunResponse -> String # showList :: [StartJobRunResponse] -> ShowS #
NFData StartJobRunResponse Source #
Instance details Defined in Amazonka.EMRContainers.StartJobRun Methods rnf :: StartJobRunResponse -> () #
Eq StartJobRunResponse Source #
Instance details Defined in Amazonka.EMRContainers.StartJobRun Methods (==) :: StartJobRunResponse -> StartJobRunResponse -> Bool # (/=) :: StartJobRunResponse -> StartJobRunResponse -> Bool #
type Rep StartJobRunResponse Source #
Instance details Defined in Amazonka.EMRContainers.StartJobRun type Rep StartJobRunResponse = D1 ('MetaData "StartJobRunResponse" "Amazonka.EMRContainers.StartJobRun" "amazonka-emr-containers-2.0-IoSteTibWXL7DljQZKPB8n" 'False) (C1 ('MetaCons "StartJobRunResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "virtualClusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newStartJobRunResponse Source #

Arguments

:: Int	`$sel:httpStatus: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:

StartJobRunResponse, startJobRunResponse_arn - This output lists the ARN of job run.

StartJobRunResponse, startJobRunResponse_id - This output displays the started job run ID.

StartJobRun, startJobRunResponse_name - This output displays the name of the started job run.

StartJobRun, startJobRunResponse_virtualClusterId - This output displays the virtual cluster ID for which the job run was submitted.

$sel:httpStatus:StartJobRunResponse', startJobRunResponse_httpStatus - The response's http status code.

Response Lenses

startJobRunResponse_arn :: Lens' StartJobRunResponse (Maybe Text) Source #

This output lists the ARN of job run.

startJobRunResponse_id :: Lens' StartJobRunResponse (Maybe Text) Source #

This output displays the started job run ID.

startJobRunResponse_name :: Lens' StartJobRunResponse (Maybe Text) Source #

This output displays the name of the started job run.

startJobRunResponse_virtualClusterId :: Lens' StartJobRunResponse (Maybe Text) Source #

This output displays the virtual cluster ID for which the job run was submitted.

startJobRunResponse_httpStatus :: Lens' StartJobRunResponse Int Source #

The response's http status code.