Route53 / Client / list_traffic_policies

list_traffic_policies#

Route53.Client.list_traffic_policies(**kwargs)#

Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account. Policies are listed in the order that they were created in.

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

See also: AWS API Documentation

Request Syntax

response = client.list_traffic_policies(
    TrafficPolicyIdMarker='string',
    MaxItems='string'
)
Parameters:

  • TrafficPolicyIdMarker (string) –

    (Conditional) For your first request to ListTrafficPolicies, don’t include the TrafficPolicyIdMarker parameter.

    If you have more traffic policies than the value of MaxItems, ListTrafficPolicies returns only the first MaxItems traffic policies. To get the next group of policies, submit another request to ListTrafficPolicies. For the value of TrafficPolicyIdMarker, specify the value of TrafficPolicyIdMarker that was returned in the previous response.

  • MaxItems (string) – (Optional) The maximum number of traffic policies that you want Amazon Route 53 to return in response to this request. If you have more than MaxItems traffic policies, the value of IsTruncated in the response is true, and the value of TrafficPolicyIdMarker is the ID of the first traffic policy that Route 53 will return if you submit another request.

Return type:

dict

Returns:

Response Syntax

{
    'TrafficPolicySummaries': [
        {
            'Id': 'string',
            'Name': 'string',
            'Type': 'SOA'|'A'|'TXT'|'NS'|'CNAME'|'MX'|'NAPTR'|'PTR'|'SRV'|'SPF'|'AAAA'|'CAA'|'DS'|'TLSA'|'SSHFP'|'SVCB'|'HTTPS',
            'LatestVersion': 123,
            'TrafficPolicyCount': 123
        },
    ],
    'IsTruncated': True|False,
    'TrafficPolicyIdMarker': 'string',
    'MaxItems': 'string'
}

Response Structure

  • (dict) –

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

    • TrafficPolicySummaries (list) –

      A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current Amazon Web Services account.

      • (dict) –

        A complex type that contains information about the latest version of one traffic policy that is associated with the current Amazon Web Services account.

        • Id (string) –

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

        • Name (string) –

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

        • 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.

        • LatestVersion (integer) –

          The version number of the latest version of the traffic policy.

        • TrafficPolicyCount (integer) –

          The number of traffic policies that are associated with the current Amazon Web Services account.

    • 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 ListTrafficPolicies request and specifying the value of TrafficPolicyIdMarker in the TrafficPolicyIdMarker request parameter.

    • TrafficPolicyIdMarker (string) –

      If the value of IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies.

    • MaxItems (string) –

      The value that you specified for the MaxItems parameter in the ListTrafficPolicies request that produced the current response.

Exceptions

  • Route53.Client.exceptions.InvalidInput