Class: Aws::LakeFormation::Types::StartQueryPlanningRequest

Inherits:

Struct

Object
Struct
Aws::LakeFormation::Types::StartQueryPlanningRequest

show all

Defined in:: gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb

Overview

Note:

When making an API call, you may pass StartQueryPlanningRequest data as a hash:

{
  query_planning_context: { # required
    catalog_id: "CatalogIdString",
    database_name: "QueryPlanningContextDatabaseNameString", # required
    query_as_of_time: Time.now,
    query_parameters: {
      "String" => "String",
    },
    transaction_id: "TransactionIdString",
  },
  query_string: "SyntheticStartQueryPlanningRequestQueryString", # required
}

Constant Summary collapse

SENSITIVE =

[:query_string]

Instance Attribute Summary collapse

#query_planning_context ⇒ Types::QueryPlanningContext
A structure containing information about the query plan.
#query_string ⇒ String
A PartiQL query statement used as an input to the planner service.

Instance Attribute Details

#query_planning_context ⇒ `Types::QueryPlanningContext`

A structure containing information about the query plan.

Returns:

(Types::QueryPlanningContext)

# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 3816

class StartQueryPlanningRequest < Struct.new(
  :query_planning_context,
  :query_string)
  SENSITIVE = [:query_string]
  include Aws::Structure
end

#query_string ⇒ `String`

A PartiQL query statement used as an input to the planner service.