Route53 / Client / list_traffic_policy_versions

list_traffic_policy_versions#

Route53.Client.list_traffic_policy_versions(**kwargs)#

Gets information about all of the versions for a specified traffic policy.

Traffic policy versions are listed in numerical order by VersionNumber.

See also: AWS API Documentation

Request Syntax

response = client.list_traffic_policy_versions(
    Id='string',
    TrafficPolicyVersionMarker='string',
    MaxItems='string'
)
Parameters:

  • Id (string) –

    [REQUIRED]

    Specify the value of Id of the traffic policy for which you want to list all versions.

  • TrafficPolicyVersionMarker (string) –

    For your first request to ListTrafficPolicyVersions, don’t include the TrafficPolicyVersionMarker parameter.

    If you have more traffic policy versions than the value of MaxItems, ListTrafficPolicyVersions returns only the first group of MaxItems versions. To get more traffic policy versions, submit another ListTrafficPolicyVersions request. For the value of TrafficPolicyVersionMarker, specify the value of TrafficPolicyVersionMarker in the previous response.

  • MaxItems (string) – The maximum number of traffic policy versions that you want Amazon Route 53 to include in the response body for this request. If the specified traffic policy has more than MaxItems versions, the value of IsTruncated in the response is true, and the value of the TrafficPolicyVersionMarker element is the ID of the first version that Route 53 will return if you submit another request.

Return type:

dict

Returns:

Response Syntax

{
    'TrafficPolicies': [
        {
            'Id': 'string',
            'Version': 123,
            'Name': 'string',
            'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS'|'TLSA'|'SSHFP'|'SVCB'|'HTTPS',
            'Document': 'string',
            'Comment': 'string'
        },
    ],
    'IsTruncated': True|False,
    'TrafficPolicyVersionMarker': 'string',
    'MaxItems': 'string'
}

Response Structure

  • (dict) –

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

    • TrafficPolicies (list) –

      A list that contains one TrafficPolicy element for each traffic policy version that is associated with the specified traffic policy.

      • (dict) –

        A complex type that contains settings for a 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.

    • IsTruncated (boolean) –

      A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of traffic policies by submitting another ListTrafficPolicyVersions request and specifying the value of NextMarker in the marker parameter.

    • TrafficPolicyVersionMarker (string) –

      If IsTruncated is true, the value of TrafficPolicyVersionMarker identifies the first traffic policy that Amazon Route 53 will return if you submit another request. Call ListTrafficPolicyVersions again and specify the value of TrafficPolicyVersionMarker in the TrafficPolicyVersionMarker request parameter.

      This element is present only if IsTruncated is true.

    • MaxItems (string) –

      The value that you specified for the maxitems parameter in the ListTrafficPolicyVersions request that produced the current response.

Exceptions

  • Route53.Client.exceptions.InvalidInput

  • Route53.Client.exceptions.NoSuchTrafficPolicy