Amazon Route 53
API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

GetGeoLocation

Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.

Use the following syntax to determine whether a continent is supported for geolocation:

GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for a continent

Use the following syntax to determine whether a country is supported for geolocation:

GET /2013-04-01/geolocation?countrycode=two-character country code

Use the following syntax to determine whether a subdivision of a country is supported for geolocation:

GET /2013-04-01/geolocation?countrycode=two-character country code&subdivisioncode=subdivision code

Request Syntax

GET /2013-04-01/geolocation?continentcode=ContinentCode&countrycode=CountryCode&subdivisioncode=SubdivisionCode HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

continentcode

For geolocation resource record sets, a two-letter abbreviation that identifies a continent. Amazon Route 53 supports the following continent codes:

  • AF: Africa

  • AN: Antarctica

  • AS: Asia

  • EU: Europe

  • OC: Oceania

  • NA: North America

  • SA: South America

Length Constraints: Fixed length of 2.

countrycode

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.

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

subdivisioncode

For SubdivisionCode, Amazon Route 53 supports only states of the United States. For a list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website.

If you specify subdivisioncode, you must also specify US for CountryCode.

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 <?xml version="1.0" encoding="UTF-8"?> <GetGeoLocationResponse> <GeoLocationDetails> <ContinentCode>string</ContinentCode> <ContinentName>string</ContinentName> <CountryCode>string</CountryCode> <CountryName>string</CountryName> <SubdivisionCode>string</SubdivisionCode> <SubdivisionName>string</SubdivisionName> </GeoLocationDetails> </GetGeoLocationResponse>

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.

GetGeoLocationResponse

Root level tag for the GetGeoLocationResponse parameters.

Required: Yes

GeoLocationDetails

A complex type that contains the codes and full continent, country, and subdivision names for the specified geolocation code.

Type: GeoLocationDetails 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

NoSuchGeoLocation

Amazon Route 53 doesn't support the specified geographic location. For a list of supported geolocation codes, see the GeoLocation data type.

HTTP Status Code: 404

Examples

Example Request

To determine whether France (FR) is supported for Route 53 geolocation, submit the following request.

GET /2013-04-01/geolocation?countrycode=FR

Example Response

The following response shows that France is supported for geolocation. If France were not supported, Route 53 would return NoSuchGeoLocation.

HTTP/1.1 200 OK <?xml version="1.0" encoding="UTF-8"?> <GetGeoLocationResponse xmlns="https://route53.amazonaws.com/doc/2013-04-01/"> <GetGeoLocationDetails> <CountryCode>FR</CountryCode> <CountryName>France</CountryName> </GeoLocationDetails> </GetGeoLocationResponse>

See Also

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