UpdateApiKey - Amazon AppSync
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Updates an API key. You can update the key as long as it's not deleted.

Request Syntax

POST /apis/apiId/apikeys/id HTTP/1.1 Content-type: application/json { "description": "string", "expires": number }

URI Request Parameters

The request uses the following URI parameters.


The ID for the GraphQL API.

Required: Yes


The API key ID.

Required: Yes

Request Body

The request accepts the following data in JSON format.


A description of the purpose of the API key.

Type: String

Required: No


From the update time, the time after which the API key expires. The date is represented as seconds since the epoch. For more information, see ApiKey.

Type: Long

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "apiKey": { "deletes": number, "description": "string", "expires": number, "id": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The API key.

Type: ApiKey object


For information about the errors that are common to all actions, see Common Errors.


The API key expiration must be set to a value between 1 and 365 days from creation (for CreateApiKey) or from update (for UpdateApiKey).

HTTP Status Code: 400


The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

HTTP Status Code: 400


An internal Amazon AppSync error occurred. Try your request again.

HTTP Status Code: 500


The request exceeded a limit. Try your request again.

HTTP Status Code: 429


The resource specified in the request was not found. Check the resource, and then try again.

HTTP Status Code: 404


You aren't authorized to perform this operation.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: