Amazonka.MachineLearning.GetBatchPrediction

Returns a BatchPrediction that includes detailed metadata, status, and data file information for a Batch Prediction request.

Creating a Request

data GetBatchPrediction

See: newGetBatchPrediction smart constructor.

Constructors

GetBatchPrediction'

Fields

• batchPredictionId :: Text

  An ID assigned to the BatchPrediction at creation.

Instances

ToJSON GetBatchPrediction

Defined in Amazonka.MachineLearning.GetBatchPrediction

Methods

toJSON :: GetBatchPrediction -> Value

toEncoding :: GetBatchPrediction -> Encoding

toJSONList :: [GetBatchPrediction] -> Value

toEncodingList :: [GetBatchPrediction] -> Encoding

ToHeaders GetBatchPrediction

Defined in Amazonka.MachineLearning.GetBatchPrediction

Methods

toHeaders :: GetBatchPrediction -> [Header]

ToPath GetBatchPrediction

Defined in Amazonka.MachineLearning.GetBatchPrediction

Methods

toPath :: GetBatchPrediction -> ByteString

ToQuery GetBatchPrediction

Defined in Amazonka.MachineLearning.GetBatchPrediction

Methods

toQuery :: GetBatchPrediction -> QueryString

AWSRequest GetBatchPrediction

Defined in Amazonka.MachineLearning.GetBatchPrediction

Associated Types

type AWSResponse GetBatchPrediction

Methods

request :: (Service -> Service) -> GetBatchPrediction -> Request GetBatchPrediction

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetBatchPrediction -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetBatchPrediction)))

Generic GetBatchPrediction

Defined in Amazonka.MachineLearning.GetBatchPrediction

Associated Types

type Rep GetBatchPrediction :: Type -> Type

Methods

from :: GetBatchPrediction -> Rep GetBatchPrediction x

to :: Rep GetBatchPrediction x -> GetBatchPrediction

Read GetBatchPrediction

Defined in Amazonka.MachineLearning.GetBatchPrediction

Methods

readsPrec :: Int -> ReadS GetBatchPrediction

readList :: ReadS [GetBatchPrediction]

readPrec :: ReadPrec GetBatchPrediction

readListPrec :: ReadPrec [GetBatchPrediction]

Show GetBatchPrediction

Defined in Amazonka.MachineLearning.GetBatchPrediction

Methods

showsPrec :: Int -> GetBatchPrediction -> ShowS

show :: GetBatchPrediction -> String

showList :: [GetBatchPrediction] -> ShowS

NFData GetBatchPrediction

Defined in Amazonka.MachineLearning.GetBatchPrediction

Methods

rnf :: GetBatchPrediction -> ()

Eq GetBatchPrediction

Defined in Amazonka.MachineLearning.GetBatchPrediction

Methods

(==) :: GetBatchPrediction -> GetBatchPrediction -> Bool

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

Hashable GetBatchPrediction

Defined in Amazonka.MachineLearning.GetBatchPrediction

Methods

hashWithSalt :: Int -> GetBatchPrediction -> Int

hash :: GetBatchPrediction -> Int

type AWSResponse GetBatchPrediction

Defined in Amazonka.MachineLearning.GetBatchPrediction

type AWSResponse GetBatchPrediction = GetBatchPredictionResponse

type Rep GetBatchPrediction

Defined in Amazonka.MachineLearning.GetBatchPrediction

type Rep GetBatchPrediction = D1 ('MetaData "GetBatchPrediction" "Amazonka.MachineLearning.GetBatchPrediction" "amazonka-ml-2.0-A3JLJ63WvmfHxGBBIqhdRA" 'False) (C1 ('MetaCons "GetBatchPrediction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "batchPredictionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetBatchPrediction

Arguments

:: Text

GetBatchPrediction

-> GetBatchPrediction

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

GetBatchPrediction, getBatchPrediction_batchPredictionId - An ID assigned to the BatchPrediction at creation.

Request Lenses

getBatchPrediction_batchPredictionId :: Lens' GetBatchPrediction Text

An ID assigned to the BatchPrediction at creation.

Destructuring the Response

data GetBatchPredictionResponse

Represents the output of a GetBatchPrediction operation and describes a BatchPrediction.

See: newGetBatchPredictionResponse smart constructor.

Constructors

GetBatchPredictionResponse'

Fields

• batchPredictionDataSourceId :: Maybe Text

  The ID of the DataSource that was used to create the BatchPrediction.

• batchPredictionId :: Maybe Text

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

• computeTime :: Maybe Integer

  The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the BatchPrediction, normalized and scaled on computation resources. ComputeTime is only available if the BatchPrediction is in the COMPLETED state.

• createdAt :: Maybe POSIX

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

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

• finishedAt :: Maybe POSIX

  The epoch time when Amazon Machine Learning marked the BatchPrediction as COMPLETED or FAILED. FinishedAt is only available when the BatchPrediction is in the COMPLETED or FAILED state.

• inputDataLocationS3 :: Maybe Text

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

• invalidRecordCount :: Maybe Integer

  The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction.

• lastUpdatedAt :: Maybe POSIX

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

• logUri :: Maybe Text

  A link to the file that contains logs of the CreateBatchPrediction operation.

• mLModelId :: Maybe Text

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

• message :: Maybe Text

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

• name :: Maybe Text

  A user-supplied name or description of the BatchPrediction.

• outputUri :: Maybe Text

  The location of an Amazon S3 bucket or directory to receive the operation results.

• startedAt :: Maybe POSIX

  The epoch time when Amazon Machine Learning marked the BatchPrediction as INPROGRESS. StartedAt isn't available if the BatchPrediction is in the PENDING state.

• status :: Maybe EntityStatus

  The status of the BatchPrediction, which can be one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate batch predictions.
  • INPROGRESS - The batch predictions are in progress.
  • 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.
• totalRecordCount :: Maybe Integer

  The number of total records that Amazon Machine Learning saw while processing the BatchPrediction.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetBatchPredictionResponse

Defined in Amazonka.MachineLearning.GetBatchPrediction

Associated Types

type Rep GetBatchPredictionResponse :: Type -> Type

Methods

from :: GetBatchPredictionResponse -> Rep GetBatchPredictionResponse x

to :: Rep GetBatchPredictionResponse x -> GetBatchPredictionResponse

Read GetBatchPredictionResponse

Defined in Amazonka.MachineLearning.GetBatchPrediction

Methods

readsPrec :: Int -> ReadS GetBatchPredictionResponse

readList :: ReadS [GetBatchPredictionResponse]

readPrec :: ReadPrec GetBatchPredictionResponse

readListPrec :: ReadPrec [GetBatchPredictionResponse]

Show GetBatchPredictionResponse

Defined in Amazonka.MachineLearning.GetBatchPrediction

Methods

showsPrec :: Int -> GetBatchPredictionResponse -> ShowS

show :: GetBatchPredictionResponse -> String

showList :: [GetBatchPredictionResponse] -> ShowS

NFData GetBatchPredictionResponse

Defined in Amazonka.MachineLearning.GetBatchPrediction

Methods

rnf :: GetBatchPredictionResponse -> ()

Eq GetBatchPredictionResponse

Defined in Amazonka.MachineLearning.GetBatchPrediction

Methods

(==) :: GetBatchPredictionResponse -> GetBatchPredictionResponse -> Bool

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

type Rep GetBatchPredictionResponse

Defined in Amazonka.MachineLearning.GetBatchPrediction

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

newGetBatchPredictionResponse

Arguments

:: Int

$sel:httpStatus:GetBatchPredictionResponse'

-> GetBatchPredictionResponse

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

GetBatchPredictionResponse, getBatchPredictionResponse_batchPredictionDataSourceId - The ID of the DataSource that was used to create the BatchPrediction.

GetBatchPrediction, getBatchPredictionResponse_batchPredictionId - An ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.

GetBatchPredictionResponse, getBatchPredictionResponse_computeTime - The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the BatchPrediction, normalized and scaled on computation resources. ComputeTime is only available if the BatchPrediction is in the COMPLETED state.

GetBatchPredictionResponse, getBatchPredictionResponse_createdAt - The time when the BatchPrediction was created. The time is expressed in epoch time.

GetBatchPredictionResponse, getBatchPredictionResponse_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.

GetBatchPredictionResponse, getBatchPredictionResponse_finishedAt - The epoch time when Amazon Machine Learning marked the BatchPrediction as COMPLETED or FAILED. FinishedAt is only available when the BatchPrediction is in the COMPLETED or FAILED state.

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

GetBatchPredictionResponse, getBatchPredictionResponse_invalidRecordCount - The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction.

GetBatchPredictionResponse, getBatchPredictionResponse_lastUpdatedAt - The time of the most recent edit to BatchPrediction. The time is expressed in epoch time.

$sel:logUri:GetBatchPredictionResponse', getBatchPredictionResponse_logUri - A link to the file that contains logs of the CreateBatchPrediction operation.

GetBatchPredictionResponse, getBatchPredictionResponse_mLModelId - The ID of the MLModel that generated predictions for the BatchPrediction request.

GetBatchPredictionResponse, getBatchPredictionResponse_message - A description of the most recent details about processing the batch prediction request.

GetBatchPredictionResponse, getBatchPredictionResponse_name - A user-supplied name or description of the BatchPrediction.

GetBatchPredictionResponse, getBatchPredictionResponse_outputUri - The location of an Amazon S3 bucket or directory to receive the operation results.

GetBatchPredictionResponse, getBatchPredictionResponse_startedAt - The epoch time when Amazon Machine Learning marked the BatchPrediction as INPROGRESS. StartedAt isn't available if the BatchPrediction is in the PENDING state.

GetBatchPredictionResponse, getBatchPredictionResponse_status - The status of the BatchPrediction, which can be one of the following values:

• PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate batch predictions.
• INPROGRESS - The batch predictions are in progress.
• 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.

GetBatchPredictionResponse, getBatchPredictionResponse_totalRecordCount - The number of total records that Amazon Machine Learning saw while processing the BatchPrediction.

$sel:httpStatus:GetBatchPredictionResponse', getBatchPredictionResponse_httpStatus - The response's http status code.

Response Lenses

getBatchPredictionResponse_batchPredictionDataSourceId :: Lens' GetBatchPredictionResponse (Maybe Text)

The ID of the DataSource that was used to create the BatchPrediction.

getBatchPredictionResponse_batchPredictionId :: Lens' GetBatchPredictionResponse (Maybe Text)

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

getBatchPredictionResponse_computeTime :: Lens' GetBatchPredictionResponse (Maybe Integer)

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the BatchPrediction, normalized and scaled on computation resources. ComputeTime is only available if the BatchPrediction is in the COMPLETED state.

getBatchPredictionResponse_createdAt :: Lens' GetBatchPredictionResponse (Maybe UTCTime)

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

getBatchPredictionResponse_createdByIamUser :: Lens' GetBatchPredictionResponse (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.

getBatchPredictionResponse_finishedAt :: Lens' GetBatchPredictionResponse (Maybe UTCTime)

The epoch time when Amazon Machine Learning marked the BatchPrediction as COMPLETED or FAILED. FinishedAt is only available when the BatchPrediction is in the COMPLETED or FAILED state.

getBatchPredictionResponse_inputDataLocationS3 :: Lens' GetBatchPredictionResponse (Maybe Text)

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

getBatchPredictionResponse_invalidRecordCount :: Lens' GetBatchPredictionResponse (Maybe Integer)

The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction.

getBatchPredictionResponse_lastUpdatedAt :: Lens' GetBatchPredictionResponse (Maybe UTCTime)

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

getBatchPredictionResponse_logUri :: Lens' GetBatchPredictionResponse (Maybe Text)

A link to the file that contains logs of the CreateBatchPrediction operation.

getBatchPredictionResponse_mLModelId :: Lens' GetBatchPredictionResponse (Maybe Text)

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

getBatchPredictionResponse_message :: Lens' GetBatchPredictionResponse (Maybe Text)

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

getBatchPredictionResponse_name :: Lens' GetBatchPredictionResponse (Maybe Text)

A user-supplied name or description of the BatchPrediction.

getBatchPredictionResponse_outputUri :: Lens' GetBatchPredictionResponse (Maybe Text)

The location of an Amazon S3 bucket or directory to receive the operation results.

getBatchPredictionResponse_startedAt :: Lens' GetBatchPredictionResponse (Maybe UTCTime)

The epoch time when Amazon Machine Learning marked the BatchPrediction as INPROGRESS. StartedAt isn't available if the BatchPrediction is in the PENDING state.

getBatchPredictionResponse_status :: Lens' GetBatchPredictionResponse (Maybe EntityStatus)

The status of the BatchPrediction, which can be one of the following values:

• PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate batch predictions.
• INPROGRESS - The batch predictions are in progress.
• 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.

getBatchPredictionResponse_totalRecordCount :: Lens' GetBatchPredictionResponse (Maybe Integer)

The number of total records that Amazon Machine Learning saw while processing the BatchPrediction.

getBatchPredictionResponse_httpStatus :: Lens' GetBatchPredictionResponse Int

The response's http status code.