EC2 / Client / get_ipam_discovered_public_addresses

get_ipam_discovered_public_addresses

EC2.Client.get_ipam_discovered_public_addresses(**kwargs)

Gets the public IP addresses that have been discovered by IPAM.

See also: AWS API Documentation

Request Syntax

response = client.get_ipam_discovered_public_addresses(
    DryRun=True|False,
    IpamResourceDiscoveryId='string',
    AddressRegion='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]

  An IPAM resource discovery ID.

• AddressRegion (string) –

  [REQUIRED]

  The Amazon Web Services Region for the IP address.

• 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) – The token for the next page of results.

• MaxResults (integer) – The maximum number of IPAM discovered public addresses to return in one page of results.

Return type:

dict

Returns:

Response Syntax

{
    'IpamDiscoveredPublicAddresses': [
        {
            'IpamResourceDiscoveryId': 'string',
            'AddressRegion': 'string',
            'Address': 'string',
            'AddressOwnerId': 'string',
            'AddressAllocationId': 'string',
            'AssociationStatus': 'associated'|'disassociated',
            'AddressType': 'service-managed-ip'|'service-managed-byoip'|'amazon-owned-eip'|'amazon-owned-contig'|'byoip'|'ec2-public-ip',
            'Service': 'nat-gateway'|'database-migration-service'|'redshift'|'elastic-container-service'|'relational-database-service'|'site-to-site-vpn'|'load-balancer'|'global-accelerator'|'other',
            'ServiceResource': 'string',
            'VpcId': 'string',
            'SubnetId': 'string',
            'PublicIpv4PoolId': 'string',
            'NetworkInterfaceId': 'string',
            'NetworkInterfaceDescription': 'string',
            'InstanceId': 'string',
            'Tags': {
                'EipTags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ]
            },
            'NetworkBorderGroup': 'string',
            'SecurityGroups': [
                {
                    'GroupName': 'string',
                    'GroupId': 'string'
                },
            ],
            'SampleTime': datetime(2015, 1, 1)
        },
    ],
    'OldestSampleTime': datetime(2015, 1, 1),
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • IpamDiscoveredPublicAddresses (list) –

    IPAM discovered public addresses.

    • (dict) –

      A public IP Address discovered by IPAM.

      • IpamResourceDiscoveryId (string) –

        The resource discovery ID.

      • AddressRegion (string) –

        The Region of the resource the IP address is assigned to.

      • Address (string) –

        The IP address.

      • AddressOwnerId (string) –

        The ID of the owner of the resource the IP address is assigned to.

      • AddressAllocationId (string) –

        The allocation ID of the resource the IP address is assigned to.

      • AssociationStatus (string) –

        The association status.

      • AddressType (string) –

        The IP address type.

      • Service (string) –

        The Amazon Web Services service associated with the IP address.

      • ServiceResource (string) –

        The resource ARN or ID.

      • VpcId (string) –

        The ID of the VPC that the resource with the assigned IP address is in.

      • SubnetId (string) –

        The ID of the subnet that the resource with the assigned IP address is in.

      • PublicIpv4PoolId (string) –

        The ID of the public IPv4 pool that the resource with the assigned IP address is from.

      • NetworkInterfaceId (string) –

        The network interface ID of the resource with the assigned IP address.

      • NetworkInterfaceDescription (string) –

        The description of the network interface that IP address is assigned to.

      • InstanceId (string) –

        The instance ID of the instance the assigned IP address is assigned to.

      • Tags (dict) –

        Tags associated with the IP address.

        • EipTags (list) –

          Tags for an Elastic IP address.

          • (dict) –

            A tag for a public IP address discovered by IPAM.

            • Key (string) –

              The tag’s key.

            • Value (string) –

              The tag’s value.

      • NetworkBorderGroup (string) –

        The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.

      • SecurityGroups (list) –

        Security groups associated with the resource that the IP address is assigned to.

        • (dict) –

          The security group that the resource with the public IP address is in.

          • GroupName (string) –

            The security group’s name.

          • GroupId (string) –

            The security group’s ID.

      • SampleTime (datetime) –

        The last successful resource discovery time.

  • OldestSampleTime (datetime) –

    The oldest successful resource discovery time.

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