Skip to content
AWS for Query.Farm

aws.route53.get_traffic_policy_instance

Example SQL Queries

SELECT * FROM
aws.route53.get_traffic_policy_instance
WHERE
"id" = 'VALUE';

Description

Gets information about a specified traffic policy instance.

Use GetTrafficPolicyInstance with the id of new traffic policy instance to confirm that the CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request completed successfully. For more information, see the State response element.

In the Route 53 console, traffic policy instances are known as policy records.

Table Definition

Column NameColumn Data Type
id Required Input Column

The ID of the traffic policy instance that you want to get information about.

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.

traffic_policy_instance

A complex type that contains settings for the traffic policy instance.

STRUCT(
    "id" VARCHAR,
    "hosted_zone_id" VARCHAR,
    "name" VARCHAR,
    "ttl" BIGINT,
    "state" VARCHAR,
    "message" VARCHAR,
    "traffic_policy_id" VARCHAR,
    "traffic_policy_version" BIGINT,
    "traffic_policy_type" VARCHAR
)
Show child fields
traffic_policy_instance.hosted_zone_id

The ID of the hosted zone that Amazon Route 53 created resource record sets in.

traffic_policy_instance.id

The ID that Amazon Route 53 assigned to the new traffic policy instance.

traffic_policy_instance.message

If State is Failed, an explanation of the reason for the failure. If State is another value, Message is empty.

traffic_policy_instance.name

The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the resource record sets that are associated with this traffic policy instance.

traffic_policy_instance.state

The value of State is one of the following values:

Applied

Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Route 53 edge locations.

Creating

Route 53 is creating the resource record sets. Use GetTrafficPolicyInstance to confirm that the CreateTrafficPolicyInstance request completed successfully.

Failed

Route 53 wasn't able to create or update the resource record sets. When the value of State is Failed, see Message for an explanation of what caused the request to fail.

traffic_policy_instance.traffic_policy_id

The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

traffic_policy_instance.traffic_policy_type

The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance.

traffic_policy_instance.traffic_policy_version

The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

traffic_policy_instance.ttl

The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone.