Menu
Amazon Route 53
API Reference

GetTrafficPolicyInstance

Gets information about a specified traffic policy instance.

Note

After you submit a CreateTrafficPolicyInstance or 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.

Note

In the Amazon Route 53 console, traffic policy instances are known as policy records.

Request Syntax

Copy
GET /2013-04-01/trafficpolicyinstance/Id HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

Id

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

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

Request Body

The request does not have a request body.

Response Syntax

Copy
HTTP/1.1 200 <?xml version="1.0" encoding="UTF-8"?> <GetTrafficPolicyInstanceResponse> <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> </GetTrafficPolicyInstanceResponse>

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.

GetTrafficPolicyInstanceResponse

Root level tag for the GetTrafficPolicyInstanceResponse parameters.

Required: Yes

TrafficPolicyInstance

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

Type: TrafficPolicyInstance object

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

Copy
GET /2013-04-01/trafficpolicyinstance/12131415-abac-5432-caba-6f5e4d3c2b1a

Example Response

Copy
HTTP/1.1 200 OK <?xml version="1.0" encoding="UTF-8"?> <GetTrafficPolicyInstanceResponse xmlns="https://route53.amazonaws.com/doc/2013-04-01/"> <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> </GetTrafficPolicyInstanceResponse>

See Also

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