Skip to content

Create Named Query

athena_create_named_query R Documentation

Creates a named query in the specified workgroup

Description

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

Usage

athena_create_named_query(Name, Description, Database, QueryString,
  ClientRequestToken, WorkGroup)

Arguments

Name

[required] The query name.

Description

The query description.

Database

[required] The database to which the query belongs.

QueryString

[required] The contents of the query with all query statements.

ClientRequestToken

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another create_named_query 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.

WorkGroup

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

Value

A list with the following syntax:

list(
  NamedQueryId = "string"
)

Request syntax

svc$create_named_query(
  Name = "string",
  Description = "string",
  Database = "string",
  QueryString = "string",
  ClientRequestToken = "string",
  WorkGroup = "string"
)