Class: Aws::Athena::Types::CreateNamedQueryInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Athena::Types::CreateNamedQueryInput
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-athena/types.rb
Overview
When making an API call, you may pass CreateNamedQueryInput data as a hash:
{
name: "NameString", # required
description: "DescriptionString",
database: "DatabaseString", # required
query_string: "QueryString", # required
client_request_token: "IdempotencyToken",
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).
-
#database ⇒ String
The database to which the query belongs.
-
#description ⇒ String
The query description.
-
#name ⇒ String
The query name.
-
#query_string ⇒ String
The contents of the query with all query statements.
-
#work_group ⇒ String
The name of the workgroup in which the named query is being created.
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 ‘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 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.
189 190 191 192 193 194 195 196 197 |
# File 'lib/aws-sdk-athena/types.rb', line 189 class CreateNamedQueryInput < Struct.new( :name, :description, :database, :query_string, :client_request_token, :work_group) include Aws::Structure end |
#database ⇒ String
The database to which the query belongs.
189 190 191 192 193 194 195 196 197 |
# File 'lib/aws-sdk-athena/types.rb', line 189 class CreateNamedQueryInput < Struct.new( :name, :description, :database, :query_string, :client_request_token, :work_group) include Aws::Structure end |
#description ⇒ String
The query description.
189 190 191 192 193 194 195 196 197 |
# File 'lib/aws-sdk-athena/types.rb', line 189 class CreateNamedQueryInput < Struct.new( :name, :description, :database, :query_string, :client_request_token, :work_group) include Aws::Structure end |
#name ⇒ String
The query name.
189 190 191 192 193 194 195 196 197 |
# File 'lib/aws-sdk-athena/types.rb', line 189 class CreateNamedQueryInput < Struct.new( :name, :description, :database, :query_string, :client_request_token, :work_group) include Aws::Structure end |
#query_string ⇒ String
The contents of the query with all query statements.
189 190 191 192 193 194 195 196 197 |
# File 'lib/aws-sdk-athena/types.rb', line 189 class CreateNamedQueryInput < Struct.new( :name, :description, :database, :query_string, :client_request_token, :work_group) include Aws::Structure end |
#work_group ⇒ String
The name of the workgroup in which the named query is being created.
189 190 191 192 193 194 195 196 197 |
# File 'lib/aws-sdk-athena/types.rb', line 189 class CreateNamedQueryInput < Struct.new( :name, :description, :database, :query_string, :client_request_token, :work_group) include Aws::Structure end |