Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1458290352.8 KB

Retrieves the API key resource details.

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.

get/metadata/v0/keys/{KeyName}

Path parameters

KeyNamestring required

The name of the API key resource.

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

Descriptionstring

The optional description for the API key resource.

ExpireTimestring date-time required

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

Keystring password required

The key value/string of an API key.

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

The name of the API key resource.

Tagsobject

Tags associated with the API key resource.

UpdateTimestring date-time required

The timestamp for when the API key resource was last updated 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>.