LocationService / Client / list_keys

list_keys

LocationService.Client.list_keys(**kwargs)

Lists API key resources in your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_keys(
    Filter={
        'KeyStatus': 'Active'|'Expired'
    },
    MaxResults=123,
    NextToken='string'
)

Parameters:

• Filter (dict) –

  Optionally filter the list to only Active or Expired API keys.

  • KeyStatus (string) –

    Filter on Active or Expired API keys.

• MaxResults (integer) –

  An optional limit for the number of resources returned in a single call.

  Default value: 100

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

Return type:

dict

Returns:

Response Syntax

{
    'Entries': [
        {
            'CreateTime': datetime(2015, 1, 1),
            'Description': 'string',
            'ExpireTime': datetime(2015, 1, 1),
            'KeyName': 'string',
            'Restrictions': {
                'AllowActions': [
                    'string',
                ],
                'AllowReferers': [
                    'string',
                ],
                'AllowResources': [
                    'string',
                ]
            },
            '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.

      • CreateTime (datetime) –

        The timestamp of when the API key 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.

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

          Note

          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.

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

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

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

Exceptions

• LocationService.Client.exceptions.InternalServerException

• LocationService.Client.exceptions.AccessDeniedException

• LocationService.Client.exceptions.ValidationException

• LocationService.Client.exceptions.ThrottlingException