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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data CreateBatchSegmentJob = CreateBatchSegmentJob' {
- filterArn :: Maybe Text
- numResults :: Maybe Int
- tags :: Maybe [Tag]
- jobName :: Text
- solutionVersionArn :: Text
- jobInput :: BatchSegmentJobInput
- jobOutput :: BatchSegmentJobOutput
- roleArn :: Text
}
newCreateBatchSegmentJob :: Text -> Text -> BatchSegmentJobInput -> BatchSegmentJobOutput -> Text -> CreateBatchSegmentJob
createBatchSegmentJob_filterArn :: Lens' CreateBatchSegmentJob (Maybe Text)
createBatchSegmentJob_numResults :: Lens' CreateBatchSegmentJob (Maybe Int)
createBatchSegmentJob_tags :: Lens' CreateBatchSegmentJob (Maybe [Tag])
createBatchSegmentJob_jobName :: Lens' CreateBatchSegmentJob Text
createBatchSegmentJob_solutionVersionArn :: Lens' CreateBatchSegmentJob Text
createBatchSegmentJob_jobInput :: Lens' CreateBatchSegmentJob BatchSegmentJobInput
createBatchSegmentJob_jobOutput :: Lens' CreateBatchSegmentJob BatchSegmentJobOutput
createBatchSegmentJob_roleArn :: Lens' CreateBatchSegmentJob Text
data CreateBatchSegmentJobResponse = CreateBatchSegmentJobResponse' {
- batchSegmentJobArn :: Maybe Text
- httpStatus :: Int
}
newCreateBatchSegmentJobResponse :: Int -> CreateBatchSegmentJobResponse
createBatchSegmentJobResponse_batchSegmentJobArn :: Lens' CreateBatchSegmentJobResponse (Maybe Text)
createBatchSegmentJobResponse_httpStatus :: Lens' CreateBatchSegmentJobResponse Int

Creating a Request

data CreateBatchSegmentJob Source #

See: newCreateBatchSegmentJob smart constructor.

Constructors

CreateBatchSegmentJob'

Fields

filterArn :: Maybe Text
The ARN of the filter to apply to the batch segment job. For more information on using filters, see Filtering batch recommendations.
numResults :: Maybe Int
The number of predicted users generated by the batch segment job for each line of input data.
tags :: Maybe [Tag]
A list of tags to apply to the batch segment job.
jobName :: Text
The name of the batch segment job to create.
solutionVersionArn :: Text
The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.
jobInput :: BatchSegmentJobInput
The Amazon S3 path for the input data used to generate the batch segment job.
jobOutput :: BatchSegmentJobOutput
The Amazon S3 path for the 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 CreateBatchSegmentJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchSegmentJob Methods toJSON :: CreateBatchSegmentJob -> Value # toEncoding :: CreateBatchSegmentJob -> Encoding # toJSONList :: [CreateBatchSegmentJob] -> Value # toEncodingList :: [CreateBatchSegmentJob] -> Encoding #
ToHeaders CreateBatchSegmentJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchSegmentJob Methods toHeaders :: CreateBatchSegmentJob -> [Header] #
ToPath CreateBatchSegmentJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchSegmentJob Methods toPath :: CreateBatchSegmentJob -> ByteString #
ToQuery CreateBatchSegmentJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchSegmentJob Methods toQuery :: CreateBatchSegmentJob -> QueryString #
AWSRequest CreateBatchSegmentJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchSegmentJob Associated Types type AWSResponse CreateBatchSegmentJob # Methods request :: (Service -> Service) -> CreateBatchSegmentJob -> Request CreateBatchSegmentJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateBatchSegmentJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBatchSegmentJob))) #
Generic CreateBatchSegmentJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchSegmentJob Associated Types type Rep CreateBatchSegmentJob :: Type -> Type # Methods from :: CreateBatchSegmentJob -> Rep CreateBatchSegmentJob x # to :: Rep CreateBatchSegmentJob x -> CreateBatchSegmentJob #
Read CreateBatchSegmentJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchSegmentJob Methods readsPrec :: Int -> ReadS CreateBatchSegmentJob # readList :: ReadS [CreateBatchSegmentJob] # readPrec :: ReadPrec CreateBatchSegmentJob # readListPrec :: ReadPrec [CreateBatchSegmentJob] #
Show CreateBatchSegmentJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchSegmentJob Methods showsPrec :: Int -> CreateBatchSegmentJob -> ShowS # show :: CreateBatchSegmentJob -> String # showList :: [CreateBatchSegmentJob] -> ShowS #
NFData CreateBatchSegmentJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchSegmentJob Methods rnf :: CreateBatchSegmentJob -> () #
Eq CreateBatchSegmentJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchSegmentJob Methods (==) :: CreateBatchSegmentJob -> CreateBatchSegmentJob -> Bool # (/=) :: CreateBatchSegmentJob -> CreateBatchSegmentJob -> Bool #
Hashable CreateBatchSegmentJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchSegmentJob Methods hashWithSalt :: Int -> CreateBatchSegmentJob -> Int # hash :: CreateBatchSegmentJob -> Int #
type AWSResponse CreateBatchSegmentJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchSegmentJob type AWSResponse CreateBatchSegmentJob = CreateBatchSegmentJobResponse
type Rep CreateBatchSegmentJob Source #
Instance details Defined in Amazonka.Personalize.CreateBatchSegmentJob type Rep CreateBatchSegmentJob = D1 ('MetaData "CreateBatchSegmentJob" "Amazonka.Personalize.CreateBatchSegmentJob" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "CreateBatchSegmentJob'" 'PrefixI 'True) (((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 BatchSegmentJobInput)) :: (S1 ('MetaSel ('Just "jobOutput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BatchSegmentJobOutput) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateBatchSegmentJob Source #

Arguments

:: Text	`CreateBatchSegmentJob`
-> Text	`CreateBatchSegmentJob`
-> BatchSegmentJobInput	`CreateBatchSegmentJob`
-> BatchSegmentJobOutput	`CreateBatchSegmentJob`
-> Text	`CreateBatchSegmentJob`
-> CreateBatchSegmentJob

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

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

CreateBatchSegmentJob, createBatchSegmentJob_numResults - The number of predicted users generated by the batch segment job for each line of input data.

$sel:tags:CreateBatchSegmentJob', createBatchSegmentJob_tags - A list of tags to apply to the batch segment job.

CreateBatchSegmentJob, createBatchSegmentJob_jobName - The name of the batch segment job to create.

CreateBatchSegmentJob, createBatchSegmentJob_solutionVersionArn - The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.

CreateBatchSegmentJob, createBatchSegmentJob_jobInput - The Amazon S3 path for the input data used to generate the batch segment job.

CreateBatchSegmentJob, createBatchSegmentJob_jobOutput - The Amazon S3 path for the bucket where the job's output will be stored.

CreateBatchSegmentJob, createBatchSegmentJob_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

createBatchSegmentJob_filterArn :: Lens' CreateBatchSegmentJob (Maybe Text) Source #

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

createBatchSegmentJob_numResults :: Lens' CreateBatchSegmentJob (Maybe Int) Source #

The number of predicted users generated by the batch segment job for each line of input data.

createBatchSegmentJob_tags :: Lens' CreateBatchSegmentJob (Maybe [Tag]) Source #

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

createBatchSegmentJob_jobName :: Lens' CreateBatchSegmentJob Text Source #

The name of the batch segment job to create.

createBatchSegmentJob_solutionVersionArn :: Lens' CreateBatchSegmentJob Text Source #

The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.

createBatchSegmentJob_jobInput :: Lens' CreateBatchSegmentJob BatchSegmentJobInput Source #

The Amazon S3 path for the input data used to generate the batch segment job.

createBatchSegmentJob_jobOutput :: Lens' CreateBatchSegmentJob BatchSegmentJobOutput Source #

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

createBatchSegmentJob_roleArn :: Lens' CreateBatchSegmentJob 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 CreateBatchSegmentJobResponse Source #

See: newCreateBatchSegmentJobResponse smart constructor.

Constructors

CreateBatchSegmentJobResponse'
Fields batchSegmentJobArn :: Maybe Text The ARN of the batch segment job. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateBatchSegmentJobResponse Source #

Arguments

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

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

CreateBatchSegmentJobResponse, createBatchSegmentJobResponse_batchSegmentJobArn - The ARN of the batch segment job.

$sel:httpStatus:CreateBatchSegmentJobResponse', createBatchSegmentJobResponse_httpStatus - The response's http status code.

Response Lenses

createBatchSegmentJobResponse_batchSegmentJobArn :: Lens' CreateBatchSegmentJobResponse (Maybe Text) Source #

The ARN of the batch segment job.

createBatchSegmentJobResponse_httpStatus :: Lens' CreateBatchSegmentJobResponse Int Source #

The response's http status code.