Class: Aws::LocationService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::LocationService::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb
Overview
An API client for LocationService. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::LocationService::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_tracker_consumer(params = {}) ⇒ Struct
Creates an association between a geofence collection and a tracker resource.
-
#batch_delete_device_position_history(params = {}) ⇒ Types::BatchDeleteDevicePositionHistoryResponse
Deletes the position history of one or more devices from a tracker resource.
-
#batch_delete_geofence(params = {}) ⇒ Types::BatchDeleteGeofenceResponse
Deletes a batch of geofences from a geofence collection.
-
#batch_evaluate_geofences(params = {}) ⇒ Types::BatchEvaluateGeofencesResponse
Evaluates device positions against the geofence geometries from a given geofence collection.
-
#batch_get_device_position(params = {}) ⇒ Types::BatchGetDevicePositionResponse
Lists the latest device positions for requested devices.
-
#batch_put_geofence(params = {}) ⇒ Types::BatchPutGeofenceResponse
A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
-
#batch_update_device_position(params = {}) ⇒ Types::BatchUpdateDevicePositionResponse
Uploads position update data for one or more devices to a tracker resource (up to 10 devices per batch).
-
#calculate_route(params = {}) ⇒ Types::CalculateRouteResponse
[Calculates a route][1] given the following required parameters:
DeparturePosition
andDestinationPosition
. -
#calculate_route_matrix(params = {}) ⇒ Types::CalculateRouteMatrixResponse
[ Calculates a route matrix][1] given the following required parameters:
DeparturePositions
andDestinationPositions
. -
#create_geofence_collection(params = {}) ⇒ Types::CreateGeofenceCollectionResponse
Creates a geofence collection, which manages and stores geofences.
-
#create_key(params = {}) ⇒ Types::CreateKeyResponse
Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer.
-
#create_map(params = {}) ⇒ Types::CreateMapResponse
Creates a map resource in your Amazon Web Services account, which provides map tiles of different styles sourced from global location data providers.
-
#create_place_index(params = {}) ⇒ Types::CreatePlaceIndexResponse
Creates a place index resource in your Amazon Web Services account.
-
#create_route_calculator(params = {}) ⇒ Types::CreateRouteCalculatorResponse
Creates a route calculator resource in your Amazon Web Services account.
-
#create_tracker(params = {}) ⇒ Types::CreateTrackerResponse
Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.
-
#delete_geofence_collection(params = {}) ⇒ Struct
Deletes a geofence collection from your Amazon Web Services account.
-
#delete_key(params = {}) ⇒ Struct
Deletes the specified API key.
-
#delete_map(params = {}) ⇒ Struct
Deletes a map resource from your Amazon Web Services account.
-
#delete_place_index(params = {}) ⇒ Struct
Deletes a place index resource from your Amazon Web Services account.
-
#delete_route_calculator(params = {}) ⇒ Struct
Deletes a route calculator resource from your Amazon Web Services account.
-
#delete_tracker(params = {}) ⇒ Struct
Deletes a tracker resource from your Amazon Web Services account.
-
#describe_geofence_collection(params = {}) ⇒ Types::DescribeGeofenceCollectionResponse
Retrieves the geofence collection details.
-
#describe_key(params = {}) ⇒ Types::DescribeKeyResponse
Retrieves the API key resource details.
-
#describe_map(params = {}) ⇒ Types::DescribeMapResponse
Retrieves the map resource details.
-
#describe_place_index(params = {}) ⇒ Types::DescribePlaceIndexResponse
Retrieves the place index resource details.
-
#describe_route_calculator(params = {}) ⇒ Types::DescribeRouteCalculatorResponse
Retrieves the route calculator resource details.
-
#describe_tracker(params = {}) ⇒ Types::DescribeTrackerResponse
Retrieves the tracker resource details.
-
#disassociate_tracker_consumer(params = {}) ⇒ Struct
Removes the association between a tracker resource and a geofence collection.
-
#forecast_geofence_events(params = {}) ⇒ Types::ForecastGeofenceEventsResponse
Evaluates device positions against geofence geometries from a given geofence collection.
-
#get_device_position(params = {}) ⇒ Types::GetDevicePositionResponse
Retrieves a device's most recent position according to its sample time.
-
#get_device_position_history(params = {}) ⇒ Types::GetDevicePositionHistoryResponse
Retrieves the device position history from a tracker resource within a specified range of time.
-
#get_geofence(params = {}) ⇒ Types::GetGeofenceResponse
Retrieves the geofence details from a geofence collection.
-
#get_map_glyphs(params = {}) ⇒ Types::GetMapGlyphsResponse
Retrieves glyphs used to display labels on a map.
-
#get_map_sprites(params = {}) ⇒ Types::GetMapSpritesResponse
Retrieves the sprite sheet corresponding to a map resource.
-
#get_map_style_descriptor(params = {}) ⇒ Types::GetMapStyleDescriptorResponse
Retrieves the map style descriptor from a map resource.
-
#get_map_tile(params = {}) ⇒ Types::GetMapTileResponse
Retrieves a vector data tile from the map resource.
-
#get_place(params = {}) ⇒ Types::GetPlaceResponse
Finds a place by its unique ID.
-
#list_device_positions(params = {}) ⇒ Types::ListDevicePositionsResponse
A batch request to retrieve all device positions.
-
#list_geofence_collections(params = {}) ⇒ Types::ListGeofenceCollectionsResponse
Lists geofence collections in your Amazon Web Services account.
-
#list_geofences(params = {}) ⇒ Types::ListGeofencesResponse
Lists geofences stored in a given geofence collection.
-
#list_keys(params = {}) ⇒ Types::ListKeysResponse
Lists API key resources in your Amazon Web Services account.
-
#list_maps(params = {}) ⇒ Types::ListMapsResponse
Lists map resources in your Amazon Web Services account.
-
#list_place_indexes(params = {}) ⇒ Types::ListPlaceIndexesResponse
Lists place index resources in your Amazon Web Services account.
-
#list_route_calculators(params = {}) ⇒ Types::ListRouteCalculatorsResponse
Lists route calculator resources in your Amazon Web Services account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags that are applied to the specified Amazon Location resource.
-
#list_tracker_consumers(params = {}) ⇒ Types::ListTrackerConsumersResponse
Lists geofence collections currently associated to the given tracker resource.
-
#list_trackers(params = {}) ⇒ Types::ListTrackersResponse
Lists tracker resources in your Amazon Web Services account.
-
#put_geofence(params = {}) ⇒ Types::PutGeofenceResponse
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.
-
#search_place_index_for_position(params = {}) ⇒ Types::SearchPlaceIndexForPositionResponse
Reverse geocodes a given coordinate and returns a legible address.
-
#search_place_index_for_suggestions(params = {}) ⇒ Types::SearchPlaceIndexForSuggestionsResponse
Generates suggestions for addresses and points of interest based on partial or misspelled free-form text.
-
#search_place_index_for_text(params = {}) ⇒ Types::SearchPlaceIndexForTextResponse
Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
-
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified Amazon Location resource.
-
#update_geofence_collection(params = {}) ⇒ Types::UpdateGeofenceCollectionResponse
Updates the specified properties of a given geofence collection.
-
#update_key(params = {}) ⇒ Types::UpdateKeyResponse
Updates the specified properties of a given API key resource.
-
#update_map(params = {}) ⇒ Types::UpdateMapResponse
Updates the specified properties of a given map resource.
-
#update_place_index(params = {}) ⇒ Types::UpdatePlaceIndexResponse
Updates the specified properties of a given place index resource.
-
#update_route_calculator(params = {}) ⇒ Types::UpdateRouteCalculatorResponse
Updates the specified properties for a given route calculator resource.
-
#update_tracker(params = {}) ⇒ Types::UpdateTrackerResponse
Updates the specified properties of a given tracker resource.
-
#verify_device_position(params = {}) ⇒ Types::VerifyDevicePositionResponse
Verifies the integrity of the device's position by determining if it was reported behind a proxy, and by comparing it to an inferred position estimated based on the device's state.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
434 435 436 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 434 def initialize(*args) super end |
Instance Method Details
#associate_tracker_consumer(params = {}) ⇒ Struct
Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection.
You can associate up to five geofence collections to each tracker resource.
480 481 482 483 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 480 def associate_tracker_consumer(params = {}, = {}) req = build_request(:associate_tracker_consumer, params) req.send_request() end |
#batch_delete_device_position_history(params = {}) ⇒ Types::BatchDeleteDevicePositionHistoryResponse
Deletes the position history of one or more devices from a tracker resource.
521 522 523 524 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 521 def batch_delete_device_position_history(params = {}, = {}) req = build_request(:batch_delete_device_position_history, params) req.send_request() end |
#batch_delete_geofence(params = {}) ⇒ Types::BatchDeleteGeofenceResponse
Deletes a batch of geofences from a geofence collection.
560 561 562 563 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 560 def batch_delete_geofence(params = {}, = {}) req = build_request(:batch_delete_geofence, params) req.send_request() end |
#batch_evaluate_geofences(params = {}) ⇒ Types::BatchEvaluateGeofencesResponse
Evaluates device positions against the geofence geometries from a given geofence collection.
This operation always returns an empty response because geofences are asynchronously evaluated. The evaluation determines if the device has entered or exited a geofenced area, and then publishes one of the following events to Amazon EventBridge:
ENTER
if Amazon Location determines that the tracked device has entered a geofenced area.EXIT
if Amazon Location determines that the tracked device has exited a geofenced area.
Accuracy
of a DevicePositionUpdate
.
DeviceID
is used as a string to represent the device. You do not
need to have a Tracker
associated with the DeviceID
.
637 638 639 640 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 637 def batch_evaluate_geofences(params = {}, = {}) req = build_request(:batch_evaluate_geofences, params) req.send_request() end |
#batch_get_device_position(params = {}) ⇒ Types::BatchGetDevicePositionResponse
Lists the latest device positions for requested devices.
687 688 689 690 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 687 def batch_get_device_position(params = {}, = {}) req = build_request(:batch_get_device_position, params) req.send_request() end |
#batch_put_geofence(params = {}) ⇒ Types::BatchPutGeofenceResponse
A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
748 749 750 751 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 748 def batch_put_geofence(params = {}, = {}) req = build_request(:batch_put_geofence, params) req.send_request() end |
#batch_update_device_position(params = {}) ⇒ Types::BatchUpdateDevicePositionResponse
Uploads position update data for one or more devices to a tracker resource (up to 10 devices per batch). Amazon Location uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 days.
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).
When PositionFiltering
is set to AccuracyBased
filtering, location
data is stored and evaluated against linked geofence collections only
if the device has moved more than the measured accuracy. For example,
if two consecutive updates from a device have a horizontal accuracy of
5 m and 10 m, the second update is neither stored or evaluated if the
device has moved less than 15 m. If PositionFiltering
is set to
AccuracyBased
filtering, Amazon Location uses the default value \{
"Horizontal": 0\}
when accuracy is not provided on a
DevicePositionUpdate
.
824 825 826 827 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 824 def batch_update_device_position(params = {}, = {}) req = build_request(:batch_update_device_position, params) req.send_request() end |
#calculate_route(params = {}) ⇒ Types::CalculateRouteResponse
Calculates a route given the following required parameters:
DeparturePosition
and DestinationPosition
. Requires that you first
create a route calculator resource.
By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route.
Additional options include:
Specifying a departure time using either
DepartureTime
orDepartNow
. This calculates a route based on predictive traffic data at the given time.You can't specify both DepartureTime
andDepartNow
in a single request. Specifying both parameters returns a validation error.Specifying a travel mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify additional route preferences in
CarModeOptions
if traveling byCar
, orTruckModeOptions
if traveling byTruck
.If you specify walking
for the travel mode and your data provider is Esri, the start and destination must be within 40km.
1111 1112 1113 1114 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 1111 def calculate_route(params = {}, = {}) req = build_request(:calculate_route, params) req.send_request() end |
#calculate_route_matrix(params = {}) ⇒ Types::CalculateRouteMatrixResponse
Calculates a route matrix given the following required
parameters: DeparturePositions
and DestinationPositions
.
CalculateRouteMatrix
calculates routes and returns the travel time
and travel distance from each departure position to each destination
position in the request. For example, given departure positions A and
B, and destination positions X and Y, CalculateRouteMatrix
will
return time and distance for routes from A to X, A to Y, B to X, and B
to Y (in that order). The number of results returned (and routes
calculated) will be the number of DeparturePositions
times the
number of DestinationPositions
.
Requires that you first create a route calculator resource.
By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating routes.
Additional options include:
Specifying a departure time using either
DepartureTime
orDepartNow
. This calculates routes based on predictive traffic data at the given time.You can't specify both DepartureTime
andDepartNow
in a single request. Specifying both parameters returns a validation error.Specifying a travel mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify additional route preferences in
CarModeOptions
if traveling byCar
, orTruckModeOptions
if traveling byTruck
.
1363 1364 1365 1366 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 1363 def calculate_route_matrix(params = {}, = {}) req = build_request(:calculate_route_matrix, params) req.send_request() end |
#create_geofence_collection(params = {}) ⇒ Types::CreateGeofenceCollectionResponse
Creates a geofence collection, which manages and stores geofences.
1451 1452 1453 1454 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 1451 def create_geofence_collection(params = {}, = {}) req = build_request(:create_geofence_collection, params) req.send_request() end |
#create_key(params = {}) ⇒ Types::CreateKeyResponse
Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer.
1556 1557 1558 1559 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 1556 def create_key(params = {}, = {}) req = build_request(:create_key, params) req.send_request() end |
#create_map(params = {}) ⇒ Types::CreateMapResponse
Creates a map resource in your Amazon Web Services account, which provides map tiles of different styles sourced from global location data providers.
1654 1655 1656 1657 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 1654 def create_map(params = {}, = {}) req = build_request(:create_map, params) req.send_request() end |
#create_place_index(params = {}) ⇒ Types::CreatePlaceIndexResponse
Creates a place index resource in your Amazon Web Services account.
Use a place index resource to geocode addresses and other text queries
by using the SearchPlaceIndexForText
operation, and reverse geocode
coordinates by using the SearchPlaceIndexForPosition
operation, and
enable autosuggestions by using the SearchPlaceIndexForSuggestions
operation.
1795 1796 1797 1798 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 1795 def create_place_index(params = {}, = {}) req = build_request(:create_place_index, params) req.send_request() end |
#create_route_calculator(params = {}) ⇒ Types::CreateRouteCalculatorResponse
Creates a route calculator resource in your Amazon Web Services account.
You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.
1930 1931 1932 1933 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 1930 def create_route_calculator(params = {}, = {}) req = build_request(:create_route_calculator, params) req.send_request() end |
#create_tracker(params = {}) ⇒ Types::CreateTrackerResponse
Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.
2087 2088 2089 2090 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 2087 def create_tracker(params = {}, = {}) req = build_request(:create_tracker, params) req.send_request() end |
#delete_geofence_collection(params = {}) ⇒ Struct
Deletes a geofence collection from your Amazon Web Services account.
2115 2116 2117 2118 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 2115 def delete_geofence_collection(params = {}, = {}) req = build_request(:delete_geofence_collection, params) req.send_request() end |
#delete_key(params = {}) ⇒ Struct
Deletes the specified API key. The API key must have been deactivated more than 90 days previously.
2153 2154 2155 2156 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 2153 def delete_key(params = {}, = {}) req = build_request(:delete_key, params) req.send_request() end |
#delete_map(params = {}) ⇒ Struct
Deletes a map resource from your Amazon Web Services account.
2180 2181 2182 2183 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 2180 def delete_map(params = {}, = {}) req = build_request(:delete_map, params) req.send_request() end |
#delete_place_index(params = {}) ⇒ Struct
Deletes a place index resource from your Amazon Web Services account.
2206 2207 2208 2209 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 2206 def delete_place_index(params = {}, = {}) req = build_request(:delete_place_index, params) req.send_request() end |
#delete_route_calculator(params = {}) ⇒ Struct
Deletes a route calculator resource from your Amazon Web Services account.
2233 2234 2235 2236 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 2233 def delete_route_calculator(params = {}, = {}) req = build_request(:delete_route_calculator, params) req.send_request() end |
#delete_tracker(params = {}) ⇒ Struct
Deletes a tracker resource from your Amazon Web Services account.
2261 2262 2263 2264 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 2261 def delete_tracker(params = {}, = {}) req = build_request(:delete_tracker, params) req.send_request() end |
#describe_geofence_collection(params = {}) ⇒ Types::DescribeGeofenceCollectionResponse
Retrieves the geofence collection details.
2308 2309 2310 2311 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 2308 def describe_geofence_collection(params = {}, = {}) req = build_request(:describe_geofence_collection, params) req.send_request() end |
#describe_key(params = {}) ⇒ Types::DescribeKeyResponse
Retrieves the API key resource details.
2358 2359 2360 2361 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 2358 def describe_key(params = {}, = {}) req = build_request(:describe_key, params) req.send_request() end |
#describe_map(params = {}) ⇒ Types::DescribeMapResponse
Retrieves the map resource details.
2406 2407 2408 2409 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 2406 def describe_map(params = {}, = {}) req = build_request(:describe_map, params) req.send_request() end |
#describe_place_index(params = {}) ⇒ Types::DescribePlaceIndexResponse
Retrieves the place index resource details.
2451 2452 2453 2454 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 2451 def describe_place_index(params = {}, = {}) req = build_request(:describe_place_index, params) req.send_request() end |
#describe_route_calculator(params = {}) ⇒ Types::DescribeRouteCalculatorResponse
Retrieves the route calculator resource details.
2494 2495 2496 2497 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 2494 def describe_route_calculator(params = {}, = {}) req = build_request(:describe_route_calculator, params) req.send_request() end |
#describe_tracker(params = {}) ⇒ Types::DescribeTrackerResponse
Retrieves the tracker resource details.
2545 2546 2547 2548 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 2545 def describe_tracker(params = {}, = {}) req = build_request(:describe_tracker, params) req.send_request() end |
#disassociate_tracker_consumer(params = {}) ⇒ Struct
Removes the association between a tracker resource and a geofence collection.
2585 2586 2587 2588 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 2585 def disassociate_tracker_consumer(params = {}, = {}) req = build_request(:disassociate_tracker_consumer, params) req.send_request() end |
#forecast_geofence_events(params = {}) ⇒ Types::ForecastGeofenceEventsResponse
Evaluates device positions against geofence geometries from a given geofence collection. The event forecasts three states for which a device can be in relative to a geofence:
ENTER
: If a device is outside of a geofence, but would breach the
fence if the device is moving at its current speed within time horizon
window.
EXIT
: If a device is inside of a geofence, but would breach the
fence if the device is moving at its current speed within time horizon
window.
IDLE
: If a device is inside of a geofence, and the device is not
moving.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2685 2686 2687 2688 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 2685 def forecast_geofence_events(params = {}, = {}) req = build_request(:forecast_geofence_events, params) req.send_request() end |
#get_device_position(params = {}) ⇒ Types::GetDevicePositionResponse
Retrieves a device's most recent position according to its sample time.
2734 2735 2736 2737 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 2734 def get_device_position(params = {}, = {}) req = build_request(:get_device_position, params) req.send_request() end |
#get_device_position_history(params = {}) ⇒ Types::GetDevicePositionHistoryResponse
Retrieves the device position history from a tracker resource within a specified range of time.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2832 2833 2834 2835 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 2832 def get_device_position_history(params = {}, = {}) req = build_request(:get_device_position_history, params) req.send_request() end |
#get_geofence(params = {}) ⇒ Types::GetGeofenceResponse
Retrieves the geofence details from a geofence collection.
2887 2888 2889 2890 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 2887 def get_geofence(params = {}, = {}) req = build_request(:get_geofence, params) req.send_request() end |
#get_map_glyphs(params = {}) ⇒ Types::GetMapGlyphsResponse
Retrieves glyphs used to display labels on a map.
3005 3006 3007 3008 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 3005 def get_map_glyphs(params = {}, = {}, &block) req = build_request(:get_map_glyphs, params) req.send_request(, &block) end |
#get_map_sprites(params = {}) ⇒ Types::GetMapSpritesResponse
Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.
3063 3064 3065 3066 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 3063 def get_map_sprites(params = {}, = {}, &block) req = build_request(:get_map_sprites, params) req.send_request(, &block) end |
#get_map_style_descriptor(params = {}) ⇒ Types::GetMapStyleDescriptorResponse
Retrieves the map style descriptor from a map resource.
The style descriptor contains specifications on how features render on a map. For example, what data to display, what order to display the data in, and the style for the data. Style descriptors follow the Mapbox Style Specification.
3108 3109 3110 3111 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 3108 def get_map_style_descriptor(params = {}, = {}, &block) req = build_request(:get_map_style_descriptor, params) req.send_request(, &block) end |
#get_map_tile(params = {}) ⇒ Types::GetMapTileResponse
Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.
The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).
3167 3168 3169 3170 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 3167 def get_map_tile(params = {}, = {}, &block) req = build_request(:get_map_tile, params) req.send_request(, &block) end |
#get_place(params = {}) ⇒ Types::GetPlaceResponse
Finds a place by its unique ID. A PlaceId
is returned by other
search operations.
GetPlace
.
Customer Amazon Web Services account
Amazon Web Services Region
Data provider specified in the place index resource
3265 3266 3267 3268 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 3265 def get_place(params = {}, = {}) req = build_request(:get_place, params) req.send_request() end |
#list_device_positions(params = {}) ⇒ Types::ListDevicePositionsResponse
A batch request to retrieve all device positions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3327 3328 3329 3330 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 3327 def list_device_positions(params = {}, = {}) req = build_request(:list_device_positions, params) req.send_request() end |
#list_geofence_collections(params = {}) ⇒ Types::ListGeofenceCollectionsResponse
Lists geofence collections in your Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3375 3376 3377 3378 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 3375 def list_geofence_collections(params = {}, = {}) req = build_request(:list_geofence_collections, params) req.send_request() end |
#list_geofences(params = {}) ⇒ Types::ListGeofencesResponse
Lists geofences stored in a given geofence collection.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3435 3436 3437 3438 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 3435 def list_geofences(params = {}, = {}) req = build_request(:list_geofences, params) req.send_request() end |
#list_keys(params = {}) ⇒ Types::ListKeysResponse
Lists API key resources in your Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3494 3495 3496 3497 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 3494 def list_keys(params = {}, = {}) req = build_request(:list_keys, params) req.send_request() end |
#list_maps(params = {}) ⇒ Types::ListMapsResponse
Lists map resources in your Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3542 3543 3544 3545 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 3542 def list_maps(params = {}, = {}) req = build_request(:list_maps, params) req.send_request() end |
#list_place_indexes(params = {}) ⇒ Types::ListPlaceIndexesResponse
Lists place index resources in your Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3590 3591 3592 3593 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 3590 def list_place_indexes(params = {}, = {}) req = build_request(:list_place_indexes, params) req.send_request() end |
#list_route_calculators(params = {}) ⇒ Types::ListRouteCalculatorsResponse
Lists route calculator resources in your Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3637 3638 3639 3640 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 3637 def list_route_calculators(params = {}, = {}) req = build_request(:list_route_calculators, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags that are applied to the specified Amazon Location resource.
3673 3674 3675 3676 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 3673 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_tracker_consumers(params = {}) ⇒ Types::ListTrackerConsumersResponse
Lists geofence collections currently associated to the given tracker resource.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3722 3723 3724 3725 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 3722 def list_tracker_consumers(params = {}, = {}) req = build_request(:list_tracker_consumers, params) req.send_request() end |
#list_trackers(params = {}) ⇒ Types::ListTrackersResponse
Lists tracker resources in your Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3770 3771 3772 3773 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 3770 def list_trackers(params = {}, = {}) req = build_request(:list_trackers, params) req.send_request() end |
#put_geofence(params = {}) ⇒ Types::PutGeofenceResponse
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.
3845 3846 3847 3848 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 3845 def put_geofence(params = {}, = {}) req = build_request(:put_geofence, params) req.send_request() end |
#search_place_index_for_position(params = {}) ⇒ Types::SearchPlaceIndexForPositionResponse
Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.
3955 3956 3957 3958 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 3955 def search_place_index_for_position(params = {}, = {}) req = build_request(:search_place_index_for_position, params) req.send_request() end |
#search_place_index_for_suggestions(params = {}) ⇒ Types::SearchPlaceIndexForSuggestionsResponse
Generates suggestions for addresses and points of interest based on partial or misspelled free-form text. This operation is also known as autocomplete, autosuggest, or fuzzy matching.
Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.
BiasPosition
, or filter results within a bounding box by using
FilterBBox
. These parameters are mutually exclusive; using both
BiasPosition
and FilterBBox
in the same command returns an error.
4125 4126 4127 4128 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 4125 def search_place_index_for_suggestions(params = {}, = {}) req = build_request(:search_place_index_for_suggestions, params) req.send_request() end |
#search_place_index_for_text(params = {}) ⇒ Types::SearchPlaceIndexForTextResponse
Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.
BiasPosition
,
or filter results within a bounding box using FilterBBox
. Providing
both parameters simultaneously returns an error.
Search results are returned in order of highest to lowest relevance.
4316 4317 4318 4319 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 4316 def search_place_index_for_text(params = {}, = {}) req = build_request(:search_place_index_for_text, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.
You can use the TagResource
operation with an Amazon Location
Service resource that already has tags. If you specify a new tag key
for the resource, this tag is appended to the tags already associated
with the resource. If you specify a tag key that's already associated
with the resource, the new tag value that you specify replaces the
previous value for that tag.
You can associate up to 50 tags with a resource.
4384 4385 4386 4387 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 4384 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified Amazon Location resource.
4416 4417 4418 4419 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 4416 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_geofence_collection(params = {}) ⇒ Types::UpdateGeofenceCollectionResponse
Updates the specified properties of a given geofence collection.
4461 4462 4463 4464 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 4461 def update_geofence_collection(params = {}, = {}) req = build_request(:update_geofence_collection, params) req.send_request() end |
#update_key(params = {}) ⇒ Types::UpdateKeyResponse
Updates the specified properties of a given API key resource.
4531 4532 4533 4534 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 4531 def update_key(params = {}, = {}) req = build_request(:update_key, params) req.send_request() end |
#update_map(params = {}) ⇒ Types::UpdateMapResponse
Updates the specified properties of a given map resource.
4580 4581 4582 4583 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 4580 def update_map(params = {}, = {}) req = build_request(:update_map, params) req.send_request() end |
#update_place_index(params = {}) ⇒ Types::UpdatePlaceIndexResponse
Updates the specified properties of a given place index resource.
4627 4628 4629 4630 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 4627 def update_place_index(params = {}, = {}) req = build_request(:update_place_index, params) req.send_request() end |
#update_route_calculator(params = {}) ⇒ Types::UpdateRouteCalculatorResponse
Updates the specified properties for a given route calculator resource.
4669 4670 4671 4672 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 4669 def update_route_calculator(params = {}, = {}) req = build_request(:update_route_calculator, params) req.send_request() end |
#update_tracker(params = {}) ⇒ Types::UpdateTrackerResponse
Updates the specified properties of a given tracker resource.
4766 4767 4768 4769 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 4766 def update_tracker(params = {}, = {}) req = build_request(:update_tracker, params) req.send_request() end |
#verify_device_position(params = {}) ⇒ Types::VerifyDevicePositionResponse
Verifies the integrity of the device's position by determining if it was reported behind a proxy, and by comparing it to an inferred position estimated based on the device's state.
4861 4862 4863 4864 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/client.rb', line 4861 def verify_device_position(params = {}, = {}) req = build_request(:verify_device_position, params) req.send_request() end |