NAME

Paws::LocationService - Perl Interface to AWS Amazon Location Service

SYNOPSIS

  use Paws;

  my $obj = Paws->service('LocationService');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/geo-2020-11-19

METHODS

AssociateTrackerConsumer

ConsumerArn => Str
TrackerName => Str

Each argument is described in detail in: Paws::LocationService::AssociateTrackerConsumer

Returns: a Paws::LocationService::AssociateTrackerConsumerResponse instance

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.

Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.

BatchDeleteDevicePositionHistory

DeviceIds => ArrayRef[Str|Undef]
TrackerName => Str

Each argument is described in detail in: Paws::LocationService::BatchDeleteDevicePositionHistory

Returns: a Paws::LocationService::BatchDeleteDevicePositionHistoryResponse instance

Deletes the position history of one or more devices from a tracker resource.

BatchDeleteGeofence

CollectionName => Str
GeofenceIds => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::LocationService::BatchDeleteGeofence

Returns: a Paws::LocationService::BatchDeleteGeofenceResponse instance

Deletes a batch of geofences from a geofence collection.

This operation deletes the resource permanently.

BatchEvaluateGeofences

CollectionName => Str
DevicePositionUpdates => ArrayRef[Paws::LocationService::DevicePositionUpdate]

Each argument is described in detail in: Paws::LocationService::BatchEvaluateGeofences

Returns: a Paws::LocationService::BatchEvaluateGeofencesResponse instance

Evaluates device positions against the geofence geometries from a given geofence collection. The evaluation determines if the device has entered or exited a geofenced area, which publishes ENTER or EXIT geofence events to Amazon EventBridge.

The last geofence that a device was observed within, if any, is tracked for 30 days after the most recent device position update

BatchGetDevicePosition

DeviceIds => ArrayRef[Str|Undef]
TrackerName => Str

Each argument is described in detail in: Paws::LocationService::BatchGetDevicePosition

Returns: a Paws::LocationService::BatchGetDevicePositionResponse instance

A batch request to retrieve all device positions.

BatchPutGeofence

CollectionName => Str
Entries => ArrayRef[Paws::LocationService::BatchPutGeofenceRequestEntry]

Each argument is described in detail in: Paws::LocationService::BatchPutGeofence

Returns: a Paws::LocationService::BatchPutGeofenceResponse instance

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.

BatchUpdateDevicePosition

TrackerName => Str
Updates => ArrayRef[Paws::LocationService::DevicePositionUpdate]

Each argument is described in detail in: Paws::LocationService::BatchUpdateDevicePosition

Returns: a Paws::LocationService::BatchUpdateDevicePositionResponse instance

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.

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.

CalculateRoute

CalculatorName => Str
DeparturePosition => ArrayRef[Num]
DestinationPosition => ArrayRef[Num]
[CarModeOptions => Paws::LocationService::CalculateRouteCarModeOptions]
[DepartNow => Bool]
[DepartureTime => Str]
[DistanceUnit => Str]
[IncludeLegGeometry => Bool]
[TravelMode => Str]
[TruckModeOptions => Paws::LocationService::CalculateRouteTruckModeOptions]
[WaypointPositions => ArrayRef[ArrayRef[Num]]]

Each argument is described in detail in: Paws::LocationService::CalculateRoute

Returns: a Paws::LocationService::CalculateRouteResponse instance

Calculates a route (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html) given the following required parameters: DeparturePostiton and DestinationPosition. Requires that you first create aroute calculator resource (https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html)

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 (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#departure-time) using either DepartureTime or DepartureNow. This calculates a route based on predictive traffic data at the given time.

You can't specify both DepartureTime and DepartureNow in a single request. Specifying both parameters returns an error message.
Specifying a travel mode (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#travel-mode) using TravelMode. This lets you specify additional route preference such as CarModeOptions if traveling by Car, or TruckModeOptions if traveling by Truck.

CreateGeofenceCollection

CollectionName => Str
PricingPlan => Str
[Description => Str]
[KmsKeyId => Str]
[PricingPlanDataSource => Str]
[Tags => Paws::LocationService::TagMap]

Each argument is described in detail in: Paws::LocationService::CreateGeofenceCollection

Returns: a Paws::LocationService::CreateGeofenceCollectionResponse instance

Creates a geofence collection, which manages and stores geofences.

CreateMap

Configuration => Paws::LocationService::MapConfiguration
MapName => Str
PricingPlan => Str
[Description => Str]
[Tags => Paws::LocationService::TagMap]

Each argument is described in detail in: Paws::LocationService::CreateMap

Returns: a Paws::LocationService::CreateMapResponse instance

Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.

CreatePlaceIndex

DataSource => Str
IndexName => Str
PricingPlan => Str
[DataSourceConfiguration => Paws::LocationService::DataSourceConfiguration]
[Description => Str]
[Tags => Paws::LocationService::TagMap]

Each argument is described in detail in: Paws::LocationService::CreatePlaceIndex

Returns: a Paws::LocationService::CreatePlaceIndexResponse instance

Creates a place index resource in your AWS account, which supports functions with geospatial data sourced from your chosen data provider.

CreateRouteCalculator

CalculatorName => Str
DataSource => Str
PricingPlan => Str
[Description => Str]
[Tags => Paws::LocationService::TagMap]

Each argument is described in detail in: Paws::LocationService::CreateRouteCalculator

Returns: a Paws::LocationService::CreateRouteCalculatorResponse instance

Creates a route calculator resource in your AWS 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.

CreateTracker

PricingPlan => Str
TrackerName => Str
[Description => Str]
[KmsKeyId => Str]
[PricingPlanDataSource => Str]
[Tags => Paws::LocationService::TagMap]

Each argument is described in detail in: Paws::LocationService::CreateTracker

Returns: a Paws::LocationService::CreateTrackerResponse instance

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

DeleteGeofenceCollection

CollectionName => Str

Each argument is described in detail in: Paws::LocationService::DeleteGeofenceCollection

Returns: a Paws::LocationService::DeleteGeofenceCollectionResponse instance

Deletes a geofence collection from your AWS account.

This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.

DeleteMap

MapName => Str

Each argument is described in detail in: Paws::LocationService::DeleteMap

Returns: a Paws::LocationService::DeleteMapResponse instance

Deletes a map resource from your AWS account.

This operation deletes the resource permanently. If the map is being used in an application, the map may not render.

DeletePlaceIndex

IndexName => Str

Each argument is described in detail in: Paws::LocationService::DeletePlaceIndex

Returns: a Paws::LocationService::DeletePlaceIndexResponse instance

Deletes a place index resource from your AWS account.

This operation deletes the resource permanently.

DeleteRouteCalculator

CalculatorName => Str

Each argument is described in detail in: Paws::LocationService::DeleteRouteCalculator

Returns: a Paws::LocationService::DeleteRouteCalculatorResponse instance

Deletes a route calculator resource from your AWS account.

This operation deletes the resource permanently.

DeleteTracker

TrackerName => Str

Each argument is described in detail in: Paws::LocationService::DeleteTracker

Returns: a Paws::LocationService::DeleteTrackerResponse instance

Deletes a tracker resource from your AWS account.

This operation deletes the resource permanently. If the tracker resource is in use, you may encounter an error. Make sure that the target resource isn't a dependency for your applications.

DescribeGeofenceCollection

CollectionName => Str

Each argument is described in detail in: Paws::LocationService::DescribeGeofenceCollection

Returns: a Paws::LocationService::DescribeGeofenceCollectionResponse instance

Retrieves the geofence collection details.

DescribeMap

MapName => Str

Each argument is described in detail in: Paws::LocationService::DescribeMap

Returns: a Paws::LocationService::DescribeMapResponse instance

Retrieves the map resource details.

DescribePlaceIndex

IndexName => Str

Each argument is described in detail in: Paws::LocationService::DescribePlaceIndex

Returns: a Paws::LocationService::DescribePlaceIndexResponse instance

Retrieves the place index resource details.

DescribeRouteCalculator

CalculatorName => Str

Each argument is described in detail in: Paws::LocationService::DescribeRouteCalculator

Returns: a Paws::LocationService::DescribeRouteCalculatorResponse instance

Retrieves the route calculator resource details.

DescribeTracker

TrackerName => Str

Each argument is described in detail in: Paws::LocationService::DescribeTracker

Returns: a Paws::LocationService::DescribeTrackerResponse instance

Retrieves the tracker resource details.

DisassociateTrackerConsumer

ConsumerArn => Str
TrackerName => Str

Each argument is described in detail in: Paws::LocationService::DisassociateTrackerConsumer

Returns: a Paws::LocationService::DisassociateTrackerConsumerResponse instance

Removes the association between a tracker resource and a geofence collection.

Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences.

GetDevicePosition

DeviceId => Str
TrackerName => Str

Each argument is described in detail in: Paws::LocationService::GetDevicePosition

Returns: a Paws::LocationService::GetDevicePositionResponse instance

Retrieves a device's most recent position according to its sample time.

Device positions are deleted after 30 days.

GetDevicePositionHistory

DeviceId => Str
TrackerName => Str
[EndTimeExclusive => Str]
[NextToken => Str]
[StartTimeInclusive => Str]

Each argument is described in detail in: Paws::LocationService::GetDevicePositionHistory

Returns: a Paws::LocationService::GetDevicePositionHistoryResponse instance

Retrieves the device position history from a tracker resource within a specified range of time.

Device positions are deleted after 30 days.

GetGeofence

CollectionName => Str
GeofenceId => Str

Each argument is described in detail in: Paws::LocationService::GetGeofence

Returns: a Paws::LocationService::GetGeofenceResponse instance

Retrieves the geofence details from a geofence collection.

GetMapGlyphs

FontStack => Str
FontUnicodeRange => Str
MapName => Str

Each argument is described in detail in: Paws::LocationService::GetMapGlyphs

Returns: a Paws::LocationService::GetMapGlyphsResponse instance

Retrieves glyphs used to display labels on a map.

GetMapSprites

FileName => Str
MapName => Str

Each argument is described in detail in: Paws::LocationService::GetMapSprites

Returns: a Paws::LocationService::GetMapSpritesResponse instance

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.

GetMapStyleDescriptor

MapName => Str

Each argument is described in detail in: Paws::LocationService::GetMapStyleDescriptor

Returns: a Paws::LocationService::GetMapStyleDescriptorResponse instance

Retrieves the map style descriptor from a map resource.

The style descriptor contains specications 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.

GetMapTile

MapName => Str
X => Str
Y => Str
Z => Str

Each argument is described in detail in: Paws::LocationService::GetMapTile

Returns: a Paws::LocationService::GetMapTileResponse instance

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

ListDevicePositions

TrackerName => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::LocationService::ListDevicePositions

Returns: a Paws::LocationService::ListDevicePositionsResponse instance

Lists the latest device positions for requested devices.

ListGeofenceCollections

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::LocationService::ListGeofenceCollections

Returns: a Paws::LocationService::ListGeofenceCollectionsResponse instance

Lists geofence collections in your AWS account.

ListGeofences

CollectionName => Str
[NextToken => Str]

Each argument is described in detail in: Paws::LocationService::ListGeofences

Returns: a Paws::LocationService::ListGeofencesResponse instance

Lists geofences stored in a given geofence collection.

ListMaps

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::LocationService::ListMaps

Returns: a Paws::LocationService::ListMapsResponse instance

Lists map resources in your AWS account.

ListPlaceIndexes

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::LocationService::ListPlaceIndexes

Returns: a Paws::LocationService::ListPlaceIndexesResponse instance

Lists place index resources in your AWS account.

ListRouteCalculators

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::LocationService::ListRouteCalculators

Returns: a Paws::LocationService::ListRouteCalculatorsResponse instance

Lists route calculator resources in your AWS account.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::LocationService::ListTagsForResource

Returns: a Paws::LocationService::ListTagsForResourceResponse instance

Returns the tags for the specified Amazon Location Service resource.

ListTrackerConsumers

TrackerName => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::LocationService::ListTrackerConsumers

Returns: a Paws::LocationService::ListTrackerConsumersResponse instance

Lists geofence collections currently associated to the given tracker resource.

ListTrackers

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::LocationService::ListTrackers

Returns: a Paws::LocationService::ListTrackersResponse instance

Lists tracker resources in your AWS account.

PutGeofence

CollectionName => Str
GeofenceId => Str
Geometry => Paws::LocationService::GeofenceGeometry

Each argument is described in detail in: Paws::LocationService::PutGeofence

Returns: a Paws::LocationService::PutGeofenceResponse instance

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.

SearchPlaceIndexForPosition

IndexName => Str
Position => ArrayRef[Num]
[MaxResults => Int]

Each argument is described in detail in: Paws::LocationService::SearchPlaceIndexForPosition

Returns: a Paws::LocationService::SearchPlaceIndexForPositionResponse instance

Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.

SearchPlaceIndexForText

IndexName => Str
Text => Str
[BiasPosition => ArrayRef[Num]]
[FilterBBox => ArrayRef[Num]]
[FilterCountries => ArrayRef[Str|Undef]]
[MaxResults => Int]

Each argument is described in detail in: Paws::LocationService::SearchPlaceIndexForText

Returns: a Paws::LocationService::SearchPlaceIndexForTextResponse instance

Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.

Includes the option to apply additional parameters to narrow your list of results.

You can search for places near a given position using BiasPosition, or filter results within a bounding box using FilterBBox. Providing both parameters simultaneously returns an error.

TagResource

ResourceArn => Str
Tags => Paws::LocationService::TagMap

Each argument is described in detail in: Paws::LocationService::TagResource

Returns: a Paws::LocationService::TagResourceResponse instance

Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.

 <p>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.</p> <p>Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.</p> <p>You can use the <code>TagResource</code> action 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 is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </p> <p>You can associate as many as 50 tags with a resource.</p>

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::LocationService::UntagResource

Returns: a Paws::LocationService::UntagResourceResponse instance

Removes one or more tags from the specified Amazon Location Service resource.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results