Start Query Execution
athena_start_query_execution | R Documentation |
Runs the SQL query statements contained in the Query¶
Description¶
Runs the SQL query statements contained in the Query
. Requires you to
have access to the workgroup in which the query ran. Running queries
against an external catalog requires get_data_catalog
permission to
the catalog. For code samples using the Amazon Web Services SDK for
Java, see Examples and Code
Samples
in the Amazon Athena User Guide.
Usage¶
athena_start_query_execution(QueryString, ClientRequestToken,
QueryExecutionContext, ResultConfiguration, WorkGroup,
ExecutionParameters, ResultReuseConfiguration)
Arguments¶
QueryString
[required] The SQL query statements to be executed.
ClientRequestToken
A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another
start_query_execution
request is received, the same response is returned and another query is not created. An error is returned if a parameter, such asQueryString
, has changed. A call tostart_query_execution
that uses a previous client request token returns the sameQueryExecutionId
even if the requester doesn't have permission on the tables specified inQueryString
.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.
QueryExecutionContext
The database within which the query executes.
ResultConfiguration
Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
WorkGroup
The name of the workgroup in which the query is being started.
ExecutionParameters
A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.
ResultReuseConfiguration
Specifies the query result reuse behavior for the query.
Value¶
A list with the following syntax:
Request syntax¶
svc$start_query_execution(
QueryString = "string",
ClientRequestToken = "string",
QueryExecutionContext = list(
Database = "string",
Catalog = "string"
),
ResultConfiguration = list(
OutputLocation = "string",
EncryptionConfiguration = list(
EncryptionOption = "SSE_S3"|"SSE_KMS"|"CSE_KMS",
KmsKey = "string"
),
ExpectedBucketOwner = "string",
AclConfiguration = list(
S3AclOption = "BUCKET_OWNER_FULL_CONTROL"
)
),
WorkGroup = "string",
ExecutionParameters = list(
"string"
),
ResultReuseConfiguration = list(
ResultReuseByAgeConfiguration = list(
Enabled = TRUE|FALSE,
MaxAgeInMinutes = 123
)
)
)