libZSservicesZSamazonka-mlZSamazonka-ml
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MachineLearning.Types.BatchPrediction

Description

 
Synopsis

Documentation

data BatchPrediction Source #

Represents the output of a GetBatchPrediction operation.

The content consists of the detailed metadata, the status, and the data file information of a Batch Prediction.

See: newBatchPrediction smart constructor.

Constructors

BatchPrediction' 

Fields

  • status :: Maybe EntityStatus

    The status of the BatchPrediction. This element can have one of the following values:

    • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations.
    • INPROGRESS - The process is underway.
    • FAILED - The request to perform a batch prediction did not run to completion. It is not usable.
    • COMPLETED - The batch prediction process completed successfully.
    • DELETED - The BatchPrediction is marked as deleted. It is not usable.
  • lastUpdatedAt :: Maybe POSIX

    The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.

  • createdAt :: Maybe POSIX

    The time that the BatchPrediction was created. The time is expressed in epoch time.

  • computeTime :: Maybe Integer
     
  • inputDataLocationS3 :: Maybe Text

    The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

  • mLModelId :: Maybe Text

    The ID of the MLModel that generated predictions for the BatchPrediction request.

  • batchPredictionDataSourceId :: Maybe Text

    The ID of the DataSource that points to the group of observations to predict.

  • totalRecordCount :: Maybe Integer
     
  • startedAt :: Maybe POSIX
     
  • batchPredictionId :: Maybe Text

    The ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.

  • finishedAt :: Maybe POSIX
     
  • invalidRecordCount :: Maybe Integer
     
  • createdByIamUser :: Maybe Text

    The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

  • name :: Maybe Text

    A user-supplied name or description of the BatchPrediction.

  • message :: Maybe Text

    A description of the most recent details about processing the batch prediction request.

  • outputUri :: Maybe Text

    The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

Instances

Instances details
Eq BatchPrediction Source # 
Instance details

Defined in Amazonka.MachineLearning.Types.BatchPrediction

Read BatchPrediction Source # 
Instance details

Defined in Amazonka.MachineLearning.Types.BatchPrediction

Show BatchPrediction Source # 
Instance details

Defined in Amazonka.MachineLearning.Types.BatchPrediction

Generic BatchPrediction Source # 
Instance details

Defined in Amazonka.MachineLearning.Types.BatchPrediction

Associated Types

type Rep BatchPrediction :: Type -> Type #

NFData BatchPrediction Source # 
Instance details

Defined in Amazonka.MachineLearning.Types.BatchPrediction

Methods

rnf :: BatchPrediction -> () #

Hashable BatchPrediction Source # 
Instance details

Defined in Amazonka.MachineLearning.Types.BatchPrediction

FromJSON BatchPrediction Source # 
Instance details

Defined in Amazonka.MachineLearning.Types.BatchPrediction

type Rep BatchPrediction Source # 
Instance details

Defined in Amazonka.MachineLearning.Types.BatchPrediction

type Rep BatchPrediction = D1 ('MetaData "BatchPrediction" "Amazonka.MachineLearning.Types.BatchPrediction" "libZSservicesZSamazonka-mlZSamazonka-ml" 'False) (C1 ('MetaCons "BatchPrediction'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityStatus)) :*: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "computeTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :*: ((S1 ('MetaSel ('Just "inputDataLocationS3") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "mLModelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "batchPredictionDataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "totalRecordCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) :*: (((S1 ('MetaSel ('Just "startedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "batchPredictionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "finishedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "invalidRecordCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :*: ((S1 ('MetaSel ('Just "createdByIamUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "outputUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newBatchPrediction :: BatchPrediction Source #

Create a value of BatchPrediction 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:status:BatchPrediction', batchPrediction_status - The status of the BatchPrediction. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations.
  • INPROGRESS - The process is underway.
  • FAILED - The request to perform a batch prediction did not run to completion. It is not usable.
  • COMPLETED - The batch prediction process completed successfully.
  • DELETED - The BatchPrediction is marked as deleted. It is not usable.

$sel:lastUpdatedAt:BatchPrediction', batchPrediction_lastUpdatedAt - The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.

$sel:createdAt:BatchPrediction', batchPrediction_createdAt - The time that the BatchPrediction was created. The time is expressed in epoch time.

$sel:computeTime:BatchPrediction', batchPrediction_computeTime - Undocumented member.

$sel:inputDataLocationS3:BatchPrediction', batchPrediction_inputDataLocationS3 - The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

$sel:mLModelId:BatchPrediction', batchPrediction_mLModelId - The ID of the MLModel that generated predictions for the BatchPrediction request.

$sel:batchPredictionDataSourceId:BatchPrediction', batchPrediction_batchPredictionDataSourceId - The ID of the DataSource that points to the group of observations to predict.

$sel:totalRecordCount:BatchPrediction', batchPrediction_totalRecordCount - Undocumented member.

$sel:startedAt:BatchPrediction', batchPrediction_startedAt - Undocumented member.

$sel:batchPredictionId:BatchPrediction', batchPrediction_batchPredictionId - The ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.

$sel:finishedAt:BatchPrediction', batchPrediction_finishedAt - Undocumented member.

$sel:invalidRecordCount:BatchPrediction', batchPrediction_invalidRecordCount - Undocumented member.

$sel:createdByIamUser:BatchPrediction', batchPrediction_createdByIamUser - The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

$sel:name:BatchPrediction', batchPrediction_name - A user-supplied name or description of the BatchPrediction.

$sel:message:BatchPrediction', batchPrediction_message - A description of the most recent details about processing the batch prediction request.

$sel:outputUri:BatchPrediction', batchPrediction_outputUri - The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

batchPrediction_status :: Lens' BatchPrediction (Maybe EntityStatus) Source #

The status of the BatchPrediction. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations.
  • INPROGRESS - The process is underway.
  • FAILED - The request to perform a batch prediction did not run to completion. It is not usable.
  • COMPLETED - The batch prediction process completed successfully.
  • DELETED - The BatchPrediction is marked as deleted. It is not usable.

batchPrediction_lastUpdatedAt :: Lens' BatchPrediction (Maybe UTCTime) Source #

The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.

batchPrediction_createdAt :: Lens' BatchPrediction (Maybe UTCTime) Source #

The time that the BatchPrediction was created. The time is expressed in epoch time.

batchPrediction_inputDataLocationS3 :: Lens' BatchPrediction (Maybe Text) Source #

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

batchPrediction_mLModelId :: Lens' BatchPrediction (Maybe Text) Source #

The ID of the MLModel that generated predictions for the BatchPrediction request.

batchPrediction_batchPredictionDataSourceId :: Lens' BatchPrediction (Maybe Text) Source #

The ID of the DataSource that points to the group of observations to predict.

batchPrediction_batchPredictionId :: Lens' BatchPrediction (Maybe Text) Source #

The ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.

batchPrediction_createdByIamUser :: Lens' BatchPrediction (Maybe Text) Source #

The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

batchPrediction_name :: Lens' BatchPrediction (Maybe Text) Source #

A user-supplied name or description of the BatchPrediction.

batchPrediction_message :: Lens' BatchPrediction (Maybe Text) Source #

A description of the most recent details about processing the batch prediction request.

batchPrediction_outputUri :: Lens' BatchPrediction (Maybe Text) Source #

The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.