Skip to content

docs(ec2): Add examples for modify/describe ipam-pool-allocation APIs #10396

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ashovlin merged 1 commit into from
Jun 19, 2026
+93 −0
Merged

docs(ec2): Add examples for modify/describe ipam-pool-allocation APIs #10396

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions awscli/examples/ec2/describe-ipam-pool-allocations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
**Example 1: To describe all your IPAM pool allocations**

The following ``describe-ipam-pool-allocations`` example describes all IPAM pool allocations owned by you.

(Linux)::
Comment thread
ashovlin marked this conversation as resolved.

aws ec2 describe-ipam-pool-allocations

(Windows)::

aws ec2 describe-ipam-pool-allocations

Output::

{
"IpamPoolAllocations": [
{
"Cidr": "10.0.0.0/24",
"IpamPoolAllocationId": "ipam-pool-alloc-018ecc28043b54ba38e2cd99943cebfbd",
"Description": "Engineering team allocation",
"ResourceType": "custom",
"ResourceOwner": "123456789012",
"Tags": []
},
{
"Cidr": "10.0.1.0/24",
"IpamPoolAllocationId": "ipam-pool-alloc-0e6186d73999e47389266a5d6991e6220",
"ResourceType": "custom",
"ResourceOwner": "123456789012",
"Tags": []
}
]
}

**Example 2: To describe a specific IPAM pool allocation**

The following ``describe-ipam-pool-allocations`` example describes a specific IPAM pool allocation by its ID.

(Linux)::

aws ec2 describe-ipam-pool-allocations \
--ipam-pool-allocation-ids ipam-pool-alloc-018ecc28043b54ba38e2cd99943cebfbd

(Windows)::

aws ec2 describe-ipam-pool-allocations ^
--ipam-pool-allocation-ids ipam-pool-alloc-018ecc28043b54ba38e2cd99943cebfbd

Output::

{
"IpamPoolAllocations": [
{
"Cidr": "10.0.0.0/24",
"IpamPoolAllocationId": "ipam-pool-alloc-018ecc28043b54ba38e2cd99943cebfbd",
"Description": "Engineering team allocation",
"ResourceType": "custom",
"ResourceOwner": "123456789012",
"Tags": []
}
]
}

For more information, see `View allocations for a pool <https://docs.aws.amazon.com/vpc/latest/ipam/view-alloc-ipam.html>`__ in the *Amazon VPC IPAM User Guide*.
29 changes: 29 additions & 0 deletions awscli/examples/ec2/modify-ipam-pool-allocation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
**To modify an IPAM pool allocation**

The following ``modify-ipam-pool-allocation`` example modifies the description of an IPAM pool allocation.

(Linux)::

aws ec2 modify-ipam-pool-allocation \
--ipam-pool-allocation-id ipam-pool-alloc-018ecc28043b54ba38e2cd99943cebfbd \
--description "Engineering team us-west-2 allocation"

(Windows)::

aws ec2 modify-ipam-pool-allocation ^
--ipam-pool-allocation-id ipam-pool-alloc-018ecc28043b54ba38e2cd99943cebfbd ^
--description "Engineering team us-west-2 allocation"

Output::

{
"IpamPoolAllocation": {
"Cidr": "10.0.0.0/24",
"IpamPoolAllocationId": "ipam-pool-alloc-018ecc28043b54ba38e2cd99943cebfbd",
"Description": "Engineering team us-west-2 allocation",
"ResourceType": "custom",
"ResourceOwner": "123456789012"
}
}

For more information, see `Modify an IPAM pool allocation <https://docs.aws.amazon.com/vpc/latest/ipam/modify-alloc-ipam.html>`__ in the *Amazon VPC IPAM User Guide*.
Loading