amazonka-location-2.0: Amazon Location Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Location.GetGeofence

Description

Retrieves the geofence details from a geofence collection.

Synopsis

Creating a Request

data GetGeofence Source #

See: newGetGeofence smart constructor.

Constructors

GetGeofence' 

Fields

Instances

Instances details
ToHeaders GetGeofence Source # 
Instance details

Defined in Amazonka.Location.GetGeofence

Methods

toHeaders :: GetGeofence -> [Header] #

ToPath GetGeofence Source # 
Instance details

Defined in Amazonka.Location.GetGeofence

ToQuery GetGeofence Source # 
Instance details

Defined in Amazonka.Location.GetGeofence

AWSRequest GetGeofence Source # 
Instance details

Defined in Amazonka.Location.GetGeofence

Associated Types

type AWSResponse GetGeofence #

Generic GetGeofence Source # 
Instance details

Defined in Amazonka.Location.GetGeofence

Associated Types

type Rep GetGeofence :: Type -> Type #

Read GetGeofence Source # 
Instance details

Defined in Amazonka.Location.GetGeofence

Show GetGeofence Source # 
Instance details

Defined in Amazonka.Location.GetGeofence

NFData GetGeofence Source # 
Instance details

Defined in Amazonka.Location.GetGeofence

Methods

rnf :: GetGeofence -> () #

Eq GetGeofence Source # 
Instance details

Defined in Amazonka.Location.GetGeofence

Hashable GetGeofence Source # 
Instance details

Defined in Amazonka.Location.GetGeofence

type AWSResponse GetGeofence Source # 
Instance details

Defined in Amazonka.Location.GetGeofence

type Rep GetGeofence Source # 
Instance details

Defined in Amazonka.Location.GetGeofence

type Rep GetGeofence = D1 ('MetaData "GetGeofence" "Amazonka.Location.GetGeofence" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "GetGeofence'" 'PrefixI 'True) (S1 ('MetaSel ('Just "collectionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "geofenceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetGeofence Source #

Create a value of GetGeofence 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:

GetGeofence, getGeofence_collectionName - The geofence collection storing the target geofence.

GetGeofence, getGeofence_geofenceId - The geofence you're retrieving details for.

Request Lenses

getGeofence_collectionName :: Lens' GetGeofence Text Source #

The geofence collection storing the target geofence.

getGeofence_geofenceId :: Lens' GetGeofence Text Source #

The geofence you're retrieving details for.

Destructuring the Response

data GetGeofenceResponse Source #

See: newGetGeofenceResponse smart constructor.

Constructors

GetGeofenceResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • createTime :: ISO8601

    The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

  • geofenceId :: Text

    The geofence identifier.

  • geometry :: GeofenceGeometry

    Contains the geofence geometry details describing a polygon or a circle.

  • status :: Text

    Identifies the state of the geofence. A geofence will hold one of the following states:

    • ACTIVE — The geofence has been indexed by the system.
    • PENDING — The geofence is being processed by the system.
    • FAILED — The geofence failed to be indexed by the system.
    • DELETED — The geofence has been deleted from the system index.
    • DELETING — The geofence is being deleted from the system index.
  • updateTime :: ISO8601

    The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Instances

Instances details
Generic GetGeofenceResponse Source # 
Instance details

Defined in Amazonka.Location.GetGeofence

Associated Types

type Rep GetGeofenceResponse :: Type -> Type #

Show GetGeofenceResponse Source # 
Instance details

Defined in Amazonka.Location.GetGeofence

NFData GetGeofenceResponse Source # 
Instance details

Defined in Amazonka.Location.GetGeofence

Methods

rnf :: GetGeofenceResponse -> () #

Eq GetGeofenceResponse Source # 
Instance details

Defined in Amazonka.Location.GetGeofence

type Rep GetGeofenceResponse Source # 
Instance details

Defined in Amazonka.Location.GetGeofence

type Rep GetGeofenceResponse = D1 ('MetaData "GetGeofenceResponse" "Amazonka.Location.GetGeofence" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "GetGeofenceResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601) :*: S1 ('MetaSel ('Just "geofenceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "geometry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GeofenceGeometry) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "updateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601)))))

newGetGeofenceResponse Source #

Create a value of GetGeofenceResponse 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:httpStatus:GetGeofenceResponse', getGeofenceResponse_httpStatus - The response's http status code.

GetGeofenceResponse, getGeofenceResponse_createTime - The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

GetGeofence, getGeofenceResponse_geofenceId - The geofence identifier.

GetGeofenceResponse, getGeofenceResponse_geometry - Contains the geofence geometry details describing a polygon or a circle.

GetGeofenceResponse, getGeofenceResponse_status - Identifies the state of the geofence. A geofence will hold one of the following states:

  • ACTIVE — The geofence has been indexed by the system.
  • PENDING — The geofence is being processed by the system.
  • FAILED — The geofence failed to be indexed by the system.
  • DELETED — The geofence has been deleted from the system index.
  • DELETING — The geofence is being deleted from the system index.

GetGeofenceResponse, getGeofenceResponse_updateTime - The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Response Lenses

getGeofenceResponse_createTime :: Lens' GetGeofenceResponse UTCTime Source #

The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

getGeofenceResponse_geometry :: Lens' GetGeofenceResponse GeofenceGeometry Source #

Contains the geofence geometry details describing a polygon or a circle.

getGeofenceResponse_status :: Lens' GetGeofenceResponse Text Source #

Identifies the state of the geofence. A geofence will hold one of the following states:

  • ACTIVE — The geofence has been indexed by the system.
  • PENDING — The geofence is being processed by the system.
  • FAILED — The geofence failed to be indexed by the system.
  • DELETED — The geofence has been deleted from the system index.
  • DELETING — The geofence is being deleted from the system index.

getGeofenceResponse_updateTime :: Lens' GetGeofenceResponse UTCTime Source #

The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ