Network.AWS.Route53.ListGeoLocations

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.

Creating a Request

listGeoLocations :: ListGeoLocations

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, 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 - (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 - 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 - 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.

data ListGeoLocations

A request to get a list of geographic locations that Amazon Route 53 supports for geolocation resource record sets.

See: listGeoLocations smart constructor.

Instances

Eq ListGeoLocations

Methods

(==) :: ListGeoLocations -> ListGeoLocations -> Bool

(/=) :: ListGeoLocations -> ListGeoLocations -> Bool

Data ListGeoLocations

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListGeoLocations -> c ListGeoLocations

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListGeoLocations

toConstr :: ListGeoLocations -> Constr

dataTypeOf :: ListGeoLocations -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListGeoLocations)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListGeoLocations)

gmapT :: (forall b. Data b => b -> b) -> ListGeoLocations -> ListGeoLocations

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListGeoLocations -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListGeoLocations -> r

gmapQ :: (forall d. Data d => d -> u) -> ListGeoLocations -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListGeoLocations -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListGeoLocations -> m ListGeoLocations

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListGeoLocations -> m ListGeoLocations

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListGeoLocations -> m ListGeoLocations

Read ListGeoLocations

Methods

readsPrec :: Int -> ReadS ListGeoLocations

readList :: ReadS [ListGeoLocations]

readPrec :: ReadPrec ListGeoLocations

readListPrec :: ReadPrec [ListGeoLocations]

Show ListGeoLocations

Methods

showsPrec :: Int -> ListGeoLocations -> ShowS

show :: ListGeoLocations -> String

showList :: [ListGeoLocations] -> ShowS

Generic ListGeoLocations

Associated Types

type Rep ListGeoLocations :: * -> *

Methods

from :: ListGeoLocations -> Rep ListGeoLocations x

to :: Rep ListGeoLocations x -> ListGeoLocations

Hashable ListGeoLocations

Methods

hashWithSalt :: Int -> ListGeoLocations -> Int

hash :: ListGeoLocations -> Int

NFData ListGeoLocations

Methods

rnf :: ListGeoLocations -> ()

AWSRequest ListGeoLocations

Associated Types

type Rs ListGeoLocations :: *

Methods

request :: ListGeoLocations -> Request ListGeoLocations

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListGeoLocations -> ClientResponse -> m (Response ListGeoLocations)

ToHeaders ListGeoLocations

Methods

toHeaders :: ListGeoLocations -> [Header]

ToPath ListGeoLocations

Methods

toPath :: ListGeoLocations -> ByteString

ToQuery ListGeoLocations

Methods

toQuery :: ListGeoLocations -> QueryString

type Rep ListGeoLocations

type Rep ListGeoLocations = D1 * (MetaData "ListGeoLocations" "Network.AWS.Route53.ListGeoLocations" "amazonka-route53-1.6.0-Ak5sZypnFS3AFXHlAYIveI" False) (C1 * (MetaCons "ListGeoLocations'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lglStartSubdivisionCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lglMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lglStartCountryCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lglStartContinentCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))

type Rs ListGeoLocations

type Rs ListGeoLocations = ListGeoLocationsResponse

Request Lenses

lglStartSubdivisionCode :: Lens' ListGeoLocations (Maybe Text)

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)

(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)

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)

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

Arguments

:: Int

lglrsResponseStatus

-> Bool

lglrsIsTruncated

-> Text

lglrsMaxItems

-> 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 - 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 - 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 - 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 - -- | The response status code.
• lglrsGeoLocationDetailsList - A complex type that contains one GeoLocationDetails element 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 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 - The value that you specified for MaxItems in the request.

data ListGeoLocationsResponse

A complex type containing the response information for the request.

See: listGeoLocationsResponse smart constructor.

Instances

Eq ListGeoLocationsResponse

Methods

(==) :: ListGeoLocationsResponse -> ListGeoLocationsResponse -> Bool

(/=) :: ListGeoLocationsResponse -> ListGeoLocationsResponse -> Bool

Data ListGeoLocationsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListGeoLocationsResponse -> c ListGeoLocationsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListGeoLocationsResponse

toConstr :: ListGeoLocationsResponse -> Constr

dataTypeOf :: ListGeoLocationsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListGeoLocationsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListGeoLocationsResponse)

gmapT :: (forall b. Data b => b -> b) -> ListGeoLocationsResponse -> ListGeoLocationsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListGeoLocationsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListGeoLocationsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListGeoLocationsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListGeoLocationsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListGeoLocationsResponse -> m ListGeoLocationsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListGeoLocationsResponse -> m ListGeoLocationsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListGeoLocationsResponse -> m ListGeoLocationsResponse

Read ListGeoLocationsResponse

Methods

readsPrec :: Int -> ReadS ListGeoLocationsResponse

readList :: ReadS [ListGeoLocationsResponse]

readPrec :: ReadPrec ListGeoLocationsResponse

readListPrec :: ReadPrec [ListGeoLocationsResponse]

Show ListGeoLocationsResponse

Methods

showsPrec :: Int -> ListGeoLocationsResponse -> ShowS

show :: ListGeoLocationsResponse -> String

showList :: [ListGeoLocationsResponse] -> ShowS

Generic ListGeoLocationsResponse

Associated Types

type Rep ListGeoLocationsResponse :: * -> *

Methods

from :: ListGeoLocationsResponse -> Rep ListGeoLocationsResponse x

to :: Rep ListGeoLocationsResponse x -> ListGeoLocationsResponse

NFData ListGeoLocationsResponse

Methods

rnf :: ListGeoLocationsResponse -> ()

type Rep ListGeoLocationsResponse

type Rep ListGeoLocationsResponse = D1 * (MetaData "ListGeoLocationsResponse" "Network.AWS.Route53.ListGeoLocations" "amazonka-route53-1.6.0-Ak5sZypnFS3AFXHlAYIveI" False) (C1 * (MetaCons "ListGeoLocationsResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lglrsNextContinentCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lglrsNextCountryCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lglrsNextSubdivisionCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lglrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_lglrsGeoLocationDetailsList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [GeoLocationDetails]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lglrsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Bool)) (S1 * (MetaSel (Just Symbol "_lglrsMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

Response Lenses

lglrsNextContinentCode :: Lens' ListGeoLocationsResponse (Maybe Text)

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)

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)

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

• - | The response status code.

lglrsGeoLocationDetailsList :: Lens' ListGeoLocationsResponse [GeoLocationDetails]

A complex type that contains one GeoLocationDetails element for each location that Amazon Route 53 supports for geolocation.

lglrsIsTruncated :: Lens' ListGeoLocationsResponse Bool

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

The value that you specified for MaxItems in the request.