Skip to content

Commit 981ed7b

Browse files
scmacdonscmacdon
committed
updated Kotlin location readme
1 parent 68bdbf1 commit 981ed7b

File tree

1 file changed

+131
-0
lines changed

1 file changed

+131
-0
lines changed

‎kotlin/services/location/README.md‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# Amazon Location code examples for the SDK for Kotlin
2+
3+
## Overview
4+
5+
Shows how to use the AWS SDK for Kotlin 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 `kotlin` 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.kt#L10) (`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.kt)
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/LocationScenario.kt#L567)
49+
- [CalculateRoute](src/main/java/com/example/location/scenario/LocationScenario.kt#L501)
50+
- [CreateGeofenceCollection](src/main/java/com/example/location/scenario/LocationScenario.kt#L648)
51+
- [CreateKey](src/main/java/com/example/location/scenario/LocationScenario.kt#L667)
52+
- [CreateMap](src/main/java/com/example/location/scenario/LocationScenario.kt#L694)
53+
- [CreateRouteCalculator](src/main/java/com/example/location/scenario/LocationScenario.kt#L528)
54+
- [CreateTracker](src/main/java/com/example/location/scenario/LocationScenario.kt#L595)
55+
- [DeleteGeofenceCollection](src/main/java/com/example/location/scenario/LocationScenario.kt#L335)
56+
- [DeleteKey](src/main/java/com/example/location/scenario/LocationScenario.kt#L355)
57+
- [DeleteMap](src/main/java/com/example/location/scenario/LocationScenario.kt#L373)
58+
- [DeleteRouteCalculator](src/main/java/com/example/location/scenario/LocationScenario.kt#L300)
59+
- [DeleteTracker](src/main/java/com/example/location/scenario/LocationScenario.kt#L317)
60+
- [GetDevicePosition](src/main/java/com/example/location/scenario/LocationScenario.kt#L548)
61+
- [PutGeofence](src/main/java/com/example/location/scenario/LocationScenario.kt#L616)
62+
63+
64+
<!--custom.examples.start-->
65+
<!--custom.examples.end-->
66+
67+
## Run the examples
68+
69+
### Instructions
70+
71+
72+
<!--custom.instructions.start-->
73+
<!--custom.instructions.end-->
74+
75+
#### Hello Amazon Location
76+
77+
This example shows you how to get started using Amazon Location.
78+
79+
80+
#### Learn the basics
81+
82+
This example shows you how to do the following:
83+
84+
- Create an Amazon Location map.
85+
- Create an Amazon Location API key.
86+
- Display Map URL.
87+
- Create a geofence collection.
88+
- Store a geofence geometry.
89+
- Create a tracker resource.
90+
- Update the position of a device.
91+
- Retrieve the most recent position update for a specified device.
92+
- Create a route calculator.
93+
- Determine the distance between Seattle and Vancouver.
94+
- Use Amazon Location higher level APIs.
95+
- Delete the Amazon Location Assets.
96+
97+
<!--custom.basic_prereqs.location_Scenario.start-->
98+
<!--custom.basic_prereqs.location_Scenario.end-->
99+
100+
101+
<!--custom.basics.location_Scenario.start-->
102+
<!--custom.basics.location_Scenario.end-->
103+
104+
105+
### Tests
106+
107+
⚠ Running tests might result in charges to your AWS account.
108+
109+
110+
To find instructions for running these tests, see the [README](../../README.md#Tests)
111+
in the `kotlin` folder.
112+
113+
114+
115+
<!--custom.tests.start-->
116+
<!--custom.tests.end-->
117+
118+
## Additional resources
119+
120+
- [Amazon Location Developer Guide](https://docs.aws.amazon.com/location/latest/developerguide/what-is.html)
121+
- [Amazon Location API Reference](https://docs.aws.amazon.com/location/latest/APIReference/Welcome.html)
122+
- [SDK for Kotlin Amazon Location reference](https://sdk.amazonaws.com/kotlin/api/latest/location/index.html)
123+
124+
<!--custom.resources.start-->
125+
<!--custom.resources.end-->
126+
127+
---
128+
129+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
130+
131+
SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)