LocationService / Client / update_key

update_key

LocationService.Client.update_key(**kwargs)

Updates the specified properties of a given API key resource.

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.update_key(
    Description='string',
    ExpireTime=datetime(2015, 1, 1),
    ForceUpdate=True|False,
    KeyName='string',
    NoExpiry=True|False,
    Restrictions={
        'AllowActions': [
            'string',
        ],
        'AllowReferers': [
            'string',
        ],
        'AllowResources': [
            'string',
        ]
    }
)

Parameters:

• Description (string) – Updates the description for the API key resource.

• ExpireTime (datetime) – Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

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

• KeyName (string) –

  [REQUIRED]

  The name of the API key resource to update.

• NoExpiry (boolean) – Whether the API key should expire. Set to true to set the API key to have no expiration time.

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

    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) – [REQUIRED]

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

Return type:

dict

Returns:

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.

Exceptions

• LocationService.Client.exceptions.InternalServerException

• LocationService.Client.exceptions.ResourceNotFoundException

• LocationService.Client.exceptions.AccessDeniedException

• LocationService.Client.exceptions.ValidationException

• LocationService.Client.exceptions.ThrottlingException