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.

Class: Aws::MachineLearning::Types::GetBatchPredictionOutput

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 and describes a BatchPrediction.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#batch_prediction_data_source_idString

The ID of the DataSource that was used to create the BatchPrediction.

Returns:

  • (String)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2060

class GetBatchPredictionOutput < 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,
  :log_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  SENSITIVE = []
  include Aws::Structure
end

#batch_prediction_idString

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

Returns:

  • (String)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2060

class GetBatchPredictionOutput < 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,
  :log_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  SENSITIVE = []
  include Aws::Structure
end

#compute_timeInteger

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the BatchPrediction, normalized and scaled on computation resources. ComputeTime is only available if the BatchPrediction is in the COMPLETED state.

Returns:

  • (Integer)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2060

class GetBatchPredictionOutput < 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,
  :log_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  SENSITIVE = []
  include Aws::Structure
end

#created_atTime

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

Returns:

  • (Time)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2060

class GetBatchPredictionOutput < 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,
  :log_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  SENSITIVE = []
  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)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2060

class GetBatchPredictionOutput < 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,
  :log_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  SENSITIVE = []
  include Aws::Structure
end

#finished_atTime

The epoch time when Amazon Machine Learning marked the BatchPrediction as COMPLETED or FAILED. FinishedAt is only available when the BatchPrediction is in the COMPLETED or FAILED state.

Returns:

  • (Time)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2060

class GetBatchPredictionOutput < 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,
  :log_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  SENSITIVE = []
  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)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2060

class GetBatchPredictionOutput < 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,
  :log_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  SENSITIVE = []
  include Aws::Structure
end

#invalid_record_countInteger

The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction.

Returns:

  • (Integer)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2060

class GetBatchPredictionOutput < 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,
  :log_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_atTime

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

Returns:

  • (Time)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2060

class GetBatchPredictionOutput < 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,
  :log_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  SENSITIVE = []
  include Aws::Structure
end

#log_uriString

A link to the file that contains logs of the CreateBatchPrediction operation.

Returns:

  • (String)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2060

class GetBatchPredictionOutput < 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,
  :log_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  SENSITIVE = []
  include Aws::Structure
end

#messageString

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

Returns:

  • (String)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2060

class GetBatchPredictionOutput < 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,
  :log_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  SENSITIVE = []
  include Aws::Structure
end

#ml_model_idString

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

Returns:

  • (String)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2060

class GetBatchPredictionOutput < 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,
  :log_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

A user-supplied name or description of the BatchPrediction.

Returns:

  • (String)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2060

class GetBatchPredictionOutput < 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,
  :log_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  SENSITIVE = []
  include Aws::Structure
end

#output_uriString

The location of an Amazon S3 bucket or directory to receive the operation results.

Returns:

  • (String)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2060

class GetBatchPredictionOutput < 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,
  :log_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  SENSITIVE = []
  include Aws::Structure
end

#started_atTime

The epoch time when Amazon Machine Learning marked the BatchPrediction as INPROGRESS. StartedAt isn't available if the BatchPrediction is in the PENDING state.

Returns:

  • (Time)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2060

class GetBatchPredictionOutput < 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,
  :log_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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 - The BatchPrediction is marked as deleted. It is not usable.

Returns:

  • (String)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2060

class GetBatchPredictionOutput < 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,
  :log_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  SENSITIVE = []
  include Aws::Structure
end

#total_record_countInteger

The number of total records that Amazon Machine Learning saw while processing the BatchPrediction.

Returns:

  • (Integer)


2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2060

class GetBatchPredictionOutput < 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,
  :log_uri,
  :message,
  :compute_time,
  :finished_at,
  :started_at,
  :total_record_count,
  :invalid_record_count)
  SENSITIVE = []
  include Aws::Structure
end