

# CreateRealtimeEndpoint
<a name="API_CreateRealtimeEndpoint"></a>

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`.

## Request Syntax
<a name="API_CreateRealtimeEndpoint_RequestSyntax"></a>

```
{
   "MLModelId": "string"
}
```

## Request Parameters
<a name="API_CreateRealtimeEndpoint_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MLModelId](#API_CreateRealtimeEndpoint_RequestSyntax) **   <a name="amazonml-CreateRealtimeEndpoint-request-MLModelId"></a>
The ID assigned to the `MLModel` during creation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

## Response Syntax
<a name="API_CreateRealtimeEndpoint_ResponseSyntax"></a>

```
{
   "MLModelId": "string",
   "RealtimeEndpointInfo": { 
      "CreatedAt": number,
      "EndpointStatus": "string",
      "EndpointUrl": "string",
      "PeakRequestsPerSecond": number
   }
}
```

## Response Elements
<a name="API_CreateRealtimeEndpoint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [MLModelId](#API_CreateRealtimeEndpoint_ResponseSyntax) **   <a name="amazonml-CreateRealtimeEndpoint-response-MLModelId"></a>
A user-supplied ID that uniquely identifies the `MLModel`. This value should be identical to the value of the `MLModelId` in the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_.-]+` 

 ** [RealtimeEndpointInfo](#API_CreateRealtimeEndpoint_ResponseSyntax) **   <a name="amazonml-CreateRealtimeEndpoint-response-RealtimeEndpointInfo"></a>
The endpoint information of the `MLModel`   
Type: [RealtimeEndpointInfo](API_RealtimeEndpointInfo.md) object

## Errors
<a name="API_CreateRealtimeEndpoint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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
<a name="API_CreateRealtimeEndpoint_Examples"></a>

### The following is a sample request and response of the CreateRealtimeEndpoint operation.
<a name="API_CreateRealtimeEndpoint_Example_1"></a>

This example illustrates one usage of CreateRealtimeEndpoint.

#### Sample Request
<a name="API_CreateRealtimeEndpoint_Example_1_Request"></a>

```
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.CreateRealtimeEndpoint
{
  "MLModelId": "ml-ModelExampleId",
}
```

#### Sample Response
<a name="API_CreateRealtimeEndpoint_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
  "MLModelId": "ml-ModelExampleId", 
  "EndpointInfo": 
  {
    "CreatedAt": 1422488124.71, 
    "EndpointUrl": "<realtime endpoint from Amazon Machine Learning for ml-ModelExampleId>", 
    "EndpointStatus": "READY", 
    "PeakRequestsPerSecond": 200
  }
}
```

## See Also
<a name="API_CreateRealtimeEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/machinelearning-2014-12-12/CreateRealtimeEndpoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/machinelearning-2014-12-12/CreateRealtimeEndpoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/machinelearning-2014-12-12/CreateRealtimeEndpoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/machinelearning-2014-12-12/CreateRealtimeEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/machinelearning-2014-12-12/CreateRealtimeEndpoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/machinelearning-2014-12-12/CreateRealtimeEndpoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/machinelearning-2014-12-12/CreateRealtimeEndpoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/machinelearning-2014-12-12/CreateRealtimeEndpoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/machinelearning-2014-12-12/CreateRealtimeEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/machinelearning-2014-12-12/CreateRealtimeEndpoint) 