UpdateBatchPrediction
Updates the BatchPredictionName of a BatchPrediction.
You can use the GetBatchPrediction operation to view the contents of the updated data element.
Request Syntax
{
"BatchPredictionId": "string",
"BatchPredictionName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- BatchPredictionId
-
The ID assigned to the
BatchPredictionduring creation.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_.-]+Required: Yes
- BatchPredictionName
-
A new user-supplied name or description of the
BatchPrediction.Type: String
Length Constraints: Maximum length of 1024.
Pattern:
.*\S.*|^$Required: Yes
Response Syntax
{
"BatchPredictionId": "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.
- BatchPredictionId
-
The ID assigned to the
BatchPredictionduring creation. This value should be identical to the value of theBatchPredictionIdin the request.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_.-]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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
- ResourceNotFoundException
-
A specified resource cannot be located.
HTTP Status Code: 400
Examples
The following is a sample request and response of the UpdateBatchPrediction operation.
This example illustrates one usage of UpdateBatchPrediction.
Sample Request
POST / HTTP/1.1
Host: machinelearning.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=contenttype;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid,Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AmazonML_20141212.UpdateBatchPrediction
{
"BatchPredictionId": "bp-exampleBatchPredictionId",
"BatchPredictionName": "bp-exampleBatchPredictionName"
}Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{"BatchPredictionId": "bp-exampleBatchPredictionId"}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
