map_style_descriptors
Creates, updates, deletes, gets or lists a map_style_descriptors resource.
Overview
| Name | map_style_descriptors |
| Type | Resource |
| Id | aws.location.map_style_descriptors |
Fields
The following fields are returned by SELECT queries:
- get_map_style_descriptor
| Name | Datatype | Description |
|---|---|---|
blob | string (byte) | Contains the body of the style descriptor. |
cache_control | string | The HTTP Cache-Control directive for the value. |
content_type | string | The style descriptor's content type. For example, application/json. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_map_style_descriptor | select | map_name, region | key | This operation is no longer current and may be deprecated in the future. We recommend upgrading to GetStyleDescriptor unless you require Grab data. GetMapStyleDescriptor 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 version 2 GetStyleDescriptor operation gives a better user experience and is compatible with the remainder of the V2 Maps API. 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 style descriptor from a map resource. The style descriptor contains specifications 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. |
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 map resource to retrieve the style descriptor from. |
region | string | AWS region (default: us-east-1) |
key | string | The optional API key to authorize the request. |
SELECT examples
- get_map_style_descriptor
This operation is no longer current and may be deprecated in the future. We recommend upgrading to GetStyleDescriptor unless you require Grab data. GetMapStyleDescriptor 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 version 2 GetStyleDescriptor operation gives a better user experience and is compatible with the remainder of the V2 Maps API. 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 style descriptor from a map resource. The style descriptor contains specifications 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.
SELECT
blob,
cache_control,
content_type
FROM aws.location.map_style_descriptors
WHERE map_name = '{{ map_name }}' -- required
AND region = '{{ region }}' -- required
AND key = '{{ key }}'
;