lib/aws-sdk-locationservice/client.rb in aws-sdk-locationservice-1.8.0 vs lib/aws-sdk-locationservice/client.rb in aws-sdk-locationservice-1.9.0

- old
+ new

@@ -612,16 +612,24 @@ req = build_request(:batch_put_geofence, params) req.send_request(options) end # Uploads position update data for one or more devices to a tracker - # resource. Amazon Location uses the data when reporting the last known - # device position and position history. + # resource. Amazon Location uses the data when it reports the last known + # device position and position history. Amazon Location retains location + # data for 30 days. # - # <note markdown="1"> Only one position update is stored per sample time. Location data is - # sampled at a fixed rate of one position per 30-second interval and - # retained for 30 days before it's deleted. + # <note markdown="1"> Position updates are handled based on the `PositionFiltering` property + # of the tracker. When `PositionFiltering` is set to `TimeBased`, + # updates are evaluated against linked geofence collections, and + # location data is stored at a maximum of one position per 30 second + # interval. If your update frequency is more often than every 30 + # seconds, only one update per 30 seconds is stored for each unique + # device ID. When `PositionFiltering` is set to `DistanceBased` + # filtering, location data is stored and evaluated against linked + # geofence collections only if the device has moved more than 30 m (98.4 + # ft). # # </note> # # @option params [required, String] :tracker_name # The name of the tracker resource to update. @@ -721,11 +729,13 @@ # * For example, `[-123.115, 49.285]` # # ^ # # <note markdown="1"> If you specify a departure that's not located on a road, Amazon - # Location [moves the position to the nearest road][2]. + # Location [moves the position to the nearest road][2]. If Esri is the + # provider for your route calculator, specifying a route that is longer + # than 400 km returns a `400 RoutesValidationException` error. # # </note> # # Valid Values: `[-180 to 180,-90 to 90]` # @@ -821,10 +831,14 @@ # Amazon Location [moves the position to the nearest road][1]. # # Specifying more than 23 waypoints returns a `400 ValidationException` # error. # + # If Esri is the provider for your route calculator, specifying a route + # that is longer than 400 km returns a `400 RoutesValidationException` + # error. + # # </note> # # Valid Values: `[-180 to 180,-90 to 90]` # # @@ -1043,11 +1057,11 @@ # # @option params [required, String] :pricing_plan # Specifies the pricing plan for your map resource. # # For additional details and restrictions on each pricing plan option, - # see the [Amazon Location Service pricing page][1]. + # see [Amazon Location Service pricing][1]. # # # # [1]: https://aws.amazon.com/location/pricing/ # @@ -1121,11 +1135,11 @@ # # * `Esri` – For additional information about [Esri][1]'s coverage in # your region of interest, see [Esri details on geocoding # coverage][2]. # - # * `Here` – For additional information about [HERE Technologies][3]'s + # * `Here` – For additional information about [HERE Technologies][3]' # coverage in your region of interest, see [HERE details on goecoding # coverage][4]. # # Place index resources using HERE Technologies as a data provider # can't [store results][5] for locations in Japan. For more @@ -1165,11 +1179,11 @@ # # @option params [required, String] :pricing_plan # Specifies the pricing plan for your place index resource. # # For additional details and restrictions on each pricing plan option, - # see the [Amazon Location Service pricing page][1]. + # see [Amazon Location Service pricing][1]. # # # # [1]: https://aws.amazon.com/location/pricing/ # @@ -1249,21 +1263,23 @@ # # @option params [required, String] :data_source # Specifies the data provider of traffic and road network data. # # <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For - # example, entering `HERE` returns an error. + # example, entering `HERE` returns an error. Route calculators that use + # Esri as a data source only calculate routes that are shorter than 400 + # km. # # </note> # # Valid values include: # # * `Esri` – For additional information about [Esri][1]'s coverage in # your region of interest, see [Esri details on street networks and # traffic coverage][2]. # - # * `Here` – For additional information about [HERE Technologies][3]'s + # * `Here` – For additional information about [HERE Technologies][3]' # coverage in your region of interest, see [HERE car routing # coverage][4] and [HERE truck routing coverage][5]. # # For additional information , see [Data providers][6] on the *Amazon # Location Service Developer Guide*. @@ -1359,15 +1375,36 @@ # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html # + # @option params [String] :position_filtering + # 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 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. + # + # This field is optional. If not specified, the default value is + # `TimeBased`. + # # @option params [required, String] :pricing_plan # Specifies the pricing plan for the tracker resource. # # For additional details and restrictions on each pricing plan option, - # see the [Amazon Location Service pricing page][1]. + # see [Amazon Location Service pricing][1]. # # # # [1]: https://aws.amazon.com/location/pricing/ # @@ -1387,11 +1424,11 @@ # the data provider, and will remain in your AWS account or Region # unless you move it. # # </note> # - # Valid Values: `Esri` \| `Here` + # Valid values: `Esri` \| `Here` # # # # [1]: https://aws.amazon.com/location/data-providers/ # [2]: https://aws.amazon.com/location/pricing/ @@ -1437,10 +1474,11 @@ # @example Request syntax with placeholder values # # resp = client.create_tracker({ # description: "ResourceDescription", # kms_key_id: "KmsKeyId", + # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement # pricing_plan_data_source: "String", # tags: { # "TagKey" => "TagValue", # }, @@ -1783,10 +1821,11 @@ # @return [Types::DescribeTrackerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeTrackerResponse#create_time #create_time} => Time # * {Types::DescribeTrackerResponse#description #description} => String # * {Types::DescribeTrackerResponse#kms_key_id #kms_key_id} => String + # * {Types::DescribeTrackerResponse#position_filtering #position_filtering} => String # * {Types::DescribeTrackerResponse#pricing_plan #pricing_plan} => String # * {Types::DescribeTrackerResponse#pricing_plan_data_source #pricing_plan_data_source} => String # * {Types::DescribeTrackerResponse#tags #tags} => Hash&lt;String,String&gt; # * {Types::DescribeTrackerResponse#tracker_arn #tracker_arn} => String # * {Types::DescribeTrackerResponse#tracker_name #tracker_name} => String @@ -1801,10 +1840,11 @@ # @example Response structure # # resp.create_time #=> Time # resp.description #=> String # resp.kms_key_id #=> String + # resp.position_filtering #=> String, one of "TimeBased", "DistanceBased" # resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" # resp.pricing_plan_data_source #=> String # resp.tags #=> Hash # resp.tags["TagKey"] #=> String # resp.tracker_arn #=> String @@ -2039,11 +2079,11 @@ # # @option params [required, String] :font_stack # A comma-separated list of fonts to load glyphs from in order of # preference. For example, `Noto Sans Regular, Arial Unicode`. # - # Valid fonts for [Esri][1] styles: + # Valid fonts stacks for [Esri][1] styles: # # * VectorEsriDarkGrayCanvas – `Ubuntu Medium Italic` \| `Ubuntu Medium` # \| `Ubuntu Italic` \| `Ubuntu Regular` \| `Ubuntu Bold` # # * VectorEsriLightGrayCanvas – `Ubuntu Italic` \| `Ubuntu Regular` \| @@ -2057,13 +2097,13 @@ # Bold` # # * VectorEsriNavigation – `Arial Regular` \| `Arial Italic` \| `Arial # Bold` # - # Valid fonts for [HERE Technologies][2] styles: + # Valid font stacks for [HERE Technologies][2] styles: # - # * `VectorHereBerlin` – `Fira GO Regular` \| `Fira GO Bold` + # * VectorHereBerlin – `Fira GO Regular` \| `Fira GO Bold` # # ^ # # # @@ -3198,10 +3238,28 @@ # Updates the specified properties of a given tracker resource. # # @option params [String] :description # Updates the description for the tracker resource. # + # @option params [String] :position_filtering + # 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. + # # @option params [String] :pricing_plan # Updates the pricing plan for the tracker resource. # # For more information about each pricing plan option restrictions, see # [Amazon Location Service pricing][1]. @@ -3245,10 +3303,11 @@ # # @example Request syntax with placeholder values # # resp = client.update_tracker({ # description: "ResourceDescription", + # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement # pricing_plan_data_source: "String", # tracker_name: "ResourceName", # required # }) # @@ -3278,10 +3337,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-locationservice' - context[:gem_version] = '1.8.0' + context[:gem_version] = '1.9.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated