Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateEnvironmentHost

Creates an ESXi host and adds it to an Amazon EVS environment. Amazon EVS supports 4-16 hosts per environment.

This action can only be used after the Amazon EVS environment is deployed.

You can use the dedicatedHostId parameter to specify an Amazon EC2 Dedicated Host for ESXi host creation.

You can use the placementGroupId parameter to specify a cluster or partition placement group to launch EC2 instances into.

Note

You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironmentHost action. This results in a ValidationException response.

Request Syntax


{
   "clientToken": "string",
   "environmentId": "string",
   "host": { 
      "dedicatedHostId": "string",
      "hostName": "string",
      "instanceType": "string",
      "keyName": "string",
      "placementGroupId": "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.

Note

In the following list, the required parameters are described first.

environmentId

A unique ID for the environment that the host is added to.

Type: String

Pattern: (env-[a-zA-Z0-9]{10})

Required: Yes

host

The host that is created and added to the environment.

Type: HostInfoForCreate object

Required: Yes

clientToken

Note

This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.

A unique, case-sensitive identifier that you provide to ensure the idempotency of the host creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [!-~]+

Required: No

Response Syntax


{
   "environmentSummary": { 
      "createdAt": number,
      "environmentArn": "string",
      "environmentId": "string",
      "environmentName": "string",
      "environmentState": "string",
      "environmentStatus": "string",
      "modifiedAt": number,
      "vcfVersion": "string"
   },
   "host": { 
      "createdAt": number,
      "dedicatedHostId": "string",
      "ec2InstanceId": "string",
      "hostName": "string",
      "hostState": "string",
      "instanceType": "string",
      "ipAddress": "string",
      "keyName": "string",
      "modifiedAt": number,
      "networkInterfaces": [ 
         { 
            "networkInterfaceId": "string"
         }
      ],
      "placementGroupId": "string",
      "stateDetails": "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.

environmentSummary

A summary of the environment that the host is created in.

Type: EnvironmentSummary object

host

A description of the created host.

Type: Host object

Errors

For information about the errors that are common to all actions, see Common Errors.

ThrottlingException

The CreateEnvironmentHost operation couldn't be performed because the service is throttling requests. This exception is thrown when the CreateEnvironmentHost request exceeds concurrency of 1 transaction per second (TPS).

HTTP Status Code: 400

ValidationException

The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.

HTTP Status Code: 400