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

Description

Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.

Synopsis

Creating a Request

data CreateTracker Source #

See: newCreateTracker smart constructor.

Constructors

CreateTracker' 

Fields

  • description :: Maybe Text

    An optional description for the tracker resource.

  • kmsKeyId :: Maybe Text

    A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

  • positionFiltering :: Maybe PositionFiltering

    Specifies 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 area are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.
    • AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This can reduce the effects of GPS noise when displaying device trajectories on a map, and can help control your costs by reducing the number of geofence evaluations.

    This field is optional. If not specified, the default value is TimeBased.

  • pricingPlan :: Maybe PricingPlan

    No longer used. If included, the only allowed value is RequestBasedUsage.

  • pricingPlanDataSource :: Maybe Text

    This parameter is no longer used.

  • tags :: Maybe (HashMap Text Text)

    Applies one or more tags to the tracker resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

    Format: "key" : "value"

    Restrictions:

    • Maximum 50 tags per resource
    • Each resource tag must be unique with a maximum of one value.
    • Maximum key length: 128 Unicode characters in UTF-8
    • Maximum value length: 256 Unicode characters in UTF-8
    • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
    • Cannot use "aws:" as a prefix for a key.
  • trackerName :: Text

    The name for the tracker resource.

    Requirements:

    • Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).
    • Must be a unique tracker resource name.
    • No spaces allowed. For example, ExampleTracker.

Instances

Instances details
ToJSON CreateTracker Source # 
Instance details

Defined in Amazonka.Location.CreateTracker

ToHeaders CreateTracker Source # 
Instance details

Defined in Amazonka.Location.CreateTracker

ToPath CreateTracker Source # 
Instance details

Defined in Amazonka.Location.CreateTracker

ToQuery CreateTracker Source # 
Instance details

Defined in Amazonka.Location.CreateTracker

AWSRequest CreateTracker Source # 
Instance details

Defined in Amazonka.Location.CreateTracker

Associated Types

type AWSResponse CreateTracker #

Generic CreateTracker Source # 
Instance details

Defined in Amazonka.Location.CreateTracker

Associated Types

type Rep CreateTracker :: Type -> Type #

Read CreateTracker Source # 
Instance details

Defined in Amazonka.Location.CreateTracker

Show CreateTracker Source # 
Instance details

Defined in Amazonka.Location.CreateTracker

NFData CreateTracker Source # 
Instance details

Defined in Amazonka.Location.CreateTracker

Methods

rnf :: CreateTracker -> () #

Eq CreateTracker Source # 
Instance details

Defined in Amazonka.Location.CreateTracker

Hashable CreateTracker Source # 
Instance details

Defined in Amazonka.Location.CreateTracker

type AWSResponse CreateTracker Source # 
Instance details

Defined in Amazonka.Location.CreateTracker

type Rep CreateTracker Source # 
Instance details

Defined in Amazonka.Location.CreateTracker

newCreateTracker Source #

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

CreateTracker, createTracker_description - An optional description for the tracker resource.

$sel:kmsKeyId:CreateTracker', createTracker_kmsKeyId - A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

$sel:positionFiltering:CreateTracker', createTracker_positionFiltering - Specifies 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 area are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.
  • AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This can reduce the effects of GPS noise when displaying device trajectories on a map, and can help control your costs by reducing the number of geofence evaluations.

This field is optional. If not specified, the default value is TimeBased.

CreateTracker, createTracker_pricingPlan - No longer used. If included, the only allowed value is RequestBasedUsage.

CreateTracker, createTracker_pricingPlanDataSource - This parameter is no longer used.

$sel:tags:CreateTracker', createTracker_tags - Applies one or more tags to the tracker resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource
  • Each resource tag must be unique with a maximum of one value.
  • Maximum key length: 128 Unicode characters in UTF-8
  • Maximum value length: 256 Unicode characters in UTF-8
  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
  • Cannot use "aws:" as a prefix for a key.

CreateTracker, createTracker_trackerName - The name for the tracker resource.

Requirements:

  • Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).
  • Must be a unique tracker resource name.
  • No spaces allowed. For example, ExampleTracker.

Request Lenses

createTracker_description :: Lens' CreateTracker (Maybe Text) Source #

An optional description for the tracker resource.

createTracker_kmsKeyId :: Lens' CreateTracker (Maybe Text) Source #

A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

createTracker_positionFiltering :: Lens' CreateTracker (Maybe PositionFiltering) Source #

Specifies 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 area are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.
  • AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This can reduce the effects of GPS noise when displaying device trajectories on a map, and can help control your costs by reducing the number of geofence evaluations.

This field is optional. If not specified, the default value is TimeBased.

createTracker_pricingPlan :: Lens' CreateTracker (Maybe PricingPlan) Source #

No longer used. If included, the only allowed value is RequestBasedUsage.

createTracker_tags :: Lens' CreateTracker (Maybe (HashMap Text Text)) Source #

Applies one or more tags to the tracker resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource
  • Each resource tag must be unique with a maximum of one value.
  • Maximum key length: 128 Unicode characters in UTF-8
  • Maximum value length: 256 Unicode characters in UTF-8
  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
  • Cannot use "aws:" as a prefix for a key.

createTracker_trackerName :: Lens' CreateTracker Text Source #

The name for the tracker resource.

Requirements:

  • Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).
  • Must be a unique tracker resource name.
  • No spaces allowed. For example, ExampleTracker.

Destructuring the Response

data CreateTrackerResponse Source #

See: newCreateTrackerResponse smart constructor.

Constructors

CreateTrackerResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • createTime :: ISO8601

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

  • trackerArn :: Text

    The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.

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

    The name of the tracker resource.

Instances

Instances details
Generic CreateTrackerResponse Source # 
Instance details

Defined in Amazonka.Location.CreateTracker

Associated Types

type Rep CreateTrackerResponse :: Type -> Type #

Read CreateTrackerResponse Source # 
Instance details

Defined in Amazonka.Location.CreateTracker

Show CreateTrackerResponse Source # 
Instance details

Defined in Amazonka.Location.CreateTracker

NFData CreateTrackerResponse Source # 
Instance details

Defined in Amazonka.Location.CreateTracker

Methods

rnf :: CreateTrackerResponse -> () #

Eq CreateTrackerResponse Source # 
Instance details

Defined in Amazonka.Location.CreateTracker

type Rep CreateTrackerResponse Source # 
Instance details

Defined in Amazonka.Location.CreateTracker

type Rep CreateTrackerResponse = D1 ('MetaData "CreateTrackerResponse" "Amazonka.Location.CreateTracker" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "CreateTrackerResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601)) :*: (S1 ('MetaSel ('Just "trackerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "trackerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateTrackerResponse Source #

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

CreateTrackerResponse, createTrackerResponse_createTime - The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

$sel:trackerArn:CreateTrackerResponse', createTrackerResponse_trackerArn - The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.

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

CreateTracker, createTrackerResponse_trackerName - The name of the tracker resource.

Response Lenses

createTrackerResponse_createTime :: Lens' CreateTrackerResponse UTCTime Source #

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

createTrackerResponse_trackerArn :: Lens' CreateTrackerResponse Text Source #

The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.

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