amazonaws.com – machinelearning
Definition of the public APIs exposed by Amazon Machine Learning
- Homepage
- https://api.apis.guru/v2/specs/amazonaws.com:machinelearning/2014-12-12.json
- Provider
- amazonaws.com:machinelearning / machinelearning
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/amazonaws.com/machinelearning/2014-12-12/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/amazonaws.com/machinelearning/2014-12-12/openapi.yaml
Tools (30)
Extracted live via the executor SDK.
-
xAmzTargetAmazonMl20141212AddTags.addTagsAdds one or more tags to an object, up to a limit of 10. Each tag consists of a key and an optional value. If you add a tag using a key that is already associated with the ML object,
AddTagsupdates the tag's value. -
xAmzTargetAmazonMl20141212CreateBatchPrediction.createBatchPredictionGenerates predictions for a group of observations. The observations to process exist in one or more data files referenced by a
DataSource. This operation creates a newBatchPrediction, and uses anMLModeland the data files referenced by theDataSourceas information sources.CreateBatchPredictionis an asynchronous operation. In response toCreateBatchPrediction, Amazon Machine Learning (Amazon ML) immediately returns and sets theBatchPredictionstatus toPENDING. After theBatchPredictioncompletes, Amazon ML sets the status toCOMPLETED.You can poll for status updates by using the GetBatchPrediction [blocked] operation and checking the
Statusparameter of the result. After theCOMPLETEDstatus appears, the results are available in the location specified by theOutputUriparameter. -
xAmzTargetAmazonMl20141212CreateDataSourceFromRds.createDataSourceFromRdsCreates a
DataSourceobject from an (Amazon RDS). ADataSourcereferences data that can be used to performCreateMLModel,CreateEvaluation, orCreateBatchPredictionoperations.CreateDataSourceFromRDSis an asynchronous operation. In response toCreateDataSourceFromRDS, Amazon Machine Learning (Amazon ML) immediately returns and sets theDataSourcestatus toPENDING. After theDataSourceis created and ready for use, Amazon ML sets theStatusparameter toCOMPLETED.DataSourcein theCOMPLETEDorPENDINGstate can be used only to perform>CreateMLModel>,CreateEvaluation, orCreateBatchPredictionoperations.If Amazon ML cannot accept the input source, it sets the
Statusparameter toFAILEDand includes an error message in theMessageattribute of theGetDataSourceoperation response. -
xAmzTargetAmazonMl20141212CreateDataSourceFromRedshift.createDataSourceFromRedshiftCreates a
DataSourcefrom a database hosted on an Amazon Redshift cluster. ADataSourcereferences data that can be used to perform eitherCreateMLModel,CreateEvaluation, orCreateBatchPredictionoperations.CreateDataSourceFromRedshiftis an asynchronous operation. In response toCreateDataSourceFromRedshift, Amazon Machine Learning (Amazon ML) immediately returns and sets theDataSourcestatus toPENDING. After theDataSourceis created and ready for use, Amazon ML sets theStatusparameter toCOMPLETED.DataSourceinCOMPLETEDorPENDINGstates can be used to perform onlyCreateMLModel,CreateEvaluation, orCreateBatchPredictionoperations.If Amazon ML can't accept the input source, it sets the
Statusparameter toFAILEDand includes an error message in theMessageattribute of theGetDataSourceoperation response.The observations should be contained in the database hosted on an Amazon Redshift cluster and should be specified by a
SelectSqlQueryquery. Amazon ML executes anUnloadcommand in Amazon Redshift to transfer the result set of theSelectSqlQueryquery toS3StagingLocation.After the
DataSourcehas been created, it's ready for use in evaluations and batch predictions. If you plan to use theDataSourceto train anMLModel, theDataSourcealso requires a recipe. A recipe describes how each input variable will be used in training anMLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions.You can't change an existing datasource, but you can copy and modify the settings from an existing Amazon Redshift datasource to create a new datasource. To do so, call
GetDataSourcefor an existing datasource and copy the values to aCreateDataSourcecall. Change the settings that you want to change and make sure that all required fields have the appropriate values. -
xAmzTargetAmazonMl20141212CreateDataSourceFromS3.createDataSourceFromS3Creates a
DataSourceobject. ADataSourcereferences data that can be used to performCreateMLModel,CreateEvaluation, orCreateBatchPredictionoperations.CreateDataSourceFromS3is an asynchronous operation. In response toCreateDataSourceFromS3, Amazon Machine Learning (Amazon ML) immediately returns and sets theDataSourcestatus toPENDING. After theDataSourcehas been created and is ready for use, Amazon ML sets theStatusparameter toCOMPLETED.DataSourcein theCOMPLETEDorPENDINGstate can be used to perform onlyCreateMLModel,CreateEvaluationorCreateBatchPredictionoperations.If Amazon ML can't accept the input source, it sets the
Statusparameter toFAILEDand includes an error message in theMessageattribute of theGetDataSourceoperation response.The observation data used in a
DataSourceshould be ready to use; that is, it should have a consistent structure, and missing data values should be kept to a minimum. The observation data must reside in one or more .csv files in an Amazon Simple Storage Service (Amazon S3) location, along with a schema that describes the data items by name and type. The same schema must be used for all of the data files referenced by theDataSource.After the
DataSourcehas been created, it's ready to use in evaluations and batch predictions. If you plan to use theDataSourceto train anMLModel, theDataSourcealso needs a recipe. A recipe describes how each input variable will be used in training anMLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions. -
xAmzTargetAmazonMl20141212CreateEvaluation.createEvaluationCreates a new
Evaluationof anMLModel. AnMLModelis evaluated on a set of observations associated to aDataSource. Like aDataSourcefor anMLModel, theDataSourcefor anEvaluationcontains values for theTarget Variable. TheEvaluationcompares the predicted result for each observation to the actual outcome and provides a summary so that you know how effective theMLModelfunctions on the test data. Evaluation generates a relevant performance metric, such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the correspondingMLModelType:BINARY,REGRESSIONorMULTICLASS.CreateEvaluationis an asynchronous operation. In response toCreateEvaluation, Amazon Machine Learning (Amazon ML) immediately returns and sets the evaluation status toPENDING. After theEvaluationis created and ready for use, Amazon ML sets the status toCOMPLETED.You can use the
GetEvaluationoperation to check progress of the evaluation during the creation operation. -
xAmzTargetAmazonMl20141212CreateMlModel.createMlModelCreates a new
MLModelusing theDataSourceand the recipe as information sources.An
MLModelis nearly immutable. Users can update only theMLModelNameand theScoreThresholdin anMLModelwithout creating a newMLModel.CreateMLModelis an asynchronous operation. In response toCreateMLModel, Amazon Machine Learning (Amazon ML) immediately returns and sets theMLModelstatus toPENDING. After theMLModelhas been created and ready is for use, Amazon ML sets the status toCOMPLETED.You can use the
GetMLModeloperation to check the progress of theMLModelduring the creation operation.CreateMLModelrequires aDataSourcewith computed statistics, which can be created by settingComputeStatisticstotrueinCreateDataSourceFromRDS,CreateDataSourceFromS3, orCreateDataSourceFromRedshiftoperations. -
xAmzTargetAmazonMl20141212CreateRealtimeEndpoint.createRealtimeEndpointCreates a real-time endpoint for the
MLModel. The endpoint contains the URI of theMLModel; that is, the location to send real-time prediction requests for the specifiedMLModel. -
xAmzTargetAmazonMl20141212DeleteBatchPrediction.deleteBatchPredictionAssigns the DELETED status to a
BatchPrediction, rendering it unusable.After using the
DeleteBatchPredictionoperation, you can use the GetBatchPrediction [blocked] operation to verify that the status of theBatchPredictionchanged to DELETED.Caution: The result of the
DeleteBatchPredictionoperation is irreversible. -
xAmzTargetAmazonMl20141212DeleteDataSource.deleteDataSourceAssigns the DELETED status to a
DataSource, rendering it unusable.After using the
DeleteDataSourceoperation, you can use the GetDataSource [blocked] operation to verify that the status of theDataSourcechanged to DELETED.Caution: The results of the
DeleteDataSourceoperation are irreversible. -
xAmzTargetAmazonMl20141212DeleteEvaluation.deleteEvaluationAssigns the
DELETEDstatus to anEvaluation, rendering it unusable.After invoking the
DeleteEvaluationoperation, you can use theGetEvaluationoperation to verify that the status of theEvaluationchanged toDELETED.Caution: The results of the
DeleteEvaluationoperation are irreversible. -
xAmzTargetAmazonMl20141212DeleteMlModel.deleteMlModelAssigns the
DELETEDstatus to anMLModel, rendering it unusable.After using the
DeleteMLModeloperation, you can use theGetMLModeloperation to verify that the status of theMLModelchanged to DELETED.Caution: The result of the
DeleteMLModeloperation is irreversible. -
xAmzTargetAmazonMl20141212DeleteRealtimeEndpoint.deleteRealtimeEndpointDeletes a real time endpoint of an
MLModel. -
xAmzTargetAmazonMl20141212DeleteTags.deleteTagsDeletes the specified tags associated with an ML object. After this operation is complete, you can't recover deleted tags.
If you specify a tag that doesn't exist, Amazon ML ignores it.
-
xAmzTargetAmazonMl20141212DescribeBatchPredictions.describeBatchPredictionsReturns a list of
BatchPredictionoperations that match the search criteria in the request. -
xAmzTargetAmazonMl20141212DescribeDataSources.describeDataSourcesReturns a list of
DataSourcethat match the search criteria in the request. -
xAmzTargetAmazonMl20141212DescribeEvaluations.describeEvaluationsReturns a list of
DescribeEvaluationsthat match the search criteria in the request. -
xAmzTargetAmazonMl20141212DescribeMlModels.describeMlModelsReturns a list of
MLModelthat match the search criteria in the request. -
xAmzTargetAmazonMl20141212DescribeTags.describeTagsDescribes one or more of the tags for your Amazon ML object.
-
xAmzTargetAmazonMl20141212GetBatchPrediction.getBatchPredictionReturns a
BatchPredictionthat includes detailed metadata, status, and data file information for aBatch Predictionrequest. -
xAmzTargetAmazonMl20141212GetDataSource.getDataSourceReturns a
DataSourcethat includes metadata and data file information, as well as the current status of theDataSource.GetDataSourceprovides results in normal or verbose format. The verbose format adds the schema description and the list of files pointed to by the DataSource to the normal format. -
xAmzTargetAmazonMl20141212GetEvaluation.getEvaluationReturns an
Evaluationthat includes metadata as well as the current status of theEvaluation. -
xAmzTargetAmazonMl20141212GetMlModel.getMlModelReturns an
MLModelthat includes detailed metadata, data source information, and the current status of theMLModel.GetMLModelprovides results in normal or verbose format. -
xAmzTargetAmazonMl20141212Predict.predictGenerates a prediction for the observation using the specified
ML Model.Note: Not all response parameters will be populated. Whether a response parameter is populated depends on the type of model requested.
-
xAmzTargetAmazonMl20141212UpdateBatchPrediction.updateBatchPredictionUpdates the
BatchPredictionNameof aBatchPrediction.You can use the
GetBatchPredictionoperation to view the contents of the updated data element. -
xAmzTargetAmazonMl20141212UpdateDataSource.updateDataSourceUpdates the
DataSourceNameof aDataSource.You can use the
GetDataSourceoperation to view the contents of the updated data element. -
xAmzTargetAmazonMl20141212UpdateEvaluation.updateEvaluationUpdates the
EvaluationNameof anEvaluation.You can use the
GetEvaluationoperation to view the contents of the updated data element. -
xAmzTargetAmazonMl20141212UpdateMlModel.updateMlModelUpdates the
MLModelNameand theScoreThresholdof anMLModel.You can use the
GetMLModeloperation to view the contents of the updated data element. -
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools