maps

Creates, updates, deletes, gets or lists a maps resource.

Overview

Name	maps
Type	Resource
Id	aws.location.maps

Fields

The following fields are returned by SELECT queries:

describe_map

Name	Datatype	Description
configuration	object	Specifies the map tile style selected from an available provider.
create_time	string (date-time)	The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
data_source	string	Specifies the data provider for the associated map tiles.
description	string	The optional description for the map resource.
map_arn	string	The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all Amazon Web Services. Format example: arn:aws:geo:region:account-id:map/ExampleMap (pattern: <code>arn(:[a-z0-9]+([.-][a-z0-9]+)):geo(:([a-z0-9]+([.-][a-z0-9]+)))(:[0-9]+):((*)|([-a-z]+[/][*-._\w]+))</code>)
map_name	string	The map style selected from an available provider. (pattern: <code>[-._\w]+</code>)
pricing_plan	string	No longer used. Always returns RequestBasedUsage. (RequestBasedUsage, MobileAssetTracking, MobileAssetManagement)
tags	object	Tags associated with the map resource.
update_time	string (date-time)	The timestamp for when the map resource was last update in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

list_maps

Name	Datatype	Description
create_time	string (date-time)	The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
data_source	string	Specifies the data provider for the associated map tiles.
description	string	The description for the map resource.
map_name	string	The name of the associated map resource. (pattern: <code>[-._\w]+</code>)
pricing_plan	string	No longer used. Always returns RequestBasedUsage. (RequestBasedUsage, MobileAssetTracking, MobileAssetManagement)
update_time	string (date-time)	The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_map	select	map_name, region		This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data. DescribeMap is part of a previous Amazon Location Service Maps API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2). The Maps API version 2 has a simplified interface that can be used without creating or managing map resources. If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is found under geo-maps or geo_maps, not under location. Since Grab is not yet fully supported in Maps API version 2, we recommend you continue using API version 1 when using Grab. Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide. Retrieves the map resource details.
list_maps	select	region		This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data. ListMaps is part of a previous Amazon Location Service Maps API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2). The Maps API version 2 has a simplified interface that can be used without creating or managing map resources. If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is found under geo-maps or geo_maps, not under location. Since Grab is not yet fully supported in Maps API version 2, we recommend you continue using API version 1 when using Grab. Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide. Lists map resources in your Amazon Web Services account.
create_map	insert	region, MapName		This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data. CreateMap is part of a previous Amazon Location Service Maps API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2). The Maps API version 2 has a simplified interface that can be used without creating or managing map resources. If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is found under geo-maps or geo_maps, not under location. Since Grab is not yet fully supported in Maps API version 2, we recommend you continue using API version 1 when using Grab. Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide. Creates a map resource in your Amazon Web Services account, which provides map tiles of different styles sourced from global location data providers. If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.
update_map	update	map_name, region		This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data. UpdateMap is part of a previous Amazon Location Service Maps API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2). The Maps API version 2 has a simplified interface that can be used without creating or managing map resources. If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is found under geo-maps or geo_maps, not under location. Since Grab is not yet fully supported in Maps API version 2, we recommend you continue using API version 1 when using Grab. Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide. Updates the specified properties of a given map resource.
delete_map	delete	map_name, region		This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data. DeleteMap is part of a previous Amazon Location Service Maps API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2). The Maps API version 2 has a simplified interface that can be used without creating or managing map resources. If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is found under geo-maps or geo_maps, not under location. Since Grab is not yet fully supported in Maps API version 2, we recommend you continue using API version 1 when using Grab. Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide. Deletes a map resource from your Amazon Web Services account. This operation deletes the resource permanently. If the map is being used in an application, the map may not render.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
map_name	string	The name of the map resource to be deleted.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_map

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data. DescribeMap is part of a previous Amazon Location Service Maps API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2). The Maps API version 2 has a simplified interface that can be used without creating or managing map resources. If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is found under geo-maps or geo_maps, not under location. Since Grab is not yet fully supported in Maps API version 2, we recommend you continue using API version 1 when using Grab. Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide. Retrieves the map resource details.

SELECT
configuration,
create_time,
data_source,
description,
map_arn,
map_name,
pricing_plan,
tags,
update_time
FROM aws.location.maps
WHERE map_name = '{{ map_name }}' -- required
AND region = '{{ region }}' -- required
;

list_maps

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data. ListMaps is part of a previous Amazon Location Service Maps API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2). The Maps API version 2 has a simplified interface that can be used without creating or managing map resources. If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is found under geo-maps or geo_maps, not under location. Since Grab is not yet fully supported in Maps API version 2, we recommend you continue using API version 1 when using Grab. Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide. Lists map resources in your Amazon Web Services account.

SELECT
create_time,
data_source,
description,
map_name,
pricing_plan,
update_time
FROM aws.location.maps
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_map

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data. CreateMap is part of a previous Amazon Location Service Maps API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2). The Maps API version 2 has a simplified interface that can be used without creating or managing map resources. If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is found under geo-maps or geo_maps, not under location. Since Grab is not yet fully supported in Maps API version 2, we recommend you continue using API version 1 when using Grab. Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide. Creates a map resource in your Amazon Web Services account, which provides map tiles of different styles sourced from global location data providers. If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.

INSERT INTO aws.location.maps (
MapName,
Configuration,
PricingPlan,
Description,
Tags,
region
)
SELECT 
'{{ MapName }}' /* required */,
'{{ Configuration }}',
'{{ PricingPlan }}',
'{{ Description }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
create_time,
map_arn,
map_name
;

Manifest

# Description fields are for documentation purposes
- name: maps
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the maps resource.
  - name: MapName
    value: "{{ MapName }}"
  - name: Configuration
    description: |
      Specifies the map tile style selected from an available provider.
    value:
      Style: "{{ Style }}"
      PoliticalView: "{{ PoliticalView }}"
      CustomLayers:
        - "{{ CustomLayers }}"
  - name: PricingPlan
    value: "{{ PricingPlan }}"
    valid_values: ['RequestBasedUsage', 'MobileAssetTracking', 'MobileAssetManagement']
  - name: Description
    value: "{{ Description }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_map

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data. UpdateMap is part of a previous Amazon Location Service Maps API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2). The Maps API version 2 has a simplified interface that can be used without creating or managing map resources. If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is found under geo-maps or geo_maps, not under location. Since Grab is not yet fully supported in Maps API version 2, we recommend you continue using API version 1 when using Grab. Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide. Updates the specified properties of a given map resource.

UPDATE aws.location.maps
SET 
PricingPlan = '{{ PricingPlan }}',
Description = '{{ Description }}',
ConfigurationUpdate = '{{ ConfigurationUpdate }}'
WHERE 
map_name = '{{ map_name }}' --required
AND region = '{{ region }}' --required
RETURNING
map_arn,
map_name,
update_time;

DELETE examples

delete_map

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data. DeleteMap is part of a previous Amazon Location Service Maps API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2). The Maps API version 2 has a simplified interface that can be used without creating or managing map resources. If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is found under geo-maps or geo_maps, not under location. Since Grab is not yet fully supported in Maps API version 2, we recommend you continue using API version 1 when using Grab. Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide. Deletes a map resource from your Amazon Web Services account. This operation deletes the resource permanently. If the map is being used in an application, the map may not render.

DELETE FROM aws.location.maps
WHERE map_name = '{{ map_name }}' --required
AND region = '{{ region }}' --required
;