Skip to content

Commit 20009a1

Browse files
committed
added Readme
1 parent 7c34727 commit 20009a1

File tree

1 file changed

+130
-0
lines changed

1 file changed

+130
-0
lines changed
Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Amazon Location code examples for the SDK for Java 2.x
2+
3+
## Overview
4+
5+
Shows how to use the AWS SDK for Java 2.x to work with Amazon Location Service.
6+
7+
<!--custom.overview.start-->
8+
<!--custom.overview.end-->
9+
10+
_Amazon Location lets you easily and securely add maps, places, routes, geofences, and trackers, to your applications._
11+
12+
## ⚠ Important
13+
14+
* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
15+
* Running the tests might result in charges to your AWS account.
16+
* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
17+
* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
18+
19+
<!--custom.important.start-->
20+
<!--custom.important.end-->
21+
22+
## Code examples
23+
24+
### Prerequisites
25+
26+
For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav2` folder.
27+
28+
29+
<!--custom.prerequisites.start-->
30+
<!--custom.prerequisites.end-->
31+
32+
### Get started
33+
34+
- [Hello Amazon Location](src/main/java/com/example/location/HelloLocation.java#L18) (`ListGeofencesPaginator`)
35+
36+
37+
### Basics
38+
39+
Code examples that show you how to perform the essential operations within a service.
40+
41+
- [Learn the basics](src/main/java/com/example/location/scenario/LocationScenario.java)
42+
43+
44+
### Single actions
45+
46+
Code excerpts that show you how to call individual service functions.
47+
48+
- [BatchUpdateDevicePosition](src/main/java/com/example/location/scenario/LocationActions.java#L355)
49+
- [CalculateRoute](src/main/java/com/example/location/scenario/LocationActions.java#L254)
50+
- [CreateGeofenceCollection](src/main/java/com/example/location/scenario/LocationActions.java#L480)
51+
- [CreateKey](src/main/java/com/example/location/scenario/LocationActions.java#L512)
52+
- [CreateMap](src/main/java/com/example/location/scenario/LocationActions.java#L552)
53+
- [CreateRouteCalculator](src/main/java/com/example/location/scenario/LocationActions.java#L292)
54+
- [CreateTracker](src/main/java/com/example/location/scenario/LocationActions.java#L399)
55+
- [DeleteGeofenceCollection](src/main/java/com/example/location/scenario/LocationActions.java#L589)
56+
- [DeleteMap](src/main/java/com/example/location/scenario/LocationActions.java#L654)
57+
- [DeleteRouteCalculator](src/main/java/com/example/location/scenario/LocationActions.java#L720)
58+
- [DeleteTracker](src/main/java/com/example/location/scenario/LocationActions.java#L685)
59+
- [GetDevicePosition](src/main/java/com/example/location/scenario/LocationActions.java#L323)
60+
- [PutGeofence](src/main/java/com/example/location/scenario/LocationActions.java#L434)
61+
62+
63+
<!--custom.examples.start-->
64+
<!--custom.examples.end-->
65+
66+
## Run the examples
67+
68+
### Instructions
69+
70+
71+
<!--custom.instructions.start-->
72+
<!--custom.instructions.end-->
73+
74+
#### Hello Amazon Location
75+
76+
This example shows you how to get started using Amazon Location.
77+
78+
79+
#### Learn the basics
80+
81+
This example shows you how to do the following:
82+
83+
- Create an Amazon Location map.
84+
- Create an Amazon Location API key.
85+
- Display Map URL.
86+
- Create a geofence collection.
87+
- Store a geofence geometry.
88+
- Create a tracker resource.
89+
- Update the position of a device.
90+
- Retrieve the most recent position update for a specified device.
91+
- Create a route calculator.
92+
- Determine the distance between Seattle and Vancouver.
93+
- Use Amazon Location higher level APIs.
94+
- Delete the Amazon Location Assets.
95+
96+
<!--custom.basic_prereqs.location_Scenario.start-->
97+
<!--custom.basic_prereqs.location_Scenario.end-->
98+
99+
100+
<!--custom.basics.location_Scenario.start-->
101+
<!--custom.basics.location_Scenario.end-->
102+
103+
104+
### Tests
105+
106+
⚠ Running tests might result in charges to your AWS account.
107+
108+
109+
To find instructions for running these tests, see the [README](../../README.md#Tests)
110+
in the `javav2` folder.
111+
112+
113+
114+
<!--custom.tests.start-->
115+
<!--custom.tests.end-->
116+
117+
## Additional resources
118+
119+
- [Amazon Location Developer Guide](https://docs.aws.amazon.com/location/latest/developerguide/what-is.html)
120+
- [Amazon Location API Reference](https://docs.aws.amazon.com/location/latest/APIReference/Welcome.html)
121+
- [SDK for Java 2.x Amazon Location reference](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/entityresolution/package-summary.html)
122+
123+
<!--custom.resources.start-->
124+
<!--custom.resources.end-->
125+
126+
---
127+
128+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
129+
130+
SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)