Menu
Amazon Route 53
API Reference

ListTrafficPolicyVersions

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

Traffic policy versions are listed in numerical order by VersionNumber.

Request Syntax

GET /2013-04-01/trafficpolicies/Id/versions?maxitems=MaxItems&trafficpolicyversion=TrafficPolicyVersionMarker HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

Id

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

Length Constraints: Minimum length of 1. Maximum length of 36.

maxitems

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 Amazon Route 53 will return if you submit another request.

trafficpolicyversion

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.

Length Constraints: Maximum length of 4.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<ListTrafficPolicyVersionsResponse>
   <IsTruncated>boolean</IsTruncated>
   <MaxItems>string</MaxItems>
   <TrafficPolicies>
      <TrafficPolicy>
         <Comment>string</Comment>
         <Document>string</Document>
         <Id>string</Id>
         <Name>string</Name>
         <Type>string</Type>
         <Version>integer</Version>
      </TrafficPolicy>
   </TrafficPolicies>
   <TrafficPolicyVersionMarker>string</TrafficPolicyVersionMarker>
</ListTrafficPolicyVersionsResponse>

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in XML format by the service.

ListTrafficPolicyVersionsResponse

Root level tag for the ListTrafficPolicyVersionsResponse parameters.

Required: Yes

IsTruncated

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.

Type: Boolean

MaxItems

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

Type: String

TrafficPolicies

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

Type: Array of TrafficPolicy objects

TrafficPolicyVersionMarker

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.

Type: String

Length Constraints: Maximum length of 4.

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidInput

The input is not valid.

HTTP Status Code: 400

NoSuchTrafficPolicy

No traffic policy exists with the specified ID.

HTTP Status Code: 404

Examples

Example Request

Copy
GET /2013-04-01/trafficpolicy/12345678-abcd-9876-fedc-1a2b3c4de5f6/versions?maxitems=1

Example Response

Copy
HTTP/1.1 200 OK <?xml version="1.0" encoding="UTF-8"?> <ListTrafficPolicyVersionsResponse xmlns="https://route53.amazonaws.com/doc/2013-04-01/"> <TrafficPolicies> <TrafficPolicy> <Id>12345678-abcd-9876-fedc-1a2b3c4de5f6</Id> <VersionNumber>77</VersionNumber> <Name>MyTrafficPolicy</Name> <Type>A</Type> <Document>JSON-formatted definition of this traffic policy</Definition> <Comment>First traffic policy</Comment> </TrafficPolicy> </TrafficPolicies> <IsTrucated>true</IsTruncated> <TrafficPolicyVersionMarker>12345678-abcd-9876-fedc-1a2b3c4de5f7</TrafficPolicyVersionMarker> <MaxItems>1</MaxItems> </ListTrafficPolicyVersionsResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: