Skip to content

delete_coip_pool

delete_coip_pool(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    coip_pool_id: Optional[Ipv4PoolCoipId] = None,
    dry_run: Optional[Boolean] = None,
) -> DeleteCoipPoolResult

Deletes a pool of customer-owned IP (CoIP) addresses.

Parameters:

  • coip_pool_id (Optional[Ipv4PoolCoipId], default: None ) –

    The ID of the CoIP pool that you want to delete.

  • 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 delete_coip_pool(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    coip_pool_id: Optional[
        "capo_ec2.types.ipv4_pool_coip_id.Ipv4PoolCoipId"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.delete_coip_pool_result.DeleteCoipPoolResult":
    """<p>Deletes a pool of customer-owned IP (CoIP) addresses. </p>

    Args:
        coip_pool_id: <p>The ID of the CoIP pool that you want to delete. </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.delete_coip_pool_request.DeleteCoipPoolRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.delete_coip_pool_result.DeleteCoipPoolResult"
    ]:
        import capo_ec2._operations.amazon_ec2.delete_coip_pool

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteCoipPool")
    )
    input_: capo_ec2.types.delete_coip_pool_request.DeleteCoipPoolRequest = {}
    if coip_pool_id is not None:
        input_["coip_pool_id"] = coip_pool_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