Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

AssociateEipToVlan

Associates an Elastic IP address with a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.

Request Syntax


{
   "allocationId": "string",
   "clientToken": "string",
   "environmentId": "string",
   "vlanName": "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.

allocationId

The Elastic IP address allocation ID.

Type: String

Length Constraints: Minimum length of 9. Maximum length of 26.

Pattern: eipalloc-[a-zA-Z0-9_-]+

Required: Yes

environmentId

A unique ID for the environment containing the VLAN that the Elastic IP address associates with.

Type: String

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

Required: Yes

vlanName

The name of the VLAN. hcx is the only accepted VLAN name at this time.

Type: String

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

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 environment 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


{
   "vlan": { 
      "availabilityZone": "string",
      "cidr": "string",
      "createdAt": number,
      "eipAssociations": [ 
         { 
            "allocationId": "string",
            "associationId": "string",
            "ipAddress": "string"
         }
      ],
      "functionName": "string",
      "isPublic": boolean,
      "modifiedAt": number,
      "networkAclId": "string",
      "stateDetails": "string",
      "subnetId": "string",
      "vlanId": number,
      "vlanState": "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.

vlan

The VLANs that Amazon EVS creates during environment creation.

Type: Vlan object

Errors

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

ResourceNotFoundException

A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.

HTTP Status Code: 400

ThrottlingException

The operation couldn't be performed because the service is throttling requests. This exception is thrown when there are too many requests accepted concurrently from the service endpoint.

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