Interface MachineLearningAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
Definition of the public APIs exposed by Amazon Machine Learning-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptiondefault CompletableFuture<AddTagsResponse> addTags(Consumer<AddTagsRequest.Builder> addTagsRequest) Adds one or more tags to an object, up to a limit of 10.default CompletableFuture<AddTagsResponse> addTags(AddTagsRequest addTagsRequest) Adds one or more tags to an object, up to a limit of 10.builder()Create a builder that can be used to configure and create aMachineLearningAsyncClient.static MachineLearningAsyncClientcreate()Create aMachineLearningAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createBatchPrediction(Consumer<CreateBatchPredictionRequest.Builder> createBatchPredictionRequest) Generates predictions for a group of observations.createBatchPrediction(CreateBatchPredictionRequest createBatchPredictionRequest) Generates predictions for a group of observations.createDataSourceFromRDS(Consumer<CreateDataSourceFromRdsRequest.Builder> createDataSourceFromRdsRequest) Creates aDataSourceobject from an Amazon Relational Database Service (Amazon RDS).createDataSourceFromRDS(CreateDataSourceFromRdsRequest createDataSourceFromRdsRequest) Creates aDataSourceobject from an Amazon Relational Database Service (Amazon RDS).createDataSourceFromRedshift(Consumer<CreateDataSourceFromRedshiftRequest.Builder> createDataSourceFromRedshiftRequest) Creates aDataSourcefrom a database hosted on an Amazon Redshift cluster.createDataSourceFromRedshift(CreateDataSourceFromRedshiftRequest createDataSourceFromRedshiftRequest) Creates aDataSourcefrom a database hosted on an Amazon Redshift cluster.createDataSourceFromS3(Consumer<CreateDataSourceFromS3Request.Builder> createDataSourceFromS3Request) Creates aDataSourceobject.createDataSourceFromS3(CreateDataSourceFromS3Request createDataSourceFromS3Request) Creates aDataSourceobject.createEvaluation(Consumer<CreateEvaluationRequest.Builder> createEvaluationRequest) Creates a newEvaluationof anMLModel.createEvaluation(CreateEvaluationRequest createEvaluationRequest) Creates a newEvaluationof anMLModel.default CompletableFuture<CreateMlModelResponse> createMLModel(Consumer<CreateMlModelRequest.Builder> createMlModelRequest) Creates a newMLModelusing theDataSourceand the recipe as information sources.default CompletableFuture<CreateMlModelResponse> createMLModel(CreateMlModelRequest createMlModelRequest) Creates a newMLModelusing theDataSourceand the recipe as information sources.createRealtimeEndpoint(Consumer<CreateRealtimeEndpointRequest.Builder> createRealtimeEndpointRequest) Creates a real-time endpoint for theMLModel.createRealtimeEndpoint(CreateRealtimeEndpointRequest createRealtimeEndpointRequest) Creates a real-time endpoint for theMLModel.deleteBatchPrediction(Consumer<DeleteBatchPredictionRequest.Builder> deleteBatchPredictionRequest) Assigns the DELETED status to aBatchPrediction, rendering it unusable.deleteBatchPrediction(DeleteBatchPredictionRequest deleteBatchPredictionRequest) Assigns the DELETED status to aBatchPrediction, rendering it unusable.deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest) Assigns the DELETED status to aDataSource, rendering it unusable.deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) Assigns the DELETED status to aDataSource, rendering it unusable.deleteEvaluation(Consumer<DeleteEvaluationRequest.Builder> deleteEvaluationRequest) Assigns theDELETEDstatus to anEvaluation, rendering it unusable.deleteEvaluation(DeleteEvaluationRequest deleteEvaluationRequest) Assigns theDELETEDstatus to anEvaluation, rendering it unusable.default CompletableFuture<DeleteMlModelResponse> deleteMLModel(Consumer<DeleteMlModelRequest.Builder> deleteMlModelRequest) Assigns theDELETEDstatus to anMLModel, rendering it unusable.default CompletableFuture<DeleteMlModelResponse> deleteMLModel(DeleteMlModelRequest deleteMlModelRequest) Assigns theDELETEDstatus to anMLModel, rendering it unusable.deleteRealtimeEndpoint(Consumer<DeleteRealtimeEndpointRequest.Builder> deleteRealtimeEndpointRequest) Deletes a real time endpoint of anMLModel.deleteRealtimeEndpoint(DeleteRealtimeEndpointRequest deleteRealtimeEndpointRequest) Deletes a real time endpoint of anMLModel.default CompletableFuture<DeleteTagsResponse> deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) Deletes the specified tags associated with an ML object.default CompletableFuture<DeleteTagsResponse> deleteTags(DeleteTagsRequest deleteTagsRequest) Deletes the specified tags associated with an ML object.Returns a list ofBatchPredictionoperations that match the search criteria in the request.describeBatchPredictions(Consumer<DescribeBatchPredictionsRequest.Builder> describeBatchPredictionsRequest) Returns a list ofBatchPredictionoperations that match the search criteria in the request.describeBatchPredictions(DescribeBatchPredictionsRequest describeBatchPredictionsRequest) Returns a list ofBatchPredictionoperations that match the search criteria in the request.This is a variant ofdescribeBatchPredictions(software.amazon.awssdk.services.machinelearning.model.DescribeBatchPredictionsRequest)operation.describeBatchPredictionsPaginator(Consumer<DescribeBatchPredictionsRequest.Builder> describeBatchPredictionsRequest) This is a variant ofdescribeBatchPredictions(software.amazon.awssdk.services.machinelearning.model.DescribeBatchPredictionsRequest)operation.describeBatchPredictionsPaginator(DescribeBatchPredictionsRequest describeBatchPredictionsRequest) This is a variant ofdescribeBatchPredictions(software.amazon.awssdk.services.machinelearning.model.DescribeBatchPredictionsRequest)operation.Returns a list ofDataSourcethat match the search criteria in the request.describeDataSources(Consumer<DescribeDataSourcesRequest.Builder> describeDataSourcesRequest) Returns a list ofDataSourcethat match the search criteria in the request.describeDataSources(DescribeDataSourcesRequest describeDataSourcesRequest) Returns a list ofDataSourcethat match the search criteria in the request.default DescribeDataSourcesPublisherThis is a variant ofdescribeDataSources(software.amazon.awssdk.services.machinelearning.model.DescribeDataSourcesRequest)operation.default DescribeDataSourcesPublisherdescribeDataSourcesPaginator(Consumer<DescribeDataSourcesRequest.Builder> describeDataSourcesRequest) This is a variant ofdescribeDataSources(software.amazon.awssdk.services.machinelearning.model.DescribeDataSourcesRequest)operation.default DescribeDataSourcesPublisherdescribeDataSourcesPaginator(DescribeDataSourcesRequest describeDataSourcesRequest) This is a variant ofdescribeDataSources(software.amazon.awssdk.services.machinelearning.model.DescribeDataSourcesRequest)operation.Returns a list ofDescribeEvaluationsthat match the search criteria in the request.describeEvaluations(Consumer<DescribeEvaluationsRequest.Builder> describeEvaluationsRequest) Returns a list ofDescribeEvaluationsthat match the search criteria in the request.describeEvaluations(DescribeEvaluationsRequest describeEvaluationsRequest) Returns a list ofDescribeEvaluationsthat match the search criteria in the request.default DescribeEvaluationsPublisherThis is a variant ofdescribeEvaluations(software.amazon.awssdk.services.machinelearning.model.DescribeEvaluationsRequest)operation.default DescribeEvaluationsPublisherdescribeEvaluationsPaginator(Consumer<DescribeEvaluationsRequest.Builder> describeEvaluationsRequest) This is a variant ofdescribeEvaluations(software.amazon.awssdk.services.machinelearning.model.DescribeEvaluationsRequest)operation.default DescribeEvaluationsPublisherdescribeEvaluationsPaginator(DescribeEvaluationsRequest describeEvaluationsRequest) This is a variant ofdescribeEvaluations(software.amazon.awssdk.services.machinelearning.model.DescribeEvaluationsRequest)operation.Returns a list ofMLModelthat match the search criteria in the request.describeMLModels(Consumer<DescribeMlModelsRequest.Builder> describeMlModelsRequest) Returns a list ofMLModelthat match the search criteria in the request.describeMLModels(DescribeMlModelsRequest describeMlModelsRequest) Returns a list ofMLModelthat match the search criteria in the request.default DescribeMLModelsPublisherThis is a variant ofdescribeMLModels(software.amazon.awssdk.services.machinelearning.model.DescribeMlModelsRequest)operation.default DescribeMLModelsPublisherdescribeMLModelsPaginator(Consumer<DescribeMlModelsRequest.Builder> describeMlModelsRequest) This is a variant ofdescribeMLModels(software.amazon.awssdk.services.machinelearning.model.DescribeMlModelsRequest)operation.default DescribeMLModelsPublisherdescribeMLModelsPaginator(DescribeMlModelsRequest describeMlModelsRequest) This is a variant ofdescribeMLModels(software.amazon.awssdk.services.machinelearning.model.DescribeMlModelsRequest)operation.default CompletableFuture<DescribeTagsResponse> describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) Describes one or more of the tags for your Amazon ML object.default CompletableFuture<DescribeTagsResponse> describeTags(DescribeTagsRequest describeTagsRequest) Describes one or more of the tags for your Amazon ML object.getBatchPrediction(Consumer<GetBatchPredictionRequest.Builder> getBatchPredictionRequest) Returns aBatchPredictionthat includes detailed metadata, status, and data file information for aBatch Predictionrequest.getBatchPrediction(GetBatchPredictionRequest getBatchPredictionRequest) Returns aBatchPredictionthat includes detailed metadata, status, and data file information for aBatch Predictionrequest.default CompletableFuture<GetDataSourceResponse> getDataSource(Consumer<GetDataSourceRequest.Builder> getDataSourceRequest) Returns aDataSourcethat includes metadata and data file information, as well as the current status of theDataSource.default CompletableFuture<GetDataSourceResponse> getDataSource(GetDataSourceRequest getDataSourceRequest) Returns aDataSourcethat includes metadata and data file information, as well as the current status of theDataSource.default CompletableFuture<GetEvaluationResponse> getEvaluation(Consumer<GetEvaluationRequest.Builder> getEvaluationRequest) Returns anEvaluationthat includes metadata as well as the current status of theEvaluation.default CompletableFuture<GetEvaluationResponse> getEvaluation(GetEvaluationRequest getEvaluationRequest) Returns anEvaluationthat includes metadata as well as the current status of theEvaluation.default CompletableFuture<GetMlModelResponse> getMLModel(Consumer<GetMlModelRequest.Builder> getMlModelRequest) Returns anMLModelthat includes detailed metadata, data source information, and the current status of theMLModel.default CompletableFuture<GetMlModelResponse> getMLModel(GetMlModelRequest getMlModelRequest) Returns anMLModelthat includes detailed metadata, data source information, and the current status of theMLModel.default CompletableFuture<PredictResponse> predict(Consumer<PredictRequest.Builder> predictRequest) Generates a prediction for the observation using the specifiedML Model.default CompletableFuture<PredictResponse> predict(PredictRequest predictRequest) Generates a prediction for the observation using the specifiedML Model.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationupdateBatchPrediction(Consumer<UpdateBatchPredictionRequest.Builder> updateBatchPredictionRequest) Updates theBatchPredictionNameof aBatchPrediction.updateBatchPrediction(UpdateBatchPredictionRequest updateBatchPredictionRequest) Updates theBatchPredictionNameof aBatchPrediction.updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) Updates theDataSourceNameof aDataSource.updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) Updates theDataSourceNameof aDataSource.updateEvaluation(Consumer<UpdateEvaluationRequest.Builder> updateEvaluationRequest) Updates theEvaluationNameof anEvaluation.updateEvaluation(UpdateEvaluationRequest updateEvaluationRequest) Updates theEvaluationNameof anEvaluation.default CompletableFuture<UpdateMlModelResponse> updateMLModel(Consumer<UpdateMlModelRequest.Builder> updateMlModelRequest) Updates theMLModelNameand theScoreThresholdof anMLModel.default CompletableFuture<UpdateMlModelResponse> updateMLModel(UpdateMlModelRequest updateMlModelRequest) Updates theMLModelNameand theScoreThresholdof anMLModel.default MachineLearningAsyncWaiterwaiter()Create an instance ofMachineLearningAsyncWaiterusing this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
addTags
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,
AddTagsupdates 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
addTags
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,
AddTagsupdates the tag's value.
This is a convenience which creates an instance of the
AddTagsRequest.Builderavoiding the need to create one manually viaAddTagsRequest.builder()- Parameters:
addTagsRequest- AConsumerthat will call methods onAddTagsRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
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 newBatchPrediction, and uses anMLModeland the data files referenced by theDataSourceas information sources.CreateBatchPredictionis an asynchronous operation. In response toCreateBatchPrediction, Amazon Machine Learning (Amazon ML) immediately returns and sets theBatchPredictionstatus toPENDING. After theBatchPredictioncompletes, Amazon ML sets the status toCOMPLETED.You can poll for status updates by using the GetBatchPrediction operation and checking the
Statusparameter of the result. After theCOMPLETEDstatus appears, the results are available in the location specified by theOutputUriparameter.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
createBatchPrediction
default CompletableFuture<CreateBatchPredictionResponse> createBatchPrediction(Consumer<CreateBatchPredictionRequest.Builder> 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 newBatchPrediction, and uses anMLModeland the data files referenced by theDataSourceas information sources.CreateBatchPredictionis an asynchronous operation. In response toCreateBatchPrediction, Amazon Machine Learning (Amazon ML) immediately returns and sets theBatchPredictionstatus toPENDING. After theBatchPredictioncompletes, Amazon ML sets the status toCOMPLETED.You can poll for status updates by using the GetBatchPrediction operation and checking the
Statusparameter of the result. After theCOMPLETEDstatus appears, the results are available in the location specified by theOutputUriparameter.
This is a convenience which creates an instance of the
CreateBatchPredictionRequest.Builderavoiding the need to create one manually viaCreateBatchPredictionRequest.builder()- Parameters:
createBatchPredictionRequest- AConsumerthat will call methods onCreateBatchPredictionRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
createDataSourceFromRDS
default CompletableFuture<CreateDataSourceFromRdsResponse> createDataSourceFromRDS(CreateDataSourceFromRdsRequest createDataSourceFromRdsRequest) Creates a
DataSourceobject from an Amazon Relational Database Service (Amazon RDS). ADataSourcereferences data that can be used to performCreateMLModel,CreateEvaluation, orCreateBatchPredictionoperations.CreateDataSourceFromRDSis an asynchronous operation. In response toCreateDataSourceFromRDS, Amazon Machine Learning (Amazon ML) immediately returns and sets theDataSourcestatus toPENDING. After theDataSourceis created and ready for use, Amazon ML sets theStatusparameter toCOMPLETED.DataSourcein theCOMPLETEDorPENDINGstate can be used only to perform>CreateMLModel>,CreateEvaluation, orCreateBatchPredictionoperations.If Amazon ML cannot accept the input source, it sets the
Statusparameter toFAILEDand includes an error message in theMessageattribute of theGetDataSourceoperation 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
createDataSourceFromRDS
default CompletableFuture<CreateDataSourceFromRdsResponse> createDataSourceFromRDS(Consumer<CreateDataSourceFromRdsRequest.Builder> createDataSourceFromRdsRequest) Creates a
DataSourceobject from an Amazon Relational Database Service (Amazon RDS). ADataSourcereferences data that can be used to performCreateMLModel,CreateEvaluation, orCreateBatchPredictionoperations.CreateDataSourceFromRDSis an asynchronous operation. In response toCreateDataSourceFromRDS, Amazon Machine Learning (Amazon ML) immediately returns and sets theDataSourcestatus toPENDING. After theDataSourceis created and ready for use, Amazon ML sets theStatusparameter toCOMPLETED.DataSourcein theCOMPLETEDorPENDINGstate can be used only to perform>CreateMLModel>,CreateEvaluation, orCreateBatchPredictionoperations.If Amazon ML cannot accept the input source, it sets the
Statusparameter toFAILEDand includes an error message in theMessageattribute of theGetDataSourceoperation response.
This is a convenience which creates an instance of the
CreateDataSourceFromRdsRequest.Builderavoiding the need to create one manually viaCreateDataSourceFromRdsRequest.builder()- Parameters:
createDataSourceFromRdsRequest- AConsumerthat will call methods onCreateDataSourceFromRdsRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
createDataSourceFromRedshift
default CompletableFuture<CreateDataSourceFromRedshiftResponse> createDataSourceFromRedshift(CreateDataSourceFromRedshiftRequest createDataSourceFromRedshiftRequest) Creates a
DataSourcefrom a database hosted on an Amazon Redshift cluster. ADataSourcereferences data that can be used to perform eitherCreateMLModel,CreateEvaluation, orCreateBatchPredictionoperations.CreateDataSourceFromRedshiftis an asynchronous operation. In response toCreateDataSourceFromRedshift, Amazon Machine Learning (Amazon ML) immediately returns and sets theDataSourcestatus toPENDING. After theDataSourceis created and ready for use, Amazon ML sets theStatusparameter toCOMPLETED.DataSourceinCOMPLETEDorPENDINGstates can be used to perform onlyCreateMLModel,CreateEvaluation, orCreateBatchPredictionoperations.If Amazon ML can't accept the input source, it sets the
Statusparameter toFAILEDand includes an error message in theMessageattribute of theGetDataSourceoperation response.The observations should be contained in the database hosted on an Amazon Redshift cluster and should be specified by a
SelectSqlQueryquery. Amazon ML executes anUnloadcommand in Amazon Redshift to transfer the result set of theSelectSqlQueryquery toS3StagingLocation.After the
DataSourcehas been created, it's ready for use in evaluations and batch predictions. If you plan to use theDataSourceto train anMLModel, theDataSourcealso requires a recipe. A recipe describes how each input variable will be used in training anMLModel. 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
GetDataSourcefor an existing datasource and copy the values to aCreateDataSourcecall. 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
createDataSourceFromRedshift
default CompletableFuture<CreateDataSourceFromRedshiftResponse> createDataSourceFromRedshift(Consumer<CreateDataSourceFromRedshiftRequest.Builder> createDataSourceFromRedshiftRequest) Creates a
DataSourcefrom a database hosted on an Amazon Redshift cluster. ADataSourcereferences data that can be used to perform eitherCreateMLModel,CreateEvaluation, orCreateBatchPredictionoperations.CreateDataSourceFromRedshiftis an asynchronous operation. In response toCreateDataSourceFromRedshift, Amazon Machine Learning (Amazon ML) immediately returns and sets theDataSourcestatus toPENDING. After theDataSourceis created and ready for use, Amazon ML sets theStatusparameter toCOMPLETED.DataSourceinCOMPLETEDorPENDINGstates can be used to perform onlyCreateMLModel,CreateEvaluation, orCreateBatchPredictionoperations.If Amazon ML can't accept the input source, it sets the
Statusparameter toFAILEDand includes an error message in theMessageattribute of theGetDataSourceoperation response.The observations should be contained in the database hosted on an Amazon Redshift cluster and should be specified by a
SelectSqlQueryquery. Amazon ML executes anUnloadcommand in Amazon Redshift to transfer the result set of theSelectSqlQueryquery toS3StagingLocation.After the
DataSourcehas been created, it's ready for use in evaluations and batch predictions. If you plan to use theDataSourceto train anMLModel, theDataSourcealso requires a recipe. A recipe describes how each input variable will be used in training anMLModel. 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
GetDataSourcefor an existing datasource and copy the values to aCreateDataSourcecall. Change the settings that you want to change and make sure that all required fields have the appropriate values.
This is a convenience which creates an instance of the
CreateDataSourceFromRedshiftRequest.Builderavoiding the need to create one manually viaCreateDataSourceFromRedshiftRequest.builder()- Parameters:
createDataSourceFromRedshiftRequest- AConsumerthat will call methods onCreateDataSourceFromRedshiftRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
createDataSourceFromS3
default CompletableFuture<CreateDataSourceFromS3Response> createDataSourceFromS3(CreateDataSourceFromS3Request createDataSourceFromS3Request) Creates a
DataSourceobject. ADataSourcereferences data that can be used to performCreateMLModel,CreateEvaluation, orCreateBatchPredictionoperations.CreateDataSourceFromS3is an asynchronous operation. In response toCreateDataSourceFromS3, Amazon Machine Learning (Amazon ML) immediately returns and sets theDataSourcestatus toPENDING. After theDataSourcehas been created and is ready for use, Amazon ML sets theStatusparameter toCOMPLETED.DataSourcein theCOMPLETEDorPENDINGstate can be used to perform onlyCreateMLModel,CreateEvaluationorCreateBatchPredictionoperations.If Amazon ML can't accept the input source, it sets the
Statusparameter toFAILEDand includes an error message in theMessageattribute of theGetDataSourceoperation response.The observation data used in a
DataSourceshould 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 theDataSource.After the
DataSourcehas been created, it's ready to use in evaluations and batch predictions. If you plan to use theDataSourceto train anMLModel, theDataSourcealso needs a recipe. A recipe describes how each input variable will be used in training anMLModel. 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
createDataSourceFromS3
default CompletableFuture<CreateDataSourceFromS3Response> createDataSourceFromS3(Consumer<CreateDataSourceFromS3Request.Builder> createDataSourceFromS3Request) Creates a
DataSourceobject. ADataSourcereferences data that can be used to performCreateMLModel,CreateEvaluation, orCreateBatchPredictionoperations.CreateDataSourceFromS3is an asynchronous operation. In response toCreateDataSourceFromS3, Amazon Machine Learning (Amazon ML) immediately returns and sets theDataSourcestatus toPENDING. After theDataSourcehas been created and is ready for use, Amazon ML sets theStatusparameter toCOMPLETED.DataSourcein theCOMPLETEDorPENDINGstate can be used to perform onlyCreateMLModel,CreateEvaluationorCreateBatchPredictionoperations.If Amazon ML can't accept the input source, it sets the
Statusparameter toFAILEDand includes an error message in theMessageattribute of theGetDataSourceoperation response.The observation data used in a
DataSourceshould 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 theDataSource.After the
DataSourcehas been created, it's ready to use in evaluations and batch predictions. If you plan to use theDataSourceto train anMLModel, theDataSourcealso needs a recipe. A recipe describes how each input variable will be used in training anMLModel. 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.
This is a convenience which creates an instance of the
CreateDataSourceFromS3Request.Builderavoiding the need to create one manually viaCreateDataSourceFromS3Request.builder()- Parameters:
createDataSourceFromS3Request- AConsumerthat will call methods onCreateDataSourceFromS3Request.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
createEvaluation
default CompletableFuture<CreateEvaluationResponse> createEvaluation(CreateEvaluationRequest createEvaluationRequest) Creates a new
Evaluationof anMLModel. AnMLModelis evaluated on a set of observations associated to aDataSource. Like aDataSourcefor anMLModel, theDataSourcefor anEvaluationcontains values for theTarget Variable. TheEvaluationcompares the predicted result for each observation to the actual outcome and provides a summary so that you know how effective theMLModelfunctions on the test data. Evaluation generates a relevant performance metric, such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the correspondingMLModelType:BINARY,REGRESSIONorMULTICLASS.CreateEvaluationis an asynchronous operation. In response toCreateEvaluation, Amazon Machine Learning (Amazon ML) immediately returns and sets the evaluation status toPENDING. After theEvaluationis created and ready for use, Amazon ML sets the status toCOMPLETED.You can use the
GetEvaluationoperation 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
createEvaluation
default CompletableFuture<CreateEvaluationResponse> createEvaluation(Consumer<CreateEvaluationRequest.Builder> createEvaluationRequest) Creates a new
Evaluationof anMLModel. AnMLModelis evaluated on a set of observations associated to aDataSource. Like aDataSourcefor anMLModel, theDataSourcefor anEvaluationcontains values for theTarget Variable. TheEvaluationcompares the predicted result for each observation to the actual outcome and provides a summary so that you know how effective theMLModelfunctions on the test data. Evaluation generates a relevant performance metric, such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the correspondingMLModelType:BINARY,REGRESSIONorMULTICLASS.CreateEvaluationis an asynchronous operation. In response toCreateEvaluation, Amazon Machine Learning (Amazon ML) immediately returns and sets the evaluation status toPENDING. After theEvaluationis created and ready for use, Amazon ML sets the status toCOMPLETED.You can use the
GetEvaluationoperation to check progress of the evaluation during the creation operation.
This is a convenience which creates an instance of the
CreateEvaluationRequest.Builderavoiding the need to create one manually viaCreateEvaluationRequest.builder()- Parameters:
createEvaluationRequest- AConsumerthat will call methods onCreateEvaluationRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
createMLModel
default CompletableFuture<CreateMlModelResponse> createMLModel(CreateMlModelRequest createMlModelRequest) Creates a new
MLModelusing theDataSourceand the recipe as information sources.An
MLModelis nearly immutable. Users can update only theMLModelNameand theScoreThresholdin anMLModelwithout creating a newMLModel.CreateMLModelis an asynchronous operation. In response toCreateMLModel, Amazon Machine Learning (Amazon ML) immediately returns and sets theMLModelstatus toPENDING. After theMLModelhas been created and ready is for use, Amazon ML sets the status toCOMPLETED.You can use the
GetMLModeloperation to check the progress of theMLModelduring the creation operation.CreateMLModelrequires aDataSourcewith computed statistics, which can be created by settingComputeStatisticstotrueinCreateDataSourceFromRDS,CreateDataSourceFromS3, orCreateDataSourceFromRedshiftoperations.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
createMLModel
default CompletableFuture<CreateMlModelResponse> createMLModel(Consumer<CreateMlModelRequest.Builder> createMlModelRequest) Creates a new
MLModelusing theDataSourceand the recipe as information sources.An
MLModelis nearly immutable. Users can update only theMLModelNameand theScoreThresholdin anMLModelwithout creating a newMLModel.CreateMLModelis an asynchronous operation. In response toCreateMLModel, Amazon Machine Learning (Amazon ML) immediately returns and sets theMLModelstatus toPENDING. After theMLModelhas been created and ready is for use, Amazon ML sets the status toCOMPLETED.You can use the
GetMLModeloperation to check the progress of theMLModelduring the creation operation.CreateMLModelrequires aDataSourcewith computed statistics, which can be created by settingComputeStatisticstotrueinCreateDataSourceFromRDS,CreateDataSourceFromS3, orCreateDataSourceFromRedshiftoperations.
This is a convenience which creates an instance of the
CreateMlModelRequest.Builderavoiding the need to create one manually viaCreateMlModelRequest.builder()- Parameters:
createMlModelRequest- AConsumerthat will call methods onCreateMlModelRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
createRealtimeEndpoint
default CompletableFuture<CreateRealtimeEndpointResponse> createRealtimeEndpoint(CreateRealtimeEndpointRequest createRealtimeEndpointRequest) Creates a real-time endpoint for the
MLModel. The endpoint contains the URI of theMLModel; that is, the location to send real-time prediction requests for the specifiedMLModel.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
createRealtimeEndpoint
default CompletableFuture<CreateRealtimeEndpointResponse> createRealtimeEndpoint(Consumer<CreateRealtimeEndpointRequest.Builder> createRealtimeEndpointRequest) Creates a real-time endpoint for the
MLModel. The endpoint contains the URI of theMLModel; that is, the location to send real-time prediction requests for the specifiedMLModel.
This is a convenience which creates an instance of the
CreateRealtimeEndpointRequest.Builderavoiding the need to create one manually viaCreateRealtimeEndpointRequest.builder()- Parameters:
createRealtimeEndpointRequest- AConsumerthat will call methods onCreateRealtimeEndpointRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
deleteBatchPrediction
default CompletableFuture<DeleteBatchPredictionResponse> deleteBatchPrediction(DeleteBatchPredictionRequest deleteBatchPredictionRequest) Assigns the DELETED status to a
BatchPrediction, rendering it unusable.After using the
DeleteBatchPredictionoperation, you can use the GetBatchPrediction operation to verify that the status of theBatchPredictionchanged to DELETED.Caution: The result of the
DeleteBatchPredictionoperation 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
deleteBatchPrediction
default CompletableFuture<DeleteBatchPredictionResponse> deleteBatchPrediction(Consumer<DeleteBatchPredictionRequest.Builder> deleteBatchPredictionRequest) Assigns the DELETED status to a
BatchPrediction, rendering it unusable.After using the
DeleteBatchPredictionoperation, you can use the GetBatchPrediction operation to verify that the status of theBatchPredictionchanged to DELETED.Caution: The result of the
DeleteBatchPredictionoperation is irreversible.
This is a convenience which creates an instance of the
DeleteBatchPredictionRequest.Builderavoiding the need to create one manually viaDeleteBatchPredictionRequest.builder()- Parameters:
deleteBatchPredictionRequest- AConsumerthat will call methods onDeleteBatchPredictionRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
deleteDataSource
default CompletableFuture<DeleteDataSourceResponse> deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) Assigns the DELETED status to a
DataSource, rendering it unusable.After using the
DeleteDataSourceoperation, you can use the GetDataSource operation to verify that the status of theDataSourcechanged to DELETED.Caution: The results of the
DeleteDataSourceoperation 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
deleteDataSource
default CompletableFuture<DeleteDataSourceResponse> deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest) Assigns the DELETED status to a
DataSource, rendering it unusable.After using the
DeleteDataSourceoperation, you can use the GetDataSource operation to verify that the status of theDataSourcechanged to DELETED.Caution: The results of the
DeleteDataSourceoperation are irreversible.
This is a convenience which creates an instance of the
DeleteDataSourceRequest.Builderavoiding the need to create one manually viaDeleteDataSourceRequest.builder()- Parameters:
deleteDataSourceRequest- AConsumerthat will call methods onDeleteDataSourceRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
deleteEvaluation
default CompletableFuture<DeleteEvaluationResponse> deleteEvaluation(DeleteEvaluationRequest deleteEvaluationRequest) Assigns the
DELETEDstatus to anEvaluation, rendering it unusable.After invoking the
DeleteEvaluationoperation, you can use theGetEvaluationoperation to verify that the status of theEvaluationchanged toDELETED.Caution: The results of the
DeleteEvaluationoperation 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
deleteEvaluation
default CompletableFuture<DeleteEvaluationResponse> deleteEvaluation(Consumer<DeleteEvaluationRequest.Builder> deleteEvaluationRequest) Assigns the
DELETEDstatus to anEvaluation, rendering it unusable.After invoking the
DeleteEvaluationoperation, you can use theGetEvaluationoperation to verify that the status of theEvaluationchanged toDELETED.Caution: The results of the
DeleteEvaluationoperation are irreversible.
This is a convenience which creates an instance of the
DeleteEvaluationRequest.Builderavoiding the need to create one manually viaDeleteEvaluationRequest.builder()- Parameters:
deleteEvaluationRequest- AConsumerthat will call methods onDeleteEvaluationRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
deleteMLModel
default CompletableFuture<DeleteMlModelResponse> deleteMLModel(DeleteMlModelRequest deleteMlModelRequest) Assigns the
DELETEDstatus to anMLModel, rendering it unusable.After using the
DeleteMLModeloperation, you can use theGetMLModeloperation to verify that the status of theMLModelchanged to DELETED.Caution: The result of the
DeleteMLModeloperation 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
deleteMLModel
default CompletableFuture<DeleteMlModelResponse> deleteMLModel(Consumer<DeleteMlModelRequest.Builder> deleteMlModelRequest) Assigns the
DELETEDstatus to anMLModel, rendering it unusable.After using the
DeleteMLModeloperation, you can use theGetMLModeloperation to verify that the status of theMLModelchanged to DELETED.Caution: The result of the
DeleteMLModeloperation is irreversible.
This is a convenience which creates an instance of the
DeleteMlModelRequest.Builderavoiding the need to create one manually viaDeleteMlModelRequest.builder()- Parameters:
deleteMlModelRequest- AConsumerthat will call methods onDeleteMlModelRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
deleteRealtimeEndpoint
default CompletableFuture<DeleteRealtimeEndpointResponse> deleteRealtimeEndpoint(Consumer<DeleteRealtimeEndpointRequest.Builder> deleteRealtimeEndpointRequest) Deletes a real time endpoint of an
MLModel.
This is a convenience which creates an instance of the
DeleteRealtimeEndpointRequest.Builderavoiding the need to create one manually viaDeleteRealtimeEndpointRequest.builder()- Parameters:
deleteRealtimeEndpointRequest- AConsumerthat will call methods onDeleteRealtimeEndpointRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
deleteTags
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
deleteTags
default CompletableFuture<DeleteTagsResponse> deleteTags(Consumer<DeleteTagsRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteTagsRequest.Builderavoiding the need to create one manually viaDeleteTagsRequest.builder()- Parameters:
deleteTagsRequest- AConsumerthat will call methods onDeleteTagsRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeBatchPredictions
default CompletableFuture<DescribeBatchPredictionsResponse> describeBatchPredictions(DescribeBatchPredictionsRequest describeBatchPredictionsRequest) Returns a list of
BatchPredictionoperations 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeBatchPredictions
default CompletableFuture<DescribeBatchPredictionsResponse> describeBatchPredictions(Consumer<DescribeBatchPredictionsRequest.Builder> describeBatchPredictionsRequest) Returns a list of
BatchPredictionoperations that match the search criteria in the request.
This is a convenience which creates an instance of the
DescribeBatchPredictionsRequest.Builderavoiding the need to create one manually viaDescribeBatchPredictionsRequest.builder()- Parameters:
describeBatchPredictionsRequest- AConsumerthat will call methods onDescribeBatchPredictionsRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeBatchPredictions
Returns a list of
BatchPredictionoperations that match the search criteria in the request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeBatchPredictionsPaginator
This is a variant of
describeBatchPredictions(software.amazon.awssdk.services.machinelearning.model.DescribeBatchPredictionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.machinelearning.paginators.DescribeBatchPredictionsPublisher publisher = client.describeBatchPredictionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.machinelearning.paginators.DescribeBatchPredictionsPublisher publisher = client.describeBatchPredictionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.machinelearning.model.DescribeBatchPredictionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.machinelearning.model.DescribeBatchPredictionsResponse response) { //... }; });Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBatchPredictions(software.amazon.awssdk.services.machinelearning.model.DescribeBatchPredictionsRequest)operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeBatchPredictionsPaginator
default DescribeBatchPredictionsPublisher describeBatchPredictionsPaginator(DescribeBatchPredictionsRequest describeBatchPredictionsRequest) This is a variant of
describeBatchPredictions(software.amazon.awssdk.services.machinelearning.model.DescribeBatchPredictionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.machinelearning.paginators.DescribeBatchPredictionsPublisher publisher = client.describeBatchPredictionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.machinelearning.paginators.DescribeBatchPredictionsPublisher publisher = client.describeBatchPredictionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.machinelearning.model.DescribeBatchPredictionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.machinelearning.model.DescribeBatchPredictionsResponse response) { //... }; });Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBatchPredictions(software.amazon.awssdk.services.machinelearning.model.DescribeBatchPredictionsRequest)operation.- Parameters:
describeBatchPredictionsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeBatchPredictionsPaginator
default DescribeBatchPredictionsPublisher describeBatchPredictionsPaginator(Consumer<DescribeBatchPredictionsRequest.Builder> describeBatchPredictionsRequest) This is a variant of
describeBatchPredictions(software.amazon.awssdk.services.machinelearning.model.DescribeBatchPredictionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.machinelearning.paginators.DescribeBatchPredictionsPublisher publisher = client.describeBatchPredictionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.machinelearning.paginators.DescribeBatchPredictionsPublisher publisher = client.describeBatchPredictionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.machinelearning.model.DescribeBatchPredictionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.machinelearning.model.DescribeBatchPredictionsResponse response) { //... }; });Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBatchPredictions(software.amazon.awssdk.services.machinelearning.model.DescribeBatchPredictionsRequest)operation.
This is a convenience which creates an instance of the
DescribeBatchPredictionsRequest.Builderavoiding the need to create one manually viaDescribeBatchPredictionsRequest.builder()- Parameters:
describeBatchPredictionsRequest- AConsumerthat will call methods onDescribeBatchPredictionsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeDataSources
default CompletableFuture<DescribeDataSourcesResponse> describeDataSources(DescribeDataSourcesRequest describeDataSourcesRequest) Returns a list of
DataSourcethat 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeDataSources
default CompletableFuture<DescribeDataSourcesResponse> describeDataSources(Consumer<DescribeDataSourcesRequest.Builder> describeDataSourcesRequest) Returns a list of
DataSourcethat match the search criteria in the request.
This is a convenience which creates an instance of the
DescribeDataSourcesRequest.Builderavoiding the need to create one manually viaDescribeDataSourcesRequest.builder()- Parameters:
describeDataSourcesRequest- AConsumerthat will call methods onDescribeDataSourcesRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeDataSources
Returns a list of
DataSourcethat match the search criteria in the request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeDataSourcesPaginator
This is a variant of
describeDataSources(software.amazon.awssdk.services.machinelearning.model.DescribeDataSourcesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.machinelearning.paginators.DescribeDataSourcesPublisher publisher = client.describeDataSourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.machinelearning.paginators.DescribeDataSourcesPublisher publisher = client.describeDataSourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.machinelearning.model.DescribeDataSourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.machinelearning.model.DescribeDataSourcesResponse response) { //... }; });Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDataSources(software.amazon.awssdk.services.machinelearning.model.DescribeDataSourcesRequest)operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeDataSourcesPaginator
default DescribeDataSourcesPublisher describeDataSourcesPaginator(DescribeDataSourcesRequest describeDataSourcesRequest) This is a variant of
describeDataSources(software.amazon.awssdk.services.machinelearning.model.DescribeDataSourcesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.machinelearning.paginators.DescribeDataSourcesPublisher publisher = client.describeDataSourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.machinelearning.paginators.DescribeDataSourcesPublisher publisher = client.describeDataSourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.machinelearning.model.DescribeDataSourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.machinelearning.model.DescribeDataSourcesResponse response) { //... }; });Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDataSources(software.amazon.awssdk.services.machinelearning.model.DescribeDataSourcesRequest)operation.- Parameters:
describeDataSourcesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeDataSourcesPaginator
default DescribeDataSourcesPublisher describeDataSourcesPaginator(Consumer<DescribeDataSourcesRequest.Builder> describeDataSourcesRequest) This is a variant of
describeDataSources(software.amazon.awssdk.services.machinelearning.model.DescribeDataSourcesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.machinelearning.paginators.DescribeDataSourcesPublisher publisher = client.describeDataSourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.machinelearning.paginators.DescribeDataSourcesPublisher publisher = client.describeDataSourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.machinelearning.model.DescribeDataSourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.machinelearning.model.DescribeDataSourcesResponse response) { //... }; });Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDataSources(software.amazon.awssdk.services.machinelearning.model.DescribeDataSourcesRequest)operation.
This is a convenience which creates an instance of the
DescribeDataSourcesRequest.Builderavoiding the need to create one manually viaDescribeDataSourcesRequest.builder()- Parameters:
describeDataSourcesRequest- AConsumerthat will call methods onDescribeDataSourcesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeEvaluations
default CompletableFuture<DescribeEvaluationsResponse> describeEvaluations(DescribeEvaluationsRequest describeEvaluationsRequest) Returns a list of
DescribeEvaluationsthat 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeEvaluations
default CompletableFuture<DescribeEvaluationsResponse> describeEvaluations(Consumer<DescribeEvaluationsRequest.Builder> describeEvaluationsRequest) Returns a list of
DescribeEvaluationsthat match the search criteria in the request.
This is a convenience which creates an instance of the
DescribeEvaluationsRequest.Builderavoiding the need to create one manually viaDescribeEvaluationsRequest.builder()- Parameters:
describeEvaluationsRequest- AConsumerthat will call methods onDescribeEvaluationsRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeEvaluations
Returns a list of
DescribeEvaluationsthat match the search criteria in the request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeEvaluationsPaginator
This is a variant of
describeEvaluations(software.amazon.awssdk.services.machinelearning.model.DescribeEvaluationsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.machinelearning.paginators.DescribeEvaluationsPublisher publisher = client.describeEvaluationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.machinelearning.paginators.DescribeEvaluationsPublisher publisher = client.describeEvaluationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.machinelearning.model.DescribeEvaluationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.machinelearning.model.DescribeEvaluationsResponse response) { //... }; });Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvaluations(software.amazon.awssdk.services.machinelearning.model.DescribeEvaluationsRequest)operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeEvaluationsPaginator
default DescribeEvaluationsPublisher describeEvaluationsPaginator(DescribeEvaluationsRequest describeEvaluationsRequest) This is a variant of
describeEvaluations(software.amazon.awssdk.services.machinelearning.model.DescribeEvaluationsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.machinelearning.paginators.DescribeEvaluationsPublisher publisher = client.describeEvaluationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.machinelearning.paginators.DescribeEvaluationsPublisher publisher = client.describeEvaluationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.machinelearning.model.DescribeEvaluationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.machinelearning.model.DescribeEvaluationsResponse response) { //... }; });Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvaluations(software.amazon.awssdk.services.machinelearning.model.DescribeEvaluationsRequest)operation.- Parameters:
describeEvaluationsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeEvaluationsPaginator
default DescribeEvaluationsPublisher describeEvaluationsPaginator(Consumer<DescribeEvaluationsRequest.Builder> describeEvaluationsRequest) This is a variant of
describeEvaluations(software.amazon.awssdk.services.machinelearning.model.DescribeEvaluationsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.machinelearning.paginators.DescribeEvaluationsPublisher publisher = client.describeEvaluationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.machinelearning.paginators.DescribeEvaluationsPublisher publisher = client.describeEvaluationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.machinelearning.model.DescribeEvaluationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.machinelearning.model.DescribeEvaluationsResponse response) { //... }; });Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvaluations(software.amazon.awssdk.services.machinelearning.model.DescribeEvaluationsRequest)operation.
This is a convenience which creates an instance of the
DescribeEvaluationsRequest.Builderavoiding the need to create one manually viaDescribeEvaluationsRequest.builder()- Parameters:
describeEvaluationsRequest- AConsumerthat will call methods onDescribeEvaluationsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeMLModels
default CompletableFuture<DescribeMlModelsResponse> describeMLModels(DescribeMlModelsRequest describeMlModelsRequest) Returns a list of
MLModelthat 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeMLModels
default CompletableFuture<DescribeMlModelsResponse> describeMLModels(Consumer<DescribeMlModelsRequest.Builder> describeMlModelsRequest) Returns a list of
MLModelthat match the search criteria in the request.
This is a convenience which creates an instance of the
DescribeMlModelsRequest.Builderavoiding the need to create one manually viaDescribeMlModelsRequest.builder()- Parameters:
describeMlModelsRequest- AConsumerthat will call methods onDescribeMlModelsRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeMLModels
Returns a list of
MLModelthat match the search criteria in the request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeMLModelsPaginator
This is a variant of
describeMLModels(software.amazon.awssdk.services.machinelearning.model.DescribeMlModelsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.machinelearning.paginators.DescribeMLModelsPublisher publisher = client.describeMLModelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.machinelearning.paginators.DescribeMLModelsPublisher publisher = client.describeMLModelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.machinelearning.model.DescribeMlModelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.machinelearning.model.DescribeMlModelsResponse response) { //... }; });Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMLModels(software.amazon.awssdk.services.machinelearning.model.DescribeMlModelsRequest)operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeMLModelsPaginator
default DescribeMLModelsPublisher describeMLModelsPaginator(DescribeMlModelsRequest describeMlModelsRequest) This is a variant of
describeMLModels(software.amazon.awssdk.services.machinelearning.model.DescribeMlModelsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.machinelearning.paginators.DescribeMLModelsPublisher publisher = client.describeMLModelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.machinelearning.paginators.DescribeMLModelsPublisher publisher = client.describeMLModelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.machinelearning.model.DescribeMlModelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.machinelearning.model.DescribeMlModelsResponse response) { //... }; });Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMLModels(software.amazon.awssdk.services.machinelearning.model.DescribeMlModelsRequest)operation.- Parameters:
describeMlModelsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeMLModelsPaginator
default DescribeMLModelsPublisher describeMLModelsPaginator(Consumer<DescribeMlModelsRequest.Builder> describeMlModelsRequest) This is a variant of
describeMLModels(software.amazon.awssdk.services.machinelearning.model.DescribeMlModelsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.machinelearning.paginators.DescribeMLModelsPublisher publisher = client.describeMLModelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.machinelearning.paginators.DescribeMLModelsPublisher publisher = client.describeMLModelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.machinelearning.model.DescribeMlModelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.machinelearning.model.DescribeMlModelsResponse response) { //... }; });Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMLModels(software.amazon.awssdk.services.machinelearning.model.DescribeMlModelsRequest)operation.
This is a convenience which creates an instance of the
DescribeMlModelsRequest.Builderavoiding the need to create one manually viaDescribeMlModelsRequest.builder()- Parameters:
describeMlModelsRequest- AConsumerthat will call methods onDescribeMlModelsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
describeTags
default CompletableFuture<DescribeTagsResponse> describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) Describes one or more of the tags for your Amazon ML object.
This is a convenience which creates an instance of the
DescribeTagsRequest.Builderavoiding the need to create one manually viaDescribeTagsRequest.builder()- Parameters:
describeTagsRequest- AConsumerthat will call methods onDescribeTagsRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
getBatchPrediction
default CompletableFuture<GetBatchPredictionResponse> getBatchPrediction(GetBatchPredictionRequest getBatchPredictionRequest) Returns a
BatchPredictionthat includes detailed metadata, status, and data file information for aBatch Predictionrequest.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
getBatchPrediction
default CompletableFuture<GetBatchPredictionResponse> getBatchPrediction(Consumer<GetBatchPredictionRequest.Builder> getBatchPredictionRequest) Returns a
BatchPredictionthat includes detailed metadata, status, and data file information for aBatch Predictionrequest.
This is a convenience which creates an instance of the
GetBatchPredictionRequest.Builderavoiding the need to create one manually viaGetBatchPredictionRequest.builder()- Parameters:
getBatchPredictionRequest- AConsumerthat will call methods onGetBatchPredictionRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
getDataSource
default CompletableFuture<GetDataSourceResponse> getDataSource(GetDataSourceRequest getDataSourceRequest) Returns a
DataSourcethat includes metadata and data file information, as well as the current status of theDataSource.GetDataSourceprovides 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
getDataSource
default CompletableFuture<GetDataSourceResponse> getDataSource(Consumer<GetDataSourceRequest.Builder> getDataSourceRequest) Returns a
DataSourcethat includes metadata and data file information, as well as the current status of theDataSource.GetDataSourceprovides 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.
This is a convenience which creates an instance of the
GetDataSourceRequest.Builderavoiding the need to create one manually viaGetDataSourceRequest.builder()- Parameters:
getDataSourceRequest- AConsumerthat will call methods onGetDataSourceRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
getEvaluation
default CompletableFuture<GetEvaluationResponse> getEvaluation(GetEvaluationRequest getEvaluationRequest) Returns an
Evaluationthat includes metadata as well as the current status of theEvaluation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
getEvaluation
default CompletableFuture<GetEvaluationResponse> getEvaluation(Consumer<GetEvaluationRequest.Builder> getEvaluationRequest) Returns an
Evaluationthat includes metadata as well as the current status of theEvaluation.
This is a convenience which creates an instance of the
GetEvaluationRequest.Builderavoiding the need to create one manually viaGetEvaluationRequest.builder()- Parameters:
getEvaluationRequest- AConsumerthat will call methods onGetEvaluationRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
getMLModel
Returns an
MLModelthat includes detailed metadata, data source information, and the current status of theMLModel.GetMLModelprovides 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
getMLModel
default CompletableFuture<GetMlModelResponse> getMLModel(Consumer<GetMlModelRequest.Builder> getMlModelRequest) Returns an
MLModelthat includes detailed metadata, data source information, and the current status of theMLModel.GetMLModelprovides results in normal or verbose format.
This is a convenience which creates an instance of the
GetMlModelRequest.Builderavoiding the need to create one manually viaGetMlModelRequest.builder()- Parameters:
getMlModelRequest- AConsumerthat will call methods onGetMlModelRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
predict
Generates a prediction for the observation using the specified
ML Model.Note: 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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. - SdkException 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 type.
-
predict
Generates a prediction for the observation using the specified
ML Model.Note: Not all response parameters will be populated. Whether a response parameter is populated depends on the type of model requested.
This is a convenience which creates an instance of the
PredictRequest.Builderavoiding the need to create one manually viaPredictRequest.builder()- Parameters:
predictRequest- AConsumerthat will call methods onPredictRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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. - SdkException 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 type.
-
updateBatchPrediction
default CompletableFuture<UpdateBatchPredictionResponse> updateBatchPrediction(UpdateBatchPredictionRequest updateBatchPredictionRequest) Updates the
BatchPredictionNameof aBatchPrediction.You can use the
GetBatchPredictionoperation 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
updateBatchPrediction
default CompletableFuture<UpdateBatchPredictionResponse> updateBatchPrediction(Consumer<UpdateBatchPredictionRequest.Builder> updateBatchPredictionRequest) Updates the
BatchPredictionNameof aBatchPrediction.You can use the
GetBatchPredictionoperation to view the contents of the updated data element.
This is a convenience which creates an instance of the
UpdateBatchPredictionRequest.Builderavoiding the need to create one manually viaUpdateBatchPredictionRequest.builder()- Parameters:
updateBatchPredictionRequest- AConsumerthat will call methods onUpdateBatchPredictionRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
updateDataSource
default CompletableFuture<UpdateDataSourceResponse> updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) Updates the
DataSourceNameof aDataSource.You can use the
GetDataSourceoperation 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
updateDataSource
default CompletableFuture<UpdateDataSourceResponse> updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) Updates the
DataSourceNameof aDataSource.You can use the
GetDataSourceoperation to view the contents of the updated data element.
This is a convenience which creates an instance of the
UpdateDataSourceRequest.Builderavoiding the need to create one manually viaUpdateDataSourceRequest.builder()- Parameters:
updateDataSourceRequest- AConsumerthat will call methods onUpdateDataSourceRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
updateEvaluation
default CompletableFuture<UpdateEvaluationResponse> updateEvaluation(UpdateEvaluationRequest updateEvaluationRequest) Updates the
EvaluationNameof anEvaluation.You can use the
GetEvaluationoperation 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
updateEvaluation
default CompletableFuture<UpdateEvaluationResponse> updateEvaluation(Consumer<UpdateEvaluationRequest.Builder> updateEvaluationRequest) Updates the
EvaluationNameof anEvaluation.You can use the
GetEvaluationoperation to view the contents of the updated data element.
This is a convenience which creates an instance of the
UpdateEvaluationRequest.Builderavoiding the need to create one manually viaUpdateEvaluationRequest.builder()- Parameters:
updateEvaluationRequest- AConsumerthat will call methods onUpdateEvaluationRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
updateMLModel
default CompletableFuture<UpdateMlModelResponse> updateMLModel(UpdateMlModelRequest updateMlModelRequest) Updates the
MLModelNameand theScoreThresholdof anMLModel.You can use the
GetMLModeloperation 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
updateMLModel
default CompletableFuture<UpdateMlModelResponse> updateMLModel(Consumer<UpdateMlModelRequest.Builder> updateMlModelRequest) Updates the
MLModelNameand theScoreThresholdof anMLModel.You can use the
GetMLModeloperation to view the contents of the updated data element.
This is a convenience which creates an instance of the
UpdateMlModelRequest.Builderavoiding the need to create one manually viaUpdateMlModelRequest.builder()- Parameters:
updateMlModelRequest- AConsumerthat will call methods onUpdateMlModelRequest.Builderto create a request.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException 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 type.
-
waiter
Create an instance ofMachineLearningAsyncWaiterusing this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
MachineLearningAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aMachineLearningAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aMachineLearningAsyncClient.
-