Amazonka.Pinpoint.Types.EndpointLocation

Documentation

data EndpointLocation

Specifies geographic information about an endpoint.

See: newEndpointLocation smart constructor.

Constructors

EndpointLocation'

Fields

• city :: Maybe Text

  The name of the city where the endpoint is located.

• country :: Maybe Text

  The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.

• latitude :: Maybe Double

  The latitude coordinate of the endpoint location, rounded to one decimal place.

• longitude :: Maybe Double

  The longitude coordinate of the endpoint location, rounded to one decimal place.

• postalCode :: Maybe Text

  The postal or ZIP code for the area where the endpoint is located.

• region :: Maybe Text

  The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.

Instances

FromJSON EndpointLocation

Defined in Amazonka.Pinpoint.Types.EndpointLocation

Methods

parseJSON :: Value -> Parser EndpointLocation

parseJSONList :: Value -> Parser [EndpointLocation]

ToJSON EndpointLocation

Defined in Amazonka.Pinpoint.Types.EndpointLocation

Methods

toJSON :: EndpointLocation -> Value

toEncoding :: EndpointLocation -> Encoding

toJSONList :: [EndpointLocation] -> Value

toEncodingList :: [EndpointLocation] -> Encoding

Generic EndpointLocation

Defined in Amazonka.Pinpoint.Types.EndpointLocation

Associated Types

type Rep EndpointLocation :: Type -> Type

Methods

from :: EndpointLocation -> Rep EndpointLocation x

to :: Rep EndpointLocation x -> EndpointLocation

Read EndpointLocation

Defined in Amazonka.Pinpoint.Types.EndpointLocation

Methods

readsPrec :: Int -> ReadS EndpointLocation

readList :: ReadS [EndpointLocation]

readPrec :: ReadPrec EndpointLocation

readListPrec :: ReadPrec [EndpointLocation]

Show EndpointLocation

Defined in Amazonka.Pinpoint.Types.EndpointLocation

Methods

showsPrec :: Int -> EndpointLocation -> ShowS

show :: EndpointLocation -> String

showList :: [EndpointLocation] -> ShowS

NFData EndpointLocation

Defined in Amazonka.Pinpoint.Types.EndpointLocation

Methods

rnf :: EndpointLocation -> ()

Eq EndpointLocation

Defined in Amazonka.Pinpoint.Types.EndpointLocation

Methods

(==) :: EndpointLocation -> EndpointLocation -> Bool

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

Hashable EndpointLocation

Defined in Amazonka.Pinpoint.Types.EndpointLocation

Methods

hashWithSalt :: Int -> EndpointLocation -> Int

hash :: EndpointLocation -> Int

type Rep EndpointLocation

Defined in Amazonka.Pinpoint.Types.EndpointLocation

type Rep EndpointLocation = D1 ('MetaData "EndpointLocation" "Amazonka.Pinpoint.Types.EndpointLocation" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "EndpointLocation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "city") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "country") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "latitude") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) :*: (S1 ('MetaSel ('Just "longitude") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "postalCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newEndpointLocation :: EndpointLocation

Create a value of EndpointLocation 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:city:EndpointLocation', endpointLocation_city - The name of the city where the endpoint is located.

$sel:country:EndpointLocation', endpointLocation_country - The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.

$sel:latitude:EndpointLocation', endpointLocation_latitude - The latitude coordinate of the endpoint location, rounded to one decimal place.

$sel:longitude:EndpointLocation', endpointLocation_longitude - The longitude coordinate of the endpoint location, rounded to one decimal place.

$sel:postalCode:EndpointLocation', endpointLocation_postalCode - The postal or ZIP code for the area where the endpoint is located.

$sel:region:EndpointLocation', endpointLocation_region - The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.

endpointLocation_city :: Lens' EndpointLocation (Maybe Text)

The name of the city where the endpoint is located.

endpointLocation_country :: Lens' EndpointLocation (Maybe Text)

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.

endpointLocation_latitude :: Lens' EndpointLocation (Maybe Double)

The latitude coordinate of the endpoint location, rounded to one decimal place.

endpointLocation_longitude :: Lens' EndpointLocation (Maybe Double)

The longitude coordinate of the endpoint location, rounded to one decimal place.

endpointLocation_postalCode :: Lens' EndpointLocation (Maybe Text)

The postal or ZIP code for the area where the endpoint is located.

endpointLocation_region :: Lens' EndpointLocation (Maybe Text)

The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.