Skip to content
AWS for Query.Farm

aws.ec2.describe_ipam_resource_discoveries

Example SQL Queries

SELECT * FROM
aws.ec2.describe_ipam_resource_discoveries;

Description

Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

Table Definition

Column NameColumn Data Type
dry_run Input Column

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.

BOOLEAN
filters Input Column

The resource discovery filters.

STRUCT(
    "name" VARCHAR,
    "values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name of the filter. Filter names are case-sensitive.

filters[].values[]
ipam_resource_discovery_ids Input Column

The IPAM resource discovery IDs.

VARCHAR[]
Show child fields
ipam_resource_discovery_ids[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
description

The resource discovery description.

VARCHAR
ipam_resource_discovery_arn

The resource discovery Amazon Resource Name (ARN).

VARCHAR
ipam_resource_discovery_id

The resource discovery ID.

VARCHAR
ipam_resource_discovery_region

The resource discovery Region.

VARCHAR
is_default

Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.

BOOLEAN
operating_regions

The operating Regions for the resource discovery. 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.

STRUCT(
    "region_name" VARCHAR
)[]
Show child fields
operating_regions[]
Show child fields
operating_regions[].region_name

The name of the operating Region.

owner_id

The ID of the owner.

VARCHAR
state

The lifecycle state of the resource discovery.

  • create-in-progress - Resource discovery is being created.

  • create-complete - Resource discovery creation is complete.

  • create-failed - Resource discovery creation has failed.

  • modify-in-progress - Resource discovery is being modified.

  • modify-complete - Resource discovery modification is complete.

  • modify-failed - Resource discovery modification has failed.

  • delete-in-progress - Resource discovery is being deleted.

  • delete-complete - Resource discovery deletion is complete.

  • delete-failed - Resource discovery deletion has failed.

  • isolate-in-progress - Amazon Web Services account that created the resource discovery has been removed and the resource discovery is being isolated.

  • isolate-complete - Resource discovery isolation is complete.

  • restore-in-progress - Amazon Web Services account that created the resource discovery and was isolated has been restored.

VARCHAR
tags

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

STRUCT(
    "key" VARCHAR,
    "value" VARCHAR
)[]
Show child fields
tags[]
Show child fields
tags[].key

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

tags[].value

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.