| Copyright | (c) 2013-2018 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.Route53.ListGeoLocations
Description
Retrieves a list of supported geo locations.
Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country (for example, states or provinces), the subdivisions for that country are listed in alphabetical order immediately after the corresponding country.
Synopsis
- listGeoLocations :: ListGeoLocations
- data ListGeoLocations
- lglStartSubdivisionCode :: Lens' ListGeoLocations (Maybe Text)
- lglMaxItems :: Lens' ListGeoLocations (Maybe Text)
- lglStartCountryCode :: Lens' ListGeoLocations (Maybe Text)
- lglStartContinentCode :: Lens' ListGeoLocations (Maybe Text)
- listGeoLocationsResponse :: Int -> Bool -> Text -> ListGeoLocationsResponse
- data ListGeoLocationsResponse
- lglrsNextContinentCode :: Lens' ListGeoLocationsResponse (Maybe Text)
- lglrsNextCountryCode :: Lens' ListGeoLocationsResponse (Maybe Text)
- lglrsNextSubdivisionCode :: Lens' ListGeoLocationsResponse (Maybe Text)
- lglrsResponseStatus :: Lens' ListGeoLocationsResponse Int
- lglrsGeoLocationDetailsList :: Lens' ListGeoLocationsResponse [GeoLocationDetails]
- lglrsIsTruncated :: Lens' ListGeoLocationsResponse Bool
- lglrsMaxItems :: Lens' ListGeoLocationsResponse Text
Creating a Request
listGeoLocations :: ListGeoLocations Source #
Creates a value of ListGeoLocations with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lglStartSubdivisionCode- The code for the subdivision (for example, state or province) with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, ifIsTruncatedistrue, and ifNextSubdivisionCodefrom the previous response has a value, enter that value inStartSubdivisionCodeto return the next page of results. To list subdivisions of a country, you must include bothStartCountryCodeandStartSubdivisionCode.lglMaxItems- (Optional) The maximum number of geolocations to be included in the response body for this request. If more thanMaxItemsgeolocations remain to be listed, then the value of theIsTruncatedelement in the response istrue.lglStartCountryCode- The code for the country with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, ifIsTruncatedistrue, and ifNextCountryCodefrom the previous response has a value, enter that value inStartCountryCodeto return the next page of results. Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2 .lglStartContinentCode- The code for the continent with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, ifIsTruncatedis true, and ifNextContinentCodefrom the previous response has a value, enter that value inStartContinentCodeto return the next page of results. IncludeStartContinentCodeonly if you want to list continents. Don't includeStartContinentCodewhen you're listing countries or countries with their subdivisions.
data ListGeoLocations Source #
A request to get a list of geographic locations that Amazon Route 53 supports for geolocation resource record sets.
See: listGeoLocations smart constructor.
Instances
Request Lenses
lglStartSubdivisionCode :: Lens' ListGeoLocations (Maybe Text) Source #
The code for the subdivision (for example, state or province) with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if IsTruncated is true , and if NextSubdivisionCode from the previous response has a value, enter that value in StartSubdivisionCode to return the next page of results. To list subdivisions of a country, you must include both StartCountryCode and StartSubdivisionCode .
lglMaxItems :: Lens' ListGeoLocations (Maybe Text) Source #
(Optional) The maximum number of geolocations to be included in the response body for this request. If more than MaxItems geolocations remain to be listed, then the value of the IsTruncated element in the response is true .
lglStartCountryCode :: Lens' ListGeoLocations (Maybe Text) Source #
The code for the country with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if IsTruncated is true , and if NextCountryCode from the previous response has a value, enter that value in StartCountryCode to return the next page of results. Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2 .
lglStartContinentCode :: Lens' ListGeoLocations (Maybe Text) Source #
The code for the continent with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextContinentCode from the previous response has a value, enter that value in StartContinentCode to return the next page of results. Include StartContinentCode only if you want to list continents. Don't include StartContinentCode when you're listing countries or countries with their subdivisions.
Destructuring the Response
listGeoLocationsResponse Source #
Arguments
| :: Int | |
| -> Bool | |
| -> Text | |
| -> ListGeoLocationsResponse |
Creates a value of ListGeoLocationsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lglrsNextContinentCode- IfIsTruncatedistrue, you can make a follow-up request to display more locations. Enter the value ofNextContinentCodein theStartContinentCodeparameter in anotherListGeoLocationsrequest.lglrsNextCountryCode- IfIsTruncatedistrue, you can make a follow-up request to display more locations. Enter the value ofNextCountryCodein theStartCountryCodeparameter in anotherListGeoLocationsrequest.lglrsNextSubdivisionCode- IfIsTruncatedistrue, you can make a follow-up request to display more locations. Enter the value ofNextSubdivisionCodein theStartSubdivisionCodeparameter in anotherListGeoLocationsrequest.lglrsResponseStatus- -- | The response status code.lglrsGeoLocationDetailsList- A complex type that contains oneGeoLocationDetailselement for each location that Amazon Route 53 supports for geolocation.lglrsIsTruncated- A value that indicates whether more locations remain to be listed after the last location in this response. If so, the value ofIsTruncatedistrue. To get more values, submit another request and include the values ofNextContinentCode,NextCountryCode, andNextSubdivisionCodein theStartContinentCode,StartCountryCode, andStartSubdivisionCode, as applicable.lglrsMaxItems- The value that you specified forMaxItemsin the request.
data ListGeoLocationsResponse Source #
A complex type containing the response information for the request.
See: listGeoLocationsResponse smart constructor.
Instances
Response Lenses
lglrsNextContinentCode :: Lens' ListGeoLocationsResponse (Maybe Text) Source #
If IsTruncated is true , you can make a follow-up request to display more locations. Enter the value of NextContinentCode in the StartContinentCode parameter in another ListGeoLocations request.
lglrsNextCountryCode :: Lens' ListGeoLocationsResponse (Maybe Text) Source #
If IsTruncated is true , you can make a follow-up request to display more locations. Enter the value of NextCountryCode in the StartCountryCode parameter in another ListGeoLocations request.
lglrsNextSubdivisionCode :: Lens' ListGeoLocationsResponse (Maybe Text) Source #
If IsTruncated is true , you can make a follow-up request to display more locations. Enter the value of NextSubdivisionCode in the StartSubdivisionCode parameter in another ListGeoLocations request.
lglrsResponseStatus :: Lens' ListGeoLocationsResponse Int Source #
- - | The response status code.
lglrsGeoLocationDetailsList :: Lens' ListGeoLocationsResponse [GeoLocationDetails] Source #
A complex type that contains one GeoLocationDetails element for each location that Amazon Route 53 supports for geolocation.
lglrsIsTruncated :: Lens' ListGeoLocationsResponse Bool Source #
A value that indicates whether more locations remain to be listed after the last location in this response. If so, the value of IsTruncated is true . To get more values, submit another request and include the values of NextContinentCode , NextCountryCode , and NextSubdivisionCode in the StartContinentCode , StartCountryCode , and StartSubdivisionCode , as applicable.
lglrsMaxItems :: Lens' ListGeoLocationsResponse Text Source #
The value that you specified for MaxItems in the request.