Skip to content

associate_eip_to_vlan async

associate_eip_to_vlan(
    environment_id: EnvironmentId,
    vlan_name: str,
    allocation_id: AllocationId,
    *,
    config_overrides: Optional[AsyncevsClientConfig] = None,
    client_token: Optional[ClientToken] = None,
) -> AssociateEipToVlanResponse

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

Parameters:

  • client_token (Optional[ClientToken], default: None ) –

    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.

  • environment_id (EnvironmentId) –

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

  • vlan_name (str) –

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

  • allocation_id (AllocationId) –

    The Elastic IP address allocation ID.

Raises:

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

  • ThrottlingException –

    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.

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

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_evs/_services/async_evs.py
async 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[AsyncevsClientConfig] = 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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_evs.types.associate_eip_to_vlan_request.AssociateEipToVlanRequest]",
    ) -> AsyncOperationResponse[
        "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,
        ) = await capo_evs._operations.amazon_elastic_v_mware_service.associate_eip_to_vlan.async_associate_eip_to_vlan(
            req.options, req.input
        )
        return AsyncOperationResponse(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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output