modify_ipam_pool_allocation `async` ¶

modify_ipam_pool_allocation(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    ipam_pool_allocation_id: Optional[IpamPoolAllocationId] = None,
    description: Optional[String] = None,
) -> ModifyIpamPoolAllocationResult

Modifies the description of an IPAM pool allocation. For more information, see Modify an IPAM pool allocation in the Amazon VPC IPAM User Guide.

Parameters:

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

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 DryRunOperation. Otherwise, it is UnauthorizedOperation.
ipam_pool_allocation_id (Optional[IpamPoolAllocationId], default: None ) –

The ID of the IPAM pool allocation you want to modify.
description (Optional[String], default: None ) –

The new description for the IPAM pool allocation. If you submit a null value, the description is removed from the allocation.

Raises:

UnknownServiceError –

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

Source code in docs_src/capo_ec2/_services/async_ec2.py

async def modify_ipam_pool_allocation(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = 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.
    """

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

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.modify_ipam_pool_allocation.async_modify_ipam_pool_allocation(
            req.options, req.input
        )
        return AsyncOperationResponse(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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

modify_ipam_pool_allocation async ¶

modify_ipam_pool_allocation `async` ¶