Skip to content
AWS for Query.Farm

aws.sesv2.get_dedicated_ips

Example SQL Queries

SELECT * FROM
aws.sesv2.get_dedicated_ips;

Description

List the dedicated IP addresses that are associated with your Amazon Web Services account.

Table Definition

Column NameColumn Data Type
next_token Input Column

A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to GetDedicatedIps, passing this token in the NextToken parameter.

VARCHAR
page_size Input Column

The number of results to show in a single call to GetDedicatedIpsRequest. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

BIGINT
pool_name Input Column

The name of the IP pool that the dedicated IP address is associated with.

VARCHAR
_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.

dedicated_ips

A list of dedicated IP addresses that are associated with your Amazon Web Services account.

STRUCT(
    "ip" VARCHAR,
    "warmup_status" VARCHAR,
    "warmup_percentage" BIGINT,
    "pool_name" VARCHAR
)[]
Show child fields
dedicated_ips[]
Show child fields
dedicated_ips[].ip

An IPv4 address.

dedicated_ips[].pool_name

The name of the dedicated IP pool that the IP address is associated with.

dedicated_ips[].warmup_percentage

Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.

dedicated_ips[].warmup_status

The warm-up status of a dedicated IP address. The status can have one of the following values:

  • IN_PROGRESS – The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.

  • DONE – The dedicated IP warm-up process is complete, and the IP address is ready to use.