list_keys

LocationService.Client.list_keys(**kwargs)

Lists API key resources in your Amazon Web Services account.

Warning

The API keys feature is in preview. We may add, change, or remove features before announcing general availability. For more information, see Using API keys.

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

          Note

          Currently, the only valid action is geo:GetMap* as an input to the list. For example, ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not.

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

          For more information about ARN format, see Amazon Resource Names (ARNs).

          Note

          In this preview, you can allow only map resources.

          Requirements:

          • Must be prefixed with arn .
          • partition and service must not be empty and should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).
          • region and account-id can be empty or should begin with only alphanumeric characters (A–Z, a–z, 0–9) and contain only alphanumeric numbers, hyphens (-) and periods (.).
          • resource-id can begin with any character except for forward slash (/) and contain any characters after, including forward slashes to form a path. resource-id can also include wildcard characters, denoted by an asterisk (*).
          • arn , partition , service , region , account-id and resource-id must be delimited by a colon (:).
          • No spaces allowed. For example, arn:aws:geo:region:account-id:map/ExampleMap* .
          • (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