release_address ¶

def release_address(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    allocation_id: Optional["capo_ec2.types.allocation_id.AllocationId"] = None,
    public_ip: Optional["capo_ec2.types.string.String"] = None,
    network_border_group: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> None:
    """<p>Releases the specified Elastic IP address.</p> <p>[Default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. Alternatively, you can disassociate an Elastic IP address without releasing it.</p> <p>[Nondefault VPC] You must disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (<code>InvalidIPAddress.InUse</code>).</p> <p>After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an <code>AuthFailure</code> error if the address is already allocated to another Amazon Web Services account.</p> <p>After you release an Elastic IP address, you might be able to recover it. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing-eips-releasing.html">Release an Elastic IP address</a>.</p>

    Args:
        allocation_id: <p>The allocation ID. This parameter is required.</p>
        public_ip: <p>Deprecated.</p>
        network_border_group: <p>The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.</p> <p>If you provide an incorrect network border group, you receive an <code>InvalidAddress.NotFound</code> error.</p>
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To release an Elastic IP address
        This example releases the specified Elastic IP address.

        >>> client.release_address(allocation_id='eipalloc-64d5890a')
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.release_address_request.ReleaseAddressRequest]",
    ) -> OperationResponse[None]:
        import capo_ec2._operations.amazon_ec2.release_address

        output, http_response = (
            capo_ec2._operations.amazon_ec2.release_address.release_address(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ReleaseAddress")
    )
    input_: capo_ec2.types.release_address_request.ReleaseAddressRequest = {}
    if allocation_id is not None:
        input_["allocation_id"] = allocation_id
    if public_ip is not None:
        input_["public_ip"] = public_ip
    if network_border_group is not None:
        input_["network_border_group"] = network_border_group
    if dry_run is not None:
        input_["dry_run"] = dry_run

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