Post metadatav0keys — location

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1458290352.8 KB

Creates an API key resource in your Amazon Web Services account, which lets you grant geo:GetMap* actions for Amazon Location Map resources to the API key bearer.

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.

post/metadata/v0/keys

Request body

Descriptionstring

An optional description for the API key resource.

ExpireTimestring date-time

The optional timestamp for when the API key resource will expire in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. One of <code>NoExpiry</code> or <code>ExpireTime</code> must be set.

KeyNamestring required

A custom name for the API key resource. Requirements: <ul> <li> Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). </li> <li> Must be a unique API key name. </li> <li> No spaces allowed. For example, <code>ExampleAPIKey</code>. </li> </ul>

NoExpiryboolean

Optionally set to <code>true</code> to set no expiration time for the API key. One of <code>NoExpiry</code> or <code>ExpireTime</code> must be set.

Tagsobject

Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them. Format: <code>"key" : "value"</code> Restrictions: <ul> <li> Maximum 50 tags per resource </li> <li> Each resource tag must be unique with a maximum of one value. </li> <li> Maximum key length: 128 Unicode characters in UTF-8 </li> <li> Maximum value length: 256 Unicode characters in UTF-8 </li> <li> Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. </li> <li> Cannot use "aws:" as a prefix for a key. </li> </ul>

Response

Success

CreateTimestring date-time required

The timestamp for when the API key resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.

Keystring password required

The key value/string of an API key. This value is used when making API calls to authorize the call. For example, see <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_GetMapGlyphs.html">GetMapGlyphs</a>.

KeyArnstring required

The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services. <ul> <li> Format example: <code>arn:aws:geo:region:account-id:key/ExampleKey</code> </li> </ul>

KeyNamestring required

The name of the API key resource.