Skip to content

/AWS1/CL_ML_BATCHPREDICTION

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_batchpredictionid TYPE /AWS1/ML_ENTITYID /AWS1/ML_ENTITYID

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

iv_mlmodelid TYPE /AWS1/ML_ENTITYID /AWS1/ML_ENTITYID

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

iv_batchpredictiondatasrcid TYPE /AWS1/ML_ENTITYID /AWS1/ML_ENTITYID

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

iv_inputdatalocations3 TYPE /AWS1/ML_S3URL /AWS1/ML_S3URL

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

iv_createdbyiamuser TYPE /AWS1/ML_AWSUSERARN /AWS1/ML_AWSUSERARN

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.

iv_createdat TYPE /AWS1/ML_EPOCHTIME /AWS1/ML_EPOCHTIME

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

iv_lastupdatedat TYPE /AWS1/ML_EPOCHTIME /AWS1/ML_EPOCHTIME

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

iv_name TYPE /AWS1/ML_ENTITYNAME /AWS1/ML_ENTITYNAME

A user-supplied name or description of the BatchPrediction.

iv_status TYPE /AWS1/ML_ENTITYSTATUS /AWS1/ML_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.

iv_outputuri TYPE /AWS1/ML_S3URL /AWS1/ML_S3URL

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: ':', '//', '/./', '/../'.

iv_message TYPE /AWS1/ML_MESSAGE /AWS1/ML_MESSAGE

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

iv_computetime TYPE /AWS1/ML_LONGTYPE /AWS1/ML_LONGTYPE

Long integer type that is a 64-bit signed number.

iv_finishedat TYPE /AWS1/ML_EPOCHTIME /AWS1/ML_EPOCHTIME

A timestamp represented in epoch time.

iv_startedat TYPE /AWS1/ML_EPOCHTIME /AWS1/ML_EPOCHTIME

A timestamp represented in epoch time.

iv_totalrecordcount TYPE /AWS1/ML_LONGTYPE /AWS1/ML_LONGTYPE

Long integer type that is a 64-bit signed number.

iv_invalidrecordcount TYPE /AWS1/ML_LONGTYPE /AWS1/ML_LONGTYPE

Long integer type that is a 64-bit signed number.

Queryable Attributes

BatchPredictionId

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

Accessible with the following methods

Method Description
GET_BATCHPREDICTIONID() Getter for BATCHPREDICTIONID, with configurable default
ASK_BATCHPREDICTIONID() Getter for BATCHPREDICTIONID w/ exceptions if field has no v
HAS_BATCHPREDICTIONID() Determine if BATCHPREDICTIONID has a value

MLModelId

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

Accessible with the following methods

Method Description
GET_MLMODELID() Getter for MLMODELID, with configurable default
ASK_MLMODELID() Getter for MLMODELID w/ exceptions if field has no value
HAS_MLMODELID() Determine if MLMODELID has a value

BatchPredictionDataSourceId

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

Accessible with the following methods

Method Description
GET_BATCHPREDICTIONDATASRCID() Getter for BATCHPREDICTIONDATASOURCEID, with configurable de
ASK_BATCHPREDICTIONDATASRCID() Getter for BATCHPREDICTIONDATASOURCEID w/ exceptions if fiel
HAS_BATCHPREDICTIONDATASRCID() Determine if BATCHPREDICTIONDATASOURCEID has a value

InputDataLocationS3

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

Accessible with the following methods

Method Description
GET_INPUTDATALOCATIONS3() Getter for INPUTDATALOCATIONS3, with configurable default
ASK_INPUTDATALOCATIONS3() Getter for INPUTDATALOCATIONS3 w/ exceptions if field has no
HAS_INPUTDATALOCATIONS3() Determine if INPUTDATALOCATIONS3 has a value

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.

Accessible with the following methods

Method Description
GET_CREATEDBYIAMUSER() Getter for CREATEDBYIAMUSER, with configurable default
ASK_CREATEDBYIAMUSER() Getter for CREATEDBYIAMUSER w/ exceptions if field has no va
HAS_CREATEDBYIAMUSER() Determine if CREATEDBYIAMUSER has a value

CreatedAt

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

Accessible with the following methods

Method Description
GET_CREATEDAT() Getter for CREATEDAT, with configurable default
ASK_CREATEDAT() Getter for CREATEDAT w/ exceptions if field has no value
HAS_CREATEDAT() Determine if CREATEDAT has a value

LastUpdatedAt

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

Accessible with the following methods

Method Description
GET_LASTUPDATEDAT() Getter for LASTUPDATEDAT, with configurable default
ASK_LASTUPDATEDAT() Getter for LASTUPDATEDAT w/ exceptions if field has no value
HAS_LASTUPDATEDAT() Determine if LASTUPDATEDAT has a value

Name

A user-supplied name or description of the BatchPrediction.

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

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.

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

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: ':', '//', '/./', '/../'.

Accessible with the following methods

Method Description
GET_OUTPUTURI() Getter for OUTPUTURI, with configurable default
ASK_OUTPUTURI() Getter for OUTPUTURI w/ exceptions if field has no value
HAS_OUTPUTURI() Determine if OUTPUTURI has a value

Message

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

Accessible with the following methods

Method Description
GET_MESSAGE() Getter for MESSAGE, with configurable default
ASK_MESSAGE() Getter for MESSAGE w/ exceptions if field has no value
HAS_MESSAGE() Determine if MESSAGE has a value

ComputeTime

Long integer type that is a 64-bit signed number.

Accessible with the following methods

Method Description
GET_COMPUTETIME() Getter for COMPUTETIME, with configurable default
ASK_COMPUTETIME() Getter for COMPUTETIME w/ exceptions if field has no value
HAS_COMPUTETIME() Determine if COMPUTETIME has a value

FinishedAt

A timestamp represented in epoch time.

Accessible with the following methods

Method Description
GET_FINISHEDAT() Getter for FINISHEDAT, with configurable default
ASK_FINISHEDAT() Getter for FINISHEDAT w/ exceptions if field has no value
HAS_FINISHEDAT() Determine if FINISHEDAT has a value

StartedAt

A timestamp represented in epoch time.

Accessible with the following methods

Method Description
GET_STARTEDAT() Getter for STARTEDAT, with configurable default
ASK_STARTEDAT() Getter for STARTEDAT w/ exceptions if field has no value
HAS_STARTEDAT() Determine if STARTEDAT has a value

TotalRecordCount

Long integer type that is a 64-bit signed number.

Accessible with the following methods

Method Description
GET_TOTALRECORDCOUNT() Getter for TOTALRECORDCOUNT, with configurable default
ASK_TOTALRECORDCOUNT() Getter for TOTALRECORDCOUNT w/ exceptions if field has no va
HAS_TOTALRECORDCOUNT() Determine if TOTALRECORDCOUNT has a value

InvalidRecordCount

Long integer type that is a 64-bit signed number.

Accessible with the following methods

Method Description
GET_INVALIDRECORDCOUNT() Getter for INVALIDRECORDCOUNT, with configurable default
ASK_INVALIDRECORDCOUNT() Getter for INVALIDRECORDCOUNT w/ exceptions if field has no
HAS_INVALIDRECORDCOUNT() Determine if INVALIDRECORDCOUNT has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_BATCHPREDICTIONS

TYPES TT_BATCHPREDICTIONS TYPE STANDARD TABLE OF REF TO /AWS1/CL_ML_BATCHPREDICTION WITH DEFAULT KEY
.