LocationService / Client / describe_key



Retrieves the API key resource details.

See also: AWS API Documentation

Request Syntax

response = client.describe_key(

KeyName (string) –


The name of the API key resource.

Return type:



Response Syntax

    'CreateTime': datetime(2015, 1, 1),
    'Description': 'string',
    'ExpireTime': datetime(2015, 1, 1),
    'Key': 'string',
    'KeyArn': 'string',
    'KeyName': 'string',
    'Restrictions': {
        'AllowActions': [
        'AllowReferers': [
        'AllowResources': [
    'Tags': {
        'string': 'string'
    'UpdateTime': datetime(2015, 1, 1)

Response Structure

  • (dict) –

    • CreateTime (datetime) –

      The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

    • Description (string) –

      The optional description for 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.

    • 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.

        • 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.

        • Route actions

          • geo:CalculateRoute - Allows point to point routing.

          • geo:CalculateRouteMatrix - Allows calculating a matrix of routes.


        You must use these strings exactly. For example, to provide access to map rendering, the only valid action is geo:GetMap* as an input to the list. ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not. Similarly, you cannot use ["geo:SearchPlaceIndexFor*"] - you must list each of the Place actions separately.

        • (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.


        • 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) –

      • 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) –

    • Tags (dict) –

      Tags associated with the API key resource.

      • (string) –

        • (string) –

    • UpdateTime (datetime) –

      The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.


  • LocationService.Client.exceptions.InternalServerException

  • LocationService.Client.exceptions.ResourceNotFoundException

  • LocationService.Client.exceptions.AccessDeniedException

  • LocationService.Client.exceptions.ValidationException

  • LocationService.Client.exceptions.ThrottlingException