Class: Aws::Athena::Types::StartQueryExecutionInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Athena::Types::StartQueryExecutionInput
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-athena/types.rb
Overview
When making an API call, you may pass StartQueryExecutionInput data as a hash:
{
query_string: "QueryString", # required
client_request_token: "IdempotencyToken",
query_execution_context: {
database: "DatabaseString",
},
result_configuration: {
output_location: "String",
encryption_configuration: {
encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
kms_key: "String",
},
},
work_group: "WorkGroupName",
}
Instance Attribute Summary collapse
-
#client_request_token ⇒ String
A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once).
-
#query_execution_context ⇒ Types::QueryExecutionContext
The database within which the query executes.
-
#query_string ⇒ String
The SQL query statements to be executed.
-
#result_configuration ⇒ Types::ResultConfiguration
Specifies information about where and how to save the results of the query execution.
-
#work_group ⇒ String
The name of the workgroup in which the query is being started.
Instance Attribute Details
#client_request_token ⇒ String
A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another ‘StartQueryExecution` 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 AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.
**A suitable default value is auto-generated.** You should normally not need to pass this option.
1115 1116 1117 1118 1119 1120 1121 1122 |
# File 'lib/aws-sdk-athena/types.rb', line 1115 class StartQueryExecutionInput < Struct.new( :query_string, :client_request_token, :query_execution_context, :result_configuration, :work_group) include Aws::Structure end |
#query_execution_context ⇒ Types::QueryExecutionContext
The database within which the query executes.
1115 1116 1117 1118 1119 1120 1121 1122 |
# File 'lib/aws-sdk-athena/types.rb', line 1115 class StartQueryExecutionInput < Struct.new( :query_string, :client_request_token, :query_execution_context, :result_configuration, :work_group) include Aws::Structure end |
#query_string ⇒ String
The SQL query statements to be executed.
1115 1116 1117 1118 1119 1120 1121 1122 |
# File 'lib/aws-sdk-athena/types.rb', line 1115 class StartQueryExecutionInput < Struct.new( :query_string, :client_request_token, :query_execution_context, :result_configuration, :work_group) include Aws::Structure end |
#result_configuration ⇒ Types::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.
1115 1116 1117 1118 1119 1120 1121 1122 |
# File 'lib/aws-sdk-athena/types.rb', line 1115 class StartQueryExecutionInput < Struct.new( :query_string, :client_request_token, :query_execution_context, :result_configuration, :work_group) include Aws::Structure end |
#work_group ⇒ String
The name of the workgroup in which the query is being started.
1115 1116 1117 1118 1119 1120 1121 1122 |
# File 'lib/aws-sdk-athena/types.rb', line 1115 class StartQueryExecutionInput < Struct.new( :query_string, :client_request_token, :query_execution_context, :result_configuration, :work_group) include Aws::Structure end |