MachineLearningClient

Definition of the public APIs exposed by Amazon Machine Learning

Properties

Link copied to clipboard
abstract override val config: MachineLearningClient.Config

MachineLearningClient's configuration

Functions

Link copied to clipboard
abstract suspend fun addTags(input: AddTagsRequest): AddTagsResponse

Adds one or more tags to an object, up to a limit of 10. Each tag consists of a key and an optional value. If you add a tag using a key that is already associated with the ML object, AddTags updates the tag's value.

Link copied to clipboard

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.

Link copied to clipboard

Creates a DataSource object from an Amazon Relational Database Service (Amazon RDS). A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.

Link copied to clipboard

Creates a DataSource from a database hosted on an Amazon Redshift cluster. A DataSource references data that can be used to perform either CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.

Link copied to clipboard

Creates a DataSource object. A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.

Link copied to clipboard

Creates a new Evaluation of an MLModel. An MLModel is evaluated on a set of observations associated to a DataSource. Like a DataSource for an MLModel, the DataSource for an Evaluation contains values for the Target Variable. The Evaluation compares the predicted result for each observation to the actual outcome and provides a summary so that you know how effective the MLModel functions on the test data. Evaluation generates a relevant performance metric, such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the corresponding MLModelType: BINARY, REGRESSION or MULTICLASS.

Link copied to clipboard

Creates a new MLModel using the DataSource and the recipe as information sources.

Link copied to clipboard

Creates a real-time endpoint for the MLModel. The endpoint contains the URI of the MLModel; that is, the location to send real-time prediction requests for the specified MLModel.

Link copied to clipboard

Assigns the DELETED status to a BatchPrediction, rendering it unusable.

Link copied to clipboard

Assigns the DELETED status to a DataSource, rendering it unusable.

Link copied to clipboard

Assigns the DELETED status to an Evaluation, rendering it unusable.

Link copied to clipboard

Assigns the DELETED status to an MLModel, rendering it unusable.

Link copied to clipboard

Deletes a real time endpoint of an MLModel.

Link copied to clipboard
abstract suspend fun deleteTags(input: DeleteTagsRequest): DeleteTagsResponse

Deletes the specified tags associated with an ML object. After this operation is complete, you can't recover deleted tags.

Link copied to clipboard
abstract suspend fun describeBatchPredictions(input: DescribeBatchPredictionsRequest = DescribeBatchPredictionsRequest { }): DescribeBatchPredictionsResponse

Returns a list of BatchPrediction operations that match the search criteria in the request.

Link copied to clipboard
abstract suspend fun describeDataSources(input: DescribeDataSourcesRequest = DescribeDataSourcesRequest { }): DescribeDataSourcesResponse

Returns a list of DataSource that match the search criteria in the request.

Link copied to clipboard
abstract suspend fun describeEvaluations(input: DescribeEvaluationsRequest = DescribeEvaluationsRequest { }): DescribeEvaluationsResponse

Returns a list of DescribeEvaluations that match the search criteria in the request.

Link copied to clipboard
abstract suspend fun describeMlModels(input: DescribeMlModelsRequest = DescribeMlModelsRequest { }): DescribeMlModelsResponse

Returns a list of MLModel that match the search criteria in the request.

Link copied to clipboard

Describes one or more of the tags for your Amazon ML object.

Link copied to clipboard

Returns a BatchPrediction that includes detailed metadata, status, and data file information for a Batch Prediction request.

Link copied to clipboard

Returns a DataSource that includes metadata and data file information, as well as the current status of the DataSource.

Link copied to clipboard

Returns an Evaluation that includes metadata as well as the current status of the Evaluation.

Link copied to clipboard
abstract suspend fun getMlModel(input: GetMlModelRequest): GetMlModelResponse

Returns an MLModel that includes detailed metadata, data source information, and the current status of the MLModel.

Link copied to clipboard
abstract suspend fun predict(input: PredictRequest): PredictResponse

Generates a prediction for the observation using the specified ML Model.

Link copied to clipboard

Updates the BatchPredictionName of a BatchPrediction.

Link copied to clipboard

Updates the DataSourceName of a DataSource.

Link copied to clipboard

Updates the EvaluationName of an Evaluation.

Link copied to clipboard

Updates the MLModelName and the ScoreThreshold of an MLModel.

Inherited functions

Link copied to clipboard
inline suspend fun MachineLearningClient.addTags(crossinline block: AddTagsRequest.Builder.() -> Unit): AddTagsResponse

Adds one or more tags to an object, up to a limit of 10. Each tag consists of a key and an optional value. If you add a tag using a key that is already associated with the ML object, AddTags updates the tag's value.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

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.

Link copied to clipboard

Creates a DataSource object from an Amazon Relational Database Service (Amazon RDS). A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.

Link copied to clipboard

Creates a DataSource from a database hosted on an Amazon Redshift cluster. A DataSource references data that can be used to perform either CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.

Link copied to clipboard

Creates a DataSource object. A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.

Link copied to clipboard

Creates a new Evaluation of an MLModel. An MLModel is evaluated on a set of observations associated to a DataSource. Like a DataSource for an MLModel, the DataSource for an Evaluation contains values for the Target Variable. The Evaluation compares the predicted result for each observation to the actual outcome and provides a summary so that you know how effective the MLModel functions on the test data. Evaluation generates a relevant performance metric, such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the corresponding MLModelType: BINARY, REGRESSION or MULTICLASS.

Link copied to clipboard

Creates a new MLModel using the DataSource and the recipe as information sources.

Link copied to clipboard

Creates a real-time endpoint for the MLModel. The endpoint contains the URI of the MLModel; that is, the location to send real-time prediction requests for the specified MLModel.

Link copied to clipboard

Assigns the DELETED status to a BatchPrediction, rendering it unusable.

Link copied to clipboard

Assigns the DELETED status to a DataSource, rendering it unusable.

Link copied to clipboard

Assigns the DELETED status to an Evaluation, rendering it unusable.

Link copied to clipboard

Assigns the DELETED status to an MLModel, rendering it unusable.

Link copied to clipboard

Deletes a real time endpoint of an MLModel.

Link copied to clipboard

Deletes the specified tags associated with an ML object. After this operation is complete, you can't recover deleted tags.

Link copied to clipboard

Returns a list of BatchPrediction operations that match the search criteria in the request.

Link copied to clipboard

Returns a list of DataSource that match the search criteria in the request.

Link copied to clipboard

Returns a list of DescribeEvaluations that match the search criteria in the request.

Link copied to clipboard

Returns a list of MLModel that match the search criteria in the request.

Link copied to clipboard

Describes one or more of the tags for your Amazon ML object.

Link copied to clipboard

Returns a BatchPrediction that includes detailed metadata, status, and data file information for a Batch Prediction request.

Link copied to clipboard

Returns a DataSource that includes metadata and data file information, as well as the current status of the DataSource.

Link copied to clipboard

Returns an Evaluation that includes metadata as well as the current status of the Evaluation.

Link copied to clipboard

Returns an MLModel that includes detailed metadata, data source information, and the current status of the MLModel.

Link copied to clipboard
inline suspend fun MachineLearningClient.predict(crossinline block: PredictRequest.Builder.() -> Unit): PredictResponse

Generates a prediction for the observation using the specified ML Model.

Link copied to clipboard

Updates the BatchPredictionName of a BatchPrediction.

Link copied to clipboard

Updates the DataSourceName of a DataSource.

Link copied to clipboard

Updates the EvaluationName of an Evaluation.

Link copied to clipboard

Updates the MLModelName and the ScoreThreshold of an MLModel.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.