Menu
Amazon Machine Learning
API Reference (API Version 2014-12-12)

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.

Contents

BatchPredictionDataSourceId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_.-]+

Required: No

BatchPredictionId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_.-]+

Required: No

ComputeTime

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

Type: Long

Required: No

CreatedAt

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

Type: Timestamp

Required: No

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.

Type: String

Pattern: arn:aws:iam::[0-9]+:((user/.+)|(root))

Required: No

FinishedAt

A timestamp represented in epoch time.

Type: Timestamp

Required: No

InputDataLocationS3

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

Type: String

Length Constraints: Maximum length of 2048.

Pattern: s3://([^/]+)(/.*)?

Required: No

InvalidRecordCount

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

Type: Long

Required: No

LastUpdatedAt

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

Type: Timestamp

Required: No

Message

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

Type: String

Length Constraints: Maximum length of 10240.

Required: No

MLModelId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_.-]+

Required: No

Name

A user-supplied name or description of the BatchPrediction.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: .*\S.*|^$

Required: No

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

Type: String

Length Constraints: Maximum length of 2048.

Pattern: s3://([^/]+)(/.*)?

Required: No

StartedAt

A timestamp represented in epoch time.

Type: Timestamp

Required: No

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.

Type: String

Valid Values: PENDING | INPROGRESS | FAILED | COMPLETED | DELETED

Required: No

TotalRecordCount

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

Type: Long

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: