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.PutGeofence

Description

Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.

Synopsis

Creating a Request

data PutGeofence Source #

See: newPutGeofence smart constructor.

Constructors

PutGeofence' 

Fields

Instances

Instances details
Eq PutGeofence Source # 
Instance details

Defined in Amazonka.Location.PutGeofence

Methods

(==) :: PutGeofence -> PutGeofence -> Bool #

(/=) :: PutGeofence -> PutGeofence -> Bool #

Show PutGeofence Source # 
Instance details

Defined in Amazonka.Location.PutGeofence

Methods

showsPrec :: Int -> PutGeofence -> ShowS #

show :: PutGeofence -> String #

showList :: [PutGeofence] -> ShowS #

Generic PutGeofence Source # 
Instance details

Defined in Amazonka.Location.PutGeofence

Associated Types

type Rep PutGeofence :: Type -> Type #

Methods

from :: PutGeofence -> Rep PutGeofence x #

to :: Rep PutGeofence x -> PutGeofence #

NFData PutGeofence Source # 
Instance details

Defined in Amazonka.Location.PutGeofence

Methods

rnf :: PutGeofence -> () #

Hashable PutGeofence Source # 
Instance details

Defined in Amazonka.Location.PutGeofence

Methods

hashWithSalt :: Int -> PutGeofence -> Int #

hash :: PutGeofence -> Int #

ToJSON PutGeofence Source # 
Instance details

Defined in Amazonka.Location.PutGeofence

Methods

toJSON :: PutGeofence -> Value #

toEncoding :: PutGeofence -> Encoding #

toJSONList :: [PutGeofence] -> Value #

toEncodingList :: [PutGeofence] -> Encoding #

AWSRequest PutGeofence Source # 
Instance details

Defined in Amazonka.Location.PutGeofence

Associated Types

type AWSResponse PutGeofence #

Methods

request :: PutGeofence -> Request PutGeofence #

response :: MonadResource m => Logger -> Service -> Proxy PutGeofence -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutGeofence))) #

ToHeaders PutGeofence Source # 
Instance details

Defined in Amazonka.Location.PutGeofence

Methods

toHeaders :: PutGeofence -> [Header] #

ToPath PutGeofence Source # 
Instance details

Defined in Amazonka.Location.PutGeofence

Methods

toPath :: PutGeofence -> ByteString #

ToQuery PutGeofence Source # 
Instance details

Defined in Amazonka.Location.PutGeofence

Methods

toQuery :: PutGeofence -> QueryString #

type Rep PutGeofence Source # 
Instance details

Defined in Amazonka.Location.PutGeofence

type Rep PutGeofence = D1 ('MetaData "PutGeofence" "Amazonka.Location.PutGeofence" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "PutGeofence'" 'PrefixI 'True) (S1 ('MetaSel ('Just "collectionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "geofenceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "geometry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GeofenceGeometry))))
type AWSResponse PutGeofence Source # 
Instance details

Defined in Amazonka.Location.PutGeofence

type AWSResponse PutGeofence = PutGeofenceResponse

newPutGeofence Source #

Arguments

:: Text

$sel:collectionName:PutGeofence'

-> Text

$sel:geofenceId:PutGeofence'

-> GeofenceGeometry

$sel:geometry:PutGeofence'

-> PutGeofence 

Create a value of PutGeofence 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:collectionName:PutGeofence', putGeofence_collectionName - The geofence collection to store the geofence in.

$sel:geofenceId:PutGeofence', putGeofence_geofenceId - An identifier for the geofence. For example, ExampleGeofence-1.

$sel:geometry:PutGeofence', putGeofence_geometry - Contains the polygon details to specify the position of the geofence.

Each geofence polygon can have a maximum of 1,000 vertices.

Request Lenses

putGeofence_collectionName :: Lens' PutGeofence Text Source #

The geofence collection to store the geofence in.

putGeofence_geofenceId :: Lens' PutGeofence Text Source #

An identifier for the geofence. For example, ExampleGeofence-1.

putGeofence_geometry :: Lens' PutGeofence GeofenceGeometry Source #

Contains the polygon details to specify the position of the geofence.

Each geofence polygon can have a maximum of 1,000 vertices.

Destructuring the Response

data PutGeofenceResponse Source #

See: newPutGeofenceResponse smart constructor.

Constructors

PutGeofenceResponse' 

Fields

Instances

Instances details
Eq PutGeofenceResponse Source # 
Instance details

Defined in Amazonka.Location.PutGeofence

Methods

(==) :: PutGeofenceResponse -> PutGeofenceResponse -> Bool #

(/=) :: PutGeofenceResponse -> PutGeofenceResponse -> Bool #

Read PutGeofenceResponse Source # 
Instance details

Defined in Amazonka.Location.PutGeofence

Methods

readsPrec :: Int -> ReadS PutGeofenceResponse #

readList :: ReadS [PutGeofenceResponse] #

readPrec :: ReadPrec PutGeofenceResponse #

readListPrec :: ReadPrec [PutGeofenceResponse] #

Show PutGeofenceResponse Source # 
Instance details

Defined in Amazonka.Location.PutGeofence

Methods

showsPrec :: Int -> PutGeofenceResponse -> ShowS #

show :: PutGeofenceResponse -> String #

showList :: [PutGeofenceResponse] -> ShowS #

Generic PutGeofenceResponse Source # 
Instance details

Defined in Amazonka.Location.PutGeofence

Associated Types

type Rep PutGeofenceResponse :: Type -> Type #

Methods

from :: PutGeofenceResponse -> Rep PutGeofenceResponse x #

to :: Rep PutGeofenceResponse x -> PutGeofenceResponse #

NFData PutGeofenceResponse Source # 
Instance details

Defined in Amazonka.Location.PutGeofence

Methods

rnf :: PutGeofenceResponse -> () #

type Rep PutGeofenceResponse Source # 
Instance details

Defined in Amazonka.Location.PutGeofence

type Rep PutGeofenceResponse = D1 ('MetaData "PutGeofenceResponse" "Amazonka.Location.PutGeofence" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "PutGeofenceResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)) :*: (S1 ('MetaSel ('Just "geofenceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "updateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))

newPutGeofenceResponse Source #

Arguments

:: Int

$sel:httpStatus:PutGeofenceResponse'

-> UTCTime

$sel:createTime:PutGeofenceResponse'

-> Text

$sel:geofenceId:PutGeofence'

-> UTCTime

$sel:updateTime:PutGeofenceResponse'

-> PutGeofenceResponse 

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

$sel:createTime:PutGeofenceResponse', putGeofenceResponse_createTime - The timestamp for when the geofence was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

$sel:geofenceId:PutGeofence', putGeofenceResponse_geofenceId - The geofence identifier entered in the request.

$sel:updateTime:PutGeofenceResponse', putGeofenceResponse_updateTime - The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Response Lenses

putGeofenceResponse_httpStatus :: Lens' PutGeofenceResponse Int Source #

The response's http status code.

putGeofenceResponse_createTime :: Lens' PutGeofenceResponse UTCTime Source #

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

putGeofenceResponse_geofenceId :: Lens' PutGeofenceResponse Text Source #

The geofence identifier entered in the request.

putGeofenceResponse_updateTime :: Lens' PutGeofenceResponse UTCTime Source #

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