AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ec2 ]

get-ipam-discovered-public-addresses

Description

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

See also: AWS API Documentation

Synopsis

  get-ipam-discovered-public-addresses
[--dry-run | --no-dry-run]
--ipam-resource-discovery-id <value>
--address-region <value>
[--filters <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--dry-run | --no-dry-run (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 .

--ipam-resource-discovery-id (string)

An IPAM resource discovery ID.

--address-region (string)

The Amazon Web Services Region for the IP address.

--filters (list)

Filters.

(structure)

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)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--next-token (string)

The token for the next page of results.

--max-results (integer)

The maximum number of IPAM discovered public addresses to return in one page of results.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

IpamDiscoveredPublicAddresses -> (list)

IPAM discovered public addresses.

(structure)

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 -> (structure)

Tags associated with the IP address.

EipTags -> (list)

Tags for an Elastic IP address.

(structure)

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 network border group that the resource that the IP address is assigned to is in.

SecurityGroups -> (list)

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

(structure)

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 -> (timestamp)

The last successful resource discovery time.

OldestSampleTime -> (timestamp)

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.