You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Athena::Types::StartQueryExecutionInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb

Overview

Note:

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: { # required
    output_location: "String", # required
    encryption_configuration: {
      encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
      kms_key: "String",
    },
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

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.

Returns:

  • (String)


735
736
737
738
739
740
741
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 735

class StartQueryExecutionInput < Struct.new(
  :query_string,
  :client_request_token,
  :query_execution_context,
  :result_configuration)
  include Aws::Structure
end

#query_execution_contextTypes::QueryExecutionContext

The database within which the query executes.



735
736
737
738
739
740
741
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 735

class StartQueryExecutionInput < Struct.new(
  :query_string,
  :client_request_token,
  :query_execution_context,
  :result_configuration)
  include Aws::Structure
end

#query_stringString

The SQL query statements to be executed.

Returns:

  • (String)


735
736
737
738
739
740
741
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 735

class StartQueryExecutionInput < Struct.new(
  :query_string,
  :client_request_token,
  :query_execution_context,
  :result_configuration)
  include Aws::Structure
end

#result_configurationTypes::ResultConfiguration

Specifies information about where and how to save the results of the query execution.



735
736
737
738
739
740
741
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 735

class StartQueryExecutionInput < Struct.new(
  :query_string,
  :client_request_token,
  :query_execution_context,
  :result_configuration)
  include Aws::Structure
end