You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MachineLearning::Types::BatchPrediction

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#batch_prediction_data_source_idString

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

Returns:

  • (String)


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 154

class BatchPrediction < Struct.new(
  :batch_prediction_id,
  :ml_model_id,
  :batch_prediction_data_source_id,
  :input_data_location_s3,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :name,
  :status,
  :output_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  include Aws::Structure
end

#batch_prediction_idString

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

Returns:

  • (String)


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 154

class BatchPrediction < Struct.new(
  :batch_prediction_id,
  :ml_model_id,
  :batch_prediction_data_source_id,
  :input_data_location_s3,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :name,
  :status,
  :output_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  include Aws::Structure
end

#compute_timeInteger

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

Returns:

  • (Integer)


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 154

class BatchPrediction < Struct.new(
  :batch_prediction_id,
  :ml_model_id,
  :batch_prediction_data_source_id,
  :input_data_location_s3,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :name,
  :status,
  :output_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  include Aws::Structure
end

#created_atTime

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

Returns:

  • (Time)


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 154

class BatchPrediction < Struct.new(
  :batch_prediction_id,
  :ml_model_id,
  :batch_prediction_data_source_id,
  :input_data_location_s3,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :name,
  :status,
  :output_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  include Aws::Structure
end

#created_by_iam_userString

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.

Returns:

  • (String)


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 154

class BatchPrediction < Struct.new(
  :batch_prediction_id,
  :ml_model_id,
  :batch_prediction_data_source_id,
  :input_data_location_s3,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :name,
  :status,
  :output_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  include Aws::Structure
end

#finished_atTime

A timestamp represented in epoch time.

Returns:

  • (Time)


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 154

class BatchPrediction < Struct.new(
  :batch_prediction_id,
  :ml_model_id,
  :batch_prediction_data_source_id,
  :input_data_location_s3,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :name,
  :status,
  :output_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  include Aws::Structure
end

#input_data_location_s3String

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

Returns:

  • (String)


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 154

class BatchPrediction < Struct.new(
  :batch_prediction_id,
  :ml_model_id,
  :batch_prediction_data_source_id,
  :input_data_location_s3,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :name,
  :status,
  :output_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  include Aws::Structure
end

#invalid_record_countInteger

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

Returns:

  • (Integer)


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 154

class BatchPrediction < Struct.new(
  :batch_prediction_id,
  :ml_model_id,
  :batch_prediction_data_source_id,
  :input_data_location_s3,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :name,
  :status,
  :output_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  include Aws::Structure
end

#last_updated_atTime

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

Returns:

  • (Time)


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 154

class BatchPrediction < Struct.new(
  :batch_prediction_id,
  :ml_model_id,
  :batch_prediction_data_source_id,
  :input_data_location_s3,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :name,
  :status,
  :output_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  include Aws::Structure
end

#messageString

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

Returns:

  • (String)


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 154

class BatchPrediction < Struct.new(
  :batch_prediction_id,
  :ml_model_id,
  :batch_prediction_data_source_id,
  :input_data_location_s3,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :name,
  :status,
  :output_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  include Aws::Structure
end

#ml_model_idString

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

Returns:

  • (String)


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 154

class BatchPrediction < Struct.new(
  :batch_prediction_id,
  :ml_model_id,
  :batch_prediction_data_source_id,
  :input_data_location_s3,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :name,
  :status,
  :output_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  include Aws::Structure
end

#nameString

A user-supplied name or description of the BatchPrediction.

Returns:

  • (String)


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 154

class BatchPrediction < Struct.new(
  :batch_prediction_id,
  :ml_model_id,
  :batch_prediction_data_source_id,
  :input_data_location_s3,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :name,
  :status,
  :output_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  include Aws::Structure
end

#output_uriString

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

Returns:

  • (String)


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 154

class BatchPrediction < Struct.new(
  :batch_prediction_id,
  :ml_model_id,
  :batch_prediction_data_source_id,
  :input_data_location_s3,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :name,
  :status,
  :output_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  include Aws::Structure
end

#started_atTime

A timestamp represented in epoch time.

Returns:

  • (Time)


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 154

class BatchPrediction < Struct.new(
  :batch_prediction_id,
  :ml_model_id,
  :batch_prediction_data_source_id,
  :input_data_location_s3,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :name,
  :status,
  :output_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  include Aws::Structure
end

#statusString

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.

Returns:

  • (String)


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 154

class BatchPrediction < Struct.new(
  :batch_prediction_id,
  :ml_model_id,
  :batch_prediction_data_source_id,
  :input_data_location_s3,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :name,
  :status,
  :output_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  include Aws::Structure
end

#total_record_countInteger

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

Returns:

  • (Integer)


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 154

class BatchPrediction < Struct.new(
  :batch_prediction_id,
  :ml_model_id,
  :batch_prediction_data_source_id,
  :input_data_location_s3,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :name,
  :status,
  :output_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  include Aws::Structure
end