public class AmazonMachineLearningClient extends com.amazonaws.AmazonWebServiceClient implements AmazonMachineLearning
Definition of the public APIs exposed by Amazon Machine Learning
| Modifier and Type | Field and Description |
|---|---|
protected List<com.amazonaws.transform.JsonErrorUnmarshaller> |
jsonErrorUnmarshallers
List of exception unmarshallers for all AmazonMachineLearning exceptions.
|
| Constructor and Description |
|---|
AmazonMachineLearningClient()
Constructs a new client to invoke service methods on
AmazonMachineLearning.
|
AmazonMachineLearningClient(com.amazonaws.auth.AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on
AmazonMachineLearning using the specified AWS account credentials.
|
AmazonMachineLearningClient(com.amazonaws.auth.AWSCredentials awsCredentials,
com.amazonaws.ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonMachineLearning using the specified AWS account credentials
and client configuration options.
|
AmazonMachineLearningClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on
AmazonMachineLearning using the specified AWS account credentials provider.
|
AmazonMachineLearningClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider,
com.amazonaws.ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonMachineLearning using the specified AWS account credentials
provider and client configuration options.
|
AmazonMachineLearningClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider,
com.amazonaws.ClientConfiguration clientConfiguration,
com.amazonaws.metrics.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(com.amazonaws.ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonMachineLearning.
|
| 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. |
com.amazonaws.ResponseMetadata |
getCachedResponseMetadata(com.amazonaws.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 ("https://machinelearning.us-east-1.amazonaws.com").
|
void |
setEndpoint(String endpoint,
String serviceName,
String regionId) |
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 . |
addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetRegion, shutdownprotected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers
public AmazonMachineLearningClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChainpublic AmazonMachineLearningClient(com.amazonaws.ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this
client connects to AmazonMachineLearning
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChainpublic AmazonMachineLearningClient(com.amazonaws.auth.AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AmazonMachineLearningClient(com.amazonaws.auth.AWSCredentials awsCredentials,
com.amazonaws.ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).public AmazonMachineLearningClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AmazonMachineLearningClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider,
com.amazonaws.ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).public AmazonMachineLearningClient(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider,
com.amazonaws.ClientConfiguration clientConfiguration,
com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 collectorpublic 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.
updateEvaluation in interface AmazonMachineLearningupdateEvaluationRequest - Container for the necessary parameters
to execute the UpdateEvaluation service method on
AmazonMachineLearning.ResourceNotFoundExceptionInvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.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.
createMLModel in interface AmazonMachineLearningcreateMLModelRequest - Container for the necessary parameters to
execute the CreateMLModel service method on AmazonMachineLearning.InvalidInputExceptionIdempotentParameterMismatchExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.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 .
createRealtimeEndpoint in interface AmazonMachineLearningcreateRealtimeEndpointRequest - Container for the necessary
parameters to execute the CreateRealtimeEndpoint service method on
AmazonMachineLearning.ResourceNotFoundExceptionInvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.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
.
createDataSourceFromS3 in interface AmazonMachineLearningcreateDataSourceFromS3Request - Container for the necessary
parameters to execute the CreateDataSourceFromS3 service method on
AmazonMachineLearning.InvalidInputExceptionIdempotentParameterMismatchExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.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.
deleteMLModel in interface AmazonMachineLearningdeleteMLModelRequest - Container for the necessary parameters to
execute the DeleteMLModel service method on AmazonMachineLearning.ResourceNotFoundExceptionInvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.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.
predict in interface AmazonMachineLearningpredictRequest - Container for the necessary parameters to
execute the Predict service method on AmazonMachineLearning.ResourceNotFoundExceptionInvalidInputExceptionPredictorNotMountedExceptionLimitExceededExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.public DescribeBatchPredictionsResult describeBatchPredictions(DescribeBatchPredictionsRequest describeBatchPredictionsRequest)
Returns a list of BatchPrediction operations that match
the search criteria in the request.
describeBatchPredictions in interface AmazonMachineLearningdescribeBatchPredictionsRequest - Container for the necessary
parameters to execute the DescribeBatchPredictions service method on
AmazonMachineLearning.InvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.public GetEvaluationResult getEvaluation(GetEvaluationRequest getEvaluationRequest)
Returns an Evaluation that includes metadata as well as
the current status of the Evaluation .
getEvaluation in interface AmazonMachineLearninggetEvaluationRequest - Container for the necessary parameters to
execute the GetEvaluation service method on AmazonMachineLearning.ResourceNotFoundExceptionInvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.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.
updateMLModel in interface AmazonMachineLearningupdateMLModelRequest - Container for the necessary parameters to
execute the UpdateMLModel service method on AmazonMachineLearning.ResourceNotFoundExceptionInvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.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.
getDataSource in interface AmazonMachineLearninggetDataSourceRequest - Container for the necessary parameters to
execute the GetDataSource service method on AmazonMachineLearning.ResourceNotFoundExceptionInvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.public DescribeDataSourcesResult describeDataSources(DescribeDataSourcesRequest describeDataSourcesRequest)
Returns a list of DataSource that match the search
criteria in the request.
describeDataSources in interface AmazonMachineLearningdescribeDataSourcesRequest - Container for the necessary
parameters to execute the DescribeDataSources service method on
AmazonMachineLearning.InvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.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 .
deleteEvaluation in interface AmazonMachineLearningdeleteEvaluationRequest - Container for the necessary parameters
to execute the DeleteEvaluation service method on
AmazonMachineLearning.ResourceNotFoundExceptionInvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.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.
updateBatchPrediction in interface AmazonMachineLearningupdateBatchPredictionRequest - Container for the necessary
parameters to execute the UpdateBatchPrediction service method on
AmazonMachineLearning.ResourceNotFoundExceptionInvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.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.
createBatchPrediction in interface AmazonMachineLearningcreateBatchPredictionRequest - Container for the necessary
parameters to execute the CreateBatchPrediction service method on
AmazonMachineLearning.InvalidInputExceptionIdempotentParameterMismatchExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.public DescribeMLModelsResult describeMLModels(DescribeMLModelsRequest describeMLModelsRequest)
Returns a list of MLModel that match the search criteria
in the request.
describeMLModels in interface AmazonMachineLearningdescribeMLModelsRequest - Container for the necessary parameters
to execute the DescribeMLModels service method on
AmazonMachineLearning.InvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.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.
deleteBatchPrediction in interface AmazonMachineLearningdeleteBatchPredictionRequest - Container for the necessary
parameters to execute the DeleteBatchPrediction service method on
AmazonMachineLearning.ResourceNotFoundExceptionInvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.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.
updateDataSource in interface AmazonMachineLearningupdateDataSourceRequest - Container for the necessary parameters
to execute the UpdateDataSource service method on
AmazonMachineLearning.ResourceNotFoundExceptionInvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.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.
createDataSourceFromRDS in interface AmazonMachineLearningcreateDataSourceFromRDSRequest - Container for the necessary
parameters to execute the CreateDataSourceFromRDS service method on
AmazonMachineLearning.InvalidInputExceptionIdempotentParameterMismatchExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.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.
createDataSourceFromRedshift in interface AmazonMachineLearningcreateDataSourceFromRedshiftRequest - Container for the necessary
parameters to execute the CreateDataSourceFromRedshift service method
on AmazonMachineLearning.InvalidInputExceptionIdempotentParameterMismatchExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.public DescribeEvaluationsResult describeEvaluations(DescribeEvaluationsRequest describeEvaluationsRequest)
Returns a list of DescribeEvaluations that match the
search criteria in the request.
describeEvaluations in interface AmazonMachineLearningdescribeEvaluationsRequest - Container for the necessary
parameters to execute the DescribeEvaluations service method on
AmazonMachineLearning.InvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.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.
getMLModel in interface AmazonMachineLearninggetMLModelRequest - Container for the necessary parameters to
execute the GetMLModel service method on AmazonMachineLearning.ResourceNotFoundExceptionInvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.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.
deleteDataSource in interface AmazonMachineLearningdeleteDataSourceRequest - Container for the necessary parameters
to execute the DeleteDataSource service method on
AmazonMachineLearning.ResourceNotFoundExceptionInvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.public GetBatchPredictionResult getBatchPrediction(GetBatchPredictionRequest getBatchPredictionRequest)
Returns a BatchPrediction that includes detailed
metadata, status, and data file information for a Batch
Prediction request.
getBatchPrediction in interface AmazonMachineLearninggetBatchPredictionRequest - Container for the necessary
parameters to execute the GetBatchPrediction service method on
AmazonMachineLearning.ResourceNotFoundExceptionInvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.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.
createEvaluation in interface AmazonMachineLearningcreateEvaluationRequest - Container for the necessary parameters
to execute the CreateEvaluation service method on
AmazonMachineLearning.InvalidInputExceptionIdempotentParameterMismatchExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.public DeleteRealtimeEndpointResult deleteRealtimeEndpoint(DeleteRealtimeEndpointRequest deleteRealtimeEndpointRequest)
Deletes a real time endpoint of an MLModel .
deleteRealtimeEndpoint in interface AmazonMachineLearningdeleteRealtimeEndpointRequest - Container for the necessary
parameters to execute the DeleteRealtimeEndpoint service method on
AmazonMachineLearning.ResourceNotFoundExceptionInvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.public DescribeBatchPredictionsResult describeBatchPredictions() throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Returns a list of BatchPrediction operations that match
the search criteria in the request.
describeBatchPredictions in interface AmazonMachineLearningInvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.public DescribeDataSourcesResult describeDataSources() throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Returns a list of DataSource that match the search
criteria in the request.
describeDataSources in interface AmazonMachineLearningInvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.public DescribeMLModelsResult describeMLModels() throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Returns a list of MLModel that match the search criteria
in the request.
describeMLModels in interface AmazonMachineLearningInvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.public DescribeEvaluationsResult describeEvaluations() throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Returns a list of DescribeEvaluations that match the
search criteria in the request.
describeEvaluations in interface AmazonMachineLearningInvalidInputExceptionInternalServerExceptioncom.amazonaws.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.com.amazonaws.AmazonServiceException - If an error response is returned by AmazonMachineLearning indicating
either a problem with the data in the request, or a server side issue.public void setEndpoint(String endpoint)
AmazonMachineLearning
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.
setEndpoint in interface AmazonMachineLearningsetEndpoint in class com.amazonaws.AmazonWebServiceClientendpoint - 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.public void setEndpoint(String endpoint, String serviceName, String regionId) throws IllegalArgumentException
setEndpoint in class com.amazonaws.AmazonWebServiceClientIllegalArgumentExceptionpublic com.amazonaws.ResponseMetadata getCachedResponseMetadata(com.amazonaws.AmazonWebServiceRequest request)
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.
getCachedResponseMetadata in interface AmazonMachineLearningrequest - The originally executed requestCopyright © 2015. All rights reserved.