com.amazonaws.services.machinelearning

Interface AmazonMachineLearning

All Known Implementing Classes:

AmazonMachineLearningClient

public interface AmazonMachineLearning

Interface for accessing Amazon Machine Learning Definition of the public APIs exposed by Amazon Machine Learning

Method Summary

Modifier and Type	Method and Description
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.
GetMLModelResult	getMLModel(GetMLModelRequest getMLModelRequest) Returns an MLModel that includes detailed metadata, data source information, and the current status of the MLModel.
PredictResult	predict(PredictRequest predictRequest) Generates a prediction for the observation using the specified ML Model.
void	setEndpoint(java.lang.String endpoint) Overrides the default endpoint for this client ("https://machinelearning.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Method Detail

setEndpoint

void setEndpoint(java.lang.String endpoint)
          throws java.lang.IllegalArgumentException

Overrides the default endpoint for this client ("https://machinelearning.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "machinelearning.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://machinelearning.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

This method is not threadsafe. An endpoint 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 or retrying.

Parameters:

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

Throws:

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

setRegion

void setRegion(Region region)
        throws java.lang.IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region 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 or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

java.lang.IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

getMLModel

GetMLModelResult getMLModel(GetMLModelRequest getMLModelRequest)
                     throws AmazonClientException,
                            AmazonServiceException

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

GetMLModel provides results in normal or verbose format.

Parameters:

getMLModelRequest -

Returns:

getMLModelResult The response from the GetMLModel service method, as returned by Amazon Machine Learning.

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.

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 Amazon Machine Learning indicating either a problem with the data in the request, or a server side issue.

predict

PredictResult predict(PredictRequest predictRequest)
               throws AmazonClientException,
                      AmazonServiceException

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

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

Parameters:

predictRequest -

Returns:

predictResult The response from the Predict service method, as returned by Amazon Machine Learning.

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 as DataSource.

InternalServerException -

An error on the server occurred when trying to process a request.

PredictorNotMountedException -

The exception is thrown when a predict request is made to an unmounted MLModel.

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 Amazon Machine Learning indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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