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.Personalize.CreateBatchInferenceJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Creating a batch inference job.

Synopsis

Creating a Request

data CreateBatchInferenceJob Source #

See: newCreateBatchInferenceJob smart constructor.

Constructors

CreateBatchInferenceJob'

Fields

batchInferenceJobConfig :: Maybe BatchInferenceJobConfig
The configuration details of a batch inference job.
filterArn :: Maybe Text
The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.
numResults :: Maybe Int
The number of recommendations to retrieve.
tags :: Maybe [Tag]
A list of tags to apply to the batch inference job.
jobName :: Text
The name of the batch inference job to create.
solutionVersionArn :: Text
The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.
jobInput :: BatchInferenceJobInput
The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.
jobOutput :: BatchInferenceJobOutput
The path to the Amazon S3 bucket where the job's output will be stored.
roleArn :: Text
The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.

Instances

Instances details

ToJSON CreateBatchInferenceJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchInferenceJob Methods toJSON :: CreateBatchInferenceJob -> Value # toEncoding :: CreateBatchInferenceJob -> Encoding # toJSONList :: [CreateBatchInferenceJob] -> Value # toEncodingList :: [CreateBatchInferenceJob] -> Encoding #
ToHeaders CreateBatchInferenceJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchInferenceJob Methods toHeaders :: CreateBatchInferenceJob -> [Header] #
ToPath CreateBatchInferenceJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchInferenceJob Methods toPath :: CreateBatchInferenceJob -> ByteString #
ToQuery CreateBatchInferenceJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchInferenceJob Methods toQuery :: CreateBatchInferenceJob -> QueryString #
AWSRequest CreateBatchInferenceJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchInferenceJob Associated Types type AWSResponse CreateBatchInferenceJob # Methods request :: (Service -> Service) -> CreateBatchInferenceJob -> Request CreateBatchInferenceJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateBatchInferenceJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBatchInferenceJob))) #
Generic CreateBatchInferenceJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchInferenceJob Associated Types type Rep CreateBatchInferenceJob :: Type -> Type # Methods from :: CreateBatchInferenceJob -> Rep CreateBatchInferenceJob x # to :: Rep CreateBatchInferenceJob x -> CreateBatchInferenceJob #
Read CreateBatchInferenceJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchInferenceJob Methods readsPrec :: Int -> ReadS CreateBatchInferenceJob # readList :: ReadS [CreateBatchInferenceJob] # readPrec :: ReadPrec CreateBatchInferenceJob # readListPrec :: ReadPrec [CreateBatchInferenceJob] #
Show CreateBatchInferenceJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchInferenceJob Methods showsPrec :: Int -> CreateBatchInferenceJob -> ShowS # show :: CreateBatchInferenceJob -> String # showList :: [CreateBatchInferenceJob] -> ShowS #
NFData CreateBatchInferenceJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchInferenceJob Methods rnf :: CreateBatchInferenceJob -> () #
Eq CreateBatchInferenceJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchInferenceJob Methods (==) :: CreateBatchInferenceJob -> CreateBatchInferenceJob -> Bool # (/=) :: CreateBatchInferenceJob -> CreateBatchInferenceJob -> Bool #
Hashable CreateBatchInferenceJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchInferenceJob Methods hashWithSalt :: Int -> CreateBatchInferenceJob -> Int # hash :: CreateBatchInferenceJob -> Int #
type AWSResponse CreateBatchInferenceJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchInferenceJob type AWSResponse CreateBatchInferenceJob = CreateBatchInferenceJobResponse
type Rep CreateBatchInferenceJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchInferenceJob type Rep CreateBatchInferenceJob = D1 ('MetaData "CreateBatchInferenceJob" "Amazonka.Personalize.CreateBatchInferenceJob" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "CreateBatchInferenceJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "batchInferenceJobConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchInferenceJobConfig)) :: S1 ('MetaSel ('Just "filterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "numResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :: ((S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "solutionVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "jobInput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BatchInferenceJobInput) :: (S1 ('MetaSel ('Just "jobOutput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BatchInferenceJobOutput) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateBatchInferenceJob Source #

Arguments

:: Text	`CreateBatchInferenceJob`
-> Text	`CreateBatchInferenceJob`
-> BatchInferenceJobInput	`CreateBatchInferenceJob`
-> BatchInferenceJobOutput	`CreateBatchInferenceJob`
-> Text	`CreateBatchInferenceJob`
-> CreateBatchInferenceJob

Create a value of CreateBatchInferenceJob 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:

CreateBatchInferenceJob, createBatchInferenceJob_batchInferenceJobConfig - The configuration details of a batch inference job.

CreateBatchInferenceJob, createBatchInferenceJob_filterArn - The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.

CreateBatchInferenceJob, createBatchInferenceJob_numResults - The number of recommendations to retrieve.

$sel:tags:CreateBatchInferenceJob', createBatchInferenceJob_tags - A list of tags to apply to the batch inference job.

CreateBatchInferenceJob, createBatchInferenceJob_jobName - The name of the batch inference job to create.

CreateBatchInferenceJob, createBatchInferenceJob_solutionVersionArn - The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

CreateBatchInferenceJob, createBatchInferenceJob_jobInput - The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.

CreateBatchInferenceJob, createBatchInferenceJob_jobOutput - The path to the Amazon S3 bucket where the job's output will be stored.

CreateBatchInferenceJob, createBatchInferenceJob_roleArn - The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.

Request Lenses

createBatchInferenceJob_batchInferenceJobConfig :: Lens' CreateBatchInferenceJob (Maybe BatchInferenceJobConfig) Source #

The configuration details of a batch inference job.

createBatchInferenceJob_filterArn :: Lens' CreateBatchInferenceJob (Maybe Text) Source #

The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.

createBatchInferenceJob_numResults :: Lens' CreateBatchInferenceJob (Maybe Int) Source #

The number of recommendations to retrieve.

createBatchInferenceJob_tags :: Lens' CreateBatchInferenceJob (Maybe [Tag]) Source #

A list of tags to apply to the batch inference job.

createBatchInferenceJob_jobName :: Lens' CreateBatchInferenceJob Text Source #

The name of the batch inference job to create.

createBatchInferenceJob_solutionVersionArn :: Lens' CreateBatchInferenceJob Text Source #

The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

createBatchInferenceJob_jobInput :: Lens' CreateBatchInferenceJob BatchInferenceJobInput Source #

The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.

createBatchInferenceJob_jobOutput :: Lens' CreateBatchInferenceJob BatchInferenceJobOutput Source #

The path to the Amazon S3 bucket where the job's output will be stored.

createBatchInferenceJob_roleArn :: Lens' CreateBatchInferenceJob Text Source #

The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.

Destructuring the Response

data CreateBatchInferenceJobResponse Source #

See: newCreateBatchInferenceJobResponse smart constructor.

Constructors

CreateBatchInferenceJobResponse'
Fields batchInferenceJobArn :: Maybe Text The ARN of the batch inference job. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateBatchInferenceJobResponse Source #
Instance details Defined in Amazonka.Personalize.CreateBatchInferenceJob Associated Types type Rep CreateBatchInferenceJobResponse :: Type -> Type # Methods from :: CreateBatchInferenceJobResponse -> Rep CreateBatchInferenceJobResponse x # to :: Rep CreateBatchInferenceJobResponse x -> CreateBatchInferenceJobResponse #
Read CreateBatchInferenceJobResponse Source #
Instance details Defined in Amazonka.Personalize.CreateBatchInferenceJob Methods readsPrec :: Int -> ReadS CreateBatchInferenceJobResponse # readList :: ReadS [CreateBatchInferenceJobResponse] # readPrec :: ReadPrec CreateBatchInferenceJobResponse # readListPrec :: ReadPrec [CreateBatchInferenceJobResponse] #
Show CreateBatchInferenceJobResponse Source #
Instance details Defined in Amazonka.Personalize.CreateBatchInferenceJob Methods showsPrec :: Int -> CreateBatchInferenceJobResponse -> ShowS # show :: CreateBatchInferenceJobResponse -> String # showList :: [CreateBatchInferenceJobResponse] -> ShowS #
NFData CreateBatchInferenceJobResponse Source #
Instance details Defined in Amazonka.Personalize.CreateBatchInferenceJob Methods rnf :: CreateBatchInferenceJobResponse -> () #
Eq CreateBatchInferenceJobResponse Source #
Instance details Defined in Amazonka.Personalize.CreateBatchInferenceJob Methods (==) :: CreateBatchInferenceJobResponse -> CreateBatchInferenceJobResponse -> Bool # (/=) :: CreateBatchInferenceJobResponse -> CreateBatchInferenceJobResponse -> Bool #
type Rep CreateBatchInferenceJobResponse Source #
Instance details Defined in Amazonka.Personalize.CreateBatchInferenceJob type Rep CreateBatchInferenceJobResponse = D1 ('MetaData "CreateBatchInferenceJobResponse" "Amazonka.Personalize.CreateBatchInferenceJob" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "CreateBatchInferenceJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "batchInferenceJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateBatchInferenceJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateBatchInferenceJobResponse'`
-> CreateBatchInferenceJobResponse

Create a value of CreateBatchInferenceJobResponse 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:

CreateBatchInferenceJobResponse, createBatchInferenceJobResponse_batchInferenceJobArn - The ARN of the batch inference job.

$sel:httpStatus:CreateBatchInferenceJobResponse', createBatchInferenceJobResponse_httpStatus - The response's http status code.

Response Lenses

createBatchInferenceJobResponse_batchInferenceJobArn :: Lens' CreateBatchInferenceJobResponse (Maybe Text) Source #

The ARN of the batch inference job.

createBatchInferenceJobResponse_httpStatus :: Lens' CreateBatchInferenceJobResponse Int Source #

The response's http status code.