Skip to content

enable_address_transfer

enable_address_transfer(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    allocation_id: Optional[AllocationId] = None,
    transfer_account_id: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
) -> EnableAddressTransferResult

Enables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.

Parameters:

  • allocation_id (Optional[AllocationId], default: None ) –

    The allocation ID of an Elastic IP address.

  • transfer_account_id (Optional[String], default: None ) –

    The ID of the account that you want to transfer the Elastic IP address to.

  • dry_run (Optional[Boolean], default: None ) –

    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 DryRunOperation. Otherwise, it is UnauthorizedOperation.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def enable_address_transfer(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    allocation_id: Optional["capo_ec2.types.allocation_id.AllocationId"] = None,
    transfer_account_id: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.enable_address_transfer_result.EnableAddressTransferResult":
    """<p>Enables Elastic IP address transfer. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro">Transfer Elastic IP addresses</a> in the <i>Amazon VPC User Guide</i>.</p>

    Args:
        allocation_id: <p>The allocation ID of an Elastic IP address.</p>
        transfer_account_id: <p>The ID of the account that you want to transfer the Elastic IP address to.</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.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.enable_address_transfer_request.EnableAddressTransferRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.enable_address_transfer_result.EnableAddressTransferResult"
    ]:
        import capo_ec2._operations.amazon_ec2.enable_address_transfer

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("EnableAddressTransfer")
    )
    input_: capo_ec2.types.enable_address_transfer_request.EnableAddressTransferRequest = {}
    if allocation_id is not None:
        input_["allocation_id"] = allocation_id
    if transfer_account_id is not None:
        input_["transfer_account_id"] = transfer_account_id
    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