get_traffic_policy_instance

get_traffic_policy_instance(**kwargs)

Gets information about a specified traffic policy instance.

Note

After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

Note

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

See also: AWS API Documentation

Request Syntax

response = client.get_traffic_policy_instance(
    Id='string'
)

Parameters

Id (string) --

[REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'TrafficPolicyInstance': {
        'Id': 'string',
        'HostedZoneId': 'string',
        'Name': 'string',
        'TTL': 123,
        'State': 'string',
        'Message': 'string',
        'TrafficPolicyId': 'string',
        'TrafficPolicyVersion': 123,
        'TrafficPolicyType': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS'
    }
}

Response Structure

• (dict) --

  A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.

  • TrafficPolicyInstance (dict) --

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

    • Id (string) --

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

    • HostedZoneId (string) --

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

    • Name (string) --

      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.

    • TTL (integer) --

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

    • State (string) --

      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.

    • Message (string) --

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

    • TrafficPolicyId (string) --

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

    • TrafficPolicyVersion (integer) --

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

    • TrafficPolicyType (string) --

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

Exceptions

• Route53.Client.exceptions.NoSuchTrafficPolicyInstance
• Route53.Client.exceptions.InvalidInput