Amazonka.M2.StartBatchJob

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.

Creating a Request

data StartBatchJob

See: newStartBatchJob smart constructor.

Constructors

StartBatchJob'

Fields

• jobParams :: Maybe (HashMap Text Text)

  The collection of batch job parameters. For details about limits for keys and values, see Coding variables in JCL.

• applicationId :: Text

  The unique identifier of the application associated with this batch job.

• batchJobIdentifier :: BatchJobIdentifier

  The unique identifier of the batch job.

Instances

ToJSON StartBatchJob

Defined in Amazonka.M2.StartBatchJob

Methods

toJSON :: StartBatchJob -> Value

toEncoding :: StartBatchJob -> Encoding

toJSONList :: [StartBatchJob] -> Value

toEncodingList :: [StartBatchJob] -> Encoding

ToHeaders StartBatchJob

Defined in Amazonka.M2.StartBatchJob

Methods

toHeaders :: StartBatchJob -> [Header]

ToPath StartBatchJob

Defined in Amazonka.M2.StartBatchJob

Methods

toPath :: StartBatchJob -> ByteString

ToQuery StartBatchJob

Defined in Amazonka.M2.StartBatchJob

Methods

toQuery :: StartBatchJob -> QueryString

AWSRequest StartBatchJob

Defined in Amazonka.M2.StartBatchJob

Associated Types

type AWSResponse StartBatchJob

Methods

request :: (Service -> Service) -> StartBatchJob -> Request StartBatchJob

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartBatchJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartBatchJob)))

Generic StartBatchJob

Defined in Amazonka.M2.StartBatchJob

Associated Types

type Rep StartBatchJob :: Type -> Type

Methods

from :: StartBatchJob -> Rep StartBatchJob x

to :: Rep StartBatchJob x -> StartBatchJob

Read StartBatchJob

Defined in Amazonka.M2.StartBatchJob

Methods

readsPrec :: Int -> ReadS StartBatchJob

readList :: ReadS [StartBatchJob]

readPrec :: ReadPrec StartBatchJob

readListPrec :: ReadPrec [StartBatchJob]

Show StartBatchJob

Defined in Amazonka.M2.StartBatchJob

Methods

showsPrec :: Int -> StartBatchJob -> ShowS

show :: StartBatchJob -> String

showList :: [StartBatchJob] -> ShowS

NFData StartBatchJob

Defined in Amazonka.M2.StartBatchJob

Methods

rnf :: StartBatchJob -> ()

Eq StartBatchJob

Defined in Amazonka.M2.StartBatchJob

Methods

(==) :: StartBatchJob -> StartBatchJob -> Bool

(/=) :: StartBatchJob -> StartBatchJob -> Bool

Hashable StartBatchJob

Defined in Amazonka.M2.StartBatchJob

Methods

hashWithSalt :: Int -> StartBatchJob -> Int

hash :: StartBatchJob -> Int

type AWSResponse StartBatchJob

Defined in Amazonka.M2.StartBatchJob

type AWSResponse StartBatchJob = StartBatchJobResponse

type Rep StartBatchJob

Defined in Amazonka.M2.StartBatchJob

type Rep StartBatchJob = D1 ('MetaData "StartBatchJob" "Amazonka.M2.StartBatchJob" "amazonka-m2-2.0-1kXEGTJs74f5RPbatSDeMH" 'False) (C1 ('MetaCons "StartBatchJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "batchJobIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BatchJobIdentifier))))

newStartBatchJob

Arguments

:: Text

StartBatchJob

-> BatchJobIdentifier

$sel:batchJobIdentifier:StartBatchJob'

-> 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))

The collection of batch job parameters. For details about limits for keys and values, see Coding variables in JCL.

startBatchJob_applicationId :: Lens' StartBatchJob Text

The unique identifier of the application associated with this batch job.

startBatchJob_batchJobIdentifier :: Lens' StartBatchJob BatchJobIdentifier

The unique identifier of the batch job.

Destructuring the Response

data StartBatchJobResponse

See: newStartBatchJobResponse smart constructor.

Constructors

StartBatchJobResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• executionId :: Text

  The unique identifier of this execution of the batch job.

Instances

Generic StartBatchJobResponse

Defined in Amazonka.M2.StartBatchJob

Associated Types

type Rep StartBatchJobResponse :: Type -> Type

Methods

from :: StartBatchJobResponse -> Rep StartBatchJobResponse x

to :: Rep StartBatchJobResponse x -> StartBatchJobResponse

Read StartBatchJobResponse

Defined in Amazonka.M2.StartBatchJob

Methods

readsPrec :: Int -> ReadS StartBatchJobResponse

readList :: ReadS [StartBatchJobResponse]

readPrec :: ReadPrec StartBatchJobResponse

readListPrec :: ReadPrec [StartBatchJobResponse]

Show StartBatchJobResponse

Defined in Amazonka.M2.StartBatchJob

Methods

showsPrec :: Int -> StartBatchJobResponse -> ShowS

show :: StartBatchJobResponse -> String

showList :: [StartBatchJobResponse] -> ShowS

NFData StartBatchJobResponse

Defined in Amazonka.M2.StartBatchJob

Methods

rnf :: StartBatchJobResponse -> ()

Eq StartBatchJobResponse

Defined in Amazonka.M2.StartBatchJob

Methods

(==) :: StartBatchJobResponse -> StartBatchJobResponse -> Bool

(/=) :: StartBatchJobResponse -> StartBatchJobResponse -> Bool

type Rep StartBatchJobResponse

Defined in Amazonka.M2.StartBatchJob

type Rep StartBatchJobResponse = D1 ('MetaData "StartBatchJobResponse" "Amazonka.M2.StartBatchJob" "amazonka-m2-2.0-1kXEGTJs74f5RPbatSDeMH" 'False) (C1 ('MetaCons "StartBatchJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "executionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStartBatchJobResponse

Arguments

:: Int

$sel:httpStatus:StartBatchJobResponse'

-> Text

StartBatchJobResponse

-> 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

The response's http status code.

startBatchJobResponse_executionId :: Lens' StartBatchJobResponse Text

The unique identifier of this execution of the batch job.