EC2 / Client / modify_ipam_pool_allocation

modify_ipam_pool_allocation

EC2.Client.modify_ipam_pool_allocation(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.modify_ipam_pool_allocation(
    DryRun=True|False,
    IpamPoolAllocationId='string',
    Description='string'
)
Parameters:

  • DryRun (boolean) – 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.

  • IpamPoolAllocationId (string) –

    [REQUIRED]

    The ID of the IPAM pool allocation you want to modify.

  • Description (string) – The new description for the IPAM pool allocation. If you submit a null value, the description is removed from the allocation.

Return type:

dict

Returns:

Response Syntax

{
    'IpamPoolAllocation': {
        'Cidr': 'string',
        'IpamPoolAllocationId': 'string',
        'Description': 'string',
        'ResourceId': 'string',
        'ResourceType': 'ipam-pool'|'vpc'|'ec2-public-ipv4-pool'|'custom'|'subnet'|'eip'|'anycast-ip-list',
        'ResourceRegion': 'string',
        'ResourceOwner': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • IpamPoolAllocation (dict) –

      The modified IPAM pool allocation.

      • Cidr (string) –

        The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.

      • IpamPoolAllocationId (string) –

        The ID of an allocation.

      • Description (string) –

        A description of the pool allocation.

      • ResourceId (string) –

        The ID of the resource.

      • ResourceType (string) –

        The type of the resource.

      • ResourceRegion (string) –

        The Amazon Web Services Region of the resource.

      • ResourceOwner (string) –

        The owner of the resource.

      • Tags (list) –

        The tags for the IPAM pool allocation.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.