2025/04/30 - Amazon Elastic Compute Cloud - 4 updated api methods
Changes Launch of cost distribution feature for IPAM owners to distribute costs to internal teams.
{'MeteredAccount': 'ipam-owner | resource-owner'}
Response {'Ipam': {'MeteredAccount': 'ipam-owner | resource-owner'}}
Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.
For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.
See also: AWS API Documentation
Request Syntax
client.create_ipam(
DryRun=True|False,
Description='string',
OperatingRegions=[
{
'RegionName': 'string'
},
],
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ClientToken='string',
Tier='free'|'advanced',
EnablePrivateGua=True|False,
MeteredAccount='ipam-owner'|'resource-owner'
)
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.
string
A description for the IPAM.
list
The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
(dict) --
Add an operating Region to an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
RegionName (string) --
The name of the operating Region.
list
The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
(dict) --
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(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.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
string
IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
boolean
Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
string
A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.
Possible values:
ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
dict
Response Syntax
{
'Ipam': {
'OwnerId': 'string',
'IpamId': 'string',
'IpamArn': 'string',
'IpamRegion': 'string',
'PublicDefaultScopeId': 'string',
'PrivateDefaultScopeId': 'string',
'ScopeCount': 123,
'Description': 'string',
'OperatingRegions': [
{
'RegionName': 'string'
},
],
'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'DefaultResourceDiscoveryId': 'string',
'DefaultResourceDiscoveryAssociationId': 'string',
'ResourceDiscoveryAssociationCount': 123,
'StateMessage': 'string',
'Tier': 'free'|'advanced',
'EnablePrivateGua': True|False,
'MeteredAccount': 'ipam-owner'|'resource-owner'
}
}
Response Structure
(dict) --
Ipam (dict) --
Information about the IPAM created.
OwnerId (string) --
The Amazon Web Services account ID of the owner of the IPAM.
IpamId (string) --
The ID of the IPAM.
IpamArn (string) --
The Amazon Resource Name (ARN) of the IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM.
PublicDefaultScopeId (string) --
The ID of the IPAM's default public scope.
PrivateDefaultScopeId (string) --
The ID of the IPAM's default private scope.
ScopeCount (integer) --
The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.
Description (string) --
The description for the IPAM.
OperatingRegions (list) --
The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
(dict) --
The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
RegionName (string) --
The name of the operating Region.
State (string) --
The state of the IPAM.
Tags (list) --
The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
(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.
DefaultResourceDiscoveryId (string) --
The IPAM's default resource discovery ID.
DefaultResourceDiscoveryAssociationId (string) --
The IPAM's default resource discovery association ID.
ResourceDiscoveryAssociationCount (integer) --
The IPAM's resource discovery association count.
StateMessage (string) --
The state message.
Tier (string) --
IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
EnablePrivateGua (boolean) --
Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
MeteredAccount (string) --
A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.
Possible values:
ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
{'Ipam': {'MeteredAccount': 'ipam-owner | resource-owner'}}
Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.
For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.
See also: AWS API Documentation
Request Syntax
client.delete_ipam(
DryRun=True|False,
IpamId='string',
Cascade=True|False
)
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.
string
[REQUIRED]
The ID of the IPAM to delete.
boolean
Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:
Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.
Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.
Deletes all IPAM pools in private scopes.
Deletes all non-default private scopes in the IPAM.
Deletes the default public and private scopes and the IPAM.
dict
Response Syntax
{
'Ipam': {
'OwnerId': 'string',
'IpamId': 'string',
'IpamArn': 'string',
'IpamRegion': 'string',
'PublicDefaultScopeId': 'string',
'PrivateDefaultScopeId': 'string',
'ScopeCount': 123,
'Description': 'string',
'OperatingRegions': [
{
'RegionName': 'string'
},
],
'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'DefaultResourceDiscoveryId': 'string',
'DefaultResourceDiscoveryAssociationId': 'string',
'ResourceDiscoveryAssociationCount': 123,
'StateMessage': 'string',
'Tier': 'free'|'advanced',
'EnablePrivateGua': True|False,
'MeteredAccount': 'ipam-owner'|'resource-owner'
}
}
Response Structure
(dict) --
Ipam (dict) --
Information about the results of the deletion.
OwnerId (string) --
The Amazon Web Services account ID of the owner of the IPAM.
IpamId (string) --
The ID of the IPAM.
IpamArn (string) --
The Amazon Resource Name (ARN) of the IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM.
PublicDefaultScopeId (string) --
The ID of the IPAM's default public scope.
PrivateDefaultScopeId (string) --
The ID of the IPAM's default private scope.
ScopeCount (integer) --
The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.
Description (string) --
The description for the IPAM.
OperatingRegions (list) --
The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
(dict) --
The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
RegionName (string) --
The name of the operating Region.
State (string) --
The state of the IPAM.
Tags (list) --
The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
(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.
DefaultResourceDiscoveryId (string) --
The IPAM's default resource discovery ID.
DefaultResourceDiscoveryAssociationId (string) --
The IPAM's default resource discovery association ID.
ResourceDiscoveryAssociationCount (integer) --
The IPAM's resource discovery association count.
StateMessage (string) --
The state message.
Tier (string) --
IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
EnablePrivateGua (boolean) --
Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
MeteredAccount (string) --
A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.
Possible values:
ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
{'Ipams': {'MeteredAccount': 'ipam-owner | resource-owner'}}
Get information about your IPAM pools.
For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
See also: AWS API Documentation
Request Syntax
client.describe_ipams(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
IpamIds=[
'string',
]
)
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.
list
One or more filters for the request. For more information about filtering, see Filtering CLI output.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
integer
The maximum number of results to return in the request.
string
The token for the next page of results.
list
The IDs of the IPAMs you want information on.
(string) --
dict
Response Syntax
{
'NextToken': 'string',
'Ipams': [
{
'OwnerId': 'string',
'IpamId': 'string',
'IpamArn': 'string',
'IpamRegion': 'string',
'PublicDefaultScopeId': 'string',
'PrivateDefaultScopeId': 'string',
'ScopeCount': 123,
'Description': 'string',
'OperatingRegions': [
{
'RegionName': 'string'
},
],
'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'DefaultResourceDiscoveryId': 'string',
'DefaultResourceDiscoveryAssociationId': 'string',
'ResourceDiscoveryAssociationCount': 123,
'StateMessage': 'string',
'Tier': 'free'|'advanced',
'EnablePrivateGua': True|False,
'MeteredAccount': 'ipam-owner'|'resource-owner'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Ipams (list) --
Information about the IPAMs.
(dict) --
IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
OwnerId (string) --
The Amazon Web Services account ID of the owner of the IPAM.
IpamId (string) --
The ID of the IPAM.
IpamArn (string) --
The Amazon Resource Name (ARN) of the IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM.
PublicDefaultScopeId (string) --
The ID of the IPAM's default public scope.
PrivateDefaultScopeId (string) --
The ID of the IPAM's default private scope.
ScopeCount (integer) --
The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.
Description (string) --
The description for the IPAM.
OperatingRegions (list) --
The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
(dict) --
The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
RegionName (string) --
The name of the operating Region.
State (string) --
The state of the IPAM.
Tags (list) --
The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
(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.
DefaultResourceDiscoveryId (string) --
The IPAM's default resource discovery ID.
DefaultResourceDiscoveryAssociationId (string) --
The IPAM's default resource discovery association ID.
ResourceDiscoveryAssociationCount (integer) --
The IPAM's resource discovery association count.
StateMessage (string) --
The state message.
Tier (string) --
IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
EnablePrivateGua (boolean) --
Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
MeteredAccount (string) --
A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.
Possible values:
ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
{'MeteredAccount': 'ipam-owner | resource-owner'}
Response {'Ipam': {'MeteredAccount': 'ipam-owner | resource-owner'}}
Modify the configurations of an IPAM.
See also: AWS API Documentation
Request Syntax
client.modify_ipam(
DryRun=True|False,
IpamId='string',
Description='string',
AddOperatingRegions=[
{
'RegionName': 'string'
},
],
RemoveOperatingRegions=[
{
'RegionName': 'string'
},
],
Tier='free'|'advanced',
EnablePrivateGua=True|False,
MeteredAccount='ipam-owner'|'resource-owner'
)
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.
string
[REQUIRED]
The ID of the IPAM you want to modify.
string
The description of the IPAM you want to modify.
list
Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
(dict) --
Add an operating Region to an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
RegionName (string) --
The name of the operating Region.
list
The operating Regions to remove.
(dict) --
Remove an operating Region from an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide
RegionName (string) --
The name of the operating Region you want to remove.
string
IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
boolean
Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
string
A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.
Possible values:
ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
dict
Response Syntax
{
'Ipam': {
'OwnerId': 'string',
'IpamId': 'string',
'IpamArn': 'string',
'IpamRegion': 'string',
'PublicDefaultScopeId': 'string',
'PrivateDefaultScopeId': 'string',
'ScopeCount': 123,
'Description': 'string',
'OperatingRegions': [
{
'RegionName': 'string'
},
],
'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'DefaultResourceDiscoveryId': 'string',
'DefaultResourceDiscoveryAssociationId': 'string',
'ResourceDiscoveryAssociationCount': 123,
'StateMessage': 'string',
'Tier': 'free'|'advanced',
'EnablePrivateGua': True|False,
'MeteredAccount': 'ipam-owner'|'resource-owner'
}
}
Response Structure
(dict) --
Ipam (dict) --
The results of the modification.
OwnerId (string) --
The Amazon Web Services account ID of the owner of the IPAM.
IpamId (string) --
The ID of the IPAM.
IpamArn (string) --
The Amazon Resource Name (ARN) of the IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM.
PublicDefaultScopeId (string) --
The ID of the IPAM's default public scope.
PrivateDefaultScopeId (string) --
The ID of the IPAM's default private scope.
ScopeCount (integer) --
The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.
Description (string) --
The description for the IPAM.
OperatingRegions (list) --
The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
(dict) --
The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
RegionName (string) --
The name of the operating Region.
State (string) --
The state of the IPAM.
Tags (list) --
The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
(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.
DefaultResourceDiscoveryId (string) --
The IPAM's default resource discovery ID.
DefaultResourceDiscoveryAssociationId (string) --
The IPAM's default resource discovery association ID.
ResourceDiscoveryAssociationCount (integer) --
The IPAM's resource discovery association count.
StateMessage (string) --
The state message.
Tier (string) --
IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
EnablePrivateGua (boolean) --
Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
MeteredAccount (string) --
A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.
Possible values:
ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.