api_key
Gets an individual api_key resource
Overview
| Name | api_key |
| Type | Resource |
| Description | api_key |
| Id | awscc.location.api_key |
Fields
| Name | Datatype | Description |
|---|---|---|
create_time | string | |
description | string | |
expire_time | string | |
force_update | boolean | |
key_arn | string | |
key_name | string | |
no_expiry | boolean | |
restrictions | object | |
tags | array | An array of key-value pairs to apply to this resource. |
update_time | string | |
force_delete | boolean | |
arn | string | |
region | string | AWS region. |
Methods
Currently only SELECT is supported for this resource resource.
Example
SELECT
region,
create_time,
description,
expire_time,
force_update,
key_arn,
key_name,
no_expiry,
restrictions,
tags,
update_time,
force_delete,
arn
FROM awscc.location.api_key
WHERE data__Identifier = '<KeyName>';
Permissions
To operate on the api_key resource, the following permissions are required:
Read
geo:DescribeKey
Update
geo:CreateKey,
geo:DescribeKey,
geo:TagResource,
geo:UntagResource,
geo:GetMapTile,
geo:GetMapStyleDescriptor,
geo:GetMapSprites,
geo:GetMapGlyphs,
geo:SearchPlaceIndexForText,
geo:SearchPlaceIndexForPosition,
geo:SearchPlaceIndexForSuggestions,
geo:GetPlace,
geo:CalculateRoute,
geo:CalculateRouteMatrix,
geo:UpdateKey
Delete
geo:DeleteKey,
geo:DescribeKey