Athena / Client / create_named_query

create_named_query#

Athena.Client.create_named_query(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.create_named_query(
    Name='string',
    Description='string',
    Database='string',
    QueryString='string',
    ClientRequestToken='string',
    WorkGroup='string'
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The query name.

  • Description (string) – The query description.

  • Database (string) –

    [REQUIRED]

    The database to which the query belongs.

  • QueryString (string) –

    [REQUIRED]

    The contents of the query with all query statements.

  • ClientRequestToken (string) –

    A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another CreateNamedQuery request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

    Warning

    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.

    This field is autopopulated if not provided.

  • WorkGroup (string) – The name of the workgroup in which the named query is being created.

Return type:

dict

Returns:

Response Syntax

{
    'NamedQueryId': 'string'
}

Response Structure

  • (dict) –

    • NamedQueryId (string) –

      The unique ID of the query.

Exceptions

  • Athena.Client.exceptions.InternalServerException

  • Athena.Client.exceptions.InvalidRequestException