Class AmazonMachineLearningClient
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceClient
-
- com.amazonaws.services.machinelearning.AmazonMachineLearningClient
-
- All Implemented Interfaces:
AmazonMachineLearning
- Direct Known Subclasses:
AmazonMachineLearningAsyncClient
@ThreadSafe public class AmazonMachineLearningClient extends AmazonWebServiceClient implements AmazonMachineLearning
Client for accessing Amazon Machine Learning. All service calls made using this client are blocking, and will not return until the service call completes.Definition of the public APIs exposed by Amazon Machine Learning
-
-
Field Summary
Fields Modifier and Type Field Description protected static ClientConfigurationFactoryconfigFactoryClient configuration factory providing ClientConfigurations tailored to this client-
Fields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
-
-
Constructor Summary
Constructors Constructor Description AmazonMachineLearningClient()Constructs a new client to invoke service methods on Amazon Machine Learning.AmazonMachineLearningClient(AWSCredentials awsCredentials)Constructs a new client to invoke service methods on Amazon Machine Learning using the specified AWS account credentials.AmazonMachineLearningClient(AWSCredentialsProvider awsCredentialsProvider)Constructs a new client to invoke service methods on Amazon Machine Learning using the specified AWS account credentials provider.AmazonMachineLearningClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)Constructs a new client to invoke service methods on Amazon Machine Learning using the specified AWS account credentials provider and client configuration options.AmazonMachineLearningClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)Constructs a new client to invoke service methods on Amazon Machine Learning using the specified AWS account credentials provider, client configuration options, and request metric collector.AmazonMachineLearningClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)Constructs a new client to invoke service methods on Amazon Machine Learning using the specified AWS account credentials and client configuration options.AmazonMachineLearningClient(ClientConfiguration clientConfiguration)Constructs a new client to invoke service methods on Amazon Machine Learning.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CreateBatchPredictionResultcreateBatchPrediction(CreateBatchPredictionRequest createBatchPredictionRequest)Generates predictions for a group of observations.CreateDataSourceFromRDSResultcreateDataSourceFromRDS(CreateDataSourceFromRDSRequest createDataSourceFromRDSRequest)Creates aDataSourceobject from an Amazon Relational Database Service (Amazon RDS).CreateDataSourceFromRedshiftResultcreateDataSourceFromRedshift(CreateDataSourceFromRedshiftRequest createDataSourceFromRedshiftRequest)Creates aDataSourcefrom Amazon Redshift.CreateDataSourceFromS3ResultcreateDataSourceFromS3(CreateDataSourceFromS3Request createDataSourceFromS3Request)Creates aDataSourceobject.CreateEvaluationResultcreateEvaluation(CreateEvaluationRequest createEvaluationRequest)Creates a newEvaluationof anMLModel.CreateMLModelResultcreateMLModel(CreateMLModelRequest createMLModelRequest)Creates a newMLModelusing the data files and the recipe as information sources.CreateRealtimeEndpointResultcreateRealtimeEndpoint(CreateRealtimeEndpointRequest createRealtimeEndpointRequest)Creates a real-time endpoint for theMLModel.DeleteBatchPredictionResultdeleteBatchPrediction(DeleteBatchPredictionRequest deleteBatchPredictionRequest)Assigns the DELETED status to aBatchPrediction, rendering it unusable.DeleteDataSourceResultdeleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)Assigns the DELETED status to aDataSource, rendering it unusable.DeleteEvaluationResultdeleteEvaluation(DeleteEvaluationRequest deleteEvaluationRequest)Assigns theDELETEDstatus to anEvaluation, rendering it unusable.DeleteMLModelResultdeleteMLModel(DeleteMLModelRequest deleteMLModelRequest)Assigns the DELETED status to anMLModel, rendering it unusable.DeleteRealtimeEndpointResultdeleteRealtimeEndpoint(DeleteRealtimeEndpointRequest deleteRealtimeEndpointRequest)Deletes a real time endpoint of anMLModel.DescribeBatchPredictionsResultdescribeBatchPredictions()Simplified method form for invoking the DescribeBatchPredictions operation.DescribeBatchPredictionsResultdescribeBatchPredictions(DescribeBatchPredictionsRequest describeBatchPredictionsRequest)Returns a list ofBatchPredictionoperations that match the search criteria in the request.DescribeDataSourcesResultdescribeDataSources()Simplified method form for invoking the DescribeDataSources operation.DescribeDataSourcesResultdescribeDataSources(DescribeDataSourcesRequest describeDataSourcesRequest)Returns a list ofDataSourcethat match the search criteria in the request.DescribeEvaluationsResultdescribeEvaluations()Simplified method form for invoking the DescribeEvaluations operation.DescribeEvaluationsResultdescribeEvaluations(DescribeEvaluationsRequest describeEvaluationsRequest)Returns a list ofDescribeEvaluationsthat match the search criteria in the request.DescribeMLModelsResultdescribeMLModels()Simplified method form for invoking the DescribeMLModels operation.DescribeMLModelsResultdescribeMLModels(DescribeMLModelsRequest describeMLModelsRequest)Returns a list ofMLModelthat match the search criteria in the request.GetBatchPredictionResultgetBatchPrediction(GetBatchPredictionRequest getBatchPredictionRequest)Returns aBatchPredictionthat includes detailed metadata, status, and data file information for aBatch Predictionrequest.ResponseMetadatagetCachedResponseMetadata(AmazonWebServiceRequest request)Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.GetDataSourceResultgetDataSource(GetDataSourceRequest getDataSourceRequest)Returns aDataSourcethat includes metadata and data file information, as well as the current status of theDataSource.GetEvaluationResultgetEvaluation(GetEvaluationRequest getEvaluationRequest)Returns anEvaluationthat includes metadata as well as the current status of theEvaluation.GetMLModelResultgetMLModel(GetMLModelRequest getMLModelRequest)Returns anMLModelthat includes detailed metadata, and data source information as well as the current status of theMLModel.PredictResultpredict(PredictRequest predictRequest)Generates a prediction for the observation using the specifiedML Model.UpdateBatchPredictionResultupdateBatchPrediction(UpdateBatchPredictionRequest updateBatchPredictionRequest)Updates theBatchPredictionNameof aBatchPrediction.UpdateDataSourceResultupdateDataSource(UpdateDataSourceRequest updateDataSourceRequest)Updates theDataSourceNameof aDataSource.UpdateEvaluationResultupdateEvaluation(UpdateEvaluationRequest updateEvaluationRequest)Updates theEvaluationNameof anEvaluation.UpdateMLModelResultupdateMLModel(UpdateMLModelRequest updateMLModelRequest)Updates theMLModelNameand theScoreThresholdof anMLModel.-
Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.amazonaws.services.machinelearning.AmazonMachineLearning
setEndpoint, setRegion, shutdown
-
-
-
-
Field Detail
-
configFactory
protected static final ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
-
-
Constructor Detail
-
AmazonMachineLearningClient
public AmazonMachineLearningClient()
Constructs a new client to invoke service methods on Amazon Machine Learning. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- See Also:
DefaultAWSCredentialsProviderChain
-
AmazonMachineLearningClient
public AmazonMachineLearningClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon Machine Learning. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
clientConfiguration- The client configuration options controlling how this client connects to Amazon Machine Learning (ex: proxy settings, retry counts, etc.).- See Also:
DefaultAWSCredentialsProviderChain
-
AmazonMachineLearningClient
public AmazonMachineLearningClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on Amazon Machine Learning using the specified AWS account credentials.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
-
AmazonMachineLearningClient
public AmazonMachineLearningClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon Machine Learning using the specified AWS account credentials and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration- The client configuration options controlling how this client connects to Amazon Machine Learning (ex: proxy settings, retry counts, etc.).
-
AmazonMachineLearningClient
public AmazonMachineLearningClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on Amazon Machine Learning using the specified AWS account credentials provider.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
-
AmazonMachineLearningClient
public AmazonMachineLearningClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon Machine Learning using the specified AWS account credentials provider and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration- The client configuration options controlling how this client connects to Amazon Machine Learning (ex: proxy settings, retry counts, etc.).
-
AmazonMachineLearningClient
public AmazonMachineLearningClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on Amazon Machine Learning using the specified AWS account credentials provider, client configuration options, and request metric collector.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration- The client configuration options controlling how this client connects to Amazon Machine Learning (ex: proxy settings, retry counts, etc.).requestMetricCollector- optional request metric collector
-
-
Method Detail
-
createBatchPrediction
public CreateBatchPredictionResult 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.- Specified by:
createBatchPredictionin interfaceAmazonMachineLearning- Parameters:
createBatchPredictionRequest-- Returns:
- Result of the CreateBatchPrediction operation returned by the service.
- Throws:
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.
-
createDataSourceFromRDS
public CreateDataSourceFromRDSResult createDataSourceFromRDS(CreateDataSourceFromRDSRequest createDataSourceFromRDSRequest)
Creates a
DataSourceobject from an Amazon Relational Database Service (Amazon RDS). ADataSourcereferences data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.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.DataSourceinCOMPLETEDorPENDINGstatus can only be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.If Amazon ML cannot accept the input source, it sets the
Statusparameter toFAILEDand includes an error message in theMessageattribute of the GetDataSource operation response.- Specified by:
createDataSourceFromRDSin interfaceAmazonMachineLearning- Parameters:
createDataSourceFromRDSRequest-- Returns:
- Result of the CreateDataSourceFromRDS operation returned by the service.
- Throws:
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.
-
createDataSourceFromRedshift
public CreateDataSourceFromRedshiftResult createDataSourceFromRedshift(CreateDataSourceFromRedshiftRequest createDataSourceFromRedshiftRequest)
Creates a
DataSourcefrom Amazon Redshift. ADataSourcereferences data that can be used to perform either CreateMLModel, CreateEvaluation or CreateBatchPrediction operations.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.DataSourceinCOMPLETEDorPENDINGstatus can only be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.If Amazon ML cannot accept the input source, it sets the
Statusparameter toFAILEDand includes an error message in theMessageattribute of the GetDataSource operation response.The observations should exist in the database hosted on an Amazon Redshift cluster and should be specified by a
SelectSqlQuery. Amazon ML executes Unload command in Amazon Redshift to transfer the result set ofSelectSqlQuerytoS3StagingLocation.After the
DataSourceis created, it's ready for use in evaluations and batch predictions. If you plan to use theDataSourceto train anMLModel, theDataSourcerequires another item -- a recipe. A recipe describes the observation variables that participate in training anMLModel. A recipe describes how each input variable will be used in training. Will the variable be included or excluded from training? Will the variable be manipulated, for example, combined with another variable or split apart into word combinations? The recipe provides answers to these questions. For more information, see the Amazon Machine Learning Developer Guide.- Specified by:
createDataSourceFromRedshiftin interfaceAmazonMachineLearning- Parameters:
createDataSourceFromRedshiftRequest-- Returns:
- Result of the CreateDataSourceFromRedshift operation returned by the service.
- Throws:
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.
-
createDataSourceFromS3
public CreateDataSourceFromS3Result createDataSourceFromS3(CreateDataSourceFromS3Request createDataSourceFromS3Request)
Creates a
DataSourceobject. ADataSourcereferences data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.CreateDataSourceFromS3is an asynchronous operation. In response toCreateDataSourceFromS3, Amazon Machine Learning (Amazon ML) immediately returns and sets theDataSourcestatus toPENDING. After theDataSourceis created and ready for use, Amazon ML sets theStatusparameter toCOMPLETED.DataSourceinCOMPLETEDorPENDINGstatus can only be used to perform CreateMLModel, CreateEvaluation or CreateBatchPrediction operations.If Amazon ML cannot accept the input source, it sets the
Statusparameter toFAILEDand includes an error message in theMessageattribute of the GetDataSource operation 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) bucket, 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, theDataSourcerequires another item: a recipe. A recipe describes the observation variables that participate in training anMLModel. A recipe describes how each input variable will be used in training. Will the variable be included or excluded from training? Will the variable be manipulated, for example, combined with another variable, or split apart into word combinations? The recipe provides answers to these questions. For more information, see the Amazon Machine Learning Developer Guide.- Specified by:
createDataSourceFromS3in interfaceAmazonMachineLearning- Parameters:
createDataSourceFromS3Request-- Returns:
- Result of the CreateDataSourceFromS3 operation returned by the service.
- Throws:
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.
-
createEvaluation
public CreateEvaluationResult 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 the Target 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 GetEvaluation operation to check progress of the evaluation during the creation operation.
- Specified by:
createEvaluationin interfaceAmazonMachineLearning- Parameters:
createEvaluationRequest-- Returns:
- Result of the CreateEvaluation operation returned by the service.
- Throws:
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.
-
createMLModel
public CreateMLModelResult createMLModel(CreateMLModelRequest createMLModelRequest)
Creates a new
MLModelusing the data files and the recipe as information sources.An
MLModelis nearly immutable. Users can only update 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 theMLModelis created and ready for use, Amazon ML sets the status toCOMPLETED.You can use the GetMLModel operation to check progress of the
MLModelduring the creation operation.CreateMLModel requires a
DataSourcewith computed statistics, which can be created by settingComputeStatisticstotruein CreateDataSourceFromRDS, CreateDataSourceFromS3, or CreateDataSourceFromRedshift operations.- Specified by:
createMLModelin interfaceAmazonMachineLearning- Parameters:
createMLModelRequest-- Returns:
- Result of the CreateMLModel operation returned by the service.
- Throws:
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.
-
createRealtimeEndpoint
public CreateRealtimeEndpointResult 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.- Specified by:
createRealtimeEndpointin interfaceAmazonMachineLearning- Parameters:
createRealtimeEndpointRequest-- Returns:
- Result of the CreateRealtimeEndpoint operation returned by the service.
- Throws:
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.
-
deleteBatchPrediction
public DeleteBatchPredictionResult 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.- Specified by:
deleteBatchPredictionin interfaceAmazonMachineLearning- Parameters:
deleteBatchPredictionRequest-- Returns:
- Result of the DeleteBatchPrediction operation returned by the service.
- Throws:
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.
-
deleteDataSource
public DeleteDataSourceResult 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.- Specified by:
deleteDataSourcein interfaceAmazonMachineLearning- Parameters:
deleteDataSourceRequest-- Returns:
- Result of the DeleteDataSource operation returned by the service.
- Throws:
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.
-
deleteEvaluation
public DeleteEvaluationResult deleteEvaluation(DeleteEvaluationRequest deleteEvaluationRequest)
Assigns the
DELETEDstatus to anEvaluation, rendering it unusable.After invoking the
DeleteEvaluationoperation, you can use the GetEvaluation operation to verify that the status of theEvaluationchanged toDELETED.Caution: The results of the
DeleteEvaluationoperation are irreversible.- Specified by:
deleteEvaluationin interfaceAmazonMachineLearning- Parameters:
deleteEvaluationRequest-- Returns:
- Result of the DeleteEvaluation operation returned by the service.
- Throws:
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.
-
deleteMLModel
public DeleteMLModelResult deleteMLModel(DeleteMLModelRequest deleteMLModelRequest)
Assigns the DELETED status to an
MLModel, rendering it unusable.After using the
DeleteMLModeloperation, you can use the GetMLModel operation to verify that the status of theMLModelchanged to DELETED.Caution: The result of the
DeleteMLModeloperation is irreversible.- Specified by:
deleteMLModelin interfaceAmazonMachineLearning- Parameters:
deleteMLModelRequest-- Returns:
- Result of the DeleteMLModel operation returned by the service.
- Throws:
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.
-
deleteRealtimeEndpoint
public DeleteRealtimeEndpointResult deleteRealtimeEndpoint(DeleteRealtimeEndpointRequest deleteRealtimeEndpointRequest)
Deletes a real time endpoint of an
MLModel.- Specified by:
deleteRealtimeEndpointin interfaceAmazonMachineLearning- Parameters:
deleteRealtimeEndpointRequest-- Returns:
- Result of the DeleteRealtimeEndpoint operation returned by the service.
- Throws:
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.
-
describeBatchPredictions
public DescribeBatchPredictionsResult describeBatchPredictions(DescribeBatchPredictionsRequest describeBatchPredictionsRequest)
Returns a list of
BatchPredictionoperations that match the search criteria in the request.- Specified by:
describeBatchPredictionsin interfaceAmazonMachineLearning- Parameters:
describeBatchPredictionsRequest-- Returns:
- Result of the DescribeBatchPredictions operation returned by the service.
- Throws:
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.
-
describeBatchPredictions
public DescribeBatchPredictionsResult describeBatchPredictions()
Description copied from interface:AmazonMachineLearningSimplified method form for invoking the DescribeBatchPredictions operation.- Specified by:
describeBatchPredictionsin interfaceAmazonMachineLearning- See Also:
AmazonMachineLearning.describeBatchPredictions(DescribeBatchPredictionsRequest)
-
describeDataSources
public DescribeDataSourcesResult describeDataSources(DescribeDataSourcesRequest describeDataSourcesRequest)
Returns a list of
DataSourcethat match the search criteria in the request.- Specified by:
describeDataSourcesin interfaceAmazonMachineLearning- Parameters:
describeDataSourcesRequest-- Returns:
- Result of the DescribeDataSources operation returned by the service.
- Throws:
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.
-
describeDataSources
public DescribeDataSourcesResult describeDataSources()
Description copied from interface:AmazonMachineLearningSimplified method form for invoking the DescribeDataSources operation.- Specified by:
describeDataSourcesin interfaceAmazonMachineLearning- See Also:
AmazonMachineLearning.describeDataSources(DescribeDataSourcesRequest)
-
describeEvaluations
public DescribeEvaluationsResult describeEvaluations(DescribeEvaluationsRequest describeEvaluationsRequest)
Returns a list of
DescribeEvaluationsthat match the search criteria in the request.- Specified by:
describeEvaluationsin interfaceAmazonMachineLearning- Parameters:
describeEvaluationsRequest-- Returns:
- Result of the DescribeEvaluations operation returned by the service.
- Throws:
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.
-
describeEvaluations
public DescribeEvaluationsResult describeEvaluations()
Description copied from interface:AmazonMachineLearningSimplified method form for invoking the DescribeEvaluations operation.- Specified by:
describeEvaluationsin interfaceAmazonMachineLearning- See Also:
AmazonMachineLearning.describeEvaluations(DescribeEvaluationsRequest)
-
describeMLModels
public DescribeMLModelsResult describeMLModels(DescribeMLModelsRequest describeMLModelsRequest)
Returns a list of
MLModelthat match the search criteria in the request.- Specified by:
describeMLModelsin interfaceAmazonMachineLearning- Parameters:
describeMLModelsRequest-- Returns:
- Result of the DescribeMLModels operation returned by the service.
- Throws:
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.
-
describeMLModels
public DescribeMLModelsResult describeMLModels()
Description copied from interface:AmazonMachineLearningSimplified method form for invoking the DescribeMLModels operation.- Specified by:
describeMLModelsin interfaceAmazonMachineLearning- See Also:
AmazonMachineLearning.describeMLModels(DescribeMLModelsRequest)
-
getBatchPrediction
public GetBatchPredictionResult getBatchPrediction(GetBatchPredictionRequest getBatchPredictionRequest)
Returns a
BatchPredictionthat includes detailed metadata, status, and data file information for aBatch Predictionrequest.- Specified by:
getBatchPredictionin interfaceAmazonMachineLearning- Parameters:
getBatchPredictionRequest-- Returns:
- Result of the GetBatchPrediction operation returned by the service.
- Throws:
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.
-
getDataSource
public GetDataSourceResult 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.- Specified by:
getDataSourcein interfaceAmazonMachineLearning- Parameters:
getDataSourceRequest-- Returns:
- Result of the GetDataSource operation returned by the service.
- Throws:
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.
-
getEvaluation
public GetEvaluationResult getEvaluation(GetEvaluationRequest getEvaluationRequest)
Returns an
Evaluationthat includes metadata as well as the current status of theEvaluation.- Specified by:
getEvaluationin interfaceAmazonMachineLearning- Parameters:
getEvaluationRequest-- Returns:
- Result of the GetEvaluation operation returned by the service.
- Throws:
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.
-
getMLModel
public GetMLModelResult getMLModel(GetMLModelRequest getMLModelRequest)
Returns an
MLModelthat includes detailed metadata, and data source information as well as the current status of theMLModel.GetMLModelprovides results in normal or verbose format.- Specified by:
getMLModelin interfaceAmazonMachineLearning- Parameters:
getMLModelRequest-- Returns:
- Result of the GetMLModel operation returned by the service.
- Throws:
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.
-
predict
public PredictResult predict(PredictRequest predictRequest)
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.
- Specified by:
predictin interfaceAmazonMachineLearning- Parameters:
predictRequest-- Returns:
- Result of the Predict operation returned by the service.
- Throws:
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 asDataSource.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 unmountedMLModel.
-
updateBatchPrediction
public UpdateBatchPredictionResult updateBatchPrediction(UpdateBatchPredictionRequest updateBatchPredictionRequest)
Updates the
BatchPredictionNameof aBatchPrediction.You can use the GetBatchPrediction operation to view the contents of the updated data element.
- Specified by:
updateBatchPredictionin interfaceAmazonMachineLearning- Parameters:
updateBatchPredictionRequest-- Returns:
- Result of the UpdateBatchPrediction operation returned by the service.
- Throws:
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.
-
updateDataSource
public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
Updates the
DataSourceNameof aDataSource.You can use the GetDataSource operation to view the contents of the updated data element.
- Specified by:
updateDataSourcein interfaceAmazonMachineLearning- Parameters:
updateDataSourceRequest-- Returns:
- Result of the UpdateDataSource operation returned by the service.
- Throws:
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.
-
updateEvaluation
public UpdateEvaluationResult updateEvaluation(UpdateEvaluationRequest updateEvaluationRequest)
Updates the
EvaluationNameof anEvaluation.You can use the GetEvaluation operation to view the contents of the updated data element.
- Specified by:
updateEvaluationin interfaceAmazonMachineLearning- Parameters:
updateEvaluationRequest-- Returns:
- Result of the UpdateEvaluation operation returned by the service.
- Throws:
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.
-
updateMLModel
public UpdateMLModelResult updateMLModel(UpdateMLModelRequest updateMLModelRequest)
Updates the
MLModelNameand theScoreThresholdof anMLModel.You can use the GetMLModel operation to view the contents of the updated data element.
- Specified by:
updateMLModelin interfaceAmazonMachineLearning- Parameters:
updateMLModelRequest-- Returns:
- Result of the UpdateMLModel operation returned by the service.
- Throws:
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.
-
getCachedResponseMetadata
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
- Specified by:
getCachedResponseMetadatain interfaceAmazonMachineLearning- Parameters:
request- The originally executed request- Returns:
- The response metadata for the specified request, or null if none is available.
-
-