Amazonka.Personalize.Types.BatchSegmentJob

Documentation

data BatchSegmentJob

Contains information on a batch segment job.

See: newBatchSegmentJob smart constructor.

Constructors

BatchSegmentJob'

Fields

• batchSegmentJobArn :: Maybe Text

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

• creationDateTime :: Maybe POSIX

  The time at which the batch segment job was created.

• failureReason :: Maybe Text

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

• filterArn :: Maybe Text

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

• jobInput :: Maybe BatchSegmentJobInput

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

• jobName :: Maybe Text

  The name of the batch segment job.

• jobOutput :: Maybe BatchSegmentJobOutput

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

• lastUpdatedDateTime :: Maybe POSIX

  The time at which the batch segment job last updated.

• numResults :: Maybe Int

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

• roleArn :: Maybe Text

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

• solutionVersionArn :: Maybe Text

  The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.

• status :: Maybe Text

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

  • PENDING
  • IN PROGRESS
  • ACTIVE
  • CREATE FAILED

Instances

FromJSON BatchSegmentJob

Defined in Amazonka.Personalize.Types.BatchSegmentJob

Methods

parseJSON :: Value -> Parser BatchSegmentJob

parseJSONList :: Value -> Parser [BatchSegmentJob]

Generic BatchSegmentJob

Defined in Amazonka.Personalize.Types.BatchSegmentJob

Associated Types

type Rep BatchSegmentJob :: Type -> Type

Methods

from :: BatchSegmentJob -> Rep BatchSegmentJob x

to :: Rep BatchSegmentJob x -> BatchSegmentJob

Read BatchSegmentJob

Defined in Amazonka.Personalize.Types.BatchSegmentJob

Methods

readsPrec :: Int -> ReadS BatchSegmentJob

readList :: ReadS [BatchSegmentJob]

readPrec :: ReadPrec BatchSegmentJob

readListPrec :: ReadPrec [BatchSegmentJob]

Show BatchSegmentJob

Defined in Amazonka.Personalize.Types.BatchSegmentJob

Methods

showsPrec :: Int -> BatchSegmentJob -> ShowS

show :: BatchSegmentJob -> String

showList :: [BatchSegmentJob] -> ShowS

NFData BatchSegmentJob

Defined in Amazonka.Personalize.Types.BatchSegmentJob

Methods

rnf :: BatchSegmentJob -> ()

Eq BatchSegmentJob

Defined in Amazonka.Personalize.Types.BatchSegmentJob

Methods

(==) :: BatchSegmentJob -> BatchSegmentJob -> Bool

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

Hashable BatchSegmentJob

Defined in Amazonka.Personalize.Types.BatchSegmentJob

Methods

hashWithSalt :: Int -> BatchSegmentJob -> Int

hash :: BatchSegmentJob -> Int

type Rep BatchSegmentJob

Defined in Amazonka.Personalize.Types.BatchSegmentJob

type Rep BatchSegmentJob = D1 ('MetaData "BatchSegmentJob" "Amazonka.Personalize.Types.BatchSegmentJob" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "BatchSegmentJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "batchSegmentJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (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 BatchSegmentJobInput)) :*: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "jobOutput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchSegmentJobOutput)) :*: (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)))))))

newBatchSegmentJob :: BatchSegmentJob

Create a value of BatchSegmentJob 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:batchSegmentJobArn:BatchSegmentJob', batchSegmentJob_batchSegmentJobArn - The Amazon Resource Name (ARN) of the batch segment job.

$sel:creationDateTime:BatchSegmentJob', batchSegmentJob_creationDateTime - The time at which the batch segment job was created.

$sel:failureReason:BatchSegmentJob', batchSegmentJob_failureReason - If the batch segment job failed, the reason for the failure.

$sel:filterArn:BatchSegmentJob', batchSegmentJob_filterArn - The ARN of the filter used on the batch segment job.

$sel:jobInput:BatchSegmentJob', batchSegmentJob_jobInput - The Amazon S3 path that leads to the input data used to generate the batch segment job.

$sel:jobName:BatchSegmentJob', batchSegmentJob_jobName - The name of the batch segment job.

$sel:jobOutput:BatchSegmentJob', batchSegmentJob_jobOutput - The Amazon S3 bucket that contains the output data generated by the batch segment job.

$sel:lastUpdatedDateTime:BatchSegmentJob', batchSegmentJob_lastUpdatedDateTime - The time at which the batch segment job last updated.

$sel:numResults:BatchSegmentJob', batchSegmentJob_numResults - The number of predicted users generated by the batch segment job for each line of input data.

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

$sel:solutionVersionArn:BatchSegmentJob', batchSegmentJob_solutionVersionArn - The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.

$sel:status:BatchSegmentJob', batchSegmentJob_status - The status of the batch segment job. The status is one of the following values:

• PENDING
• IN PROGRESS
• ACTIVE
• CREATE FAILED

batchSegmentJob_batchSegmentJobArn :: Lens' BatchSegmentJob (Maybe Text)

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

batchSegmentJob_creationDateTime :: Lens' BatchSegmentJob (Maybe UTCTime)

The time at which the batch segment job was created.

batchSegmentJob_failureReason :: Lens' BatchSegmentJob (Maybe Text)

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

batchSegmentJob_filterArn :: Lens' BatchSegmentJob (Maybe Text)

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

batchSegmentJob_jobInput :: Lens' BatchSegmentJob (Maybe BatchSegmentJobInput)

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

batchSegmentJob_jobName :: Lens' BatchSegmentJob (Maybe Text)

The name of the batch segment job.

batchSegmentJob_jobOutput :: Lens' BatchSegmentJob (Maybe BatchSegmentJobOutput)

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

batchSegmentJob_lastUpdatedDateTime :: Lens' BatchSegmentJob (Maybe UTCTime)

The time at which the batch segment job last updated.

batchSegmentJob_numResults :: Lens' BatchSegmentJob (Maybe Int)

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

batchSegmentJob_roleArn :: Lens' BatchSegmentJob (Maybe Text)

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

batchSegmentJob_solutionVersionArn :: Lens' BatchSegmentJob (Maybe Text)

The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.

batchSegmentJob_status :: Lens' BatchSegmentJob (Maybe Text)

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

• PENDING
• IN PROGRESS
• ACTIVE
• CREATE FAILED