Class: Aws::Athena::Types::CreateNamedQueryInput

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 CreateNamedQueryInput data as a hash:

{
  name: "NameString", # required
  description: "DescriptionString",
  database: "DatabaseString", # required
  query_string: "QueryString", # required
  client_request_token: "IdempotencyToken",
  work_group: "WorkGroupName",
}

Constant Summary collapse

SENSITIVE =
[]

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 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 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.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


456
457
458
459
460
461
462
463
464
465
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 456

class CreateNamedQueryInput < Struct.new(
  :name,
  :description,
  :database,
  :query_string,
  :client_request_token,
  :work_group)
  SENSITIVE = []
  include Aws::Structure
end

#databaseString

The database to which the query belongs.

Returns:

  • (String)


456
457
458
459
460
461
462
463
464
465
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 456

class CreateNamedQueryInput < Struct.new(
  :name,
  :description,
  :database,
  :query_string,
  :client_request_token,
  :work_group)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The query description.

Returns:

  • (String)


456
457
458
459
460
461
462
463
464
465
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 456

class CreateNamedQueryInput < Struct.new(
  :name,
  :description,
  :database,
  :query_string,
  :client_request_token,
  :work_group)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The query name.

Returns:

  • (String)


456
457
458
459
460
461
462
463
464
465
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 456

class CreateNamedQueryInput < Struct.new(
  :name,
  :description,
  :database,
  :query_string,
  :client_request_token,
  :work_group)
  SENSITIVE = []
  include Aws::Structure
end

#query_stringString

The contents of the query with all query statements.

Returns:

  • (String)


456
457
458
459
460
461
462
463
464
465
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 456

class CreateNamedQueryInput < Struct.new(
  :name,
  :description,
  :database,
  :query_string,
  :client_request_token,
  :work_group)
  SENSITIVE = []
  include Aws::Structure
end

#work_groupString

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

Returns:

  • (String)


456
457
458
459
460
461
462
463
464
465
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 456

class CreateNamedQueryInput < Struct.new(
  :name,
  :description,
  :database,
  :query_string,
  :client_request_token,
  :work_group)
  SENSITIVE = []
  include Aws::Structure
end