/AWS1/CL_ML_GETBTCPREDICTION01¶
Represents the output of a GetBatchPrediction operation and describes a BatchPrediction.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_batchpredictionid TYPE /AWS1/ML_ENTITYID /AWS1/ML_ENTITYID¶
An ID assigned to the
BatchPredictionat creation. This value should be identical to the value of theBatchPredictionIDin the request.
iv_mlmodelid TYPE /AWS1/ML_ENTITYID /AWS1/ML_ENTITYID¶
The ID of the
MLModelthat generated predictions for theBatchPredictionrequest.
iv_batchpredictiondatasrcid TYPE /AWS1/ML_ENTITYID /AWS1/ML_ENTITYID¶
The ID of the
DataSourcethat was used to create theBatchPrediction.
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 when the
BatchPredictionwas 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
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, 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- TheBatchPredictionis 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.
iv_loguri TYPE /AWS1/ML_PRESIGNEDS3URL /AWS1/ML_PRESIGNEDS3URL¶
A link to the file that contains logs of the
CreateBatchPredictionoperation.
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¶
The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the
BatchPrediction, normalized and scaled on computation resources.ComputeTimeis only available if theBatchPredictionis in theCOMPLETEDstate.
iv_finishedat TYPE /AWS1/ML_EPOCHTIME /AWS1/ML_EPOCHTIME¶
The epoch time when Amazon Machine Learning marked the
BatchPredictionasCOMPLETEDorFAILED.FinishedAtis only available when theBatchPredictionis in theCOMPLETEDorFAILEDstate.
iv_startedat TYPE /AWS1/ML_EPOCHTIME /AWS1/ML_EPOCHTIME¶
The epoch time when Amazon Machine Learning marked the
BatchPredictionasINPROGRESS.StartedAtisn't available if theBatchPredictionis in thePENDINGstate.
iv_totalrecordcount TYPE /AWS1/ML_LONGTYPE /AWS1/ML_LONGTYPE¶
The number of total records that Amazon Machine Learning saw while processing the
BatchPrediction.
iv_invalidrecordcount TYPE /AWS1/ML_LONGTYPE /AWS1/ML_LONGTYPE¶
The number of invalid records that Amazon Machine Learning saw while processing the
BatchPrediction.
Queryable Attributes¶
BatchPredictionId¶
An ID assigned to the
BatchPredictionat creation. This value should be identical to the value of theBatchPredictionIDin 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
MLModelthat generated predictions for theBatchPredictionrequest.
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
DataSourcethat was used to create theBatchPrediction.
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 when the
BatchPredictionwas 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
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, 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- TheBatchPredictionis 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.
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 |
LogUri¶
A link to the file that contains logs of the
CreateBatchPredictionoperation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LOGURI() |
Getter for LOGURI, with configurable default |
ASK_LOGURI() |
Getter for LOGURI w/ exceptions if field has no value |
HAS_LOGURI() |
Determine if LOGURI 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¶
The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the
BatchPrediction, normalized and scaled on computation resources.ComputeTimeis only available if theBatchPredictionis in theCOMPLETEDstate.
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¶
The epoch time when Amazon Machine Learning marked the
BatchPredictionasCOMPLETEDorFAILED.FinishedAtis only available when theBatchPredictionis in theCOMPLETEDorFAILEDstate.
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¶
The epoch time when Amazon Machine Learning marked the
BatchPredictionasINPROGRESS.StartedAtisn't available if theBatchPredictionis in thePENDINGstate.
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¶
The number of total records that Amazon Machine Learning saw while processing the
BatchPrediction.
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¶
The number of invalid records that Amazon Machine Learning saw while processing the
BatchPrediction.
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 |