Documentation

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.

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:batchPredictionDataSourceId:BatchPrediction', batchPrediction_batchPredictionDataSourceId - The ID of the DataSource that points to the group of observations to predict.

$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:computeTime:BatchPrediction', batchPrediction_computeTime - Undocumented member.

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

$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:finishedAt:BatchPrediction', batchPrediction_finishedAt - Undocumented member.

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

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

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

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

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

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

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

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

$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:totalRecordCount:BatchPrediction', batchPrediction_totalRecordCount - Undocumented member.

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

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

Undocumented member.

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

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.

Undocumented member.

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

Undocumented member.

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

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

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

A user-supplied name or description of the BatchPrediction.

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

Undocumented member.

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.

Undocumented member.