Skip to navigation

Get database compute settings

Beta

Read the database’s auto-suspend window, the same setting as auto-suspend in the database’s Settings in Athena. Reading never wakes the database.

A database suspends (scales to zero) after suspend_timeout_seconds without activity; GET/PATCH /databases/{asset_id}/settings read and set that window, and 0 keeps it running. Reading the compute status or the settings never wakes a suspended database. Two things do: POST /databases/{asset_id}/wake, which answers at once while the compute starts, or any request that runs SQL on it, such as POST /databases/{asset_id}/sql, which waits for the compute up to 120 seconds; if the compute is still starting then, the answer is 503 with Retry-After and the statement did not run. A cold start usually takes 30 seconds to 2 minutes.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

asset_idstringRequired

Headers

X-Athena-Session-CredentialstringOptional

Response

Successful Response
asset_idstring
The database asset ID
suspend_timeout_secondsinteger

Seconds without activity after which the database suspends (scales to zero). 0 means it never suspends: the compute keeps running, and keeps using capacity, until you change this. Otherwise 60 to 86400 (24 hours). A new database starts with 1800 (30 minutes). The same setting as auto-suspend in the database’s Settings in Athena.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
501
Not Implemented Error
503
Service Unavailable Error