},
"StartedAt": number, "Status": "string"
} ]}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
NextToken (p. 69)
The ID of the next page in the paginated results that indicates at least one more page follows.
Type: String Results (p. 69)
A list of Evaluation that meet the search criteria.
Type: Array of Evaluation (p. 128) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 161).
InternalServerException
An error on the server occurred when trying to process a request.
HTTP Status Code: 500 InvalidInputException
An error on the client occurred. Typically, the cause is an invalid input value.
HTTP Status Code: 400
Examples
The following is a sample request and response of the DescribeEvaluations operation.
This example illustrates one usage of DescribeEvaluations.
See Also
Sample Request
POST / HTTP/1.1
Host: machinelearning.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>,
{ "FilterVariable": "Name",
"Prefix": "ev-", "SortOrder": "asc", "Limit": 1
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes>
Date: <Date>
{ "NextToken": "{\"EvaluationId\":\"ev-exampleId2\"}", "Results": [
{
"CreatedAt": 1420745248.785,
"CreatedByIamUser": "arn:aws:iam::<awsAccountId>:user/username", "EvaluationDataSourceId": "ds-exampleDataSourceId",
"EvaluationId": "ev-exampleId1",
"InputDataLocationS3": "s3://bucket/locationToInput/example-data.testing.csv", "LastUpdatedAt": 1420745524.506,
"MLModelId": "pr-exampleModelId", "Name": "ev-1",
"PerformanceMetrics":
{
"Properties": {"BinaryAUC": "0.9228827246570067"}
},
"Status": "COMPLETED", "ComputeTime":"185200",
"FinishedAt":"1420745524.506", "StartedAt":"1420745249.324"
} ] }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
See Also
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeMLModels
DescribeMLModels
Returns a list of MLModel that match the search criteria in the request.
Request Syntax
{
"EQ": "string",
"FilterVariable": "string", "GE": "string",
"GT": "string", "LE": "string", "Limit": number, "LT": "string", "NE": "string", "NextToken": "string", "Prefix": "string", "SortOrder": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 159).
The request accepts the following data in JSON format.
EQ (p. 73)
The equal to operator. The MLModel results will have FilterVariable values that exactly match the value specified with EQ.
Type: String
Length Constraints: Maximum length of 1024.
Pattern: .*\S.*|^$
Required: No FilterVariable (p. 73)
Use one of the following variables to filter a list of MLModel:
• CreatedAt - Sets the search criteria to MLModel creation date.
• Status - Sets the search criteria to MLModel status.
• Name - Sets the search criteria to the contents of MLModel Name.
• IAMUser - Sets the search criteria to the user account that invoked the MLModel creation.
• TrainingDataSourceId - Sets the search criteria to the DataSource used to train one or more MLModel.
• RealtimeEndpointStatus - Sets the search criteria to the MLModel real-time endpoint status.
• MLModelType - Sets the search criteria to MLModel type: binary, regression, or multi-class.
• Algorithm - Sets the search criteria to the algorithm that the MLModel uses.
• TrainingDataURI - Sets the search criteria to the data file(s) used in training a MLModel.
The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
Request Parameters
Type: String
Valid Values: CreatedAt | LastUpdatedAt | Status | Name | IAMUser |
TrainingDataSourceId | RealtimeEndpointStatus | MLModelType | Algorithm | TrainingDataURI
Required: No GE (p. 73)
The greater than or equal to operator. The MLModel results will have FilterVariable values that are greater than or equal to the value specified with GE.
Type: String
Length Constraints: Maximum length of 1024.
Pattern: .*\S.*|^$
Required: No GT (p. 73)
The greater than operator. The MLModel results will have FilterVariable values that are greater than the value specified with GT.
Type: String
Length Constraints: Maximum length of 1024.
Pattern: .*\S.*|^$
Required: No LE (p. 73)
The less than or equal to operator. The MLModel results will have FilterVariable values that are less than or equal to the value specified with LE.
Type: String
Length Constraints: Maximum length of 1024.
Pattern: .*\S.*|^$
Required: No Limit (p. 73)
The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No LT (p. 73)
The less than operator. The MLModel results will have FilterVariable values that are less than the value specified with LT.
Type: String
Length Constraints: Maximum length of 1024.
Response Syntax
Pattern: .*\S.*|^$
Required: No NE (p. 73)
The not equal to operator. The MLModel results will have FilterVariable values not equal to the value specified with NE.
Type: String
Length Constraints: Maximum length of 1024.
Pattern: .*\S.*|^$
Required: No NextToken (p. 73)
The ID of the page in the paginated results.
Type: String Required: No Prefix (p. 73)
A string that is found at the beginning of a variable, such as Name or Id.
For example, an MLModel could have the Name 2014-09-09-HolidayGiftMailer. To search for this MLModel, select Name for the FilterVariable and any of the following strings for the Prefix:
• 2014-09
• 2014-09-09
• 2014-09-09-Holiday Type: String
Length Constraints: Maximum length of 1024.
Pattern: .*\S.*|^$
Required: No SortOrder (p. 73)
A two-value parameter that determines the sequence of the resulting list of MLModel.
• asc - Arranges the list in ascending order (A-Z, 0-9).
• dsc - Arranges the list in descending order (Z-A, 9-0).
Results are sorted by FilterVariable.
Type: String
Valid Values: asc | dsc Required: No
Response Syntax
{ "NextToken": "string",
Response Elements
"InputDataLocationS3": "string", "LastUpdatedAt": number,
"ScoreThresholdLastUpdatedAt": number, "SizeInBytes": number,
"StartedAt": number, "Status": "string",
"TrainingDataSourceId": "string", "TrainingParameters": {
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
NextToken (p. 75)
The ID of the next page in the paginated results that indicates at least one more page follows.
Type: String Results (p. 75)
A list of MLModel that meet the search criteria.
Type: Array of MLModel (p. 131) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 161).
InternalServerException
An error on the server occurred when trying to process a request.
HTTP Status Code: 500 InvalidInputException
An error on the client occurred. Typically, the cause is an invalid input value.
Examples
HTTP Status Code: 400