modify_ipam_pool_allocation ¶

def modify_ipam_pool_allocation(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    ipam_pool_allocation_id: Optional[
        "capo_ec2.types.ipam_pool_allocation_id.IpamPoolAllocationId"
    ] = None,
    description: Optional["capo_ec2.types.string.String"] = None,
) -> "capo_ec2.types.modify_ipam_pool_allocation_result.ModifyIpamPoolAllocationResult":
    """<p>Modifies the description of an IPAM pool allocation. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/ipam/modify-alloc-ipam.html">Modify an IPAM pool allocation</a> in the <i>Amazon VPC IPAM User Guide</i>.</p>

    Args:
        dry_run: <p>A check for 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>
        ipam_pool_allocation_id: <p>The ID of the IPAM pool allocation you want to modify.</p>
        description: <p>The new description for the IPAM pool allocation. If you submit a <code>null</code> value, the description is removed from the allocation.</p>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.modify_ipam_pool_allocation_request.ModifyIpamPoolAllocationRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.modify_ipam_pool_allocation_result.ModifyIpamPoolAllocationResult"
    ]:
        import capo_ec2._operations.amazon_ec2.modify_ipam_pool_allocation

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifyIpamPoolAllocation")
    )
    input_: capo_ec2.types.modify_ipam_pool_allocation_request.ModifyIpamPoolAllocationRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if ipam_pool_allocation_id is not None:
        input_["ipam_pool_allocation_id"] = ipam_pool_allocation_id
    if description is not None:
        input_["description"] = description

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