Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1460298233.0 KB

Creates a named query in the specified workgroup. Requires that you have access to the workgroup.

For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

post/#X-Amz-Target=AmazonAthena.CreateNamedQuery

Headers

X-Amz-Target'AmazonAthena.CreateNamedQuery' required

Request body

Namestring required

The query name.

Descriptionstring

The query description.

Databasestring required

The database to which the query belongs.

QueryStringstring required

The contents of the query with all query statements.

ClientRequestTokenstring
<p>A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another <code>CreateNamedQuery</code> request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the <code>QueryString</code>, an error is returned.</p> <important> <p>This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.</p> </important>
WorkGroupstring

The name of the workgroup in which the named query is being created.

Response

Success

NamedQueryIdstring

The unique ID of the query.