associate_eip_to_vlan ¶

def associate_eip_to_vlan(
    self,
    environment_id: "capo_evs.types.environment_id.EnvironmentId",
    vlan_name: str,
    allocation_id: "capo_evs.types.allocation_id.AllocationId",
    *,
    config_overrides: Optional[evsClientConfig] = None,
    client_token: Optional["capo_evs.types.client_token.ClientToken"] = None,
) -> "capo_evs.types.associate_eip_to_vlan_response.AssociateEipToVlanResponse":
    """<p>Associates an Elastic IP address with a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.</p>

    Args:
        client_token: <note> <p>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</p> </note> <p>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.</p>
        environment_id: <p>A unique ID for the environment containing the VLAN that the Elastic IP address associates with.</p>
        vlan_name: <p>The name of the VLAN. <code>hcx</code> is the only accepted VLAN name at this time.</p>
        allocation_id: <p>The Elastic IP address allocation ID.</p>

    Raises:
        capo_evs.errors.resource_not_found_exception.ResourceNotFoundException: <p>A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a <code>state</code> of <code>DELETED</code>.</p>
        capo_evs.errors.throttling_exception.ThrottlingException: <p>The operation could not be performed because the service is throttling requests. This exception is thrown when the service endpoint receives too many concurrent requests.</p>
        capo_evs.errors.validation_exception.ValidationException: <p>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.</p>
        capo_evs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_evs.types.associate_eip_to_vlan_request.AssociateEipToVlanRequest]",
    ) -> OperationResponse[
        "capo_evs.types.associate_eip_to_vlan_response.AssociateEipToVlanResponse"
    ]:
        import capo_evs._operations.amazon_elastic_v_mware_service.associate_eip_to_vlan

        output, http_response = (
            capo_evs._operations.amazon_elastic_v_mware_service.associate_eip_to_vlan.associate_eip_to_vlan(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AssociateEipToVlan")
    )
    input_: capo_evs.types.associate_eip_to_vlan_request.AssociateEipToVlanRequest = {
        "environment_id": environment_id,
        "vlan_name": vlan_name,
        "allocation_id": allocation_id,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output