Route53 / Client / get_traffic_policy

get_traffic_policy#

Route53.Client.get_traffic_policy(**kwargs)#

Gets information about a specific traffic policy version.

For information about how of deleting a traffic policy affects the response from GetTrafficPolicy, see DeleteTrafficPolicy.

See also: AWS API Documentation

Request Syntax

response = client.get_traffic_policy(
    Id='string',
    Version=123
)
Parameters:

  • Id (string) –

    [REQUIRED]

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

  • Version (integer) –

    [REQUIRED]

    The version number of the traffic policy that you want to get information about.

Return type:

dict

Returns:

Response Syntax

{
    'TrafficPolicy': {
        'Id': 'string',
        'Version': 123,
        'Name': 'string',
        'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS',
        'Document': 'string',
        'Comment': 'string'
    }
}

Response Structure

  • (dict) –

    A complex type that contains the response information for the request.

    • TrafficPolicy (dict) –

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

      • Id (string) –

        The ID that Amazon Route 53 assigned to a traffic policy when you created it.

      • Version (integer) –

        The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic policy, the value of Version is always 1.

      • Name (string) –

        The name that you specified when you created the traffic policy.

      • Type (string) –

        The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.

      • Document (string) –

        The definition of a traffic policy in JSON format. You specify the JSON document to use for a new traffic policy in the CreateTrafficPolicy request. For more information about the JSON format, see Traffic Policy Document Format.

      • Comment (string) –

        The comment that you specify in the CreateTrafficPolicy request, if any.

Exceptions

  • Route53.Client.exceptions.NoSuchTrafficPolicy

  • Route53.Client.exceptions.InvalidInput