2022/05/06 - Amazon Elastic Compute Cloud - 12 updated api methods
Changes Add new state values for IPAMs, IPAM Scopes, and IPAM Pools.
{'Ipam': {'State': {'isolate-complete',
'isolate-in-progress',
'restore-in-progress'}}}
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'|'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-route-table'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-service'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ClientToken='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 .
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.
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.
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'
},
]
}
}
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 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.
{'IpamPool': {'State': {'isolate-complete',
'isolate-in-progress',
'restore-in-progress'}}}
Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.
For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide .
See also: AWS API Documentation
Request Syntax
client.create_ipam_pool(
DryRun=True|False,
IpamScopeId='string',
Locale='string',
SourceIpamPoolId='string',
Description='string',
AddressFamily='ipv4'|'ipv6',
AutoImport=True|False,
PubliclyAdvertisable=True|False,
AllocationMinNetmaskLength=123,
AllocationMaxNetmaskLength=123,
AllocationDefaultNetmaskLength=123,
AllocationResourceTags=[
{
'Key': 'string',
'Value': 'string'
},
],
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'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-route-table'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-service'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ClientToken='string',
AwsService='ec2'
)
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 scope in which you would like to create the IPAM pool.
string
In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.
Possible values: Any Amazon Web Services Region, such as us-east-1.
string
The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range.
string
A description for the IPAM pool.
string
[REQUIRED]
The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.
boolean
If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
boolean
Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4 .
integer
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
integer
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
integer
The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
list
Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
(dict) --
A tag on an IPAM resource.
Key (string) --
The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Value (string) --
The value for the tag.
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.
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
Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
dict
Response Syntax
{
'IpamPool': {
'OwnerId': 'string',
'IpamPoolId': 'string',
'SourceIpamPoolId': 'string',
'IpamPoolArn': 'string',
'IpamScopeArn': 'string',
'IpamScopeType': 'public'|'private',
'IpamArn': 'string',
'IpamRegion': 'string',
'Locale': 'string',
'PoolDepth': 123,
'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',
'StateMessage': 'string',
'Description': 'string',
'AutoImport': True|False,
'PubliclyAdvertisable': True|False,
'AddressFamily': 'ipv4'|'ipv6',
'AllocationMinNetmaskLength': 123,
'AllocationMaxNetmaskLength': 123,
'AllocationDefaultNetmaskLength': 123,
'AllocationResourceTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AwsService': 'ec2'
}
}
Response Structure
(dict) --
IpamPool (dict) --
Information about the IPAM pool created.
OwnerId (string) --
The Amazon Web Services account ID of the owner of the IPAM pool.
IpamPoolId (string) --
The ID of the IPAM pool.
SourceIpamPoolId (string) --
The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.
IpamPoolArn (string) --
The ARN of the IPAM pool.
IpamScopeArn (string) --
The ARN of the scope of the IPAM pool.
IpamScopeType (string) --
In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
IpamArn (string) --
The ARN of the IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM pool.
Locale (string) --
The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.
PoolDepth (integer) --
The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide .
State (string) --
The state of the IPAM pool.
StateMessage (string) --
A message related to the failed creation of an IPAM pool.
Description (string) --
The description of the IPAM pool.
AutoImport (boolean) --
If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
PubliclyAdvertisable (boolean) --
Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4 .
AddressFamily (string) --
The address family of the pool.
AllocationMinNetmaskLength (integer) --
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
AllocationMaxNetmaskLength (integer) --
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
AllocationDefaultNetmaskLength (integer) --
The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
AllocationResourceTags (list) --
Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
(dict) --
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.
Key (string) --
The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Value (string) --
The value of the tag.
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.
AwsService (string) --
Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
{'IpamScope': {'State': {'isolate-complete',
'isolate-in-progress',
'restore-in-progress'}}}
Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
For more information, see Add a scope in the Amazon VPC IPAM User Guide .
See also: AWS API Documentation
Request Syntax
client.create_ipam_scope(
DryRun=True|False,
IpamId='string',
Description='string',
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'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-route-table'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-service'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ClientToken='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 .
string
[REQUIRED]
The ID of the IPAM for which you're creating this scope.
string
A description for the scope you're creating.
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.
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.
dict
Response Syntax
{
'IpamScope': {
'OwnerId': 'string',
'IpamScopeId': 'string',
'IpamScopeArn': 'string',
'IpamArn': 'string',
'IpamRegion': 'string',
'IpamScopeType': 'public'|'private',
'IsDefault': True|False,
'Description': 'string',
'PoolCount': 123,
'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'
},
]
}
}
Response Structure
(dict) --
IpamScope (dict) --
Information about the created scope.
OwnerId (string) --
The Amazon Web Services account ID of the owner of the scope.
IpamScopeId (string) --
The ID of the scope.
IpamScopeArn (string) --
The ARN of the scope.
IpamArn (string) --
The ARN of the IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM scope.
IpamScopeType (string) --
The type of the scope.
IsDefault (boolean) --
Defines if the scope is the default scope or not.
Description (string) --
The description of the scope.
PoolCount (integer) --
The number of pools in the scope.
State (string) --
The state of the IPAM scope.
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.
{'Ipam': {'State': {'isolate-complete',
'isolate-in-progress',
'restore-in-progress'}}}
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.
Note
No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.
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'
},
]
}
}
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 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.
{'IpamPool': {'State': {'isolate-complete',
'isolate-in-progress',
'restore-in-progress'}}}
Delete an IPAM pool.
Note
You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see ReleaseIpamPoolAllocation . To deprovision pool CIDRs, see DeprovisionIpamPoolCidr .
For more information, see Delete a pool in the Amazon VPC IPAM User Guide .
See also: AWS API Documentation
Request Syntax
client.delete_ipam_pool(
DryRun=True|False,
IpamPoolId='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 .
string
[REQUIRED]
The ID of the pool to delete.
dict
Response Syntax
{
'IpamPool': {
'OwnerId': 'string',
'IpamPoolId': 'string',
'SourceIpamPoolId': 'string',
'IpamPoolArn': 'string',
'IpamScopeArn': 'string',
'IpamScopeType': 'public'|'private',
'IpamArn': 'string',
'IpamRegion': 'string',
'Locale': 'string',
'PoolDepth': 123,
'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',
'StateMessage': 'string',
'Description': 'string',
'AutoImport': True|False,
'PubliclyAdvertisable': True|False,
'AddressFamily': 'ipv4'|'ipv6',
'AllocationMinNetmaskLength': 123,
'AllocationMaxNetmaskLength': 123,
'AllocationDefaultNetmaskLength': 123,
'AllocationResourceTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AwsService': 'ec2'
}
}
Response Structure
(dict) --
IpamPool (dict) --
Information about the results of the deletion.
OwnerId (string) --
The Amazon Web Services account ID of the owner of the IPAM pool.
IpamPoolId (string) --
The ID of the IPAM pool.
SourceIpamPoolId (string) --
The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.
IpamPoolArn (string) --
The ARN of the IPAM pool.
IpamScopeArn (string) --
The ARN of the scope of the IPAM pool.
IpamScopeType (string) --
In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
IpamArn (string) --
The ARN of the IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM pool.
Locale (string) --
The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.
PoolDepth (integer) --
The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide .
State (string) --
The state of the IPAM pool.
StateMessage (string) --
A message related to the failed creation of an IPAM pool.
Description (string) --
The description of the IPAM pool.
AutoImport (boolean) --
If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
PubliclyAdvertisable (boolean) --
Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4 .
AddressFamily (string) --
The address family of the pool.
AllocationMinNetmaskLength (integer) --
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
AllocationMaxNetmaskLength (integer) --
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
AllocationDefaultNetmaskLength (integer) --
The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
AllocationResourceTags (list) --
Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
(dict) --
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.
Key (string) --
The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Value (string) --
The value of the tag.
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.
AwsService (string) --
Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
{'IpamScope': {'State': {'isolate-complete',
'isolate-in-progress',
'restore-in-progress'}}}
Delete the scope for an IPAM. You cannot delete the default scopes.
For more information, see Delete a scope in the Amazon VPC IPAM User Guide .
See also: AWS API Documentation
Request Syntax
client.delete_ipam_scope(
DryRun=True|False,
IpamScopeId='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 .
string
[REQUIRED]
The ID of the scope to delete.
dict
Response Syntax
{
'IpamScope': {
'OwnerId': 'string',
'IpamScopeId': 'string',
'IpamScopeArn': 'string',
'IpamArn': 'string',
'IpamRegion': 'string',
'IpamScopeType': 'public'|'private',
'IsDefault': True|False,
'Description': 'string',
'PoolCount': 123,
'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'
},
]
}
}
Response Structure
(dict) --
IpamScope (dict) --
Information about the results of the deletion.
OwnerId (string) --
The Amazon Web Services account ID of the owner of the scope.
IpamScopeId (string) --
The ID of the scope.
IpamScopeArn (string) --
The ARN of the scope.
IpamArn (string) --
The ARN of the IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM scope.
IpamScopeType (string) --
The type of the scope.
IsDefault (boolean) --
Defines if the scope is the default scope or not.
Description (string) --
The description of the scope.
PoolCount (integer) --
The number of pools in the scope.
State (string) --
The state of the IPAM scope.
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.
{'IpamPools': {'State': {'isolate-complete',
'isolate-in-progress',
'restore-in-progress'}}}
Get information about your IPAM pools.
See also: AWS API Documentation
Request Syntax
client.describe_ipam_pools(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
IpamPoolIds=[
'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.
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 IPAM pools you would like information on.
(string) --
dict
Response Syntax
{
'NextToken': 'string',
'IpamPools': [
{
'OwnerId': 'string',
'IpamPoolId': 'string',
'SourceIpamPoolId': 'string',
'IpamPoolArn': 'string',
'IpamScopeArn': 'string',
'IpamScopeType': 'public'|'private',
'IpamArn': 'string',
'IpamRegion': 'string',
'Locale': 'string',
'PoolDepth': 123,
'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',
'StateMessage': 'string',
'Description': 'string',
'AutoImport': True|False,
'PubliclyAdvertisable': True|False,
'AddressFamily': 'ipv4'|'ipv6',
'AllocationMinNetmaskLength': 123,
'AllocationMaxNetmaskLength': 123,
'AllocationDefaultNetmaskLength': 123,
'AllocationResourceTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AwsService': 'ec2'
},
]
}
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.
IpamPools (list) --
Information about the IPAM pools.
(dict) --
In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.
OwnerId (string) --
The Amazon Web Services account ID of the owner of the IPAM pool.
IpamPoolId (string) --
The ID of the IPAM pool.
SourceIpamPoolId (string) --
The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.
IpamPoolArn (string) --
The ARN of the IPAM pool.
IpamScopeArn (string) --
The ARN of the scope of the IPAM pool.
IpamScopeType (string) --
In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
IpamArn (string) --
The ARN of the IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM pool.
Locale (string) --
The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.
PoolDepth (integer) --
The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide .
State (string) --
The state of the IPAM pool.
StateMessage (string) --
A message related to the failed creation of an IPAM pool.
Description (string) --
The description of the IPAM pool.
AutoImport (boolean) --
If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
PubliclyAdvertisable (boolean) --
Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4 .
AddressFamily (string) --
The address family of the pool.
AllocationMinNetmaskLength (integer) --
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
AllocationMaxNetmaskLength (integer) --
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
AllocationDefaultNetmaskLength (integer) --
The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
AllocationResourceTags (list) --
Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
(dict) --
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.
Key (string) --
The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Value (string) --
The value of the tag.
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.
AwsService (string) --
Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
{'IpamScopes': {'State': {'isolate-complete',
'isolate-in-progress',
'restore-in-progress'}}}
Get information about your IPAM scopes.
See also: AWS API Documentation
Request Syntax
client.describe_ipam_scopes(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
IpamScopeIds=[
'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.
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 scopes you want information on.
(string) --
dict
Response Syntax
{
'NextToken': 'string',
'IpamScopes': [
{
'OwnerId': 'string',
'IpamScopeId': 'string',
'IpamScopeArn': 'string',
'IpamArn': 'string',
'IpamRegion': 'string',
'IpamScopeType': 'public'|'private',
'IsDefault': True|False,
'Description': 'string',
'PoolCount': 123,
'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'
},
]
},
]
}
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.
IpamScopes (list) --
The scopes you want information on.
(dict) --
In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
For more information, see How IPAM works in the Amazon VPC IPAM User Guide .
OwnerId (string) --
The Amazon Web Services account ID of the owner of the scope.
IpamScopeId (string) --
The ID of the scope.
IpamScopeArn (string) --
The ARN of the scope.
IpamArn (string) --
The ARN of the IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM scope.
IpamScopeType (string) --
The type of the scope.
IsDefault (boolean) --
Defines if the scope is the default scope or not.
Description (string) --
The description of the scope.
PoolCount (integer) --
The number of pools in the scope.
State (string) --
The state of the IPAM scope.
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.
{'Ipams': {'State': {'isolate-complete',
'isolate-in-progress',
'restore-in-progress'}}}
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.
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'
},
]
},
]
}
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 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.
{'Ipam': {'State': {'isolate-complete',
'isolate-in-progress',
'restore-in-progress'}}}
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'
},
]
)
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.
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'
},
]
}
}
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 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.
{'IpamPool': {'State': {'isolate-complete',
'isolate-in-progress',
'restore-in-progress'}}}
Modify the configurations of an IPAM pool.
For more information, see Modify a pool in the Amazon VPC IPAM User Guide .
See also: AWS API Documentation
Request Syntax
client.modify_ipam_pool(
DryRun=True|False,
IpamPoolId='string',
Description='string',
AutoImport=True|False,
AllocationMinNetmaskLength=123,
AllocationMaxNetmaskLength=123,
AllocationDefaultNetmaskLength=123,
ClearAllocationDefaultNetmaskLength=True|False,
AddAllocationResourceTags=[
{
'Key': 'string',
'Value': 'string'
},
],
RemoveAllocationResourceTags=[
{
'Key': 'string',
'Value': '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 .
string
[REQUIRED]
The ID of the IPAM pool you want to modify.
string
The description of the IPAM pool you want to modify.
boolean
If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
integer
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.
integer
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.
integer
The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
boolean
Clear the default netmask length allocation rule for this pool.
list
Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide .
(dict) --
A tag on an IPAM resource.
Key (string) --
The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Value (string) --
The value for the tag.
list
Remove tag allocation rules from a pool.
(dict) --
A tag on an IPAM resource.
Key (string) --
The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Value (string) --
The value for the tag.
dict
Response Syntax
{
'IpamPool': {
'OwnerId': 'string',
'IpamPoolId': 'string',
'SourceIpamPoolId': 'string',
'IpamPoolArn': 'string',
'IpamScopeArn': 'string',
'IpamScopeType': 'public'|'private',
'IpamArn': 'string',
'IpamRegion': 'string',
'Locale': 'string',
'PoolDepth': 123,
'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',
'StateMessage': 'string',
'Description': 'string',
'AutoImport': True|False,
'PubliclyAdvertisable': True|False,
'AddressFamily': 'ipv4'|'ipv6',
'AllocationMinNetmaskLength': 123,
'AllocationMaxNetmaskLength': 123,
'AllocationDefaultNetmaskLength': 123,
'AllocationResourceTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AwsService': 'ec2'
}
}
Response Structure
(dict) --
IpamPool (dict) --
The results of the modification.
OwnerId (string) --
The Amazon Web Services account ID of the owner of the IPAM pool.
IpamPoolId (string) --
The ID of the IPAM pool.
SourceIpamPoolId (string) --
The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.
IpamPoolArn (string) --
The ARN of the IPAM pool.
IpamScopeArn (string) --
The ARN of the scope of the IPAM pool.
IpamScopeType (string) --
In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
IpamArn (string) --
The ARN of the IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM pool.
Locale (string) --
The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.
PoolDepth (integer) --
The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide .
State (string) --
The state of the IPAM pool.
StateMessage (string) --
A message related to the failed creation of an IPAM pool.
Description (string) --
The description of the IPAM pool.
AutoImport (boolean) --
If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
PubliclyAdvertisable (boolean) --
Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4 .
AddressFamily (string) --
The address family of the pool.
AllocationMinNetmaskLength (integer) --
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
AllocationMaxNetmaskLength (integer) --
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
AllocationDefaultNetmaskLength (integer) --
The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
AllocationResourceTags (list) --
Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
(dict) --
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.
Key (string) --
The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Value (string) --
The value of the tag.
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.
AwsService (string) --
Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
{'IpamScope': {'State': {'isolate-complete',
'isolate-in-progress',
'restore-in-progress'}}}
Modify an IPAM scope.
See also: AWS API Documentation
Request Syntax
client.modify_ipam_scope(
DryRun=True|False,
IpamScopeId='string',
Description='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 .
string
[REQUIRED]
The ID of the scope you want to modify.
string
The description of the scope you want to modify.
dict
Response Syntax
{
'IpamScope': {
'OwnerId': 'string',
'IpamScopeId': 'string',
'IpamScopeArn': 'string',
'IpamArn': 'string',
'IpamRegion': 'string',
'IpamScopeType': 'public'|'private',
'IsDefault': True|False,
'Description': 'string',
'PoolCount': 123,
'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'
},
]
}
}
Response Structure
(dict) --
IpamScope (dict) --
The results of the modification.
OwnerId (string) --
The Amazon Web Services account ID of the owner of the scope.
IpamScopeId (string) --
The ID of the scope.
IpamScopeArn (string) --
The ARN of the scope.
IpamArn (string) --
The ARN of the IPAM.
IpamRegion (string) --
The Amazon Web Services Region of the IPAM scope.
IpamScopeType (string) --
The type of the scope.
IsDefault (boolean) --
Defines if the scope is the default scope or not.
Description (string) --
The description of the scope.
PoolCount (integer) --
The number of pools in the scope.
State (string) --
The state of the IPAM scope.
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.