Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Location.UpdateTracker

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the specified properties of a given tracker resource.

Synopsis

data UpdateTracker = UpdateTracker' {
- pricingPlan :: Maybe PricingPlan
- pricingPlanDataSource :: Maybe Text
- description :: Maybe Text
- positionFiltering :: Maybe PositionFiltering
- trackerName :: Text
}
newUpdateTracker :: Text -> UpdateTracker
updateTracker_pricingPlan :: Lens' UpdateTracker (Maybe PricingPlan)
updateTracker_pricingPlanDataSource :: Lens' UpdateTracker (Maybe Text)
updateTracker_description :: Lens' UpdateTracker (Maybe Text)
updateTracker_positionFiltering :: Lens' UpdateTracker (Maybe PositionFiltering)
updateTracker_trackerName :: Lens' UpdateTracker Text
data UpdateTrackerResponse = UpdateTrackerResponse' {
- httpStatus :: Int
- trackerArn :: Text
- trackerName :: Text
- updateTime :: POSIX
}
newUpdateTrackerResponse :: Int -> Text -> Text -> UTCTime -> UpdateTrackerResponse
updateTrackerResponse_httpStatus :: Lens' UpdateTrackerResponse Int
updateTrackerResponse_trackerArn :: Lens' UpdateTrackerResponse Text
updateTrackerResponse_trackerName :: Lens' UpdateTrackerResponse Text
updateTrackerResponse_updateTime :: Lens' UpdateTrackerResponse UTCTime

Creating a Request

data UpdateTracker Source #

See: newUpdateTracker smart constructor.

Constructors

UpdateTracker'

Fields

pricingPlan :: Maybe PricingPlan
Updates the pricing plan for the tracker resource.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing.
pricingPlanDataSource :: Maybe Text
Updates the data provider for the tracker resource.
A required value for the following pricing plans: MobileAssetTracking| MobileAssetManagement
For more information about data providers and pricing plans, see the Amazon Location Service product page
This can only be updated when updating the PricingPlan in the same request.
Amazon Location Service uses PricingPlanDataSource to calculate billing for your tracker resource. Your data won't be shared with the data provider, and will remain in your AWS account and Region unless you move it.
description :: Maybe Text
Updates the description for the tracker resource.
positionFiltering :: Maybe PositionFiltering
Updates the position filtering for the tracker resource.
Valid values:
- TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.
- DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and device positions to retrieve. Distance-based filtering can also reduce the jitter effect when displaying device trajectory on a map.
trackerName :: Text
The name of the tracker resource to update.

Instances

Instances details

Eq UpdateTracker Source #
Instance details Defined in Amazonka.Location.UpdateTracker Methods (==) :: UpdateTracker -> UpdateTracker -> Bool # (/=) :: UpdateTracker -> UpdateTracker -> Bool #
Read UpdateTracker Source #
Instance details Defined in Amazonka.Location.UpdateTracker Methods readsPrec :: Int -> ReadS UpdateTracker # readList :: ReadS [UpdateTracker] # readPrec :: ReadPrec UpdateTracker # readListPrec :: ReadPrec [UpdateTracker] #
Show UpdateTracker Source #
Instance details Defined in Amazonka.Location.UpdateTracker Methods showsPrec :: Int -> UpdateTracker -> ShowS # show :: UpdateTracker -> String # showList :: [UpdateTracker] -> ShowS #
Generic UpdateTracker Source #
Instance details Defined in Amazonka.Location.UpdateTracker Associated Types type Rep UpdateTracker :: Type -> Type # Methods from :: UpdateTracker -> Rep UpdateTracker x # to :: Rep UpdateTracker x -> UpdateTracker #
NFData UpdateTracker Source #
Instance details Defined in Amazonka.Location.UpdateTracker Methods rnf :: UpdateTracker -> () #
Hashable UpdateTracker Source #
Instance details Defined in Amazonka.Location.UpdateTracker Methods hashWithSalt :: Int -> UpdateTracker -> Int # hash :: UpdateTracker -> Int #
ToJSON UpdateTracker Source #
Instance details Defined in Amazonka.Location.UpdateTracker Methods toJSON :: UpdateTracker -> Value # toEncoding :: UpdateTracker -> Encoding # toJSONList :: [UpdateTracker] -> Value # toEncodingList :: [UpdateTracker] -> Encoding #
AWSRequest UpdateTracker Source #
Instance details Defined in Amazonka.Location.UpdateTracker Associated Types type AWSResponse UpdateTracker # Methods request :: UpdateTracker -> Request UpdateTracker # response :: MonadResource m => Logger -> Service -> Proxy UpdateTracker -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateTracker))) #
ToHeaders UpdateTracker Source #
Instance details Defined in Amazonka.Location.UpdateTracker Methods toHeaders :: UpdateTracker -> [Header] #
ToPath UpdateTracker Source #
Instance details Defined in Amazonka.Location.UpdateTracker Methods toPath :: UpdateTracker -> ByteString #
ToQuery UpdateTracker Source #
Instance details Defined in Amazonka.Location.UpdateTracker Methods toQuery :: UpdateTracker -> QueryString #
type Rep UpdateTracker Source #
Instance details Defined in Amazonka.Location.UpdateTracker type Rep UpdateTracker = D1 ('MetaData "UpdateTracker" "Amazonka.Location.UpdateTracker" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "UpdateTracker'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "pricingPlan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PricingPlan)) :: S1 ('MetaSel ('Just "pricingPlanDataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "positionFiltering") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PositionFiltering)) :: S1 ('MetaSel ('Just "trackerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse UpdateTracker Source #
Instance details Defined in Amazonka.Location.UpdateTracker type AWSResponse UpdateTracker = UpdateTrackerResponse

newUpdateTracker Source #

Arguments

:: Text	`$sel:trackerName:UpdateTracker'`
-> UpdateTracker

Create a value of UpdateTracker 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:pricingPlan:UpdateTracker', updateTracker_pricingPlan - Updates the pricing plan for the tracker resource.

For more information about each pricing plan option restrictions, see Amazon Location Service pricing.

$sel:pricingPlanDataSource:UpdateTracker', updateTracker_pricingPlanDataSource - Updates the data provider for the tracker resource.

A required value for the following pricing plans: MobileAssetTracking| MobileAssetManagement

For more information about data providers and pricing plans, see the Amazon Location Service product page

This can only be updated when updating the PricingPlan in the same request.

Amazon Location Service uses PricingPlanDataSource to calculate billing for your tracker resource. Your data won't be shared with the data provider, and will remain in your AWS account and Region unless you move it.

$sel:description:UpdateTracker', updateTracker_description - Updates the description for the tracker resource.

$sel:positionFiltering:UpdateTracker', updateTracker_positionFiltering - Updates the position filtering for the tracker resource.

Valid values:

TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.
DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and device positions to retrieve. Distance-based filtering can also reduce the jitter effect when displaying device trajectory on a map.

$sel:trackerName:UpdateTracker', updateTracker_trackerName - The name of the tracker resource to update.

Request Lenses

updateTracker_pricingPlan :: Lens' UpdateTracker (Maybe PricingPlan) Source #

Updates the pricing plan for the tracker resource.

For more information about each pricing plan option restrictions, see Amazon Location Service pricing.

updateTracker_pricingPlanDataSource :: Lens' UpdateTracker (Maybe Text) Source #

Updates the data provider for the tracker resource.

A required value for the following pricing plans: MobileAssetTracking| MobileAssetManagement

For more information about data providers and pricing plans, see the Amazon Location Service product page

This can only be updated when updating the PricingPlan in the same request.

Amazon Location Service uses PricingPlanDataSource to calculate billing for your tracker resource. Your data won't be shared with the data provider, and will remain in your AWS account and Region unless you move it.

updateTracker_description :: Lens' UpdateTracker (Maybe Text) Source #

Updates the description for the tracker resource.

updateTracker_positionFiltering :: Lens' UpdateTracker (Maybe PositionFiltering) Source #

Updates the position filtering for the tracker resource.

Valid values:

TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.
DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and device positions to retrieve. Distance-based filtering can also reduce the jitter effect when displaying device trajectory on a map.

updateTracker_trackerName :: Lens' UpdateTracker Text Source #

The name of the tracker resource to update.

Destructuring the Response

data UpdateTrackerResponse Source #

See: newUpdateTrackerResponse smart constructor.

Constructors

UpdateTrackerResponse'

Fields

httpStatus :: Int
The response's http status code.
trackerArn :: Text
The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across AWS.
- Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker
trackerName :: Text
The name of the updated tracker resource.
updateTime :: POSIX
The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Instances

Instances details

Eq UpdateTrackerResponse Source #
Instance details Defined in Amazonka.Location.UpdateTracker Methods (==) :: UpdateTrackerResponse -> UpdateTrackerResponse -> Bool # (/=) :: UpdateTrackerResponse -> UpdateTrackerResponse -> Bool #
Read UpdateTrackerResponse Source #
Instance details Defined in Amazonka.Location.UpdateTracker Methods readsPrec :: Int -> ReadS UpdateTrackerResponse # readList :: ReadS [UpdateTrackerResponse] # readPrec :: ReadPrec UpdateTrackerResponse # readListPrec :: ReadPrec [UpdateTrackerResponse] #
Show UpdateTrackerResponse Source #
Instance details Defined in Amazonka.Location.UpdateTracker Methods showsPrec :: Int -> UpdateTrackerResponse -> ShowS # show :: UpdateTrackerResponse -> String # showList :: [UpdateTrackerResponse] -> ShowS #
Generic UpdateTrackerResponse Source #
Instance details Defined in Amazonka.Location.UpdateTracker Associated Types type Rep UpdateTrackerResponse :: Type -> Type # Methods from :: UpdateTrackerResponse -> Rep UpdateTrackerResponse x # to :: Rep UpdateTrackerResponse x -> UpdateTrackerResponse #
NFData UpdateTrackerResponse Source #
Instance details Defined in Amazonka.Location.UpdateTracker Methods rnf :: UpdateTrackerResponse -> () #
type Rep UpdateTrackerResponse Source #
Instance details Defined in Amazonka.Location.UpdateTracker type Rep UpdateTrackerResponse = D1 ('MetaData "UpdateTrackerResponse" "Amazonka.Location.UpdateTracker" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "UpdateTrackerResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "trackerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "trackerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "updateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))

newUpdateTrackerResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateTrackerResponse'`
-> Text	`$sel:trackerArn:UpdateTrackerResponse'`
-> Text	`$sel:trackerName:UpdateTracker'`
-> UTCTime	`$sel:updateTime:UpdateTrackerResponse'`
-> UpdateTrackerResponse

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

$sel:trackerArn:UpdateTrackerResponse', updateTrackerResponse_trackerArn - The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across AWS.

Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

$sel:trackerName:UpdateTracker', updateTrackerResponse_trackerName - The name of the updated tracker resource.

$sel:updateTime:UpdateTrackerResponse', updateTrackerResponse_updateTime - The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Response Lenses

updateTrackerResponse_httpStatus :: Lens' UpdateTrackerResponse Int Source #

The response's http status code.

updateTrackerResponse_trackerArn :: Lens' UpdateTrackerResponse Text Source #

The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across AWS.

Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

updateTrackerResponse_trackerName :: Lens' UpdateTrackerResponse Text Source #

The name of the updated tracker resource.

updateTrackerResponse_updateTime :: Lens' UpdateTrackerResponse UTCTime Source #

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