Client
locationservice | R Documentation |
Amazon Location Service¶
Description¶
"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"
Usage¶
Arguments¶
config
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to
true
to force the request to use path-style addressing, i.e.http://s3.amazonaws.com/BUCKET/KEY
.sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint
Optional shorthand for complete URL to use for the constructed client.
region
Optional shorthand for AWS Region used in instantiating the client.
Value¶
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've
assigned to the client. The available operations are listed in the
Operations section.
Service syntax¶
svc <- locationservice(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations¶
- associate_tracker_consumer
- Creates an association between a geofence collection and a tracker resource
- batch_delete_device_position_history
- Deletes the position history of one or more devices from a tracker resource
- batch_delete_geofence
- Deletes a batch of geofences from a geofence collection
- batch_evaluate_geofences
- Evaluates device positions against the geofence geometries from a given geofence collection
- batch_get_device_position
- Lists the latest device positions for requested devices
- batch_put_geofence
- 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
- Uploads position update data for one or more devices to a tracker resource (up to 10 devices per batch)
- calculate_route
- Calculates a route given the following required parameters: DeparturePosition and DestinationPosition
- calculate_route_matrix
- Calculates a route matrix given the following required parameters: DeparturePositions and DestinationPositions
- create_geofence_collection
- Creates a geofence collection, which manages and stores geofences
- create_key
- 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
- 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
- Creates a place index resource in your Amazon Web Services account
- create_route_calculator
- Creates a route calculator resource in your Amazon Web Services account
- create_tracker
- Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices
- delete_geofence_collection
- Deletes a geofence collection from your Amazon Web Services account
- delete_key
- Deletes the specified API key
- delete_map
- Deletes a map resource from your Amazon Web Services account
- delete_place_index
- Deletes a place index resource from your Amazon Web Services account
- delete_route_calculator
- Deletes a route calculator resource from your Amazon Web Services account
- delete_tracker
- Deletes a tracker resource from your Amazon Web Services account
- describe_geofence_collection
- Retrieves the geofence collection details
- describe_key
- Retrieves the API key resource details
- describe_map
- Retrieves the map resource details
- describe_place_index
- Retrieves the place index resource details
- describe_route_calculator
- Retrieves the route calculator resource details
- describe_tracker
- Retrieves the tracker resource details
- disassociate_tracker_consumer
- Removes the association between a tracker resource and a geofence collection
- forecast_geofence_events
- Evaluates device positions against geofence geometries from a given geofence collection
- get_device_position
- Retrieves a device's most recent position according to its sample time
- get_device_position_history
- Retrieves the device position history from a tracker resource within a specified range of time
- get_geofence
- Retrieves the geofence details from a geofence collection
- get_map_glyphs
- Retrieves glyphs used to display labels on a map
- get_map_sprites
- Retrieves the sprite sheet corresponding to a map resource
- get_map_style_descriptor
- Retrieves the map style descriptor from a map resource
- get_map_tile
- Retrieves a vector data tile from the map resource
- get_place
- Finds a place by its unique ID
- list_device_positions
- A batch request to retrieve all device positions
- list_geofence_collections
- Lists geofence collections in your Amazon Web Services account
- list_geofences
- Lists geofences stored in a given geofence collection
- list_keys
- Lists API key resources in your Amazon Web Services account
- list_maps
- Lists map resources in your Amazon Web Services account
- list_place_indexes
- Lists place index resources in your Amazon Web Services account
- list_route_calculators
- Lists route calculator resources in your Amazon Web Services account
- list_tags_for_resource
- Returns a list of tags that are applied to the specified Amazon Location resource
- list_tracker_consumers
- Lists geofence collections currently associated to the given tracker resource
- list_trackers
- Lists tracker resources in your Amazon Web Services account
- put_geofence
- 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
- Reverse geocodes a given coordinate and returns a legible address
- search_place_index_for_suggestions
- Generates suggestions for addresses and points of interest based on partial or misspelled free-form text
- search_place_index_for_text
- 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
- Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource
- untag_resource
- Removes one or more tags from the specified Amazon Location resource
- update_geofence_collection
- Updates the specified properties of a given geofence collection
- update_key
- Updates the specified properties of a given API key resource
- update_map
- Updates the specified properties of a given map resource
- update_place_index
- Updates the specified properties of a given place index resource
- update_route_calculator
- Updates the specified properties for a given route calculator resource
- update_tracker
- Updates the specified properties of a given tracker resource
- verify_device_position
- 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