AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateBatchPrediction operation. Generates predictions for a group of observations. The observations to process exist in one or more data files referenced by a DataSource. This operation creates a new BatchPrediction, and uses an MLModel and the data files referenced by the DataSource as information sources.

CreateBatchPrediction is an asynchronous operation. In response to CreateBatchPrediction, Amazon Machine Learning (Amazon ML) immediately returns and sets the BatchPrediction status to PENDING. After the BatchPrediction completes, Amazon ML sets the status to COMPLETED.

You can poll for status updates by using the GetBatchPrediction operation and checking the Status parameter of the result. After the COMPLETED status appears, the results are available in the location specified by the OutputUri parameter.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.MachineLearning.AmazonMachineLearningRequest
      Amazon.MachineLearning.Model.CreateBatchPredictionRequest

Namespace: Amazon.MachineLearning.Model
Assembly: AWSSDK.MachineLearning.dll
Version: 3.x.y.z

Syntax

C#
public class CreateBatchPredictionRequest : AmazonMachineLearningRequest
         IAmazonWebServiceRequest

The CreateBatchPredictionRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property BatchPredictionDataSourceId System.String

Gets and sets the property BatchPredictionDataSourceId.

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

Public Property BatchPredictionId System.String

Gets and sets the property BatchPredictionId.

A user-supplied ID that uniquely identifies the BatchPrediction.

Public Property BatchPredictionName System.String

Gets and sets the property BatchPredictionName.

A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.

Public Property MLModelId System.String

Gets and sets the property MLModelId.

The ID of the MLModel that will generate predictions for the group of observations.

Public Property OutputUri System.String

Gets and sets the property OutputUri.

The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms