Network.AWS.Route53.ListGeoLocations

To retrieve a list of supported geo locations, send a GET request to the '/Route 53 API version/geolocations' resource. The response to this request includes a GeoLocationDetailsList element with zero, one, or multiple GeoLocationDetails child elements. The list is sorted by country code, and then subdivision code, followed by continents at the end of the list.

By default, the list of geo locations is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. If the list is truncated, IsTruncated will be set to true and a combination of 'NextContinentCode, NextCountryCode, NextSubdivisionCode' will be populated. You can pass these as parameters to 'StartContinentCode, StartCountryCode, StartSubdivisionCode' to control the geo location that the list begins with.

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
• lglMaxItems
• lglStartCountryCode
• lglStartContinentCode

data ListGeoLocations

The input for a ListGeoLocations request.

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 => Logger -> Service -> Proxy * ListGeoLocations -> ClientResponse -> m (Response ListGeoLocations)

ToPath ListGeoLocations

Methods

toPath :: ListGeoLocations -> ByteString

ToHeaders ListGeoLocations

Methods

toHeaders :: ListGeoLocations -> [Header]

ToQuery ListGeoLocations

Methods

toQuery :: ListGeoLocations -> QueryString

type Rep ListGeoLocations

type Rep ListGeoLocations = D1 (MetaData "ListGeoLocations" "Network.AWS.Route53.ListGeoLocations" "amazonka-route53-1.4.2-5wB4fBZ2k8UCgPOMIGXT9n" 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 first subdivision code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.

Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

lglMaxItems :: Lens' ListGeoLocations (Maybe Text)

The maximum number of geo locations you want in the response body.

lglStartCountryCode :: Lens' ListGeoLocations (Maybe Text)

The first country code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.

The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

lglStartContinentCode :: Lens' ListGeoLocations (Maybe Text)

The first continent code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list. For non-continent geo locations, this should be null.

Valid values: AF | AN | AS | EU | OC | NA | SA

Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

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
• lglrsNextCountryCode
• lglrsNextSubdivisionCode
• lglrsResponseStatus
• lglrsGeoLocationDetailsList
• lglrsIsTruncated
• lglrsMaxItems

data ListGeoLocationsResponse

A complex type that contains information about the geo locations that are returned by the request and information about the response.

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.4.2-5wB4fBZ2k8UCgPOMIGXT9n" 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 the results were truncated, the continent code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location to list is a continent location.

lglrsNextCountryCode :: Lens' ListGeoLocationsResponse (Maybe Text)

If the results were truncated, the country code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location to list is not a continent location.

lglrsNextSubdivisionCode :: Lens' ListGeoLocationsResponse (Maybe Text)

If the results were truncated, the subdivision code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location has a subdivision.

lglrsResponseStatus :: Lens' ListGeoLocationsResponse Int

The response status code.

lglrsGeoLocationDetailsList :: Lens' ListGeoLocationsResponse [GeoLocationDetails]

A complex type that contains information about the geo locations that are returned by the request.

lglrsIsTruncated :: Lens' ListGeoLocationsResponse Bool

A flag that indicates whether there are more geo locations to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the values included in the ListGeoLocationsResponse$NextContinentCode, ListGeoLocationsResponse$NextCountryCode and ListGeoLocationsResponse$NextSubdivisionCode elements.

Valid Values: true | false

lglrsMaxItems :: Lens' ListGeoLocationsResponse Text

The maximum number of records you requested. The maximum value of MaxItems is 100.