Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1458290352.8 KB

Updates the specified properties of a given API key resource.

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.

patch/metadata/v0/keys/{KeyName}

Path parameters

KeyNamestring required

The name of the API key resource to update.

Request body

Descriptionstring

Updates the description for the API key resource.

ExpireTimestring date-time

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

ForceUpdateboolean
<p>The boolean flag to be included for updating <code>ExpireTime</code> or <code>Restrictions</code> details.</p> <p>Must be set to <code>true</code> to update an API key resource that has been used in the past 7 days.</p> <p> <code>False</code> if force update is not preferred</p> <p>Default value: <code>False</code> </p>
NoExpiryboolean

Whether the API key should expire. Set to <code>true</code> to set the API key to have no expiration time.

Response

Success

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.

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