] }
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. 57)
The ID of the next page in the paginated results that indicates at least one more page follows.
Type: String Results (p. 57)
A list of BatchPrediction objects that meet the search criteria.
Type: Array of BatchPrediction (p. 122) 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 DescribeBatchPredictions operation.
This example illustrates one usage of DescribeBatchPredictions.
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": "bp-", "SortOrder": "asc", "Limit": 1
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
"BatchPredictionDataSourceId": "ds-exampleDataSourceId", "BatchPredictionId": "bp-exampleBatchPredictionId", "CreatedAt": 1422057670.697,
"CreatedByIamUser": "arn:aws:iam::<awsAccountId>:user/username",
"InputDataLocationS3": "s3://bucket/locationToInput/example-data.testing.csv", "LastUpdatedAt": 1422057811.431,
"MLModelId": "pr-exampleModelId", "Name": "bp-exampleBatchPredictionName", "OutputUri": "s3://bucket/locationToLogs/", "Status": "COMPLETED",
"ComputeTime":"185200",
"FinishedAt":"1422057711.192", "StartedAt":"14220557678.324", "TotalRecordCount":"21154", "InvalidRecordCount":"0"
} ]}
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
• AWS SDK for JavaScript
See Also
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeDataSources
DescribeDataSources
Returns a list of DataSource 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. 61)
The equal to operator. The DataSource 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. 61)
Use one of the following variables to filter a list of DataSource:
• CreatedAt - Sets the search criteria to DataSource creation dates.
• Status - Sets the search criteria to DataSource statuses.
• Name - Sets the search criteria to the contents of DataSource Name.
• DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
• IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.
Type: String
Valid Values: CreatedAt | LastUpdatedAt | Status | Name | DataLocationS3 | IAMUser
Required: No
Request Parameters
GE (p. 61)
The greater than or equal to operator. The DataSource 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. 61)
The greater than operator. The DataSource 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. 61)
The less than or equal to operator. The DataSource 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. 61)
The maximum number of DataSource to include in the result.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No LT (p. 61)
The less than operator. The DataSource results will have FilterVariable values that are less than the value specified with LT.
Type: String
Length Constraints: Maximum length of 1024.
Pattern: .*\S.*|^$
Required: No NE (p. 61)
The not equal to operator. The DataSource results will have FilterVariable values not equal to the value specified with NE.
Response Syntax
Type: String
Length Constraints: Maximum length of 1024.
Pattern: .*\S.*|^$
Required: No NextToken (p. 61)
The ID of the page in the paginated results.
Type: String Required: No Prefix (p. 61)
A string that is found at the beginning of a variable, such as Name or Id.
For example, a DataSource could have the Name 2014-09-09-HolidayGiftMailer. To search for this DataSource, 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. 61)
A two-value parameter that determines the sequence of the resulting list of DataSource.
• 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", "Results": [
{
"ComputeStatistics": boolean, "ComputeTime": number, "CreatedAt": number,
"CreatedByIamUser": "string", "DataLocationS3": "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. 63)
An ID of the next page in the paginated results that indicates at least one more page follows.
Type: String Results (p. 63)
A list of DataSource that meet the search criteria.
Type: Array of DataSource (p. 125) 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
Examples
InvalidInputException
An error on the client occurred. Typically, the cause is an invalid input value.
HTTP Status Code: 400