Aws/location
@swamp/aws/locationv2026.10.25.1
01README
AWS LOCATION infrastructure models
02Behaviors
@swamp/aws/location/apikeyv2026.10.23.1apikey.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Description? | string | |
| ExpireTime? | string | The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ) |
| ForceUpdate? | boolean | |
| KeyName | string | |
| NoExpiry? | boolean | |
| Restrictions | object | |
| Tags? | array | An array of key-value pairs to apply to this resource. |
| ForceDelete? | boolean |
fn create()
Create a Location APIKey
fn get(identifier: string)
Get a Location APIKey
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Location APIKey |
fn update()
Update a Location APIKey
fn delete(identifier: string)
Delete a Location APIKey
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Location APIKey |
fn sync()
Sync Location APIKey state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Location APIKey resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Location APIKey resource state
@swamp/aws/location/geofence-collectionv2026.10.23.1geofence_collection.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| CollectionName | string | |
| Description? | string | |
| KmsKeyId? | string | |
| PricingPlan? | enum | |
| PricingPlanDataSource? | string | This shape is deprecated since 2022-02-01: Deprecated. No longer allowed. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a Location GeofenceCollection
fn get(identifier: string)
Get a Location GeofenceCollection
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Location GeofenceCollection |
fn update()
Update a Location GeofenceCollection
fn delete(identifier: string)
Delete a Location GeofenceCollection
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Location GeofenceCollection |
fn sync()
Sync Location GeofenceCollection state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Location GeofenceCollection resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Location GeofenceCollection resource state
@swamp/aws/location/mapv2026.10.23.1map.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Configuration | object | |
| Description? | string | |
| MapName | string | |
| PricingPlan? | enum | |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a Location Map
fn get(identifier: string)
Get a Location Map
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Location Map |
fn update()
Update a Location Map
fn delete(identifier: string)
Delete a Location Map
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Location Map |
fn sync()
Sync Location Map state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Location Map resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Location Map resource state
@swamp/aws/location/place-indexv2026.10.23.1place_index.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DataSource | string | |
| DataSourceConfiguration? | object | |
| Description? | string | |
| IndexName | string | |
| PricingPlan? | enum | |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a Location PlaceIndex
fn get(identifier: string)
Get a Location PlaceIndex
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Location PlaceIndex |
fn update()
Update a Location PlaceIndex
fn delete(identifier: string)
Delete a Location PlaceIndex
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Location PlaceIndex |
fn sync()
Sync Location PlaceIndex state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Location PlaceIndex resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Location PlaceIndex resource state
@swamp/aws/location/route-calculatorv2026.10.23.1route_calculator.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| CalculatorName | string | |
| DataSource | string | |
| Description? | string | |
| PricingPlan? | enum | |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a Location RouteCalculator
fn get(identifier: string)
Get a Location RouteCalculator
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Location RouteCalculator |
fn update()
Update a Location RouteCalculator
fn delete(identifier: string)
Delete a Location RouteCalculator
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Location RouteCalculator |
fn sync()
Sync Location RouteCalculator state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Location RouteCalculator resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Location RouteCalculator resource state
@swamp/aws/location/trackerv2026.10.23.1tracker.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Description? | string | |
| EventBridgeEnabled? | boolean | |
| KmsKeyEnableGeospatialQueries? | boolean | |
| KmsKeyId? | string | |
| PositionFiltering? | enum | |
| PricingPlan? | enum | |
| PricingPlanDataSource? | string | This shape is deprecated since 2022-02-01: Deprecated. No longer allowed. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
| TrackerName | string |
fn create()
Create a Location Tracker
fn get(identifier: string)
Get a Location Tracker
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Location Tracker |
fn update()
Update a Location Tracker
fn delete(identifier: string)
Delete a Location Tracker
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Location Tracker |
fn sync()
Sync Location Tracker state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Location Tracker resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Location Tracker resource state
@swamp/aws/location/tracker-consumerv2026.10.23.1tracker_consumer.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ConsumerArn | string | |
| TrackerName | string |
fn create()
Create a Location TrackerConsumer
fn get(identifier: string)
Get a Location TrackerConsumer
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Location TrackerConsumer |
fn delete(identifier: string)
Delete a Location TrackerConsumer
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Location TrackerConsumer |
fn sync()
Sync Location TrackerConsumer state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Location TrackerConsumer resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Location TrackerConsumer resource state
03Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: apikey, geofence_collection, map, place_index, route_calculator, tracker, tracker_consumer
2026.10.13.1
- Updated: apikey, geofence_collection, map, place_index, route_calculator, tracker, tracker_consumer
2026.10.08.1
2026.10.06.1
2026.10.04.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
2026.09.30.1
2026.09.29.1
2026.09.28.1
2026.09.27.1
2026.09.26.1
2026.09.25.1
2026.09.24.1
2026.09.23.1
2026.09.22.1
2026.09.21.1
04Stats
A
100 / 100
Downloads
33
Archive size
1.4 MB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
05Platforms
06Labels