LocationService / Client / describe_key

describe_key

LocationService.Client.describe_key(**kwargs)

Retrieves the API key resource details.

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.describe_key(
    KeyName='string'
)

Parameters:

KeyName (string) –

[REQUIRED]

The name of the API key resource.

Return type:

dict

Returns:

Response Syntax

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

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

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

Exceptions

• LocationService.Client.exceptions.InternalServerException

• LocationService.Client.exceptions.ResourceNotFoundException

• LocationService.Client.exceptions.AccessDeniedException

• LocationService.Client.exceptions.ValidationException

• LocationService.Client.exceptions.ThrottlingException