EC2 / Client / get_ipam_discovered_resource_cidrs

get_ipam_discovered_resource_cidrs

EC2.Client.get_ipam_discovered_resource_cidrs(**kwargs)

Returns the resource CIDRs that are monitored as part of a resource discovery. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses.

See also: AWS API Documentation

Request Syntax

response = client.get_ipam_discovered_resource_cidrs(
    DryRun=True|False,
    IpamResourceDiscoveryId='string',
    ResourceRegion='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)

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.

• IpamResourceDiscoveryId (string) –

  [REQUIRED]

  A resource discovery ID.

• ResourceRegion (string) –

  [REQUIRED]

  A resource Region.

• Filters (list) –

  Filters.

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

• NextToken (string) – Specify the pagination token from a previous request to retrieve the next page of results.

• MaxResults (integer) – The maximum number of discovered resource CIDRs to return in one page of results.

Return type:

dict

Returns:

Response Syntax

{
    'IpamDiscoveredResourceCidrs': [
        {
            'IpamResourceDiscoveryId': 'string',
            'ResourceRegion': 'string',
            'ResourceId': 'string',
            'ResourceOwnerId': 'string',
            'ResourceCidr': 'string',
            'IpSource': 'amazon'|'byoip'|'none',
            'ResourceType': 'vpc'|'subnet'|'eip'|'public-ipv4-pool'|'ipv6-pool'|'eni',
            'ResourceTags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'IpUsage': 123.0,
            'VpcId': 'string',
            'SubnetId': 'string',
            'NetworkInterfaceAttachmentStatus': 'available'|'in-use',
            'SampleTime': datetime(2015, 1, 1),
            'AvailabilityZoneId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • IpamDiscoveredResourceCidrs (list) –

    Discovered resource CIDRs.

    • (dict) –

      An IPAM discovered resource CIDR. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses. The discovered resource CIDR is the IP address range in CIDR notation that is associated with the resource.

      • IpamResourceDiscoveryId (string) –

        The resource discovery ID.

      • ResourceRegion (string) –

        The resource Region.

      • ResourceId (string) –

        The resource ID.

      • ResourceOwnerId (string) –

        The resource owner ID.

      • ResourceCidr (string) –

        The resource CIDR.

      • IpSource (string) –

        The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.

      • ResourceType (string) –

        The resource type.

      • ResourceTags (list) –

        The resource tags.

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

      • VpcId (string) –

        The VPC ID.

      • SubnetId (string) –

        The subnet ID.

      • NetworkInterfaceAttachmentStatus (string) –

        For elastic network interfaces, this is the status of whether or not the elastic network interface is attached.

      • SampleTime (datetime) –

        The last successful resource discovery time.

      • AvailabilityZoneId (string) –

        The Availability Zone ID.

  • NextToken (string) –

    Specify the pagination token from a previous request to retrieve the next page of results.