2025/10/24 - Amazon Location Service - 4 updated api methods
Changes Added support for mobile app restrictions in Amazon Location API keys.
{'Restrictions': {'AllowAndroidApps': [{'CertificateFingerprint': 'string',
'Package': 'string'}],
'AllowAppleApps': [{'BundleId': 'string'}]}}
Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer.
For more information, see Use API keys to authenticate in the Amazon Location Service Developer Guide.
See also: AWS API Documentation
Request Syntax
client.create_key(
KeyName='string',
Restrictions={
'AllowActions': [
'string',
],
'AllowResources': [
'string',
],
'AllowReferers': [
'string',
],
'AllowAndroidApps': [
{
'Package': 'string',
'CertificateFingerprint': 'string'
},
],
'AllowAppleApps': [
{
'BundleId': 'string'
},
]
},
Description='string',
ExpireTime=datetime(2015, 1, 1),
NoExpiry=True|False,
Tags={
'string': 'string'
}
)
string
[REQUIRED]
A custom name for the API key resource.
Requirements:
Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
Must be a unique API key name.
No spaces allowed. For example, ExampleAPIKey.
dict
[REQUIRED]
The API key restrictions for the API key resource.
AllowActions (list) -- [REQUIRED]
A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.
The following are valid values for the actions.
Map actions
geo:GetMap* - Allows all actions needed for map rendering.
geo-maps:GetTile - Allows retrieving map tiles.
geo-maps:GetStaticMap - Allows retrieving static map images.
geo-maps:* - Allows all actions related to map functionalities.
Place actions
geo:SearchPlaceIndexForText - Allows geocoding.
geo:SearchPlaceIndexForPosition - Allows reverse geocoding.
geo:SearchPlaceIndexForSuggestions - Allows generating suggestions from text.
GetPlace - Allows finding a place by place ID.
geo-places:Geocode - Allows geocoding using place information.
geo-places:ReverseGeocode - Allows reverse geocoding from location coordinates.
geo-places:SearchNearby - Allows searching for places near a location.
geo-places:SearchText - Allows searching for places based on text input.
geo-places:Autocomplete - Allows auto-completion of place names based on text input.
geo-places:Suggest - Allows generating suggestions for places based on partial input.
geo-places:GetPlace - Allows finding a place by its ID.
geo-places:* - Allows all actions related to place services.
Route actions
geo:CalculateRoute - Allows point to point routing.
geo:CalculateRouteMatrix - Allows calculating a matrix of routes.
geo-routes:CalculateRoutes - Allows calculating multiple routes between points.
geo-routes:CalculateRouteMatrix - Allows calculating a matrix of routes between points.
geo-routes:CalculateIsolines - Allows calculating isolines for a given area.
geo-routes:OptimizeWaypoints - Allows optimizing the order of waypoints in a route.
geo-routes:SnapToRoads - Allows snapping a route to the nearest roads.
geo-routes:* - Allows all actions related to routing functionalities.
(string) --
AllowResources (list) -- [REQUIRED]
A list of allowed resource ARNs that a API key bearer can perform actions on.
The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
The resources must be in the same partition, region, and account-id as the key that is being created.
Other than wildcards, you must include the full ARN, including the arn, partition, service, region, account-id and resource-id delimited by colons (:).
No spaces allowed, even with wildcards. For example, arn:aws:geo:region:account-id:map/ExampleMap*.
For more information about ARN format, see Amazon Resource Names (ARNs).
(string) --
AllowReferers (list) --
An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
Requirements:
Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list $\-._+!*`(),;/?:@=&
May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
May contain wildcard characters question mark (?) and asterisk (*). Question mark (?) will replace any single character (including hexadecimal digits). Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
No spaces allowed. For example, https://example.com.
(string) --
AllowAndroidApps (list) --
An optional list of allowed Android applications for which requests must originate from. Requests using this API key from other sources will not be allowed.
(dict) --
Unique identifying information for an Android app. Consists of a package name and a 20 byte SHA-1 certificate fingerprint.
Package (string) -- [REQUIRED]
Unique package name for an Android app.
CertificateFingerprint (string) -- [REQUIRED]
20 byte SHA-1 certificate fingerprint associated with the Android app signing certificate.
AllowAppleApps (list) --
An optional list of allowed Apple applications for which requests must originate from. Requests using this API key from other sources will not be allowed.
(dict) --
Unique identifying information for an Apple app (iOS, macOS, tvOS and watchOS). Consists of an Apple Bundle ID.
BundleId (string) -- [REQUIRED]
The unique identifier of the app across all Apple platforms (iOS, macOS, tvOS, watchOS, etc.)
string
An optional description for the API key resource.
datetime
The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.
boolean
Optionally set to true to set no expiration time for the API key. One of NoExpiry or ExpireTime must be set.
dict
Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.
Format: "key" : "value"
Restrictions:
Maximum 50 tags per resource
Each resource tag must be unique with a maximum of one value.
Maximum key length: 128 Unicode characters in UTF-8
Maximum value length: 256 Unicode characters in UTF-8
Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
Cannot use "aws:" as a prefix for a key.
(string) --
(string) --
dict
Response Syntax
{
'Key': 'string',
'KeyArn': 'string',
'KeyName': 'string',
'CreateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Key (string) --
The key value/string of an API key. This value is used when making API calls to authorize the call. For example, see GetMapGlyphs.
KeyArn (string) --
The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.
Format example: arn:aws:geo:region:account-id:key/ExampleKey
KeyName (string) --
The name of the API key resource.
CreateTime (datetime) --
The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
{'Restrictions': {'AllowAndroidApps': [{'CertificateFingerprint': 'string',
'Package': 'string'}],
'AllowAppleApps': [{'BundleId': 'string'}]}}
Retrieves the API key resource details.
For more information, see Use API keys to authenticate in the Amazon Location Service Developer Guide.
See also: AWS API Documentation
Request Syntax
client.describe_key(
KeyName='string'
)
string
[REQUIRED]
The name of the API key resource.
dict
Response Syntax
{
'Key': 'string',
'KeyArn': 'string',
'KeyName': 'string',
'Restrictions': {
'AllowActions': [
'string',
],
'AllowResources': [
'string',
],
'AllowReferers': [
'string',
],
'AllowAndroidApps': [
{
'Package': 'string',
'CertificateFingerprint': 'string'
},
],
'AllowAppleApps': [
{
'BundleId': 'string'
},
]
},
'CreateTime': datetime(2015, 1, 1),
'ExpireTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'Description': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Key (string) --
The key value/string of an API key.
KeyArn (string) --
The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.
Format example: arn:aws:geo:region:account-id:key/ExampleKey
KeyName (string) --
The name of the API key resource.
Restrictions (dict) --
API Restrictions on the allowed actions, resources, and referers for an API key resource.
AllowActions (list) --
A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.
The following are valid values for the actions.
Map actions
geo:GetMap* - Allows all actions needed for map rendering.
geo-maps:GetTile - Allows retrieving map tiles.
geo-maps:GetStaticMap - Allows retrieving static map images.
geo-maps:* - Allows all actions related to map functionalities.
Place actions
geo:SearchPlaceIndexForText - Allows geocoding.
geo:SearchPlaceIndexForPosition - Allows reverse geocoding.
geo:SearchPlaceIndexForSuggestions - Allows generating suggestions from text.
GetPlace - Allows finding a place by place ID.
geo-places:Geocode - Allows geocoding using place information.
geo-places:ReverseGeocode - Allows reverse geocoding from location coordinates.
geo-places:SearchNearby - Allows searching for places near a location.
geo-places:SearchText - Allows searching for places based on text input.
geo-places:Autocomplete - Allows auto-completion of place names based on text input.
geo-places:Suggest - Allows generating suggestions for places based on partial input.
geo-places:GetPlace - Allows finding a place by its ID.
geo-places:* - Allows all actions related to place services.
Route actions
geo:CalculateRoute - Allows point to point routing.
geo:CalculateRouteMatrix - Allows calculating a matrix of routes.
geo-routes:CalculateRoutes - Allows calculating multiple routes between points.
geo-routes:CalculateRouteMatrix - Allows calculating a matrix of routes between points.
geo-routes:CalculateIsolines - Allows calculating isolines for a given area.
geo-routes:OptimizeWaypoints - Allows optimizing the order of waypoints in a route.
geo-routes:SnapToRoads - Allows snapping a route to the nearest roads.
geo-routes:* - Allows all actions related to routing functionalities.
(string) --
AllowResources (list) --
A list of allowed resource ARNs that a API key bearer can perform actions on.
The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
The resources must be in the same partition, region, and account-id as the key that is being created.
Other than wildcards, you must include the full ARN, including the arn, partition, service, region, account-id and resource-id delimited by colons (:).
No spaces allowed, even with wildcards. For example, arn:aws:geo:region:account-id:map/ExampleMap*.
For more information about ARN format, see Amazon Resource Names (ARNs).
(string) --
AllowReferers (list) --
An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
Requirements:
Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list $\-._+!*`(),;/?:@=&
May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
May contain wildcard characters question mark (?) and asterisk (*). Question mark (?) will replace any single character (including hexadecimal digits). Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
No spaces allowed. For example, https://example.com.
(string) --
AllowAndroidApps (list) --
An optional list of allowed Android applications for which requests must originate from. Requests using this API key from other sources will not be allowed.
(dict) --
Unique identifying information for an Android app. Consists of a package name and a 20 byte SHA-1 certificate fingerprint.
Package (string) --
Unique package name for an Android app.
CertificateFingerprint (string) --
20 byte SHA-1 certificate fingerprint associated with the Android app signing certificate.
AllowAppleApps (list) --
An optional list of allowed Apple applications for which requests must originate from. Requests using this API key from other sources will not be allowed.
(dict) --
Unique identifying information for an Apple app (iOS, macOS, tvOS and watchOS). Consists of an Apple Bundle ID.
BundleId (string) --
The unique identifier of the app across all Apple platforms (iOS, macOS, tvOS, watchOS, etc.)
CreateTime (datetime) --
The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
ExpireTime (datetime) --
The timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
UpdateTime (datetime) --
The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
Description (string) --
The optional description for the API key resource.
Tags (dict) --
Tags associated with the API key resource.
(string) --
(string) --
{'Entries': {'Restrictions': {'AllowAndroidApps': [{'CertificateFingerprint': 'string',
'Package': 'string'}],
'AllowAppleApps': [{'BundleId': 'string'}]}}}
Lists API key resources in your Amazon Web Services account.
For more information, see Use API keys to authenticate in the Amazon Location Service Developer Guide.
See also: AWS API Documentation
Request Syntax
client.list_keys(
MaxResults=123,
NextToken='string',
Filter={
'KeyStatus': 'Active'|'Expired'
}
)
integer
An optional limit for the number of resources returned in a single call.
Default value: 100
string
The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value: null
dict
Optionally filter the list to only Active or Expired API keys.
KeyStatus (string) --
Filter on Active or Expired API keys.
dict
Response Syntax
{
'Entries': [
{
'KeyName': 'string',
'ExpireTime': datetime(2015, 1, 1),
'Description': 'string',
'Restrictions': {
'AllowActions': [
'string',
],
'AllowResources': [
'string',
],
'AllowReferers': [
'string',
],
'AllowAndroidApps': [
{
'Package': 'string',
'CertificateFingerprint': 'string'
},
],
'AllowAppleApps': [
{
'BundleId': 'string'
},
]
},
'CreateTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Entries (list) --
Contains API key resources in your Amazon Web Services account. Details include API key name, allowed referers and timestamp for when the API key will expire.
(dict) --
An API key resource listed in your Amazon Web Services account.
KeyName (string) --
The name of the API key resource.
ExpireTime (datetime) --
The timestamp for when the API key resource will expire, in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
Description (string) --
The optional description for the API key resource.
Restrictions (dict) --
API Restrictions on the allowed actions, resources, and referers for an API key resource.
AllowActions (list) --
A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.
The following are valid values for the actions.
Map actions
geo:GetMap* - Allows all actions needed for map rendering.
geo-maps:GetTile - Allows retrieving map tiles.
geo-maps:GetStaticMap - Allows retrieving static map images.
geo-maps:* - Allows all actions related to map functionalities.
Place actions
geo:SearchPlaceIndexForText - Allows geocoding.
geo:SearchPlaceIndexForPosition - Allows reverse geocoding.
geo:SearchPlaceIndexForSuggestions - Allows generating suggestions from text.
GetPlace - Allows finding a place by place ID.
geo-places:Geocode - Allows geocoding using place information.
geo-places:ReverseGeocode - Allows reverse geocoding from location coordinates.
geo-places:SearchNearby - Allows searching for places near a location.
geo-places:SearchText - Allows searching for places based on text input.
geo-places:Autocomplete - Allows auto-completion of place names based on text input.
geo-places:Suggest - Allows generating suggestions for places based on partial input.
geo-places:GetPlace - Allows finding a place by its ID.
geo-places:* - Allows all actions related to place services.
Route actions
geo:CalculateRoute - Allows point to point routing.
geo:CalculateRouteMatrix - Allows calculating a matrix of routes.
geo-routes:CalculateRoutes - Allows calculating multiple routes between points.
geo-routes:CalculateRouteMatrix - Allows calculating a matrix of routes between points.
geo-routes:CalculateIsolines - Allows calculating isolines for a given area.
geo-routes:OptimizeWaypoints - Allows optimizing the order of waypoints in a route.
geo-routes:SnapToRoads - Allows snapping a route to the nearest roads.
geo-routes:* - Allows all actions related to routing functionalities.
(string) --
AllowResources (list) --
A list of allowed resource ARNs that a API key bearer can perform actions on.
The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
The resources must be in the same partition, region, and account-id as the key that is being created.
Other than wildcards, you must include the full ARN, including the arn, partition, service, region, account-id and resource-id delimited by colons (:).
No spaces allowed, even with wildcards. For example, arn:aws:geo:region:account-id:map/ExampleMap*.
For more information about ARN format, see Amazon Resource Names (ARNs).
(string) --
AllowReferers (list) --
An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
Requirements:
Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list $\-._+!*`(),;/?:@=&
May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
May contain wildcard characters question mark (?) and asterisk (*). Question mark (?) will replace any single character (including hexadecimal digits). Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
No spaces allowed. For example, https://example.com.
(string) --
AllowAndroidApps (list) --
An optional list of allowed Android applications for which requests must originate from. Requests using this API key from other sources will not be allowed.
(dict) --
Unique identifying information for an Android app. Consists of a package name and a 20 byte SHA-1 certificate fingerprint.
Package (string) --
Unique package name for an Android app.
CertificateFingerprint (string) --
20 byte SHA-1 certificate fingerprint associated with the Android app signing certificate.
AllowAppleApps (list) --
An optional list of allowed Apple applications for which requests must originate from. Requests using this API key from other sources will not be allowed.
(dict) --
Unique identifying information for an Apple app (iOS, macOS, tvOS and watchOS). Consists of an Apple Bundle ID.
BundleId (string) --
The unique identifier of the app across all Apple platforms (iOS, macOS, tvOS, watchOS, etc.)
CreateTime (datetime) --
The timestamp of when the API key was created, in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
UpdateTime (datetime) --
The timestamp of when the API key was last updated, in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
NextToken (string) --
A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.
{'Restrictions': {'AllowAndroidApps': [{'CertificateFingerprint': 'string',
'Package': 'string'}],
'AllowAppleApps': [{'BundleId': 'string'}]}}
Updates the specified properties of a given API key resource.
See also: AWS API Documentation
Request Syntax
client.update_key(
KeyName='string',
Description='string',
ExpireTime=datetime(2015, 1, 1),
NoExpiry=True|False,
ForceUpdate=True|False,
Restrictions={
'AllowActions': [
'string',
],
'AllowResources': [
'string',
],
'AllowReferers': [
'string',
],
'AllowAndroidApps': [
{
'Package': 'string',
'CertificateFingerprint': 'string'
},
],
'AllowAppleApps': [
{
'BundleId': 'string'
},
]
}
)
string
[REQUIRED]
The name of the API key resource to update.
string
Updates the description for the API key resource.
datetime
Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
boolean
Whether the API key should expire. Set to true to set the API key to have no expiration time.
boolean
The boolean flag to be included for updating ExpireTime or Restrictions details.
Must be set to true to update an API key resource that has been used in the past 7 days.
False if force update is not preferred
Default value: False
dict
Updates the API key restrictions for the API key resource.
AllowActions (list) -- [REQUIRED]
A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.
The following are valid values for the actions.
Map actions
geo:GetMap* - Allows all actions needed for map rendering.
geo-maps:GetTile - Allows retrieving map tiles.
geo-maps:GetStaticMap - Allows retrieving static map images.
geo-maps:* - Allows all actions related to map functionalities.
Place actions
geo:SearchPlaceIndexForText - Allows geocoding.
geo:SearchPlaceIndexForPosition - Allows reverse geocoding.
geo:SearchPlaceIndexForSuggestions - Allows generating suggestions from text.
GetPlace - Allows finding a place by place ID.
geo-places:Geocode - Allows geocoding using place information.
geo-places:ReverseGeocode - Allows reverse geocoding from location coordinates.
geo-places:SearchNearby - Allows searching for places near a location.
geo-places:SearchText - Allows searching for places based on text input.
geo-places:Autocomplete - Allows auto-completion of place names based on text input.
geo-places:Suggest - Allows generating suggestions for places based on partial input.
geo-places:GetPlace - Allows finding a place by its ID.
geo-places:* - Allows all actions related to place services.
Route actions
geo:CalculateRoute - Allows point to point routing.
geo:CalculateRouteMatrix - Allows calculating a matrix of routes.
geo-routes:CalculateRoutes - Allows calculating multiple routes between points.
geo-routes:CalculateRouteMatrix - Allows calculating a matrix of routes between points.
geo-routes:CalculateIsolines - Allows calculating isolines for a given area.
geo-routes:OptimizeWaypoints - Allows optimizing the order of waypoints in a route.
geo-routes:SnapToRoads - Allows snapping a route to the nearest roads.
geo-routes:* - Allows all actions related to routing functionalities.
(string) --
AllowResources (list) -- [REQUIRED]
A list of allowed resource ARNs that a API key bearer can perform actions on.
The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
The resources must be in the same partition, region, and account-id as the key that is being created.
Other than wildcards, you must include the full ARN, including the arn, partition, service, region, account-id and resource-id delimited by colons (:).
No spaces allowed, even with wildcards. For example, arn:aws:geo:region:account-id:map/ExampleMap*.
For more information about ARN format, see Amazon Resource Names (ARNs).
(string) --
AllowReferers (list) --
An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.
Requirements:
Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list $\-._+!*`(),;/?:@=&
May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
May contain wildcard characters question mark (?) and asterisk (*). Question mark (?) will replace any single character (including hexadecimal digits). Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).
No spaces allowed. For example, https://example.com.
(string) --
AllowAndroidApps (list) --
An optional list of allowed Android applications for which requests must originate from. Requests using this API key from other sources will not be allowed.
(dict) --
Unique identifying information for an Android app. Consists of a package name and a 20 byte SHA-1 certificate fingerprint.
Package (string) -- [REQUIRED]
Unique package name for an Android app.
CertificateFingerprint (string) -- [REQUIRED]
20 byte SHA-1 certificate fingerprint associated with the Android app signing certificate.
AllowAppleApps (list) --
An optional list of allowed Apple applications for which requests must originate from. Requests using this API key from other sources will not be allowed.
(dict) --
Unique identifying information for an Apple app (iOS, macOS, tvOS and watchOS). Consists of an Apple Bundle ID.
BundleId (string) -- [REQUIRED]
The unique identifier of the app across all Apple platforms (iOS, macOS, tvOS, watchOS, etc.)
dict
Response Syntax
{
'KeyArn': 'string',
'KeyName': 'string',
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
KeyArn (string) --
The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.
Format example: arn:aws:geo:region:account-id:key/ExampleKey
KeyName (string) --
The name of the API key resource.
UpdateTime (datetime) --
The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.