EC2 / Client / get_ipam_resource_cidrs

get_ipam_resource_cidrs#

EC2.Client.get_ipam_resource_cidrs(**kwargs)#

Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

Request Syntax

response = client.get_ipam_resource_cidrs(
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    IpamScopeId='string',
    IpamPoolId='string',
    ResourceId='string',
    ResourceType='vpc'|'subnet'|'eip'|'public-ipv4-pool'|'ipv6-pool'|'eni',
    ResourceTag={
        'Key': 'string',
        'Value': 'string'
    },
    ResourceOwner='string'
)

Parameters:

DryRun (boolean) – A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filters (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) –
MaxResults (integer) – The maximum number of results to return in the request.
NextToken (string) – The token for the next page of results.
IpamScopeId (string) –
[REQUIRED]

The ID of the scope that the resource is in.
IpamPoolId (string) – The ID of the IPAM pool that the resource is in.
ResourceId (string) – The ID of the resource.
ResourceType (string) – The resource type.
ResourceTag (dict) –
The resource tag.
- 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.
ResourceOwner (string) – The ID of the Amazon Web Services account that owns the resource.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'IpamResourceCidrs': [
        {
            'IpamId': 'string',
            'IpamScopeId': 'string',
            'IpamPoolId': 'string',
            'ResourceRegion': 'string',
            'ResourceOwnerId': 'string',
            'ResourceId': 'string',
            'ResourceName': 'string',
            'ResourceCidr': 'string',
            'ResourceType': 'vpc'|'subnet'|'eip'|'public-ipv4-pool'|'ipv6-pool'|'eni',
            'ResourceTags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'IpUsage': 123.0,
            'ComplianceStatus': 'compliant'|'noncompliant'|'unmanaged'|'ignored',
            'ManagementState': 'managed'|'unmanaged'|'ignored',
            'OverlapStatus': 'overlapping'|'nonoverlapping'|'ignored',
            'VpcId': 'string',
            'AvailabilityZoneId': '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.
- IpamResourceCidrs (list) –
  
  The resource CIDRs.
  - (dict) –
    
    The CIDR for an IPAM resource.
    - IpamId (string) –
      
      The IPAM ID for an IPAM resource.
    - IpamScopeId (string) –
      
      The scope ID for an IPAM resource.
    - IpamPoolId (string) –
      
      The pool ID for an IPAM resource.
    - ResourceRegion (string) –
      
      The Amazon Web Services Region for an IPAM resource.
    - ResourceOwnerId (string) –
      
      The Amazon Web Services account number of the owner of an IPAM resource.
    - ResourceId (string) –
      
      The ID of an IPAM resource.
    - ResourceName (string) –
      
      The name of an IPAM resource.
    - ResourceCidr (string) –
      
      The CIDR for an IPAM resource.
    - ResourceType (string) –
      
      The type of IPAM resource.
    - ResourceTags (list) –
      
      The tags for an IPAM resource.
      - (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.
    - IpUsage (float) –
      
      The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:
      - For resources that are VPCs, this is the percentage of IP address space in the VPC that’s taken up by subnet CIDRs.
      - For resources that are subnets, if the subnet has an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in the subnet that’s in use. If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address space in use is not represented. The percentage of IPv6 address space in use cannot currently be calculated.
      - For resources that are public IPv4 pools, this is the percentage of IP address space in the pool that’s been allocated to Elastic IP addresses (EIPs).
    - ComplianceStatus (string) –
      
      The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
    - ManagementState (string) –
      
      The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
    - OverlapStatus (string) –
      
      The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
    - VpcId (string) –
      
      The ID of a VPC.
    - AvailabilityZoneId (string) –
      
      The Availability Zone ID.