ListTrafficPolicyInstances
Gets information about the traffic policy instances that you created by using the current AWS account.
Note
After you submit 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.
Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic
policy instances, you can use the MaxItems parameter to list them in groups
of up to 100.
Request Syntax
GET /2013-04-01/trafficpolicyinstances?hostedzoneid=HostedZoneIdMarker&maxitems=MaxItems&trafficpolicyinstancename=TrafficPolicyInstanceNameMarker&trafficpolicyinstancetype=TrafficPolicyInstanceTypeMarker HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- hostedzoneid
-
If the value of
IsTruncatedin the previous response wastrue, you have more traffic policy instances. To get more traffic policy instances, submit anotherListTrafficPolicyInstancesrequest. For the value ofHostedZoneId, specify the value ofHostedZoneIdMarkerfrom the previous response, which is the hosted zone ID of the first traffic policy instance in the next group of traffic policy instances.If the value of
IsTruncatedin the previous response wasfalse, there are no more traffic policy instances to get.Length Constraints: Maximum length of 32.
- maxitems
-
The maximum number of traffic policy instances that you want Amazon Route 53 to return in response to a
ListTrafficPolicyInstancesrequest. If you have more thanMaxItemstraffic policy instances, the value of theIsTruncatedelement in the response istrue, and the values ofHostedZoneIdMarker,TrafficPolicyInstanceNameMarker, andTrafficPolicyInstanceTypeMarkerrepresent the first traffic policy instance in the next group ofMaxItemstraffic policy instances. - trafficpolicyinstancename
-
If the value of
IsTruncatedin the previous response wastrue, you have more traffic policy instances. To get more traffic policy instances, submit anotherListTrafficPolicyInstancesrequest. For the value oftrafficpolicyinstancename, specify the value ofTrafficPolicyInstanceNameMarkerfrom the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances.If the value of
IsTruncatedin the previous response wasfalse, there are no more traffic policy instances to get.Length Constraints: Maximum length of 1024.
- trafficpolicyinstancetype
-
If the value of
IsTruncatedin the previous response wastrue, you have more traffic policy instances. To get more traffic policy instances, submit anotherListTrafficPolicyInstancesrequest. For the value oftrafficpolicyinstancetype, specify the value ofTrafficPolicyInstanceTypeMarkerfrom the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.If the value of
IsTruncatedin the previous response wasfalse, there are no more traffic policy instances to get.Valid Values:
SOA | A | TXT | NS | CNAME | MX | NAPTR | PTR | SRV | SPF | AAAA | CAA | DS | TLSA | SSHFP | SVCB | HTTPS
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<ListTrafficPolicyInstancesResponse>
<HostedZoneIdMarker>string</HostedZoneIdMarker>
<IsTruncated>boolean</IsTruncated>
<MaxItems>string</MaxItems>
<TrafficPolicyInstanceNameMarker>string</TrafficPolicyInstanceNameMarker>
<TrafficPolicyInstances>
<TrafficPolicyInstance>
<HostedZoneId>string</HostedZoneId>
<Id>string</Id>
<Message>string</Message>
<Name>string</Name>
<State>string</State>
<TrafficPolicyId>string</TrafficPolicyId>
<TrafficPolicyType>string</TrafficPolicyType>
<TrafficPolicyVersion>integer</TrafficPolicyVersion>
<TTL>long</TTL>
</TrafficPolicyInstance>
</TrafficPolicyInstances>
<TrafficPolicyInstanceTypeMarker>string</TrafficPolicyInstanceTypeMarker>
</ListTrafficPolicyInstancesResponse>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.
- ListTrafficPolicyInstancesResponse
-
Root level tag for the ListTrafficPolicyInstancesResponse parameters.
Required: Yes
- HostedZoneIdMarker
-
If
IsTruncatedistrue,HostedZoneIdMarkeris the ID of the hosted zone of the first traffic policy instance that Route 53 will return if you submit anotherListTrafficPolicyInstancesrequest.Type: String
Length Constraints: Maximum length of 32.
- IsTruncated
-
A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get more traffic policy instances by calling
ListTrafficPolicyInstancesagain and specifying the values of theHostedZoneIdMarker,TrafficPolicyInstanceNameMarker, andTrafficPolicyInstanceTypeMarkerin the corresponding request parameters.Type: Boolean
- MaxItems
-
The value that you specified for the
MaxItemsparameter in the call toListTrafficPolicyInstancesthat produced the current response.Type: String
- TrafficPolicyInstanceNameMarker
-
If
IsTruncatedistrue,TrafficPolicyInstanceNameMarkeris the name of the first traffic policy instance that Route 53 will return if you submit anotherListTrafficPolicyInstancesrequest.Type: String
Length Constraints: Maximum length of 1024.
- TrafficPolicyInstances
-
A list that contains one
TrafficPolicyInstanceelement for each traffic policy instance that matches the elements in the request.Type: Array of TrafficPolicyInstance objects
- TrafficPolicyInstanceTypeMarker
-
If
IsTruncatedistrue,TrafficPolicyInstanceTypeMarkeris the DNS type of the resource record sets that are associated with the first traffic policy instance that Amazon Route 53 will return if you submit anotherListTrafficPolicyInstancesrequest.Type: String
Valid Values:
SOA | A | TXT | NS | CNAME | MX | NAPTR | PTR | SRV | SPF | AAAA | CAA | DS | TLSA | SSHFP | SVCB | HTTPS
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
- NoSuchTrafficPolicyInstance
-
No traffic policy instance exists with the specified ID.
HTTP Status Code: 404
Examples
Example Request
The following example shows a request after the first request. (For the first request, you'd specify only the maxitems parameter.)
GET /2013-04-01/trafficpolicyinstances?hostedzoneid=Z1D633PJN98FT9
&trafficpolicyinstancename=www.example.com
&trafficpolicyinstancetype=A
&maxitems=1Example Response
This example illustrates one usage of ListTrafficPolicyInstances.
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<ListTrafficPolicyInstancesResponse xmlns="https://route53.amazonaws.com/doc/2013-04-01/">
<TrafficPolicyInstances>
<TrafficPolicyInstance>
<Id>12131415-abac-5432-caba-6f5e4d3c2b1a</Id>
<HostedZoneId>Z1D633PJN98FT9</HostedZoneId>
<Name>www.example.com</Name>
<TTL>300</TTL>
<State>Applied</State>
<Message/>
<TrafficPolicyId>12345678-abcd-9876-fedc-1a2b3c4de5f6</TrafficPolicyId>
<TrafficPolicyVersion>7</TrafficPolicyVersion>
<TrafficPolicyType>A</TrafficPolicyType>
</TrafficPolicyInstance>
</TrafficPolicyInstances>
<HostedZoneIdMarker>Z217DLHR85079R</HostedZoneIdMarker>
<TrafficPolicyInstanceNameMarker>www.example.net</TrafficPolicyInstanceNameMarker>
<TrafficPolicyInstanceTypeMarker>A</TrafficPolicyInstanceTypeMarker>
<IsTruncated>true</IsTruncated>
<MaxItems>1</MaxItems>
</ListTrafficPolicyInstancesResponse>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
