Skip to content

CreateNamedQueryInput

Source code in docs_src/capo_athena/types/create_named_query_input.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class CreateNamedQueryInput(TypedDict, closed=True):
    name: "capo_athena.types.name_string.NameString"
    """<p>The query name.</p>"""
    description: NotRequired["capo_athena.types.description_string.DescriptionString"]
    """<p>The query description.</p>"""
    database: "capo_athena.types.database_string.DatabaseString"
    """<p>The database to which the query belongs.</p>"""
    query_string: "capo_athena.types.query_string.QueryString"
    """<p>The contents of the query with all query statements.</p>"""
    client_request_token: NotRequired[
        "capo_athena.types.idempotency_token.IdempotencyToken"
    ]
    """<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>"""
    work_group: NotRequired["capo_athena.types.work_group_name.WorkGroupName"]
    """<p>The name of the workgroup in which the named query is being created.</p>"""

client_request_token instance-attribute 

client_request_token: NotRequired[IdempotencyToken]

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.

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.

database instance-attribute 

database: DatabaseString

The database to which the query belongs.

description instance-attribute 

description: NotRequired[DescriptionString]

The query description.

name instance-attribute 

name: NameString

The query name.

query_string instance-attribute 

query_string: QueryString

The contents of the query with all query statements.

work_group instance-attribute 

work_group: NotRequired[WorkGroupName]

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