com.amazonaws.services.machinelearning

Class AmazonMachineLearningClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.machinelearning.AmazonMachineLearningClient

All Implemented Interfaces:

AmazonMachineLearning

Direct Known Subclasses:

AmazonMachineLearningAsyncClient

public class AmazonMachineLearningClient
extends AmazonWebServiceClient
implements AmazonMachineLearning

Client for accessing AmazonMachineLearning. 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 and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all AmazonMachineLearning exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonMachineLearningClient() Constructs a new client to invoke service methods on AmazonMachineLearning.
AmazonMachineLearningClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonMachineLearning using the specified AWS account credentials.
AmazonMachineLearningClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonMachineLearning using the specified AWS account credentials and client configuration options.
AmazonMachineLearningClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonMachineLearning using the specified AWS account credentials provider.
AmazonMachineLearningClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonMachineLearning 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 AmazonMachineLearning using the specified AWS account credentials provider, client configuration options and request metric collector.
AmazonMachineLearningClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonMachineLearning.

Method Summary

Methods

Modifier and Type	Method and Description
CreateBatchPredictionResult	createBatchPrediction(CreateBatchPredictionRequest createBatchPredictionRequest) Generates predictions for a group of observations.
CreateDataSourceFromRDSResult	createDataSourceFromRDS(CreateDataSourceFromRDSRequest createDataSourceFromRDSRequest) Creates a DataSource object from an Amazon Relational Database Service (Amazon RDS).
CreateDataSourceFromRedshiftResult	createDataSourceFromRedshift(CreateDataSourceFromRedshiftRequest createDataSourceFromRedshiftRequest) Creates a DataSource from Amazon Redshift .
CreateDataSourceFromS3Result	createDataSourceFromS3(CreateDataSourceFromS3Request createDataSourceFromS3Request) Creates a DataSource object.
CreateEvaluationResult	createEvaluation(CreateEvaluationRequest createEvaluationRequest) Creates a new Evaluation of an MLModel .
CreateMLModelResult	createMLModel(CreateMLModelRequest createMLModelRequest) Creates a new MLModel using the data files and the recipe as information sources.
CreateRealtimeEndpointResult	createRealtimeEndpoint(CreateRealtimeEndpointRequest createRealtimeEndpointRequest) Creates a real-time endpoint for the MLModel .
DeleteBatchPredictionResult	deleteBatchPrediction(DeleteBatchPredictionRequest deleteBatchPredictionRequest) Assigns the DELETED status to a BatchPrediction , rendering it unusable.
DeleteDataSourceResult	deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) Assigns the DELETED status to a DataSource , rendering it unusable.
DeleteEvaluationResult	deleteEvaluation(DeleteEvaluationRequest deleteEvaluationRequest) Assigns the DELETED status to an Evaluation , rendering it unusable.
DeleteMLModelResult	deleteMLModel(DeleteMLModelRequest deleteMLModelRequest) Assigns the DELETED status to an MLModel , rendering it unusable.
DeleteRealtimeEndpointResult	deleteRealtimeEndpoint(DeleteRealtimeEndpointRequest deleteRealtimeEndpointRequest) Deletes a real time endpoint of an MLModel .
DescribeBatchPredictionsResult	describeBatchPredictions() Returns a list of BatchPrediction operations that match the search criteria in the request.
DescribeBatchPredictionsResult	describeBatchPredictions(DescribeBatchPredictionsRequest describeBatchPredictionsRequest) Returns a list of BatchPrediction operations that match the search criteria in the request.
DescribeDataSourcesResult	describeDataSources() Returns a list of DataSource that match the search criteria in the request.
DescribeDataSourcesResult	describeDataSources(DescribeDataSourcesRequest describeDataSourcesRequest) Returns a list of DataSource that match the search criteria in the request.
DescribeEvaluationsResult	describeEvaluations() Returns a list of DescribeEvaluations that match the search criteria in the request.
DescribeEvaluationsResult	describeEvaluations(DescribeEvaluationsRequest describeEvaluationsRequest) Returns a list of DescribeEvaluations that match the search criteria in the request.
DescribeMLModelsResult	describeMLModels() Returns a list of MLModel that match the search criteria in the request.
DescribeMLModelsResult	describeMLModels(DescribeMLModelsRequest describeMLModelsRequest) Returns a list of MLModel that match the search criteria in the request.
GetBatchPredictionResult	getBatchPrediction(GetBatchPredictionRequest getBatchPredictionRequest) Returns a BatchPrediction that includes detailed metadata, status, and data file information for a Batch Prediction request.
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.
GetDataSourceResult	getDataSource(GetDataSourceRequest getDataSourceRequest) Returns a DataSource that includes metadata and data file information, as well as the current status of the DataSource .
GetEvaluationResult	getEvaluation(GetEvaluationRequest getEvaluationRequest) Returns an Evaluation that includes metadata as well as the current status of the Evaluation .
GetMLModelResult	getMLModel(GetMLModelRequest getMLModelRequest) Returns an MLModel that includes detailed metadata, and data source information as well as the current status of the MLModel .
PredictResult	predict(PredictRequest predictRequest) Generates a prediction for the observation using the specified MLModel .
void	setEndpoint(String endpoint) Overrides the default endpoint for this client.
void	setEndpoint(String endpoint, String serviceName, String regionId) An internal method that is not expected to be normally called except for AWS internal development purposes.
UpdateBatchPredictionResult	updateBatchPrediction(UpdateBatchPredictionRequest updateBatchPredictionRequest) Updates the BatchPredictionName of a BatchPrediction .
UpdateDataSourceResult	updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) Updates the DataSourceName of a DataSource .
UpdateEvaluationResult	updateEvaluation(UpdateEvaluationRequest updateEvaluationRequest) Updates the EvaluationName of an Evaluation .
UpdateMLModelResult	updateMLModel(UpdateMLModelRequest updateMLModelRequest) Updates the MLModelName and the ScoreThreshold of an MLModel .

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, 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

setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all AmazonMachineLearning exceptions.

Constructor Detail

AmazonMachineLearningClient

public AmazonMachineLearningClient()

Constructs a new client to invoke service methods on AmazonMachineLearning. 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 AmazonMachineLearning. 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 AmazonMachineLearning (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonMachineLearningClient

public AmazonMachineLearningClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonMachineLearning 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 AmazonMachineLearning 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 AmazonMachineLearning (ex: proxy settings, retry counts, etc.).

AmazonMachineLearningClient

public AmazonMachineLearningClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonMachineLearning 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 AmazonMachineLearning 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 AmazonMachineLearning (ex: proxy settings, retry counts, etc.).

AmazonMachineLearningClient

public AmazonMachineLearningClient(AWSCredentialsProvider awsCredentialsProvider,
                           ClientConfiguration clientConfiguration,
                           RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on AmazonMachineLearning 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 AmazonMachineLearning (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

updateEvaluation

public UpdateEvaluationResult updateEvaluation(UpdateEvaluationRequest updateEvaluationRequest)

Updates the EvaluationName of an Evaluation .

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

Specified by:

updateEvaluation in interface AmazonMachineLearning

Parameters:

updateEvaluationRequest - Container for the necessary parameters to execute the UpdateEvaluation service method on AmazonMachineLearning.

Returns:

The response from the UpdateEvaluation service method, as returned by AmazonMachineLearning.

Throws:

ResourceNotFoundException

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

createMLModel

public CreateMLModelResult createMLModel(CreateMLModelRequest createMLModelRequest)

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

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

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

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

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

Specified by:

createMLModel in interface AmazonMachineLearning

Parameters:

createMLModelRequest - Container for the necessary parameters to execute the CreateMLModel service method on AmazonMachineLearning.

Returns:

The response from the CreateMLModel service method, as returned by AmazonMachineLearning.

Throws:

InvalidInputException

IdempotentParameterMismatchException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

createRealtimeEndpoint

public CreateRealtimeEndpointResult createRealtimeEndpoint(CreateRealtimeEndpointRequest createRealtimeEndpointRequest)

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

Specified by:

createRealtimeEndpoint in interface AmazonMachineLearning

Parameters:

createRealtimeEndpointRequest - Container for the necessary parameters to execute the CreateRealtimeEndpoint service method on AmazonMachineLearning.

Returns:

The response from the CreateRealtimeEndpoint service method, as returned by AmazonMachineLearning.

Throws:

ResourceNotFoundException

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

createDataSourceFromS3

public CreateDataSourceFromS3Result createDataSourceFromS3(CreateDataSourceFromS3Request createDataSourceFromS3Request)

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

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

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

The observation data used in a DataSource should be ready to use; that is, it should have a consistent structure, and missing data values should be kept to a minimum. The observation data must reside in one or more CSV files in an Amazon Simple Storage Service (Amazon S3) 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 the DataSource .

After the DataSource has been created, it's ready to use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel , the DataSource requires another item: a recipe. A recipe describes the observation variables that participate in training an MLModel . 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:

createDataSourceFromS3 in interface AmazonMachineLearning

Parameters:

createDataSourceFromS3Request - Container for the necessary parameters to execute the CreateDataSourceFromS3 service method on AmazonMachineLearning.

Returns:

The response from the CreateDataSourceFromS3 service method, as returned by AmazonMachineLearning.

Throws:

InvalidInputException

IdempotentParameterMismatchException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

deleteMLModel

public DeleteMLModelResult deleteMLModel(DeleteMLModelRequest deleteMLModelRequest)

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

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

Caution The result of the DeleteMLModel operation is irreversible.

Specified by:

deleteMLModel in interface AmazonMachineLearning

Parameters:

deleteMLModelRequest - Container for the necessary parameters to execute the DeleteMLModel service method on AmazonMachineLearning.

Returns:

The response from the DeleteMLModel service method, as returned by AmazonMachineLearning.

Throws:

ResourceNotFoundException

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

predict

public PredictResult predict(PredictRequest predictRequest)

Generates a prediction for the observation using the specified MLModel .

NOTE: Note Not all response parameters will be populated because this is dependent on the type of requested model.

Specified by:

predict in interface AmazonMachineLearning

Parameters:

predictRequest - Container for the necessary parameters to execute the Predict service method on AmazonMachineLearning.

Returns:

The response from the Predict service method, as returned by AmazonMachineLearning.

Throws:

ResourceNotFoundException

InvalidInputException

PredictorNotMountedException

LimitExceededException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

describeBatchPredictions

public DescribeBatchPredictionsResult describeBatchPredictions(DescribeBatchPredictionsRequest describeBatchPredictionsRequest)

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

Specified by:

describeBatchPredictions in interface AmazonMachineLearning

Parameters:

describeBatchPredictionsRequest - Container for the necessary parameters to execute the DescribeBatchPredictions service method on AmazonMachineLearning.

Returns:

The response from the DescribeBatchPredictions service method, as returned by AmazonMachineLearning.

Throws:

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

getEvaluation

public GetEvaluationResult getEvaluation(GetEvaluationRequest getEvaluationRequest)

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

Specified by:

getEvaluation in interface AmazonMachineLearning

Parameters:

getEvaluationRequest - Container for the necessary parameters to execute the GetEvaluation service method on AmazonMachineLearning.

Returns:

The response from the GetEvaluation service method, as returned by AmazonMachineLearning.

Throws:

ResourceNotFoundException

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

updateMLModel

public UpdateMLModelResult updateMLModel(UpdateMLModelRequest updateMLModelRequest)

Updates the MLModelName and the ScoreThreshold of an MLModel .

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

Specified by:

updateMLModel in interface AmazonMachineLearning

Parameters:

updateMLModelRequest - Container for the necessary parameters to execute the UpdateMLModel service method on AmazonMachineLearning.

Returns:

The response from the UpdateMLModel service method, as returned by AmazonMachineLearning.

Throws:

ResourceNotFoundException

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

getDataSource

public GetDataSourceResult getDataSource(GetDataSourceRequest getDataSourceRequest)

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

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

Specified by:

getDataSource in interface AmazonMachineLearning

Parameters:

getDataSourceRequest - Container for the necessary parameters to execute the GetDataSource service method on AmazonMachineLearning.

Returns:

The response from the GetDataSource service method, as returned by AmazonMachineLearning.

Throws:

ResourceNotFoundException

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

describeDataSources

public DescribeDataSourcesResult describeDataSources(DescribeDataSourcesRequest describeDataSourcesRequest)

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

Specified by:

describeDataSources in interface AmazonMachineLearning

Parameters:

describeDataSourcesRequest - Container for the necessary parameters to execute the DescribeDataSources service method on AmazonMachineLearning.

Returns:

The response from the DescribeDataSources service method, as returned by AmazonMachineLearning.

Throws:

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

deleteEvaluation

public DeleteEvaluationResult deleteEvaluation(DeleteEvaluationRequest deleteEvaluationRequest)

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

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

Caution The results of the DeleteEvaluation operation are irreversible.

Specified by:

deleteEvaluation in interface AmazonMachineLearning

Parameters:

deleteEvaluationRequest - Container for the necessary parameters to execute the DeleteEvaluation service method on AmazonMachineLearning.

Returns:

The response from the DeleteEvaluation service method, as returned by AmazonMachineLearning.

Throws:

ResourceNotFoundException

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

updateBatchPrediction

public UpdateBatchPredictionResult updateBatchPrediction(UpdateBatchPredictionRequest updateBatchPredictionRequest)

Updates the BatchPredictionName of a BatchPrediction .

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

Specified by:

updateBatchPrediction in interface AmazonMachineLearning

Parameters:

updateBatchPredictionRequest - Container for the necessary parameters to execute the UpdateBatchPrediction service method on AmazonMachineLearning.

Returns:

The response from the UpdateBatchPrediction service method, as returned by AmazonMachineLearning.

Throws:

ResourceNotFoundException

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

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 new BatchPrediction , and uses an MLModel and the data files referenced by the DataSource as information sources.

CreateBatchPrediction is an asynchronous operation. In response to CreateBatchPrediction , Amazon Machine Learning (Amazon ML) immediately returns and sets the BatchPrediction status to PENDING . After the BatchPrediction completes, Amazon ML sets the status to COMPLETED .

You can poll for status updates by using the GetBatchPrediction operation and checking the Status parameter of the result. After the COMPLETED status appears, the results are available in the location specified by the OutputUri parameter.

Specified by:

createBatchPrediction in interface AmazonMachineLearning

Parameters:

createBatchPredictionRequest - Container for the necessary parameters to execute the CreateBatchPrediction service method on AmazonMachineLearning.

Returns:

The response from the CreateBatchPrediction service method, as returned by AmazonMachineLearning.

Throws:

InvalidInputException

IdempotentParameterMismatchException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

describeMLModels

public DescribeMLModelsResult describeMLModels(DescribeMLModelsRequest describeMLModelsRequest)

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

Specified by:

describeMLModels in interface AmazonMachineLearning

Parameters:

describeMLModelsRequest - Container for the necessary parameters to execute the DescribeMLModels service method on AmazonMachineLearning.

Returns:

The response from the DescribeMLModels service method, as returned by AmazonMachineLearning.

Throws:

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

deleteBatchPrediction

public DeleteBatchPredictionResult deleteBatchPrediction(DeleteBatchPredictionRequest deleteBatchPredictionRequest)

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

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

Caution The result of the DeleteBatchPrediction operation is irreversible.

Specified by:

deleteBatchPrediction in interface AmazonMachineLearning

Parameters:

deleteBatchPredictionRequest - Container for the necessary parameters to execute the DeleteBatchPrediction service method on AmazonMachineLearning.

Returns:

The response from the DeleteBatchPrediction service method, as returned by AmazonMachineLearning.

Throws:

ResourceNotFoundException

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

updateDataSource

public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)

Updates the DataSourceName of a DataSource .

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

Specified by:

updateDataSource in interface AmazonMachineLearning

Parameters:

updateDataSourceRequest - Container for the necessary parameters to execute the UpdateDataSource service method on AmazonMachineLearning.

Returns:

The response from the UpdateDataSource service method, as returned by AmazonMachineLearning.

Throws:

ResourceNotFoundException

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

createDataSourceFromRDS

public CreateDataSourceFromRDSResult createDataSourceFromRDS(CreateDataSourceFromRDSRequest createDataSourceFromRDSRequest)

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

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

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

Specified by:

createDataSourceFromRDS in interface AmazonMachineLearning

Parameters:

createDataSourceFromRDSRequest - Container for the necessary parameters to execute the CreateDataSourceFromRDS service method on AmazonMachineLearning.

Returns:

The response from the CreateDataSourceFromRDS service method, as returned by AmazonMachineLearning.

Throws:

InvalidInputException

IdempotentParameterMismatchException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

createDataSourceFromRedshift

public CreateDataSourceFromRedshiftResult createDataSourceFromRedshift(CreateDataSourceFromRedshiftRequest createDataSourceFromRedshiftRequest)

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

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

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

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 of SelectSqlQuery to S3StagingLocation.

After the DataSource is created, it's ready for use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel , the DataSource requires another item -- a recipe. A recipe describes the observation variables that participate in training an MLModel . 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:

createDataSourceFromRedshift in interface AmazonMachineLearning

Parameters:

createDataSourceFromRedshiftRequest - Container for the necessary parameters to execute the CreateDataSourceFromRedshift service method on AmazonMachineLearning.

Returns:

The response from the CreateDataSourceFromRedshift service method, as returned by AmazonMachineLearning.

Throws:

InvalidInputException

IdempotentParameterMismatchException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

describeEvaluations

public DescribeEvaluationsResult describeEvaluations(DescribeEvaluationsRequest describeEvaluationsRequest)

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

Specified by:

describeEvaluations in interface AmazonMachineLearning

Parameters:

describeEvaluationsRequest - Container for the necessary parameters to execute the DescribeEvaluations service method on AmazonMachineLearning.

Returns:

The response from the DescribeEvaluations service method, as returned by AmazonMachineLearning.

Throws:

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

getMLModel

public GetMLModelResult getMLModel(GetMLModelRequest getMLModelRequest)

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

GetMLModel provides results in normal or verbose format.

Specified by:

getMLModel in interface AmazonMachineLearning

Parameters:

getMLModelRequest - Container for the necessary parameters to execute the GetMLModel service method on AmazonMachineLearning.

Returns:

The response from the GetMLModel service method, as returned by AmazonMachineLearning.

Throws:

ResourceNotFoundException

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

deleteDataSource

public DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)

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

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

Caution The results of the DeleteDataSource operation are irreversible.

Specified by:

deleteDataSource in interface AmazonMachineLearning

Parameters:

deleteDataSourceRequest - Container for the necessary parameters to execute the DeleteDataSource service method on AmazonMachineLearning.

Returns:

The response from the DeleteDataSource service method, as returned by AmazonMachineLearning.

Throws:

ResourceNotFoundException

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

getBatchPrediction

public GetBatchPredictionResult getBatchPrediction(GetBatchPredictionRequest getBatchPredictionRequest)

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

Specified by:

getBatchPrediction in interface AmazonMachineLearning

Parameters:

getBatchPredictionRequest - Container for the necessary parameters to execute the GetBatchPrediction service method on AmazonMachineLearning.

Returns:

The response from the GetBatchPrediction service method, as returned by AmazonMachineLearning.

Throws:

ResourceNotFoundException

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

createEvaluation

public CreateEvaluationResult createEvaluation(CreateEvaluationRequest createEvaluationRequest)

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

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

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

Specified by:

createEvaluation in interface AmazonMachineLearning

Parameters:

createEvaluationRequest - Container for the necessary parameters to execute the CreateEvaluation service method on AmazonMachineLearning.

Returns:

The response from the CreateEvaluation service method, as returned by AmazonMachineLearning.

Throws:

InvalidInputException

IdempotentParameterMismatchException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

deleteRealtimeEndpoint

public DeleteRealtimeEndpointResult deleteRealtimeEndpoint(DeleteRealtimeEndpointRequest deleteRealtimeEndpointRequest)

Deletes a real time endpoint of an MLModel .

Specified by:

deleteRealtimeEndpoint in interface AmazonMachineLearning

Parameters:

deleteRealtimeEndpointRequest - Container for the necessary parameters to execute the DeleteRealtimeEndpoint service method on AmazonMachineLearning.

Returns:

The response from the DeleteRealtimeEndpoint service method, as returned by AmazonMachineLearning.

Throws:

ResourceNotFoundException

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

describeBatchPredictions

public DescribeBatchPredictionsResult describeBatchPredictions()
                                                        throws AmazonServiceException,
                                                               AmazonClientException

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

Specified by:

describeBatchPredictions in interface AmazonMachineLearning

Returns:

The response from the DescribeBatchPredictions service method, as returned by AmazonMachineLearning.

Throws:

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

describeDataSources

public DescribeDataSourcesResult describeDataSources()
                                              throws AmazonServiceException,
                                                     AmazonClientException

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

Specified by:

describeDataSources in interface AmazonMachineLearning

Returns:

The response from the DescribeDataSources service method, as returned by AmazonMachineLearning.

Throws:

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

describeMLModels

public DescribeMLModelsResult describeMLModels()
                                        throws AmazonServiceException,
                                               AmazonClientException

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

Specified by:

describeMLModels in interface AmazonMachineLearning

Returns:

The response from the DescribeMLModels service method, as returned by AmazonMachineLearning.

Throws:

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

describeEvaluations

public DescribeEvaluationsResult describeEvaluations()
                                              throws AmazonServiceException,
                                                     AmazonClientException

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

Specified by:

describeEvaluations in interface AmazonMachineLearning

Returns:

The response from the DescribeEvaluations service method, as returned by AmazonMachineLearning.

Throws:

InvalidInputException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating either a problem with the data in the request, or a server side issue.

setEndpoint

public void setEndpoint(String endpoint)

Description copied from class: AmazonWebServiceClient

Overrides the default endpoint for this client. Callers can use this method to control which AWS region they want to work with.

This method is not threadsafe. Endpoints should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit.

Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

Specified by:

setEndpoint in interface AmazonMachineLearning

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

endpoint - The endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setEndpoint

public void setEndpoint(String endpoint,
               String serviceName,
               String regionId)
                 throws IllegalArgumentException

Description copied from class: AmazonWebServiceClient

An internal method that is not expected to be normally called except for AWS internal development purposes.

Overrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.

Callers can pass in just the endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

endpoint - The endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.

serviceName - This parameter is ignored.

regionId - The ID of the region in which this service resides AND the overriding region for signing purposes.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

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:

getCachedResponseMetadata in interface AmazonMachineLearning

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.