| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Route53.GetGeoLocation
Description
Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.
Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
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
Synopsis
- data GetGeoLocation = GetGeoLocation' {}
- newGetGeoLocation :: GetGeoLocation
- getGeoLocation_continentCode :: Lens' GetGeoLocation (Maybe Text)
- getGeoLocation_countryCode :: Lens' GetGeoLocation (Maybe Text)
- getGeoLocation_subdivisionCode :: Lens' GetGeoLocation (Maybe Text)
- data GetGeoLocationResponse = GetGeoLocationResponse' {}
- newGetGeoLocationResponse :: Int -> GeoLocationDetails -> GetGeoLocationResponse
- getGeoLocationResponse_httpStatus :: Lens' GetGeoLocationResponse Int
- getGeoLocationResponse_geoLocationDetails :: Lens' GetGeoLocationResponse GeoLocationDetails
Creating a Request
data GetGeoLocation Source #
A request for information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.
See: newGetGeoLocation smart constructor.
Constructors
| GetGeoLocation' | |
Fields
| |
Instances
newGetGeoLocation :: GetGeoLocation Source #
Create a value of GetGeoLocation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetGeoLocation, getGeoLocation_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
GetGeoLocation, getGeoLocation_countryCode - Amazon Route 53 uses the two-letter country codes that are specified in
ISO standard 3166-1 alpha-2.
GetGeoLocation, getGeoLocation_subdivisionCode - The code for the subdivision, such as a particular state within the
United States. For a list of US state abbreviations, see
Appendix B: Two–Letter State and Possession Abbreviations
on the United States Postal Service website. For a list of all supported
subdivision codes, use the
ListGeoLocations
API.
Request Lenses
getGeoLocation_continentCode :: Lens' GetGeoLocation (Maybe Text) Source #
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
getGeoLocation_countryCode :: Lens' GetGeoLocation (Maybe Text) Source #
Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.
getGeoLocation_subdivisionCode :: Lens' GetGeoLocation (Maybe Text) Source #
The code for the subdivision, such as a particular state within the United States. For a list of US state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website. For a list of all supported subdivision codes, use the ListGeoLocations API.
Destructuring the Response
data GetGeoLocationResponse Source #
A complex type that contains the response information for the specified geolocation code.
See: newGetGeoLocationResponse smart constructor.
Constructors
| GetGeoLocationResponse' | |
Fields
| |
Instances
newGetGeoLocationResponse Source #
Arguments
| :: Int | |
| -> GeoLocationDetails | |
| -> GetGeoLocationResponse |
Create a value of GetGeoLocationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetGeoLocationResponse', getGeoLocationResponse_httpStatus - The response's http status code.
$sel:geoLocationDetails:GetGeoLocationResponse', getGeoLocationResponse_geoLocationDetails - A complex type that contains the codes and full continent, country, and
subdivision names for the specified geolocation code.
Response Lenses
getGeoLocationResponse_httpStatus :: Lens' GetGeoLocationResponse Int Source #
The response's http status code.
getGeoLocationResponse_geoLocationDetails :: Lens' GetGeoLocationResponse GeoLocationDetails Source #
A complex type that contains the codes and full continent, country, and subdivision names for the specified geolocation code.