Package software.amazon.awssdk.services.machinelearning

Interface MachineLearningAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface MachineLearningAsyncClient
extends AutoCloseable

Service client for accessing null asynchronously. This can be created using the static builder() method. Definition of the public APIs exposed by Amazon Machine Learning

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<AddTagsResponse>	addTags(AddTagsRequest addTagsRequest)	Adds one or more tags to an object, up to a limit of 10.
static MachineLearningAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a MachineLearningAsyncClient.
static MachineLearningAsyncClient	create()	Create a MachineLearningAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateBatchPredictionResponse>	createBatchPrediction(CreateBatchPredictionRequest createBatchPredictionRequest)	Generates predictions for a group of observations.
default CompletableFuture<CreateDataSourceFromRDSResponse>	createDataSourceFromRDS(CreateDataSourceFromRDSRequest createDataSourceFromRDSRequest)	Creates a DataSource object from an Amazon Relational Database Service (Amazon RDS).
default CompletableFuture<CreateDataSourceFromRedshiftResponse>	createDataSourceFromRedshift(CreateDataSourceFromRedshiftRequest createDataSourceFromRedshiftRequest)	Creates a DataSource from a database hosted on an Amazon Redshift cluster.
default CompletableFuture<CreateDataSourceFromS3Response>	createDataSourceFromS3(CreateDataSourceFromS3Request createDataSourceFromS3Request)	Creates a DataSource object.
default CompletableFuture<CreateEvaluationResponse>	createEvaluation(CreateEvaluationRequest createEvaluationRequest)	Creates a new Evaluation of an MLModel.
default CompletableFuture<CreateMLModelResponse>	createMLModel(CreateMLModelRequest createMLModelRequest)	Creates a new MLModel using the DataSource and the recipe as information sources.
default CompletableFuture<CreateRealtimeEndpointResponse>	createRealtimeEndpoint(CreateRealtimeEndpointRequest createRealtimeEndpointRequest)	Creates a real-time endpoint for the MLModel.
default CompletableFuture<DeleteBatchPredictionResponse>	deleteBatchPrediction(DeleteBatchPredictionRequest deleteBatchPredictionRequest)	Assigns the DELETED status to a BatchPrediction, rendering it unusable.
default CompletableFuture<DeleteDataSourceResponse>	deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)	Assigns the DELETED status to a DataSource, rendering it unusable.
default CompletableFuture<DeleteEvaluationResponse>	deleteEvaluation(DeleteEvaluationRequest deleteEvaluationRequest)	Assigns the DELETED status to an Evaluation, rendering it unusable.
default CompletableFuture<DeleteMLModelResponse>	deleteMLModel(DeleteMLModelRequest deleteMLModelRequest)	Assigns the DELETED status to an MLModel, rendering it unusable.
default CompletableFuture<DeleteRealtimeEndpointResponse>	deleteRealtimeEndpoint(DeleteRealtimeEndpointRequest deleteRealtimeEndpointRequest)	Deletes a real time endpoint of an MLModel.
default CompletableFuture<DeleteTagsResponse>	deleteTags(DeleteTagsRequest deleteTagsRequest)	Deletes the specified tags associated with an ML object.
default CompletableFuture<DescribeBatchPredictionsResponse>	describeBatchPredictions(DescribeBatchPredictionsRequest describeBatchPredictionsRequest)	Returns a list of BatchPrediction operations that match the search criteria in the request.
default CompletableFuture<DescribeDataSourcesResponse>	describeDataSources(DescribeDataSourcesRequest describeDataSourcesRequest)	Returns a list of DataSource that match the search criteria in the request.
default CompletableFuture<DescribeEvaluationsResponse>	describeEvaluations(DescribeEvaluationsRequest describeEvaluationsRequest)	Returns a list of DescribeEvaluations that match the search criteria in the request.
default CompletableFuture<DescribeMLModelsResponse>	describeMLModels(DescribeMLModelsRequest describeMLModelsRequest)	Returns a list of MLModel that match the search criteria in the request.
default CompletableFuture<DescribeTagsResponse>	describeTags(DescribeTagsRequest describeTagsRequest)	Describes one or more of the tags for your Amazon ML object.
default CompletableFuture<GetBatchPredictionResponse>	getBatchPrediction(GetBatchPredictionRequest getBatchPredictionRequest)	Returns a BatchPrediction that includes detailed metadata, status, and data file information for a Batch Prediction request.
default CompletableFuture<GetDataSourceResponse>	getDataSource(GetDataSourceRequest getDataSourceRequest)	Returns a DataSource that includes metadata and data file information, as well as the current status of the DataSource.
default CompletableFuture<GetEvaluationResponse>	getEvaluation(GetEvaluationRequest getEvaluationRequest)	Returns an Evaluation that includes metadata as well as the current status of the Evaluation.
default CompletableFuture<GetMLModelResponse>	getMLModel(GetMLModelRequest getMLModelRequest)	Returns an MLModel that includes detailed metadata, data source information, and the current status of the MLModel.
default CompletableFuture<PredictResponse>	predict(PredictRequest predictRequest)	Generates a prediction for the observation using the specified ML Model.
default CompletableFuture<UpdateBatchPredictionResponse>	updateBatchPrediction(UpdateBatchPredictionRequest updateBatchPredictionRequest)	Updates the BatchPredictionName of a BatchPrediction.
default CompletableFuture<UpdateDataSourceResponse>	updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)	Updates the DataSourceName of a DataSource.
default CompletableFuture<UpdateEvaluationResponse>	updateEvaluation(UpdateEvaluationRequest updateEvaluationRequest)	Updates the EvaluationName of an Evaluation.
default CompletableFuture<UpdateMLModelResponse>	updateMLModel(UpdateMLModelRequest updateMLModelRequest)	Updates the MLModelName and the ScoreThreshold of an MLModel.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static MachineLearningAsyncClient create()

Create a MachineLearningAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static MachineLearningAsyncClientBuilder builder()

Create a builder that can be used to configure and create a MachineLearningAsyncClient.

addTags

default CompletableFuture<AddTagsResponse> addTags(AddTagsRequest addTagsRequest)

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.

Parameters:

addTagsRequest -

Returns:

A Java Future containing the result of the AddTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• InvalidTagException
• TagLimitExceededException
• ResourceNotFoundException A specified resource cannot be located.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

createBatchPrediction

default CompletableFuture<CreateBatchPredictionResponse> createBatchPrediction(CreateBatchPredictionRequest createBatchPredictionRequest)

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.

Parameters:

createBatchPredictionRequest -

Returns:

A Java Future containing the result of the CreateBatchPrediction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• InternalServerException An error on the server occurred when trying to process a request.
• IdempotentParameterMismatchException A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

createDataSourceFromRDS

default CompletableFuture<CreateDataSourceFromRDSResponse> createDataSourceFromRDS(CreateDataSourceFromRDSRequest createDataSourceFromRDSRequest)

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.

CreateDataSourceFromRDS is an asynchronous operation. In response to CreateDataSourceFromRDS, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in the COMPLETED or PENDING state can be used only to perform >CreateMLModel>, CreateEvaluation, or CreateBatchPrediction operations.

If Amazon ML cannot accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response.

Parameters:

createDataSourceFromRDSRequest -

Returns:

A Java Future containing the result of the CreateDataSourceFromRDS operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• InternalServerException An error on the server occurred when trying to process a request.
• IdempotentParameterMismatchException A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

createDataSourceFromRedshift

default CompletableFuture<CreateDataSourceFromRedshiftResponse> createDataSourceFromRedshift(CreateDataSourceFromRedshiftRequest createDataSourceFromRedshiftRequest)

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.

CreateDataSourceFromRedshift is an asynchronous operation. In response to CreateDataSourceFromRedshift, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in COMPLETED or PENDING states can be used to perform only CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.

If Amazon ML can't accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response.

The observations should be contained in the database hosted on an Amazon Redshift cluster and should be specified by a SelectSqlQuery query. Amazon ML executes an Unload command in Amazon Redshift to transfer the result set of the SelectSqlQuery query to S3StagingLocation.

After the DataSource has been created, it's ready for use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel, the DataSource also requires a recipe. A recipe describes how each input variable will be used in training an MLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions.

You can't change an existing datasource, but you can copy and modify the settings from an existing Amazon Redshift datasource to create a new datasource. To do so, call GetDataSource for an existing datasource and copy the values to a CreateDataSource call. Change the settings that you want to change and make sure that all required fields have the appropriate values.

Parameters:

createDataSourceFromRedshiftRequest -

Returns:

A Java Future containing the result of the CreateDataSourceFromRedshift operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• InternalServerException An error on the server occurred when trying to process a request.
• IdempotentParameterMismatchException A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

createDataSourceFromS3

default CompletableFuture<CreateDataSourceFromS3Response> createDataSourceFromS3(CreateDataSourceFromS3Request createDataSourceFromS3Request)

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

CreateDataSourceFromS3 is an asynchronous operation. In response to CreateDataSourceFromS3, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource has been created and is ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in the COMPLETED or PENDING state can be used to perform only CreateMLModel, CreateEvaluation or CreateBatchPrediction operations.

If Amazon ML can't accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response.

The observation data used in a DataSource should be ready to use; that is, it should have a consistent structure, and missing data values should be kept to a minimum. The observation data must reside in one or more .csv files in an Amazon Simple Storage Service (Amazon S3) location, along with a schema that describes the data items by name and type. The same schema must be used for all of the data files referenced by the DataSource.

After the DataSource has been created, it's ready to use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel, the DataSource also needs a recipe. A recipe describes how each input variable will be used in training an MLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions.

Parameters:

createDataSourceFromS3Request -

Returns:

A Java Future containing the result of the CreateDataSourceFromS3 operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• InternalServerException An error on the server occurred when trying to process a request.
• IdempotentParameterMismatchException A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

createEvaluation

default CompletableFuture<CreateEvaluationResponse> createEvaluation(CreateEvaluationRequest createEvaluationRequest)

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.

CreateEvaluation is an asynchronous operation. In response to CreateEvaluation, Amazon Machine Learning (Amazon ML) immediately returns and sets the evaluation status to PENDING. After the Evaluation is created and ready for use, Amazon ML sets the status to COMPLETED.

You can use the GetEvaluation operation to check progress of the evaluation during the creation operation.

Parameters:

createEvaluationRequest -

Returns:

A Java Future containing the result of the CreateEvaluation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• InternalServerException An error on the server occurred when trying to process a request.
• IdempotentParameterMismatchException A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

createMLModel

default CompletableFuture<CreateMLModelResponse> createMLModel(CreateMLModelRequest createMLModelRequest)

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

An MLModel is nearly immutable. Users can update only the MLModelName and the ScoreThreshold in an MLModel without creating a new MLModel.

CreateMLModel is an asynchronous operation. In response to CreateMLModel, Amazon Machine Learning (Amazon ML) immediately returns and sets the MLModel status to PENDING . After the MLModel has been created and ready is for use, Amazon ML sets the status to COMPLETED.

You can use the GetMLModel operation to check the progress of the MLModel during the creation operation.

CreateMLModel requires a DataSource with computed statistics, which can be created by setting ComputeStatistics to true in CreateDataSourceFromRDS, CreateDataSourceFromS3, or CreateDataSourceFromRedshift operations.

Parameters:

createMLModelRequest -

Returns:

A Java Future containing the result of the CreateMLModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• InternalServerException An error on the server occurred when trying to process a request.
• IdempotentParameterMismatchException A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

createRealtimeEndpoint

default CompletableFuture<CreateRealtimeEndpointResponse> createRealtimeEndpoint(CreateRealtimeEndpointRequest createRealtimeEndpointRequest)

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.

Parameters:

createRealtimeEndpointRequest -

Returns:

A Java Future containing the result of the CreateRealtimeEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• ResourceNotFoundException A specified resource cannot be located.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

deleteBatchPrediction

default CompletableFuture<DeleteBatchPredictionResponse> deleteBatchPrediction(DeleteBatchPredictionRequest deleteBatchPredictionRequest)

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

After using the DeleteBatchPrediction operation, you can use the GetBatchPrediction operation to verify that the status of the BatchPrediction changed to DELETED.

Caution: The result of the DeleteBatchPrediction operation is irreversible.

Parameters:

deleteBatchPredictionRequest -

Returns:

A Java Future containing the result of the DeleteBatchPrediction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• ResourceNotFoundException A specified resource cannot be located.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

deleteDataSource

default CompletableFuture<DeleteDataSourceResponse> deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)

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

After using the DeleteDataSource operation, you can use the GetDataSource operation to verify that the status of the DataSource changed to DELETED.

Caution: The results of the DeleteDataSource operation are irreversible.

Parameters:

deleteDataSourceRequest -

Returns:

A Java Future containing the result of the DeleteDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• ResourceNotFoundException A specified resource cannot be located.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

deleteEvaluation

default CompletableFuture<DeleteEvaluationResponse> deleteEvaluation(DeleteEvaluationRequest deleteEvaluationRequest)

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

After invoking the DeleteEvaluation operation, you can use the GetEvaluation operation to verify that the status of the Evaluation changed to DELETED.

The results of the DeleteEvaluation operation are irreversible.

Parameters:

deleteEvaluationRequest -

Returns:

A Java Future containing the result of the DeleteEvaluation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• ResourceNotFoundException A specified resource cannot be located.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

deleteMLModel

default CompletableFuture<DeleteMLModelResponse> deleteMLModel(DeleteMLModelRequest deleteMLModelRequest)

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

After using the DeleteMLModel operation, you can use the GetMLModel operation to verify that the status of the MLModel changed to DELETED.

Caution: The result of the DeleteMLModel operation is irreversible.

Parameters:

deleteMLModelRequest -

Returns:

A Java Future containing the result of the DeleteMLModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• ResourceNotFoundException A specified resource cannot be located.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

deleteRealtimeEndpoint

default CompletableFuture<DeleteRealtimeEndpointResponse> deleteRealtimeEndpoint(DeleteRealtimeEndpointRequest deleteRealtimeEndpointRequest)

Deletes a real time endpoint of an MLModel.

Parameters:

deleteRealtimeEndpointRequest -

Returns:

A Java Future containing the result of the DeleteRealtimeEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• ResourceNotFoundException A specified resource cannot be located.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

deleteTags

default CompletableFuture<DeleteTagsResponse> deleteTags(DeleteTagsRequest deleteTagsRequest)

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

If you specify a tag that doesn't exist, Amazon ML ignores it.

Parameters:

deleteTagsRequest -

Returns:

A Java Future containing the result of the DeleteTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• InvalidTagException
• ResourceNotFoundException A specified resource cannot be located.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

describeBatchPredictions

default CompletableFuture<DescribeBatchPredictionsResponse> describeBatchPredictions(DescribeBatchPredictionsRequest describeBatchPredictionsRequest)

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

Parameters:

describeBatchPredictionsRequest -

Returns:

A Java Future containing the result of the DescribeBatchPredictions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

describeDataSources

default CompletableFuture<DescribeDataSourcesResponse> describeDataSources(DescribeDataSourcesRequest describeDataSourcesRequest)

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

Parameters:

describeDataSourcesRequest -

Returns:

A Java Future containing the result of the DescribeDataSources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

describeEvaluations

default CompletableFuture<DescribeEvaluationsResponse> describeEvaluations(DescribeEvaluationsRequest describeEvaluationsRequest)

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

Parameters:

describeEvaluationsRequest -

Returns:

A Java Future containing the result of the DescribeEvaluations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

describeMLModels

default CompletableFuture<DescribeMLModelsResponse> describeMLModels(DescribeMLModelsRequest describeMLModelsRequest)

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

Parameters:

describeMLModelsRequest -

Returns:

A Java Future containing the result of the DescribeMLModels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

describeTags

default CompletableFuture<DescribeTagsResponse> describeTags(DescribeTagsRequest describeTagsRequest)

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

Parameters:

describeTagsRequest -

Returns:

A Java Future containing the result of the DescribeTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• ResourceNotFoundException A specified resource cannot be located.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getBatchPrediction

default CompletableFuture<GetBatchPredictionResponse> getBatchPrediction(GetBatchPredictionRequest getBatchPredictionRequest)

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

Parameters:

getBatchPredictionRequest -

Returns:

A Java Future containing the result of the GetBatchPrediction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• ResourceNotFoundException A specified resource cannot be located.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getDataSource

default CompletableFuture<GetDataSourceResponse> getDataSource(GetDataSourceRequest getDataSourceRequest)

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

GetDataSource provides results in normal or verbose format. The verbose format adds the schema description and the list of files pointed to by the DataSource to the normal format.

Parameters:

getDataSourceRequest -

Returns:

A Java Future containing the result of the GetDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• ResourceNotFoundException A specified resource cannot be located.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getEvaluation

default CompletableFuture<GetEvaluationResponse> getEvaluation(GetEvaluationRequest getEvaluationRequest)

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

Parameters:

getEvaluationRequest -

Returns:

A Java Future containing the result of the GetEvaluation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• ResourceNotFoundException A specified resource cannot be located.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getMLModel

default CompletableFuture<GetMLModelResponse> getMLModel(GetMLModelRequest getMLModelRequest)

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

GetMLModel provides results in normal or verbose format.

Parameters:

getMLModelRequest -

Returns:

A Java Future containing the result of the GetMLModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• ResourceNotFoundException A specified resource cannot be located.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

predict

default CompletableFuture<PredictResponse> predict(PredictRequest predictRequest)

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

Not all response parameters will be populated. Whether a response parameter is populated depends on the type of model requested.

Parameters:

predictRequest -

Returns:

A Java Future containing the result of the Predict operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• ResourceNotFoundException A specified resource cannot be located.
• LimitExceededException The subscriber exceeded the maximum number of operations. This exception can occur when listing objects such as DataSource.
• InternalServerException An error on the server occurred when trying to process a request.
• PredictorNotMountedException The exception is thrown when a predict request is made to an unmounted MLModel.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

updateBatchPrediction

default CompletableFuture<UpdateBatchPredictionResponse> updateBatchPrediction(UpdateBatchPredictionRequest updateBatchPredictionRequest)

Updates the BatchPredictionName of a BatchPrediction.

You can use the GetBatchPrediction operation to view the contents of the updated data element.

Parameters:

updateBatchPredictionRequest -

Returns:

A Java Future containing the result of the UpdateBatchPrediction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• ResourceNotFoundException A specified resource cannot be located.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

updateDataSource

default CompletableFuture<UpdateDataSourceResponse> updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)

Updates the DataSourceName of a DataSource.

You can use the GetDataSource operation to view the contents of the updated data element.

Parameters:

updateDataSourceRequest -

Returns:

A Java Future containing the result of the UpdateDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• ResourceNotFoundException A specified resource cannot be located.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

updateEvaluation

default CompletableFuture<UpdateEvaluationResponse> updateEvaluation(UpdateEvaluationRequest updateEvaluationRequest)

Updates the EvaluationName of an Evaluation.

You can use the GetEvaluation operation to view the contents of the updated data element.

Parameters:

updateEvaluationRequest -

Returns:

A Java Future containing the result of the UpdateEvaluation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• ResourceNotFoundException A specified resource cannot be located.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

updateMLModel

default CompletableFuture<UpdateMLModelResponse> updateMLModel(UpdateMLModelRequest updateMLModelRequest)

Updates the MLModelName and the ScoreThreshold of an MLModel.

You can use the GetMLModel operation to view the contents of the updated data element.

Parameters:

updateMLModelRequest -

Returns:

A Java Future containing the result of the UpdateMLModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException An error on the client occurred. Typically, the cause is an invalid input value.
• ResourceNotFoundException A specified resource cannot be located.
• InternalServerException An error on the server occurred when trying to process a request.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• MachineLearningException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this