com.amazonaws.services.machinelearning

Class AmazonMachineLearningClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.machinelearning.AmazonMachineLearningClient

All Implemented Interfaces:

AmazonMachineLearning

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Constructor Summary

Constructors

Constructor and Description
AmazonMachineLearningClient() Deprecated.
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, HttpClient httpClient) 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(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector) Deprecated.
AmazonMachineLearningClient(ClientConfiguration clientConfiguration) Deprecated.

Method Summary

Modifier and Type	Method and Description
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.machinelearning.AmazonMachineLearning

setEndpoint, setRegion, shutdown

Constructor Detail

AmazonMachineLearningClient

@Deprecated
public AmazonMachineLearningClient()

Deprecated.

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

@Deprecated
public AmazonMachineLearningClient(ClientConfiguration clientConfiguration)

Deprecated.

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.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonMachineLearningClient client = new AmazonMachineLearningClient(AWSMobileClient
                 .getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonMachineLearningClient client = new AmazonMachineLearningClient(AWSMobileClient
                 .getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonMachineLearningClient client = new AmazonMachineLearningClient(AWSMobileClient
                 .getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonMachineLearningClient client = new AmazonMachineLearningClient(AWSMobileClient
                 .getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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

@Deprecated
public AmazonMachineLearningClient(AWSCredentialsProvider awsCredentialsProvider,
                                               ClientConfiguration clientConfiguration,
                                               com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)

Deprecated.

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

AmazonMachineLearningClient

public AmazonMachineLearningClient(AWSCredentialsProvider awsCredentialsProvider,
                                   ClientConfiguration clientConfiguration,
                                   HttpClient httpClient)

Constructs a new client to invoke service methods on AmazonMachineLearning using the specified AWS account credentials provider, client configuration options and request metric collector.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonMachineLearningClient client = new AmazonMachineLearningClient(AWSMobileClient
                 .getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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.).

httpClient - A http client

Method Detail

getMLModel

public GetMLModelResult getMLModel(GetMLModelRequest getMLModelRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

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.

Specified by:

getMLModel in interface AmazonMachineLearning

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

public PredictResult predict(PredictRequest predictRequest)
                      throws AmazonServiceException,
                             AmazonClientException

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.

Specified by:

predict in interface AmazonMachineLearning

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.

getCachedResponseMetadata

@Deprecated
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.

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.