Amazonka.Location.Types.GeofenceGeometry

Documentation

data GeofenceGeometry

Contains the geofence geometry details.

A geofence geometry is made up of either a polygon or a circle. Can be either a polygon or a circle. Including both will return a validation error.

Amazon Location doesn't currently support polygons with holes, multipolygons, polygons that are wound clockwise, or that cross the antimeridian.

See: newGeofenceGeometry smart constructor.

Constructors

GeofenceGeometry'

Fields

• circle :: Maybe (Sensitive Circle)

  A circle on the earth, as defined by a center point and a radius.

• polygon :: Maybe (NonEmpty (NonEmpty (Sensitive (NonEmpty Double))))

  A polygon is a list of linear rings which are each made up of a list of vertices.

  Each vertex is a 2-dimensional point of the form: [longitude, latitude]. This is represented as an array of doubles of length 2 (so [double, double]).

  An array of 4 or more vertices, where the first and last vertex are the same (to form a closed boundary), is called a linear ring. The linear ring vertices must be listed in counter-clockwise order around the ring’s interior. The linear ring is represented as an array of vertices, or an array of arrays of doubles ([[double, double], ...]).

  A geofence consists of a single linear ring. To allow for future expansion, the Polygon parameter takes an array of linear rings, which is represented as an array of arrays of arrays of doubles ([[[double, double], ...], ...]).

  A linear ring for use in geofences can consist of between 4 and 1,000 vertices.

Instances

FromJSON GeofenceGeometry

Defined in Amazonka.Location.Types.GeofenceGeometry

Methods

parseJSON :: Value -> Parser GeofenceGeometry

parseJSONList :: Value -> Parser [GeofenceGeometry]

ToJSON GeofenceGeometry

Defined in Amazonka.Location.Types.GeofenceGeometry

Methods

toJSON :: GeofenceGeometry -> Value

toEncoding :: GeofenceGeometry -> Encoding

toJSONList :: [GeofenceGeometry] -> Value

toEncodingList :: [GeofenceGeometry] -> Encoding

Generic GeofenceGeometry

Defined in Amazonka.Location.Types.GeofenceGeometry

Associated Types

type Rep GeofenceGeometry :: Type -> Type

Methods

from :: GeofenceGeometry -> Rep GeofenceGeometry x

to :: Rep GeofenceGeometry x -> GeofenceGeometry

Show GeofenceGeometry

Defined in Amazonka.Location.Types.GeofenceGeometry

Methods

showsPrec :: Int -> GeofenceGeometry -> ShowS

show :: GeofenceGeometry -> String

showList :: [GeofenceGeometry] -> ShowS

NFData GeofenceGeometry

Defined in Amazonka.Location.Types.GeofenceGeometry

Methods

rnf :: GeofenceGeometry -> ()

Eq GeofenceGeometry

Defined in Amazonka.Location.Types.GeofenceGeometry

Methods

(==) :: GeofenceGeometry -> GeofenceGeometry -> Bool

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

Hashable GeofenceGeometry

Defined in Amazonka.Location.Types.GeofenceGeometry

Methods

hashWithSalt :: Int -> GeofenceGeometry -> Int

hash :: GeofenceGeometry -> Int

type Rep GeofenceGeometry

Defined in Amazonka.Location.Types.GeofenceGeometry

type Rep GeofenceGeometry = D1 ('MetaData "GeofenceGeometry" "Amazonka.Location.Types.GeofenceGeometry" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "GeofenceGeometry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "circle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Circle))) :*: S1 ('MetaSel ('Just "polygon") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty (NonEmpty (Sensitive (NonEmpty Double))))))))

newGeofenceGeometry :: GeofenceGeometry

Create a value of GeofenceGeometry 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:circle:GeofenceGeometry', geofenceGeometry_circle - A circle on the earth, as defined by a center point and a radius.

$sel:polygon:GeofenceGeometry', geofenceGeometry_polygon - A polygon is a list of linear rings which are each made up of a list of vertices.

Each vertex is a 2-dimensional point of the form: [longitude, latitude]. This is represented as an array of doubles of length 2 (so [double, double]).

An array of 4 or more vertices, where the first and last vertex are the same (to form a closed boundary), is called a linear ring. The linear ring vertices must be listed in counter-clockwise order around the ring’s interior. The linear ring is represented as an array of vertices, or an array of arrays of doubles ([[double, double], ...]).

A geofence consists of a single linear ring. To allow for future expansion, the Polygon parameter takes an array of linear rings, which is represented as an array of arrays of arrays of doubles ([[[double, double], ...], ...]).

A linear ring for use in geofences can consist of between 4 and 1,000 vertices.

geofenceGeometry_circle :: Lens' GeofenceGeometry (Maybe Circle)

A circle on the earth, as defined by a center point and a radius.

geofenceGeometry_polygon :: Lens' GeofenceGeometry (Maybe (NonEmpty (NonEmpty (NonEmpty Double))))

A polygon is a list of linear rings which are each made up of a list of vertices.

Each vertex is a 2-dimensional point of the form: [longitude, latitude]. This is represented as an array of doubles of length 2 (so [double, double]).

An array of 4 or more vertices, where the first and last vertex are the same (to form a closed boundary), is called a linear ring. The linear ring vertices must be listed in counter-clockwise order around the ring’s interior. The linear ring is represented as an array of vertices, or an array of arrays of doubles ([[double, double], ...]).

A geofence consists of a single linear ring. To allow for future expansion, the Polygon parameter takes an array of linear rings, which is represented as an array of arrays of arrays of doubles ([[[double, double], ...], ...]).

A linear ring for use in geofences can consist of between 4 and 1,000 vertices.