1. Packages
  2. AWS Native
  3. API Docs
  4. location
  5. getTracker

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi

aws-native.location.getTracker

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi

    Definition of AWS::Location::Tracker Resource Type

    Using getTracker

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getTracker(args: GetTrackerArgs, opts?: InvokeOptions): Promise<GetTrackerResult>
    function getTrackerOutput(args: GetTrackerOutputArgs, opts?: InvokeOptions): Output<GetTrackerResult>
    def get_tracker(tracker_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetTrackerResult
    def get_tracker_output(tracker_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetTrackerResult]
    func LookupTracker(ctx *Context, args *LookupTrackerArgs, opts ...InvokeOption) (*LookupTrackerResult, error)
    func LookupTrackerOutput(ctx *Context, args *LookupTrackerOutputArgs, opts ...InvokeOption) LookupTrackerResultOutput

    > Note: This function is named LookupTracker in the Go SDK.

    public static class GetTracker 
    {
        public static Task<GetTrackerResult> InvokeAsync(GetTrackerArgs args, InvokeOptions? opts = null)
        public static Output<GetTrackerResult> Invoke(GetTrackerInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTrackerResult> getTracker(GetTrackerArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:location:getTracker
      arguments:
        # arguments dictionary

    The following arguments are supported:

    TrackerName string

    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 .
    TrackerName string

    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 .
    trackerName String

    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 .
    trackerName string

    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 .
    tracker_name str

    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 .
    trackerName String

    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 .

    getTracker Result

    The following output properties are available:

    Arn string
    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
    CreateTime string
    The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    Description string
    An optional description for the tracker resource.
    EventBridgeEnabled bool
    KmsKeyEnableGeospatialQueries bool
    PositionFiltering Pulumi.AwsNative.Location.TrackerPositionFiltering

    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 Pulumi.AwsNative.Location.TrackerPricingPlan
    PricingPlanDataSource string
    This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    TrackerArn string
    Synonym for Arn . 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
    UpdateTime string
    The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    Arn string
    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
    CreateTime string
    The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    Description string
    An optional description for the tracker resource.
    EventBridgeEnabled bool
    KmsKeyEnableGeospatialQueries bool
    PositionFiltering TrackerPositionFiltering

    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 TrackerPricingPlan
    PricingPlanDataSource string
    This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    TrackerArn string
    Synonym for Arn . 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
    UpdateTime string
    The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn String
    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
    createTime String
    The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    description String
    An optional description for the tracker resource.
    eventBridgeEnabled Boolean
    kmsKeyEnableGeospatialQueries Boolean
    positionFiltering TrackerPositionFiltering

    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 TrackerPricingPlan
    pricingPlanDataSource String
    This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    trackerArn String
    Synonym for Arn . 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
    updateTime String
    The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn string
    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
    createTime string
    The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    description string
    An optional description for the tracker resource.
    eventBridgeEnabled boolean
    kmsKeyEnableGeospatialQueries boolean
    positionFiltering TrackerPositionFiltering

    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 TrackerPricingPlan
    pricingPlanDataSource string
    This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    trackerArn string
    Synonym for Arn . 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
    updateTime string
    The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn str
    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
    create_time str
    The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    description str
    An optional description for the tracker resource.
    event_bridge_enabled bool
    kms_key_enable_geospatial_queries bool
    position_filtering TrackerPositionFiltering

    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 .

    pricing_plan TrackerPricingPlan
    pricing_plan_data_source str
    This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    tracker_arn str
    Synonym for Arn . 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
    update_time str
    The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    arn String
    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
    createTime String
    The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
    description String
    An optional description for the tracker resource.
    eventBridgeEnabled Boolean
    kmsKeyEnableGeospatialQueries Boolean
    positionFiltering "TimeBased" | "DistanceBased" | "AccuracyBased"

    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 "RequestBasedUsage"
    pricingPlanDataSource String
    This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    trackerArn String
    Synonym for Arn . 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
    updateTime String
    The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    TrackerPositionFiltering

    TrackerPricingPlan

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi