Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Location.GetGeofence

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the geofence details from a geofence collection.

Synopsis

data GetGeofence = GetGeofence' {
- collectionName :: Text
- geofenceId :: Text
}
newGetGeofence :: Text -> Text -> GetGeofence
getGeofence_collectionName :: Lens' GetGeofence Text
getGeofence_geofenceId :: Lens' GetGeofence Text
data GetGeofenceResponse = GetGeofenceResponse' {
- httpStatus :: Int
- createTime :: ISO8601
- geofenceId :: Text
- geometry :: GeofenceGeometry
- status :: Text
- updateTime :: ISO8601
}
newGetGeofenceResponse :: Int -> UTCTime -> Text -> GeofenceGeometry -> Text -> UTCTime -> GetGeofenceResponse
getGeofenceResponse_httpStatus :: Lens' GetGeofenceResponse Int
getGeofenceResponse_createTime :: Lens' GetGeofenceResponse UTCTime
getGeofenceResponse_geofenceId :: Lens' GetGeofenceResponse Text
getGeofenceResponse_geometry :: Lens' GetGeofenceResponse GeofenceGeometry
getGeofenceResponse_status :: Lens' GetGeofenceResponse Text
getGeofenceResponse_updateTime :: Lens' GetGeofenceResponse UTCTime

Creating a Request

data GetGeofence Source #

See: newGetGeofence smart constructor.

Constructors

GetGeofence'
Fields collectionName :: Text The geofence collection storing the target geofence. geofenceId :: Text The geofence you're retrieving details for.

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 Methods toPath :: GetGeofence -> ByteString #
ToQuery GetGeofence Source #
Instance details Defined in Amazonka.Location.GetGeofence Methods toQuery :: GetGeofence -> QueryString #
AWSRequest GetGeofence Source #
Instance details Defined in Amazonka.Location.GetGeofence Associated Types type AWSResponse GetGeofence # Methods request :: (Service -> Service) -> GetGeofence -> Request GetGeofence # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetGeofence -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetGeofence))) #
Generic GetGeofence Source #
Instance details Defined in Amazonka.Location.GetGeofence Associated Types type Rep GetGeofence :: Type -> Type # Methods from :: GetGeofence -> Rep GetGeofence x # to :: Rep GetGeofence x -> GetGeofence #
Read GetGeofence Source #
Instance details Defined in Amazonka.Location.GetGeofence Methods readsPrec :: Int -> ReadS GetGeofence # readList :: ReadS [GetGeofence] # readPrec :: ReadPrec GetGeofence # readListPrec :: ReadPrec [GetGeofence] #
Show GetGeofence Source #
Instance details Defined in Amazonka.Location.GetGeofence Methods showsPrec :: Int -> GetGeofence -> ShowS # show :: GetGeofence -> String # showList :: [GetGeofence] -> ShowS #
NFData GetGeofence Source #
Instance details Defined in Amazonka.Location.GetGeofence Methods rnf :: GetGeofence -> () #
Eq GetGeofence Source #
Instance details Defined in Amazonka.Location.GetGeofence Methods (==) :: GetGeofence -> GetGeofence -> Bool # (/=) :: GetGeofence -> GetGeofence -> Bool #
Hashable GetGeofence Source #
Instance details Defined in Amazonka.Location.GetGeofence Methods hashWithSalt :: Int -> GetGeofence -> Int # hash :: GetGeofence -> Int #
type AWSResponse GetGeofence Source #
Instance details Defined in Amazonka.Location.GetGeofence type AWSResponse GetGeofence = GetGeofenceResponse
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 #

Arguments

:: Text	`GetGeofence`
-> Text	`GetGeofence`
-> GetGeofence

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 # Methods from :: GetGeofenceResponse -> Rep GetGeofenceResponse x # to :: Rep GetGeofenceResponse x -> GetGeofenceResponse #
Show GetGeofenceResponse Source #
Instance details Defined in Amazonka.Location.GetGeofence Methods showsPrec :: Int -> GetGeofenceResponse -> ShowS # show :: GetGeofenceResponse -> String # showList :: [GetGeofenceResponse] -> ShowS #
NFData GetGeofenceResponse Source #
Instance details Defined in Amazonka.Location.GetGeofence Methods rnf :: GetGeofenceResponse -> () #
Eq GetGeofenceResponse Source #
Instance details Defined in Amazonka.Location.GetGeofence Methods (==) :: GetGeofenceResponse -> GetGeofenceResponse -> Bool # (/=) :: GetGeofenceResponse -> GetGeofenceResponse -> Bool #
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 #

Arguments

:: Int	`$sel:httpStatus:GetGeofenceResponse'`
-> UTCTime	`GetGeofenceResponse`
-> Text	`GetGeofence`
-> GeofenceGeometry	`GetGeofenceResponse`
-> Text	`GetGeofenceResponse`
-> UTCTime	`GetGeofenceResponse`
-> GetGeofenceResponse

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_httpStatus :: Lens' GetGeofenceResponse Int Source #

The response's http status code.

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_geofenceId :: Lens' GetGeofenceResponse Text Source #

The geofence identifier.

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