Amazonka.Personalize.Types.BatchInferenceJob

Documentation

data BatchInferenceJob

Contains information on a batch inference job.

See: newBatchInferenceJob smart constructor.

Constructors

BatchInferenceJob'

Fields

• batchInferenceJobArn :: Maybe Text

  The Amazon Resource Name (ARN) of the batch inference job.

• batchInferenceJobConfig :: Maybe BatchInferenceJobConfig

  A string to string map of the configuration details of a batch inference job.

• creationDateTime :: Maybe POSIX

  The time at which the batch inference job was created.

• failureReason :: Maybe Text

  If the batch inference job failed, the reason for the failure.

• filterArn :: Maybe Text

  The ARN of the filter used on the batch inference job.

• jobInput :: Maybe BatchInferenceJobInput

  The Amazon S3 path that leads to the input data used to generate the batch inference job.

• jobName :: Maybe Text

  The name of the batch inference job.

• jobOutput :: Maybe BatchInferenceJobOutput

  The Amazon S3 bucket that contains the output data generated by the batch inference job.

• lastUpdatedDateTime :: Maybe POSIX

  The time at which the batch inference job was last updated.

• numResults :: Maybe Int

  The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.

• roleArn :: Maybe Text

  The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.

• solutionVersionArn :: Maybe Text

  The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.

• status :: Maybe Text

  The status of the batch inference job. The status is one of the following values:

  • PENDING
  • IN PROGRESS
  • ACTIVE
  • CREATE FAILED

Instances

FromJSON BatchInferenceJob

Defined in Amazonka.Personalize.Types.BatchInferenceJob

Methods

parseJSON :: Value -> Parser BatchInferenceJob

parseJSONList :: Value -> Parser [BatchInferenceJob]

Generic BatchInferenceJob

Defined in Amazonka.Personalize.Types.BatchInferenceJob

Associated Types

type Rep BatchInferenceJob :: Type -> Type

Methods

from :: BatchInferenceJob -> Rep BatchInferenceJob x

to :: Rep BatchInferenceJob x -> BatchInferenceJob

Read BatchInferenceJob

Defined in Amazonka.Personalize.Types.BatchInferenceJob

Methods

readsPrec :: Int -> ReadS BatchInferenceJob

readList :: ReadS [BatchInferenceJob]

readPrec :: ReadPrec BatchInferenceJob

readListPrec :: ReadPrec [BatchInferenceJob]

Show BatchInferenceJob

Defined in Amazonka.Personalize.Types.BatchInferenceJob

Methods

showsPrec :: Int -> BatchInferenceJob -> ShowS

show :: BatchInferenceJob -> String

showList :: [BatchInferenceJob] -> ShowS

NFData BatchInferenceJob

Defined in Amazonka.Personalize.Types.BatchInferenceJob

Methods

rnf :: BatchInferenceJob -> ()

Eq BatchInferenceJob

Defined in Amazonka.Personalize.Types.BatchInferenceJob

Methods

(==) :: BatchInferenceJob -> BatchInferenceJob -> Bool

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

Hashable BatchInferenceJob

Defined in Amazonka.Personalize.Types.BatchInferenceJob

Methods

hashWithSalt :: Int -> BatchInferenceJob -> Int

hash :: BatchInferenceJob -> Int

type Rep BatchInferenceJob

Defined in Amazonka.Personalize.Types.BatchInferenceJob

type Rep BatchInferenceJob = D1 ('MetaData "BatchInferenceJob" "Amazonka.Personalize.Types.BatchInferenceJob" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "BatchInferenceJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "batchInferenceJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "batchInferenceJobConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchInferenceJobConfig)) :*: S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "filterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobInput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchInferenceJobInput))))) :*: ((S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobOutput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchInferenceJobOutput)) :*: S1 ('MetaSel ('Just "lastUpdatedDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "numResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "solutionVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newBatchInferenceJob :: BatchInferenceJob

Create a value of BatchInferenceJob 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:batchInferenceJobArn:BatchInferenceJob', batchInferenceJob_batchInferenceJobArn - The Amazon Resource Name (ARN) of the batch inference job.

$sel:batchInferenceJobConfig:BatchInferenceJob', batchInferenceJob_batchInferenceJobConfig - A string to string map of the configuration details of a batch inference job.

$sel:creationDateTime:BatchInferenceJob', batchInferenceJob_creationDateTime - The time at which the batch inference job was created.

$sel:failureReason:BatchInferenceJob', batchInferenceJob_failureReason - If the batch inference job failed, the reason for the failure.

$sel:filterArn:BatchInferenceJob', batchInferenceJob_filterArn - The ARN of the filter used on the batch inference job.

$sel:jobInput:BatchInferenceJob', batchInferenceJob_jobInput - The Amazon S3 path that leads to the input data used to generate the batch inference job.

$sel:jobName:BatchInferenceJob', batchInferenceJob_jobName - The name of the batch inference job.

$sel:jobOutput:BatchInferenceJob', batchInferenceJob_jobOutput - The Amazon S3 bucket that contains the output data generated by the batch inference job.

$sel:lastUpdatedDateTime:BatchInferenceJob', batchInferenceJob_lastUpdatedDateTime - The time at which the batch inference job was last updated.

$sel:numResults:BatchInferenceJob', batchInferenceJob_numResults - The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.

$sel:roleArn:BatchInferenceJob', batchInferenceJob_roleArn - The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.

$sel:solutionVersionArn:BatchInferenceJob', batchInferenceJob_solutionVersionArn - The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.

$sel:status:BatchInferenceJob', batchInferenceJob_status - The status of the batch inference job. The status is one of the following values:

• PENDING
• IN PROGRESS
• ACTIVE
• CREATE FAILED

batchInferenceJob_batchInferenceJobArn :: Lens' BatchInferenceJob (Maybe Text)

The Amazon Resource Name (ARN) of the batch inference job.

batchInferenceJob_batchInferenceJobConfig :: Lens' BatchInferenceJob (Maybe BatchInferenceJobConfig)

A string to string map of the configuration details of a batch inference job.

batchInferenceJob_creationDateTime :: Lens' BatchInferenceJob (Maybe UTCTime)

The time at which the batch inference job was created.

batchInferenceJob_failureReason :: Lens' BatchInferenceJob (Maybe Text)

If the batch inference job failed, the reason for the failure.

batchInferenceJob_filterArn :: Lens' BatchInferenceJob (Maybe Text)

The ARN of the filter used on the batch inference job.

batchInferenceJob_jobInput :: Lens' BatchInferenceJob (Maybe BatchInferenceJobInput)

The Amazon S3 path that leads to the input data used to generate the batch inference job.

batchInferenceJob_jobName :: Lens' BatchInferenceJob (Maybe Text)

The name of the batch inference job.

batchInferenceJob_jobOutput :: Lens' BatchInferenceJob (Maybe BatchInferenceJobOutput)

The Amazon S3 bucket that contains the output data generated by the batch inference job.

batchInferenceJob_lastUpdatedDateTime :: Lens' BatchInferenceJob (Maybe UTCTime)

The time at which the batch inference job was last updated.

batchInferenceJob_numResults :: Lens' BatchInferenceJob (Maybe Int)

The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.

batchInferenceJob_roleArn :: Lens' BatchInferenceJob (Maybe Text)

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.

batchInferenceJob_solutionVersionArn :: Lens' BatchInferenceJob (Maybe Text)

The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.

batchInferenceJob_status :: Lens' BatchInferenceJob (Maybe Text)

The status of the batch inference job. The status is one of the following values:

• PENDING
• IN PROGRESS
• ACTIVE
• CREATE FAILED