libZSservicesZSamazonka-locationZSamazonka-location
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Location.Types.GeofenceGeometry

Description

 
Synopsis

Documentation

data GeofenceGeometry Source #

Contains the geofence geometry details.

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

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

    An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form: [longitude, latitude].

    The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.

Instances

Instances details
Eq GeofenceGeometry Source # 
Instance details

Defined in Amazonka.Location.Types.GeofenceGeometry

Show GeofenceGeometry Source # 
Instance details

Defined in Amazonka.Location.Types.GeofenceGeometry

Generic GeofenceGeometry Source # 
Instance details

Defined in Amazonka.Location.Types.GeofenceGeometry

Associated Types

type Rep GeofenceGeometry :: Type -> Type #

NFData GeofenceGeometry Source # 
Instance details

Defined in Amazonka.Location.Types.GeofenceGeometry

Methods

rnf :: GeofenceGeometry -> () #

Hashable GeofenceGeometry Source # 
Instance details

Defined in Amazonka.Location.Types.GeofenceGeometry

ToJSON GeofenceGeometry Source # 
Instance details

Defined in Amazonka.Location.Types.GeofenceGeometry

FromJSON GeofenceGeometry Source # 
Instance details

Defined in Amazonka.Location.Types.GeofenceGeometry

type Rep GeofenceGeometry Source # 
Instance details

Defined in Amazonka.Location.Types.GeofenceGeometry

type Rep GeofenceGeometry = D1 ('MetaData "GeofenceGeometry" "Amazonka.Location.Types.GeofenceGeometry" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "GeofenceGeometry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "polygon") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty (NonEmpty (Sensitive (NonEmpty Double))))))))

newGeofenceGeometry :: GeofenceGeometry Source #

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:polygon:GeofenceGeometry', geofenceGeometry_polygon - An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form: [longitude, latitude].

The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.

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

An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form: [longitude, latitude].

The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.